Get Documents for Document Set
Returns a list of all the Document entities contained within a specific Document Set entity.
Request takes no content, and on success returns a response containing a JSON Identifier List of all the Documents in the Document Set.
Request
Method Type: |
GET |
---|---|
URI: | |
Content: | – |
Content Type: |
– |
Add. Headers: |
If server security settings are enabled, then one of the following:
|
Parameters
Path
Name | Required | Type | Default Value | Description |
---|---|---|---|---|
documentSetId |
– |
– |
– |
The ID of the Document Set entity in Server |
Response
Success
The following lists status codes indicative of a successful response:
Status Code | Content | Content-Type | Add. Headers | Description |
---|---|---|---|---|
200 OK |
JSON Identifier List of all the Documents in Document Set | application/json | – | Identifier List of Documents returned |
Error
The following lists status codes indicative of a failed or error response:
Status Code | Content | Content-Type | Add. Headers | Description |
---|---|---|---|---|
401 Unauthorized |
– |
– |
WWW-Authenticate – BASIC (Basic Authentication credentials are accepted) |
Server authentication is required. Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. |
401 Unauthorized |
Error message |
– |
– |
Server authentication has failed. Response when the authorization token specified in the request headers has now expired. |
403 Forbidden |
Error message |
– |
– |
Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid. |