Sign in
latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

workflow_templates

Create a Workflow Template

post/app/v1/workflow_templates

Request body

namestring required
descriptionstring required
versioninteger required
status'archive' | 'draft' | 'active' required
category_idstring uuid required
outputobject required
asset_type'asset_group' | 'facility' | 'equipment' | 'device' | 'flow' required
asset_filterobject required
workflow_owner_idstring uuid required
facility_filterobject nullable

Example request

{
  "triggers": [
    {
      "output": {
        "$TRIGGERING_ASSET_ID": "$.asset_trigger.metadata.id",
        "$LEAK_EQUIPMENT": "$.answers.section1[0].question_leak.value",
        "$ASSOCIATED_ASSET_ID": "$.asset.id",
        "$ASSOCIATED_ASSET_NAME": "$.asset.name",
        "$ASSOCIATED_ASSET_TYPE": "$.asset.asset_type",
        "$FOO": "bar"
      },
      "cron": "0 8 * * ? *"
    }
  ]
}

Response

A successful operation

idstring uuid required
company_idstring uuid required
category_idstring uuid required
namestring required
descriptionstring required
versioninteger required
status'archive' | 'draft' | 'active' required
outputobject required
asset_type'asset_group' | 'facility' | 'equipment' | 'device' | 'flow' required
asset_filterobject required
workflow_owner_idstring uuid required
created_bystring uuid required
updated_bystring uuid required

Example response

{
  "triggers": [
    {
      "output": {
        "$TRIGGERING_ASSET_ID": "$.asset_trigger.metadata.id",
        "$LEAK_EQUIPMENT": "$.answers.section1[0].question_leak.value",
        "$ASSOCIATED_ASSET_ID": "$.asset.id",
        "$ASSOCIATED_ASSET_NAME": "$.asset.name",
        "$ASSOCIATED_ASSET_TYPE": "$.asset.asset_type",
        "$FOO": "bar"
      },
      "cron": "0 8 * * ? *"
    }
  ]
}