Process Data Mapping

Submits a request to initiate a new Data Mapping operation.

Request takes no 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:

/rest/serverengine/workflow/datamining/{configId}/{dataFileId}

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

configId

– – –

The Managed File ID (or Name) of the Data Mapping configuration in File Store
dataFileId – – –
  • The Managed File ID (or Name) of the PDF/VT data file in File Store
    		•

    Query

    Name Required Type Default Value Description
    validate – –

    false

    Only validate the Data Mapping operation to check for mapping errors

    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 Data Mapping operation
    • Link – Contains multiple link URLs that can be used to retrieve further information/cancel the operation

    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

    400
    Bad Request

    		 – – –
  • Data file or Data Mapping Configuration not found in File Store
    		•

    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.

    Error (Validate)

    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.

    500
    Internal Server Error

    		 – – –
  • Data file or Data Mapping Configuration not found in File Store
    		•