GET v1/{subscriptionID}/documents/{documentID}
Gets a document.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| subscriptionID |
The Circle subscription ID. |
globally unique identifier |
Required |
| documentID |
The document ID to be retrieved. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns a document for the specified document ID.
DocumentModel| Name | Description | Type | Additional information |
|---|---|---|---|
| UProduceDocumentID |
Gets the document ID in uProduce. |
globally unique identifier |
None. |
| FriendlyID |
Gets the friendly ID of the document. |
string |
None. |
| ID |
Gets the document ID. |
globally unique identifier |
None. |
| SubscriptionID |
Gets the subscription ID of the document. |
globally unique identifier |
None. |
| Name |
Gets the document name. |
string |
None. |
| CreationTime |
Gets the creation time of the document. |
date |
None. |
| Creator |
Gets the user who created the document. |
UserViewModel |
None. |
| ModificationTime |
Gets the last modification time of the document. |
date |
None. |
| Modifier |
Gets the user who was the last to modify the document. |
UserViewModel |
None. |
| Type |
Getst the document type. |
DocumentType |
None. |
Response Formats
application/json, text/json
Sample:
Sample not available.