Get Result of Operation

Retrieves the final result of a completed All-In-One operation of a specific operation ID.

Request takes no content, and on success returns a response (depending on the All-In-One configuration) containing either:

  • the ID of the Data Set, Content Set or Job Set entity produced, or
  • the absolute paths of the final output files produced (multiple spool files) or the content of a final output file (single spool file).

Request

Method Type:

POST

URI:

/rest/serverengine/workflow/print/getResult/{operationId}

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

The following lists the path parameters accepted by this method:

Name Required Type Default Value Description
operationId

–

–

–

Operation ID of All-In-One operation

Response

Success

The following lists status codes indicative of a successful response:

Status Code Content Content-Type Add. Headers Description
200
OK

Either:

  • ID of the Data Set, Content Set or Job Set, or
  • Absolute Paths of the Output Files or the Output File itself
 application/octet-stream

If the returnIdInHeader parameter in the JSON All-In-One Configuration is set to true, the response contains the following additional headers:

  • X-Data-Set-ID

  • X-Content-Set-ID

  • X-Job-Set-ID

  • X-Result-Type

 Result of completed operation successfully retrieved

The "X-Result-Type" header could have one of the following values:

  • "Data-Set-ID" - the entity contains a dataSetID (only data mapping operation requested)

  • "Content-Set-ID” - the entity contains a contentSetID (last operation: content creation)

  • "Job-Set-ID" - the entity contains a jobSetID (last operation: content creation)

  • "Output-Streamed" - the entity contains a streamed output file (last operation: content creation)

  • "Output-Local-Filepath" - the entity contains absolute path of output file (last operation: content creation)

  • "Output-Managed-Info" - the entity contains ID of persisted output file(s) (last operation: content creation)

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.

404 Not Found

JSON Error specifying error message

application/json

–

Operation not found in Server