Process Data Mapping

Submits a request to initiate a new Data Mapping operation.

Request takes an optional JSON Data Mapping Parameters, 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:

(Optional) JSON Data Mapping Parameters

Content Type:

application/json
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

JSON Error specifying error message

 application/json –

Data file or Data Mapping Configuration not found in File Store

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.

Error (Validate)

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.

500
Internal Server Error

JSON Error specifying error message

 application/json –

Data file or Data Mapping Configuration not found in File Store