flow

Partial updates the flow basic information

patch/flows/{flowId}

Request

  • Base URL: https://headless.dataddo.com/customer-api/v1
  • URL: https://headless.dataddo.com/customer-api/v1/flows/{flowId}
  • Auth: none declared

Path parameters

flowIdstring required

Request body

labelstring nullable
status'live' | 'broken' | 'retrying' | 'running' | 'inactive' | 'cancelling' | 'cancelled'
preceding_actions_policy'strict' | 'liberal'
is_lockedboolean nullable

Response

Partial updates the flow basic information

external_idstring nullable

The id of the document in external systems. By setting external_id you can link document with external systems id.

is_lockedboolean

You may mark the document as locked to prevent accidental changes. When locked, the document cannot be modified or deleted.

flow_type'fetch' | 'write'
labelstring
customer_idstring
preceding_actions_policy'strict' | 'liberal'
fetch_public_idstring nullable
created_atinteger
updated_atinteger
fdr_allowedboolean
destination_idstring
streamboolean

Example response

{
  "write_action": {
    "unique_columns": [
      "np1NErz7B4",
      "rPMOx7EOp9"
    ]
  }
}

Changes

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