Bulk Multipass API

Submits a workflow for Multipass bulk execution

This API allows users to submit a workflow for Multipass bulk execution using a file, flow id, and input mapping. The request must include the necessary payload and returns a workflow url

post/v1/multipass/bulk-operations

Request

  • Base URL: https://api.cloud.precisely.com
  • URL: https://api.cloud.precisely.com/v1/multipass/bulk-operations
  • Auth: HTTP bearer

Headers

X-Request-Idstring

The X-Request-Id header is optional but helpful for tracking requests. It acts as a unique identifier for troubleshooting and debugging issues effectively. Maximum length: 38 characters. Example: e02f00d5-e3a9-4fd6-aen1-3e5451abee46

Request body

operation'SEARCH_NEAREST' | 'SEARCH_AT_LOCATION' | 'OVERLAPS' | 'SUMMARIZE' | 'DATA_GRAPH_GET_BY_ID' | 'DATA_GRAPH_GET_BY_ADDRESS' | 'DATA_GRAPH_GET_BY_SPATIAL' | 'MULTIPASS' | 'ORDER_EXTRACTOR' | 'OTHER' | 'TRAVEL_BOUNDARY' required

Name of the bulk operations such as SEARCH_NEAREST, SEARCH_AT_LOCATION, OVERLAPS, SUMMARIZE, DATA_GRAPH_GET_BY_ID, DATA_GRAPH_GET_BY_ADDRESS, DATA_GRAPH_GET_BY_SPATIAL, MULTIPASS, TRAVEL_BOUNDARY and ORDER_EXTRACTOR

payloadJsonNode required

Example request

{
  "operation": "SEARCH_NEAREST"
}

Response

Successfully submits a workflow.

statusUrlstring uri

URI endpoint to poll for the workflow status.

Example response

{
  "statusUrl": "http://localhost:8080/api/workflows/status/sample-workflow-id"
}

Changes

No recorded changes to this operation across all 1 revision of this API.