Processing

Operations for processing submissions

Start processing

post

Use this endpoint to start processing a new submission. Provide the submission data in the request body.

Authorizations

access-token

Body

application/json

submissionIdstringRequired

The ID of the submission

generateTemplatebooleanOptional

Whether to generate a template for the submission

Default: false

Responses

200

Returns a message indicating that the processing service has started.

application/json

submissionIdstringRequired

The ID of the submission

Example: 123e4567-e89b-12d3-a456-426614174000

messagestringRequired

Response message

Example: The submission has been queued for processing. You may GET the event statuses using the provided submission ID.

templateIdnumberOptional

The ID of the template if generated

Example: 1

post

/api/processing

HTTPcURLJavaScriptPython

POST /api/processing HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "submissionId": "text",
  "generateTemplate": false
}

200

Returns a message indicating that the processing service has started.

{
  "submissionId": "123e4567-e89b-12d3-a456-426614174000",
  "message": "The submission has been queued for processing. You may GET the event statuses using the provided submission ID.",
  "templateId": 1
}