Process Output Creation (By Job) (JSON)
Submits a request to initiate a new Output Creation operation.
Request takes a JSON Identifier List (with Output Parameters) of the Job IDs as content, and on success returns a response containing additional headers that specify the ID of the new operation as well as link URLs that can be used to retrieve further information/cancel the operation.
Request
Method Type: |
POST |
---|---|
URI: | |
Content: | JSON Identifier List (with Output Parameters) specifying the Job entity IDs |
Content Type: |
application/json |
Add. Headers: |
If server security settings are enabled, then one of the following:
|
Parameters
Path
Name | Required | Type | Default Value | Description |
---|---|---|---|---|
configId |
– | – | – |
The Managed File ID (or Name) of the Output Creation Preset in File Store |
Response
Success
The following lists status codes indicative of a successful response:
Status Code | Content | Content-Type | Add. Headers | Description |
---|---|---|---|---|
202 Accepted |
– |
– |
|
Creation of new operation successful
|
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:
|
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. |
404 Not Found |
JSON Error specifying error message |
application/json |
– |
Output Creation Preset or Job entity not found in File Store/Server |
500 |
JSON Error specifying error message |
application/json |
– |
JSON Identifier List invalid or missing required structure |