Self-Service Action Runs

PreviousScorecards NextTime Series

Last updated 7 months ago

Was this helpful?

Get Flow Runs

get

/api/v1/flow-runs

Authorizations

Query parameters

filtersFilters

sortsSorts

cursorCursor

sizeSize

includeTotalIncludetotal

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/flow-runs' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

422

{
  "total": 1,
  "current_page": "text",
  "current_page_backwards": "text",
  "previous_page": "text",
  "next_page": "text",
  "items": [
    {
      "id": "text",
      "flowId": "text",
      "flowType": "automation",
      "args": {},
      "startTime": "2025-02-21T18:18:48.174Z",
      "endTime": "2025-02-21T18:18:48.174Z",
      "createdAt": "2025-02-21T18:18:48.174Z",
      "createdBy": 1,
      "updatedAt": "2025-02-21T18:18:48.174Z",
      "updatedBy": 1,
      "reviewedBy": 1,
      "reviewedAt": "2025-02-21T18:18:48.174Z",
      "actions": [
        {
          "id": "text",
          "phase": "running",
          "startTime": "2025-02-21T18:18:48.174Z",
          "endTime": "2025-02-21T18:18:48.174Z",
          "outputs": {}
        }
      ],
      "outputs": {
        "ANY_ADDITIONAL_PROPERTY": {
          "value": null,
          "error": "text"
        }
      },
      "logs": [
        {
          "timestamp": "2025-02-21T18:18:48.174Z",
          "message": "text",
          "level": "info",
          "action": "text"
        }
      ],
      "tags": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "phase": "pending"
    }
  ]
}

Successful Response

Create Flow Run

post

/api/v1/flow-runs

Authorizations

Body

idId

Pattern: ^([a-z0-9_.-]+)$

flowIdFlowidrequired

Pattern: ^([a-z0-9_.-]+)$

argsArgs

flowTypeFlowtype

Options: selfServiceAction

tagsTags

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/flow-runs' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"flowId":"text","args":{},"flowType":"selfServiceAction","tags":[{"key":"text","value":"text"}]}'

201

422

{
  "id": "text",
  "flowId": "text",
  "flowType": "automation",
  "args": {},
  "startTime": "2025-02-21T18:18:48.174Z",
  "endTime": "2025-02-21T18:18:48.174Z",
  "createdAt": "2025-02-21T18:18:48.174Z",
  "createdBy": 1,
  "updatedAt": "2025-02-21T18:18:48.174Z",
  "updatedBy": 1,
  "reviewedBy": 1,
  "reviewedAt": "2025-02-21T18:18:48.174Z",
  "actions": [
    {
      "id": "text",
      "phase": "running",
      "startTime": "2025-02-21T18:18:48.174Z",
      "endTime": "2025-02-21T18:18:48.174Z",
      "outputs": {}
    }
  ],
  "outputs": {
    "ANY_ADDITIONAL_PROPERTY": {
      "value": null,
      "error": "text"
    }
  },
  "logs": [
    {
      "timestamp": "2025-02-21T18:18:48.174Z",
      "message": "text",
      "level": "info",
      "action": "text"
    }
  ],
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "phase": "pending"
}

Successful Response

Get Flow Run

get

/api/v1/flow-runs/{id_}

Authorizations

Path parameters

id_Id required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/flow-runs/{id_}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

422

{
  "id": "text",
  "flowId": "text",
  "flowType": "automation",
  "args": {},
  "startTime": "2025-02-21T18:18:48.174Z",
  "endTime": "2025-02-21T18:18:48.174Z",
  "createdAt": "2025-02-21T18:18:48.174Z",
  "createdBy": 1,
  "updatedAt": "2025-02-21T18:18:48.174Z",
  "updatedBy": 1,
  "reviewedBy": 1,
  "reviewedAt": "2025-02-21T18:18:48.174Z",
  "actions": [
    {
      "id": "text",
      "phase": "running",
      "startTime": "2025-02-21T18:18:48.174Z",
      "endTime": "2025-02-21T18:18:48.174Z",
      "outputs": {}
    }
  ],
  "outputs": {
    "ANY_ADDITIONAL_PROPERTY": {
      "value": null,
      "error": "text"
    }
  },
  "logs": [
    {
      "timestamp": "2025-02-21T18:18:48.174Z",
      "message": "text",
      "level": "info",
      "action": "text"
    }
  ],
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "phase": "pending"
}

Successful Response

Upsert Flow Run

put

/api/v1/flow-runs/{id_}

Authorizations

Path parameters

id_Id required

Pattern: ^([a-z0-9_.-]+)$

Body

idId

Pattern: ^([a-z0-9_.-]+)$

flowIdFlowidrequired

Pattern: ^([a-z0-9_.-]+)$

flowTypeFlowTyperequired

An enumeration.

Options: automation, selfServiceAction, scorecard, reference, workflow

argsArgs

startTimeStarttime

endTimeEndtime

actionsActions

outputsOutputs

logsLogs

tagsTags

phaseall of | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v1/flow-runs/{id_}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"flowId":"text","flowType":"automation","args":{},"actions":[{"phase":"running","startTime":"2025-02-21T18:18:48.174Z","outputs":{}}],"outputs":{"ANY_ADDITIONAL_PROPERTY":{}},"logs":[{"timestamp":"2025-02-21T18:18:48.174Z","message":"text","level":"info"}],"tags":[{"key":"text","value":"text"}],"phase":"pending"}'

200

422

{
  "id": "text",
  "flowId": "text",
  "flowType": "automation",
  "args": {},
  "startTime": "2025-02-21T18:18:48.174Z",
  "endTime": "2025-02-21T18:18:48.174Z",
  "createdAt": "2025-02-21T18:18:48.174Z",
  "createdBy": 1,
  "updatedAt": "2025-02-21T18:18:48.174Z",
  "updatedBy": 1,
  "reviewedBy": 1,
  "reviewedAt": "2025-02-21T18:18:48.174Z",
  "actions": [
    {
      "id": "text",
      "phase": "running",
      "startTime": "2025-02-21T18:18:48.174Z",
      "endTime": "2025-02-21T18:18:48.174Z",
      "outputs": {}
    }
  ],
  "outputs": {
    "ANY_ADDITIONAL_PROPERTY": {
      "value": null,
      "error": "text"
    }
  },
  "logs": [
    {
      "timestamp": "2025-02-21T18:18:48.174Z",
      "message": "text",
      "level": "info",
      "action": "text"
    }
  ],
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "phase": "pending"
}

Successful Response

Delete Flow Run

delete

/api/v1/flow-runs/{id_}

Authorizations

Path parameters

id_Id required

Pattern: ^([a-z0-9_.-]+)$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v1/flow-runs/{id_}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

422

No body

Successful Response