GET api/refDocument/{id}
Return a single value from the ref.Documents table using the primary key as ID.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The ref.Documents Primary Key. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
A single ref.Document record
refDocument| Name | Description | Type | Additional information |
|---|---|---|---|
| DocumentID | integer |
None. |
|
| DocumentTypeID | RefItemType |
Required |
|
| EmployeeID | integer |
None. |
|
| AssetID | integer |
None. |
|
| DocumentName | string |
Max length: 240 |
|
| DocumentPath | string |
Max length: 240 |
|
| DocumentDescription | string |
Max length: 3000 |
|
| ContentType | string |
None. |
|
| CreatedBy | integer |
None. |
|
| CreatedDate | date |
None. |
|
| UpdatedBy | integer |
None. |
|
| UpdatedDate | date |
None. |
|
| results | Collection of ValidationResult |
None. |
Response Formats
application/json, text/json
Sample:
{
"results": null,
"DocumentID": 1,
"DocumentTypeID": 1,
"EmployeeID": 1,
"AssetID": 1,
"DocumentName": "sample string 2",
"DocumentPath": "sample string 3",
"DocumentDescription": "sample string 4",
"ContentType": "sample string 5",
"CreatedBy": 6,
"CreatedDate": "2025-12-06T23:39:59.7673407+00:00",
"UpdatedBy": 8,
"UpdatedDate": "2025-12-06T23:39:59.7673407+00:00"
}
application/xml, text/xml
Sample:
<refDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Tables">
<results xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility" />
<AssetID>1</AssetID>
<ContentType>sample string 5</ContentType>
<CreatedBy>6</CreatedBy>
<CreatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2025-12-06T23:39:59.7673407Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</CreatedDate>
<DocumentDescription>sample string 4</DocumentDescription>
<DocumentID>1</DocumentID>
<DocumentName>sample string 2</DocumentName>
<DocumentPath>sample string 3</DocumentPath>
<DocumentTypeID>Asset</DocumentTypeID>
<EmployeeID>1</EmployeeID>
<UpdatedBy>8</UpdatedBy>
<UpdatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2025-12-06T23:39:59.7673407Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</UpdatedDate>
</refDocument>