Process All-In-One (Adhoc Data)

Submits a request to initiate a new All-In-One operation using pre-existing inputs, with the exception of input data, which is submitting along with the request.

Request takes binary file data as content, and on success will return one of two responses depending on the type of operation:

  • Asynchronous – 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 (Default)
  • Synchronous – response (depending on the parameters specified) containing either:
    • the absolute paths of the final output files produced (multiple spool files) or the content of a final output file (single spool file)
    • the absolute path or paths of the final output file or files produced (single or multiple spool files respectively) (Get Result as Text Only)

Request

Method Type:

POST

URI:

/rest/serverengine/workflow/print/{dmConfigId}/{templateId}/{jcConfigId}/{ocConfigId}

Content: Data File (File)
Content Type:

application/octet-stream

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

dmConfigId

–

–

–

The Managed File ID (or Name) of the Data Mapping configuration in File Store

templateId

–

–

–

The Managed File ID (or Name) of the template in File Store

jcConfigId

Optional – the value of "0" can be specified if no preset is to be used

–

–

The Managed File ID (or Name) of the Job Creation Preset in File Store
ocConfigId

–

–

–

The Managed File ID (or Name) of the Output Creation Preset in File Store

Query

Name Required Type Default Value Description
async – –

true

Whether to run the operation asynchronously

resultAsTxt

– –

false
  • Whether to retrieve the result as text (Synchronous Only)
    		•

    createOnly

    		– –

    false

    Whether output is to be only created in the server and not sent to it's final destination

    printRange

    		– – –

    A specific range of records in the input data file to restrict the print output to

    filename

    		– – –

    The file name of the data file to be uploaded

    Response

    Success

    The following lists status codes indicative of a successful response:

    Status Code Content Content-Type Add. Headers Description
    202
    Accepted

    –

    –

    • operationId – Operation ID of new All-In-One operation
    • Link – Contains multiple link URLs that can be used to retrieve further information/cancel the operation

    Data file successfully uploaded to File Store and creation of new operation successful

    Success (Synchronous)

    The following lists status codes indicative of a successful response:

    Status Code Content Content-Type Add. Headers Description
    200
    OK    		 Absolute Paths of the Output Files or the Output File itself application/octet-stream – Data file uploaded to File Store and a new operation was created and completed successfully with the result returned

    Success (Synchronous + Get Result as Text)

    The following lists status codes indicative of a successful response:

    Status Code Content Content-Type Add. Headers Description
    200
    OK    		 Absolute Path(s) of the Output File(s) text/plain – Data file uploaded to File Store and a new operation was created and completed successfully with the result returned

    Error

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

    Status Code Content Content-Type Add. Headers Description

    400 Bad Request

    JSON Error specifying error message

    		 application/json –

    Unable to locate one or more inputs in File Store with Managed File ID(s) and/or Name(s) specified

    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.

    500 Internal Server Error

    JSON Error specifying error message

    		 application/json –

    General error with running the All-In-One Process or a specific error relating to the uploading of the data file or an individual workflow process (see error description)