Get Job Segment Metadata Properties
Returns a list of the metadata properties for a specific Job Segment entity.
Request takes no content, and on success returns a response containing a JSON Name/Value List (Properties Only) of all the metadata properties for the Job Segment.
Request
| Method Type: |
GET |
|---|---|
| URI: |
/rest/serverengine/entity/jobsegments/{jobSegmentId}/metadata |
| Content: | – |
| Content Type: |
– |
| Add. Headers: |
If server security settings are enabled, then one of the following:
|
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 Name/Value List (Properties Only) of metadata properties for Job Segment | application/json | – | Job Segment entity metadata properties successfully retrieved |
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. |