API Flows Package Post DryRun v4

Performs a dry-run of importing a flow package, which performs a check of all permissions required to import the package, as well as any specified import rules.

• For more information on import rules, see Define Import Mapping Rules.

If they occur, errors are reported in the response.

After you have successfully completed a dry-run, you can execute a formal import. See API Flows Package Post v4.

Version: v4

Required Permissions

Request

Request Type: POST

Endpoint:

/v4/flows/package/dryRun

Request URI - Example:

/v4/flows/package/dryRun

Request Body:

The request body must include the following key and value combination submitted as form data. This path is the location of the ZIP package that you are importing.

Example request - curl:

curl -X POST http://example.com:3005/v4/flows/package/dryRun \
  -H 'authorization: Basic YWRtaW5AdHJpZmFjdGEubG9jYWw6YWRtaW4=' \
  -H 'cache-control: no-cache' \
  -H 'content-type: multipart/form-data' \
  -F data=@path/to/flow.zip

Response

Response Status Code - Success:  200 - OK

Response Body Example:

{"importRuleChanges":{"object":[],"value":[]},"flowName":"[7dd7da30]  2013 POS"}

Reference

None.