Get Document Sets for Job Segment

Returns a list of all the Document Set entities contained within a specific Job Segment entity.

Request takes no content, and on success returns a response containing a JSON Identifier List of all the Document Sets in the Job Segment.

Request

Method Type:	GET
URI:	/rest/serverengine/entity/jobsegments/{jobSegmentId}
Content:	–
Content Type:	–
Add. Headers:	If server security settings are enabled, then one of the following: Authorization – Basic Authentication (Username and Password) credentials (Base64 encoded) auth_token – Authorization Token

Parameters

Path

Name	Required	Type	Default Value	Description
jobSegmentId	–	–	–	The ID of the Job Segment 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 Document Sets in Job Segment	application/json	–	Identifier List of Document Sets returned

Error

The following lists status codes indicative of a failed or error response:

Status Code	Content	Content-Type	Add. Headers	Description
401 Unauthorized	JSON Error specifying error message	application/json	WWW-Authenticate – BASIC (Basic Authentication credentials are accepted)	Server authentication has failed. Response when either: basic authentication credentials nor an authorization token have been specified in the request headers the basic authentication credentials or the authorization token specified in the request headers are invalid the authorization token specified in the request headers has now expired
403 Forbidden	JSON Error specifying error message	application/json	–	Server authentication has succeeded, but user authorization for this specific method has failed. Response when authentication of the credentials or the authorization token specified in the request headers has succeeded, but the user associated with the credentials or the authorization token specified has insufficient role assignment/privileges.

Status Code

Content

Content-Type

Add. Headers

Description

401 Unauthorized

JSON Error specifying error message

application/json

WWW-Authenticate – BASIC (Basic Authentication credentials are accepted)

Server authentication has failed.

Response when either:

basic authentication credentials nor an authorization token have been specified in the request headers
the basic authentication credentials or the authorization token specified in the request headers are invalid
the authorization token specified in the request headers has now expired

403 Forbidden

JSON Error specifying error message

application/json

–

Server authentication has succeeded, but user authorization for this specific method has failed.

Response when authentication of the credentials or the authorization token specified in the request headers has succeeded, but the user associated with the credentials or the authorization token specified has insufficient role assignment/privileges.