Multipass API

Retrieve flow definition by flow ID

Retrieves the Multipass flow definition for the specified flow ID. The flow definition contains the complete configuration and processing steps for the flow.

Path Parameter:

  • flowId : Unique identifier for the Multipass flow
get/v1/multipass/flows/{flowId}

Request

  • Base URL: https://api.cloud.precisely.com
  • URL: https://api.cloud.precisely.com/v1/multipass/flows/{flowId}
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Path parameters

flowIdstring required

Unique identifier for the Multipass flow

Headers

X-Request-Idstring

The X-Request-Id header is optional but incredibly useful for developers. It serves as a unique identifier for requests within our system. When you encounter any problems with your requests, providing us with the X-Request-Id will enable us to pinpoint the specific request in question without the need for extensive manual searching. This means faster and more efficient troubleshooting. The maximum allowed length is 38 characters.

Response

Flow definition retrieved successfully

operationstring required
statusstring required
flowIdstring required

Changes

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