workflows

Download schema

copy_workflow

POST

/api/v2/workflows/copy_workflow

copy_workflow

copy_workflow › Request Body

copy_workflow › Responses

200

success

boolean

message

string[]

data

object

create_workflow

POST

/api/v2/workflows/create_workflow

create_workflow

create_workflow › Request Body

create_workflow › Responses

200

success

boolean

message

string[]

data

object

delete_workflow

POST

/api/v2/workflows/delete_workflow

delete_workflow

delete_workflow › Request Body

delete_workflow › Responses

200

success

boolean

message

string[]

data

object

export_workflow

POST

/api/v2/workflows/export_workflow

export_workflow

export_workflow › Request Body

export_workflow › Responses

200

success

boolean

message

string[]

data

object

get_lookups

POST

/api/v2/workflows/get_lookups

get_lookups

get_lookups › Request Body

get_lookups › Responses

200

success

boolean

message

string[]

data

object

get_policy_type_coverages

POST

/api/v2/workflows/get_policy_type_coverages

get_policy_type_coverages

get_policy_type_coverages › Request Body

get_policy_type_coverages › Responses

200

success

boolean

message

string[]

data

object

get_policy_type_versions

POST

/api/v2/workflows/get_policy_type_versions

get_policy_type_versions

get_policy_type_versions › Request Body

get_policy_type_versions › Responses

200

success

boolean

message

string[]

data

object

get_run

POST

/api/v2/workflows/get_run

get_run

get_run › Request Body

get_run › Responses

200

success

boolean

message

string[]

data

object

get_workflow

POST

/api/v2/workflows/get_workflow

get_workflow

get_workflow › Request Body

get_workflow › Responses

200

success

boolean

message

string[]

data

object

import_workflow

POST

/api/v2/workflows/import_workflow

import_workflow

import_workflow › Request Body

import_workflow › Responses

200

success

boolean

message

string[]

data

object

list_executions

POST

/api/v2/workflows/list_executions

list_executions

list_executions › Request Body

list_executions › Responses

200

success

boolean

message

string[]

data

object

list_workflows

POST

/api/v2/workflows/list_workflows

list_workflows

list_workflows › Request Body

Request payload for /api/v2/workflows/list_workflows

request-workflows_list_workflows

list_workflows › Responses

200

response-workflows_list_workflows

success

boolean · required

messages

string[] · required

object · required

POST/api/v2/workflows/list_workflows

curl --request POST \
  --url /api/v2/workflows/list_workflows \
  --header 'Content-Type: application/json' \
  --data '{}'

Example Request Body

{}

json

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {
    "workflows": [
      {
        "id": "id",
        "name": "name",
        "description": "description",
        "scope": "Policy",
        "status": "active",
        "role": "draft",
        "source_workflow_id": "source_workflow_id",
        "live_ref_id": "live_ref_id",
        "current_version_id": "current_version_id",
        "live_status": "live_status",
        "live_version_number": 0,
        "has_unpublished_changes": true,
        "policy_type_version_ids": [
          "string"
        ],
        "nodes": [
          {
            "id": "id",
            "type": "type",
            "position_x": 0,
            "position_y": 0,
            "note": "note",
            "config": {}
          }
        ],
        "edges": [
          {
            "id": "id",
            "from_node_id": "from_node_id",
            "to_node_id": "to_node_id",
            "edge_type": "execution",
            "label": "label"
          }
        ],
        "last_fired_at": "2024-08-25T15:00:00Z",
        "firings_30d": 0,
        "created_at": "2024-08-25T15:00:00Z",
        "updated_at": "2024-08-25T15:00:00Z"
      }
    ]
  }
}

json

application/json

publish_workflow

POST

/api/v2/workflows/publish_workflow

publish_workflow

publish_workflow › Request Body

Request payload for /api/v2/workflows/publish_workflow

request-workflows_publish_workflow

id

string · required

Draft workflow ID

publish_workflow › Responses

200

response-workflows_publish_workflow

success

boolean · required

messages

string[] · required

workflow-def · required

POST/api/v2/workflows/publish_workflow

curl --request POST \
  --url /api/v2/workflows/publish_workflow \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "id"
}'

Example Request Body

{
  "id": "id"
}

json

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {
    "id": "id",
    "name": "name",
    "description": "description",
    "scope": "Policy",
    "status": "active",
    "role": "draft",
    "source_workflow_id": "source_workflow_id",
    "live_ref_id": "live_ref_id",
    "current_version_id": "current_version_id",
    "live_status": "live_status",
    "live_version_number": 0,
    "has_unpublished_changes": true,
    "policy_type_version_ids": [
      "string"
    ],
    "nodes": [
      {
        "id": "id",
        "type": "type",
        "position_x": 0,
        "position_y": 0,
        "note": "note",
        "config": {}
      }
    ],
    "edges": [
      {
        "id": "id",
        "from_node_id": "from_node_id",
        "to_node_id": "to_node_id",
        "edge_type": "execution",
        "label": "label"
      }
    ],
    "last_fired_at": "2024-08-25T15:00:00Z",
    "firings_30d": 0,
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

resume_run

POST

/api/v2/workflows/resume_run

resume_run

resume_run › Request Body

resume_run › Responses

200

success

boolean

message

string[]

data

object

retry_run

POST

/api/v2/workflows/retry_run

retry_run

retry_run › Request Body

retry_run › Responses

200

success

boolean

message

string[]

data

object

revert_workflow_draft

POST

/api/v2/workflows/revert_workflow_draft

revert_workflow_draft

revert_workflow_draft › Request Body

revert_workflow_draft › Responses

200

success

boolean

message

string[]

data

object

set_workflow_status

POST

/api/v2/workflows/set_workflow_status

set_workflow_status

set_workflow_status › Request Body

set_workflow_status › Responses

200

success

boolean

message

string[]

data

object

update_workflow

POST

/api/v2/workflows/update_workflow

update_workflow

update_workflow › Request Body

update_workflow › Responses

200

success

boolean

message

string[]

data

object

validate_all_references

POST

/api/v2/workflows/validate_all_references

validate_all_references

validate_all_references › Request Body

validate_all_references › Responses

200

success

boolean

message

string[]

data

object

validate_workflow

POST

/api/v2/workflows/validate_workflow

validate_workflow

validate_workflow › Request Body

validate_workflow › Responses

200

success

boolean

message

string[]

data

object

watercrafts