GET api/documents?page={page}&pageSize={pageSize}&orderBy={orderBy}&ascending={ascending}
Get all documents
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| page |
Page number |
integer |
Default value is 1 |
| pageSize |
Number of records a page can hold |
integer |
Default value is 50 |
| orderBy |
Order By |
string |
Default value is Id |
| ascending |
Asc/Desc |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
PagedResultSetOfDocumentDTONone.
Response Formats
application/json, text/json
Sample:
{
"metadata": {
"pageNumber": 1,
"pageSize": 2,
"totalNumberOfPages": 3,
"totalNumberOfRecords": 4,
"nextPageUrl": "sample string 5"
},
"results": [
{
"id": 1,
"productId": 2,
"orderId": 1,
"taskId": 1,
"name": "sample string 3",
"version": 4,
"docUri": "sample string 5",
"docType": 1,
"isLocked": true,
"createdUtc": "2026-01-12T15:41:10.0967333+00:00",
"updatedBy": "sample string 7",
"modifiedUtc": "2026-01-12T15:41:10.0967333+00:00",
"userType": 1
},
{
"id": 1,
"productId": 2,
"orderId": 1,
"taskId": 1,
"name": "sample string 3",
"version": 4,
"docUri": "sample string 5",
"docType": 1,
"isLocked": true,
"createdUtc": "2026-01-12T15:41:10.0967333+00:00",
"updatedBy": "sample string 7",
"modifiedUtc": "2026-01-12T15:41:10.0967333+00:00",
"userType": 1
}
]
}