Self-Service Action Runs

Get Flow Runs

GET/api/v1/flow-runs

Query parameters

Response

Successful Response

Body

items*Items

totalTotal

Total items

current_pageCurrent Page

Cursor to refetch the current page

current_page_backwardsCurrent Page Backwards

Cursor to refetch the current page starting from the last item

previous_pagePrevious Page

Cursor for the previous page

next_pageNext Page

Cursor for the next page

Request

const response = await fetch('/api/v1/flow-runs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "id": "text",
      "flowId": "text",
      "flowType": "automation",
      "phase": {},
      "startTime": "2024-12-21T11:33:54.665Z",
      "endTime": "2024-12-21T11:33:54.665Z",
      "actions": [
        {
          "id": "text",
          "phase": "running",
          "startTime": "2024-12-21T11:33:54.665Z",
          "endTime": "2024-12-21T11:33:54.665Z"
        }
      ],
      "logs": [
        {
          "timestamp": "2024-12-21T11:33:54.665Z",
          "message": "text",
          "level": "info",
          "action": "text"
        }
      ],
      "tags": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "createdAt": "2024-12-21T11:33:54.665Z",
      "createdBy": 0,
      "updatedAt": "2024-12-21T11:33:54.665Z",
      "updatedBy": 0,
      "reviewedBy": 0,
      "reviewedAt": "2024-12-21T11:33:54.665Z"
    }
  ],
  "total": 0,
  "current_page": "text",
  "current_page_backwards": "text",
  "previous_page": "text",
  "next_page": "text"
}

Create Flow Run

POST/api/v1/flow-runs

Body

idId

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

flowId*Flowid

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

flowTypeFlowtype

selfServiceAction

argsArgs

tagsTags

Response

Successful Response

Body

idId

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

flowId*Flowid

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

flowType*FlowType

An enumeration.

automationselfServiceActionscorecardreference

argsArgs

phasenullable all of

startTimeStarttime

endTimeEndtime

actionsActions

outputsOutputs

logsLogs

tagsTags

createdAt*Createdat

createdByCreatedby

updatedAt*Updatedat

updatedByUpdatedby

reviewedByReviewedby

reviewedAtReviewedat

Request

const response = await fetch('/api/v1/flow-runs', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "flowId": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "flowId": "text",
  "flowType": "automation",
  "phase": {},
  "startTime": "2024-12-21T11:33:54.665Z",
  "endTime": "2024-12-21T11:33:54.665Z",
  "actions": [
    {
      "id": "text",
      "phase": "running",
      "startTime": "2024-12-21T11:33:54.665Z",
      "endTime": "2024-12-21T11:33:54.665Z"
    }
  ],
  "logs": [
    {
      "timestamp": "2024-12-21T11:33:54.665Z",
      "message": "text",
      "level": "info",
      "action": "text"
    }
  ],
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "createdAt": "2024-12-21T11:33:54.665Z",
  "createdBy": 0,
  "updatedAt": "2024-12-21T11:33:54.665Z",
  "updatedBy": 0,
  "reviewedBy": 0,
  "reviewedAt": "2024-12-21T11:33:54.665Z"
}

Get Flow Run

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

Path parameters

id_*Id

Response

Successful Response

Body

idId

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

flowId*Flowid

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

flowType*FlowType

An enumeration.

automationselfServiceActionscorecardreference

argsArgs

phasenullable all of

startTimeStarttime

endTimeEndtime

actionsActions

outputsOutputs

logsLogs

tagsTags

createdAt*Createdat

createdByCreatedby

updatedAt*Updatedat

updatedByUpdatedby

reviewedByReviewedby

reviewedAtReviewedat

Request

const response = await fetch('/api/v1/flow-runs/{id_}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "flowId": "text",
  "flowType": "automation",
  "phase": {},
  "startTime": "2024-12-21T11:33:54.665Z",
  "endTime": "2024-12-21T11:33:54.665Z",
  "actions": [
    {
      "id": "text",
      "phase": "running",
      "startTime": "2024-12-21T11:33:54.665Z",
      "endTime": "2024-12-21T11:33:54.665Z"
    }
  ],
  "logs": [
    {
      "timestamp": "2024-12-21T11:33:54.665Z",
      "message": "text",
      "level": "info",
      "action": "text"
    }
  ],
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "createdAt": "2024-12-21T11:33:54.665Z",
  "createdBy": 0,
  "updatedAt": "2024-12-21T11:33:54.665Z",
  "updatedBy": 0,
  "reviewedBy": 0,
  "reviewedAt": "2024-12-21T11:33:54.665Z"
}

Upsert Flow Run

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

Path parameters

id_*Id

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

Body

idId

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

flowId*Flowid

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

flowType*FlowType

An enumeration.

automationselfServiceActionscorecardreference

argsArgs

phasenullable all of

startTimeStarttime

endTimeEndtime

actionsActions

outputsOutputs

logsLogs

tagsTags

Response

Successful Response

Body

idId

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

flowId*Flowid

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

flowType*FlowType

An enumeration.

automationselfServiceActionscorecardreference

argsArgs

phasenullable all of

startTimeStarttime

endTimeEndtime

actionsActions

outputsOutputs

logsLogs

tagsTags

createdAt*Createdat

createdByCreatedby

updatedAt*Updatedat

updatedByUpdatedby

reviewedByReviewedby

reviewedAtReviewedat

Request

const response = await fetch('/api/v1/flow-runs/{id_}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "flowId": "text",
      "flowType": "automation"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "flowId": "text",
  "flowType": "automation",
  "phase": {},
  "startTime": "2024-12-21T11:33:54.665Z",
  "endTime": "2024-12-21T11:33:54.665Z",
  "actions": [
    {
      "id": "text",
      "phase": "running",
      "startTime": "2024-12-21T11:33:54.665Z",
      "endTime": "2024-12-21T11:33:54.665Z"
    }
  ],
  "logs": [
    {
      "timestamp": "2024-12-21T11:33:54.665Z",
      "message": "text",
      "level": "info",
      "action": "text"
    }
  ],
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "createdAt": "2024-12-21T11:33:54.665Z",
  "createdBy": 0,
  "updatedAt": "2024-12-21T11:33:54.665Z",
  "updatedBy": 0,
  "reviewedBy": 0,
  "reviewedAt": "2024-12-21T11:33:54.665Z"
}

Delete Flow Run

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

Path parameters

id_*Id

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

Response

Successful Response

Request

const response = await fetch('/api/v1/flow-runs/{id_}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

PreviousScorecards NextTime Series

Last updated 5 months ago