This endpoint returns a list of documents for the user.  The returned list will be determined by the permissions/access of the API client.


GET api/library/documents/list/get/{tenant_subdomainname}/{user_id}



Request


Url Params

tenant_subDomainName
string
subdomain name of the tenant
user_idintsystem id of the user



Query Params

The end point supports oData filtering.  You are able to filter the results of the request by passing in the following query parameter in the request.  


$filter
any valid oData filter e.g. inlinecount, orderby, top or skip.  This query param is optional

this example returns only tenants whose name contains 'beta'


Authorization

The following authorization header is required.  The authorisation header should be set to a 'Bearer Token' type


Token
see How to get a bearer token


Response

The response will return an array of 0 to n JSON objects.  Each JSON object in the array contains the following properties:


fileGuidguidthe unique reference of the file
fileNamestringname of the file
fileExtensionstringthe extension of the file
title
stringtitle of the file
limitFileAccess
boolis file access limited
auditAccess
boolIs file accessible for audit
fileType
inttype of the file
fileCategoryId
int

fileCategory

object


id

intthe id of document folder category

isSystem

boolis the folder platform level folder

hasUserDocuments

booldoes folder has user documents

canUserUpload

boolis user allowed to upload

name

stringthe name of the user document folder category

displayName

stringdisplay name of the user document folder category

alwaysShow

boolis document always visible

orderPriority

intpriority of the document

fileCategoryDisplayName


stringdisplay name of file category

fileCategoryName


stringname of file category
fileType
stringthe type of the file

fileBytSize


intsize of file in bytes
fileCreatedDate
datefile creation date
fileModifiedDate
datefile modified date
deferredCreationUrl
string
allowAnonymousAccess
boolindicates anonymous access is permitted if set to true


Permissions

The API Client requires at least readonly permissions to Tenant users document library to successfully retrieve results (See Admin User Roles for more details).  Only tenants that the API client has access to will be returned.


Examples


C# Example


var client = new HttpClient(); 
var request = new HttpRequestMessage(HttpMethod.Get, "https://{platform API url}/api/library/documents/list/get/{tenatSubDomainName}/{user_id}?$inlinecount=allpages&$orderby=FileCreateDate desc&$top=10&$skip=0"); 
request.Headers.Add("Authorization", "Bearer {access token}"); 
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());


cURL Example


curl --location 'https://{platform API url}/api/library/documents/list/get/{tenantSubDomainName}/{user_id}$%24inlinecount=allpages&%24orderby=FileCreateDate desc&%24top=10&%24skip=0' \ --header 'Authorization: Bearer {access token}