Common API (1.6.0)
APIs for common InsuranceSuite platform objects like activities and notes
Retrieve a Document
Retrieves a Document
by its id
. A Document
represents a document within the application, which can have additional metadata such as the author of the document or a specific security level. The actual contents of the document are generally stored in a separate document management system that this application is linked to. (Since 1.1.0)
Authorizations:
path Parameters
documentId required | string gw-sinceVersion: 1.1.0 The |
query Parameters
fields | Array of strings gw-allowForCompositeApi: true Allows the caller to specify the set of fields that should be included on the response. This can be used to limit the set of fields returned as well as to include optional fields that otherwise wouldn't normally be returned. The parameter is either of the form |
filter | Array of strings gw-allowForCompositeApi: true Filters the list of results based on the specified field, operator, and value. The parameter is either of the form |
include | Array of strings Used to request that additional resources be returned with the API response in the |
includeTotal | Array of strings gw-allowForCompositeApi: true Used to request that results should include a count of the total number of results available, which may be more than the total number of results currently being returned. This parameter is of the form |
pageSize | Array of strings gw-allowForCompositeApi: true The maximum number of results to return in the response. The parameter is of the form |
sort | Array of strings gw-allowForCompositeApi: true Controls the sorting of elements within a response. The sort parameter is of the form |
Responses
Response samples
- 200
{- "data": {
- "attributes": {
- "account": {
- "displayName": "string",
- "id": "string",
- "jsonPath": "string",
- "refid": "string",
- "type": "string",
- "uri": "string"
}, - "author": "string",
- "contingency": {
- "displayName": "string",
- "id": "string",
- "jsonPath": "string",
- "refid": "string",
- "type": "string",
- "uri": "string"
}, - "dateModified": "2019-08-24T14:15:22Z",
- "description": "string",
- "docUID": "string",
- "id": "string",
- "inbound": true,
- "job": {
- "displayName": "string",
- "id": "string",
- "jsonPath": "string",
- "refid": "string",
- "type": "string",
- "uri": "string"
}, - "language": {
- "code": "string",
- "name": "string"
}, - "mimeType": "string",
- "name": "string",
- "obsolete": true,
- "policy": {
- "displayName": "string",
- "id": "string",
- "jsonPath": "string",
- "refid": "string",
- "type": "string",
- "uri": "string"
}, - "recipient": "string",
- "section": {
- "code": "string",
- "name": "string"
}, - "securityType": {
- "code": "string",
- "name": "string"
}, - "status": {
- "code": "string",
- "name": "string"
}, - "type": {
- "code": "string",
- "name": "string"
}
}, - "checksum": "string",
- "id": "string",
- "links": {
- "property1": {
- "href": "string",
- "methods": [
- "string"
]
}, - "property2": {
- "href": "string",
- "methods": [
- "string"
]
}
}, - "method": "post",
- "refid": "string",
- "related": {
- "property1": {
- "count": 0,
- "data": [
- {
- "displayName": "string",
- "id": "string",
- "jsonPath": "string",
- "refid": "string",
- "type": "string",
- "uri": "string"
}
], - "total": 0
}, - "property2": {
- "count": 0,
- "data": [
- {
- "displayName": "string",
- "id": "string",
- "jsonPath": "string",
- "refid": "string",
- "type": "string",
- "uri": "string"
}
], - "total": 0
}
}, - "type": "string",
- "uri": "string"
}, - "included": {
- "DocumentContent": [
- {
- "attributes": {
- "contents": "string",
- "responseMimeType": "string",
- "url": "string"
}, - "checksum": "string",
- "id": "string",
- "links": {
- "property1": {
- "href": "string",
- "methods": [
- "string"
]
}, - "property2": {
- "href": "string",
- "methods": [
- "string"
]
}
}, - "method": "post",
- "refid": "string",
- "related": {
- "property1": {
- "count": 0,
- "data": [
- {
- "displayName": "string",
- "id": "string",
- "jsonPath": "string",
- "refid": "string",
- "type": "string",
- "uri": "string"
}
], - "total": 0
}, - "property2": {
- "count": 0,
- "data": [
- {
- "displayName": "string",
- "id": "string",
- "jsonPath": "string",
- "refid": "string",
- "type": "string",
- "uri": "string"
}
], - "total": 0
}
}, - "type": "string",
- "uri": "string"
}
]
}
}
Was this page helpful?