GET api/Document?documentId={documentId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| documentId | string |
Required |
Body Parameters
None.
Response Information
Resource Description
DocumentRecord| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| BridgeID | integer |
None. |
|
| URI | string |
None. |
|
| Filename | string |
None. |
|
| Extension | string |
None. |
|
| Comments | string |
None. |
|
| TypeID | integer |
None. |
|
| ParentDocumentID | integer |
None. |
|
| RevisionNumber | integer |
None. |
|
| LatestRevision | boolean |
None. |
|
| CreatedTimestamp | date |
None. |
|
| UploadedTimestamp | date |
None. |
|
| ModifiedTimestamp | date |
None. |
|
| CreatedByUserID | string |
None. |
|
| ModifiedByUserID | string |
None. |
|
| Deleted | boolean |
None. |
|
| MimeType | string |
None. |
|
| FinalisedById | string |
None. |
|
| FinalisedOn | date |
None. |
|
| AccessLevel | integer |
None. |
|
| IsStoredLocally | boolean |
None. |
|
| UpdatedAt | date |
None. |
|
| MajorVersion | integer |
None. |
|
| MinorVersion | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": 1,
"BridgeID": 2,
"URI": "sample string 3",
"Filename": "sample string 4",
"Extension": "sample string 5",
"Comments": "sample string 6",
"TypeID": 7,
"ParentDocumentID": 1,
"RevisionNumber": 8,
"LatestRevision": true,
"CreatedTimestamp": "2025-11-08T12:14:26.7001231+00:00",
"UploadedTimestamp": "2025-11-08T12:14:26.7001231+00:00",
"ModifiedTimestamp": "2025-11-08T12:14:26.7001231+00:00",
"CreatedByUserID": "sample string 12",
"ModifiedByUserID": "sample string 13",
"Deleted": true,
"MimeType": "sample string 15",
"FinalisedById": "sample string 16",
"FinalisedOn": "2025-11-08T12:14:26.7001231+00:00",
"AccessLevel": 17,
"IsStoredLocally": true,
"UpdatedAt": "2025-11-08T12:14:26.7001231Z",
"MajorVersion": 1,
"MinorVersion": 1
}
application/xml, text/xml
Sample:
<DocumentRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.Api.DataModels"> <MajorVersion>1</MajorVersion> <MinorVersion>1</MinorVersion> <UpdatedAt>2025-11-08T12:14:26.7001231Z</UpdatedAt> <AccessLevel>17</AccessLevel> <BridgeID>2</BridgeID> <Comments>sample string 6</Comments> <CreatedByUserID>sample string 12</CreatedByUserID> <CreatedTimestamp>2025-11-08T12:14:26.7001231+00:00</CreatedTimestamp> <Deleted>true</Deleted> <Extension>sample string 5</Extension> <Filename>sample string 4</Filename> <FinalisedById>sample string 16</FinalisedById> <FinalisedOn>2025-11-08T12:14:26.7001231+00:00</FinalisedOn> <Id>1</Id> <IsStoredLocally>true</IsStoredLocally> <LatestRevision>true</LatestRevision> <MimeType>sample string 15</MimeType> <ModifiedByUserID>sample string 13</ModifiedByUserID> <ModifiedTimestamp>2025-11-08T12:14:26.7001231+00:00</ModifiedTimestamp> <ParentDocumentID>1</ParentDocumentID> <RevisionNumber>8</RevisionNumber> <TypeID>7</TypeID> <URI>sample string 3</URI> <UploadedTimestamp>2025-11-08T12:14:26.7001231+00:00</UploadedTimestamp> </DocumentRecord>