Bulk Routing API
Bulk Multipass API
Bulk Data Graph API
Bulk Order Management API
Bulk Analysis API

Fetch workflow status by workflowId

This endpoint returns the current status of a workflow execution (e.g., RUNNING, COMPLETED, FAILED) identified by the given workflowId. The request must include workflowId as a path variable whose status is to be fetched.

get/v1/li/workflows/status/{workflowId}

Request

  • Base URL: https://api.cloud.precisely.com
  • URL: https://api.cloud.precisely.com/v1/li/workflows/status/{workflowId}
  • Auth: HTTP bearer

Path parameters

workflowIdstring required

Unique workflow ID for which the workflow status is to be retrieved

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

Response

Successfully retrieved workflow status.

status'SCHEDULED' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELED' | 'TERMINATED' | 'CONTINUED_AS_NEW' | 'TIMED_OUT' | 'UNKNOWN'

Current status of the workflow

progressinteger

Percentage of the workflow completed so far (0-100). May be null if progress has not been reported yet.

orderIdstring

OrderID generated for the respective workflow

downloadUrlstring

Pre-signed S3 download URL for the output file. Available only when the workflow is COMPLETED.

rowCountinteger

Total number of rows processed by the workflow. Available only when the workflow is COMPLETED and the worker has reported it.

Example response

{
  "status": "COMPLETED",
  "progress": 42,
  "orderId": "fly-213-fun",
  "downloadUrl": "https://s3.amazonaws.com/bucket-name/output/file-123.csv",
  "error": {
    "code": "DIS-1001",
    "detail": "Unauthorized"
  },
  "rowCount": 10000
}

Changes

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