ESescape
Workflows

Get workflow.

Get a workflow.

get/workflows/{id}

Request

  • Base URL
    https://public.escape.tech/v3
  • Auth
    API key in header X-ESCAPE-API-KEY

Path parameters

idstring uuid required

The workflow ID

Example:00000000-0000-0000-0000-000000000000

Response

OK

idstring uuid

The workflow ID.

namestring

The name of the workflow.

descriptionstring nullable required

The description of the workflow. Null when the workflow has no description.

trigger'ASSET_FOUND' | 'ASSET_UPDATED' | 'INTEGRATION_FAILED' | 'ISSUE_UPDATED' | 'LOCATION_DOWN' | 'MANUAL' | 'NEW_ISSUE' | 'SCAN_COMPLETED' | 'SCAN_FAILED' | 'SCAN_STARTED' required
pausedboolean required

Whether the workflow is paused.

throttleMsnumber nullable required

The throttle in milliseconds for the workflow.

createdAtstring date-time required

The date and time the workflow was created.

updatedAtstring date-time required

The date and time the workflow was last updated.

Changes

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