List task runs

curl --request GET \
  --url https://api.cloud.wherobots.com/task-runs \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.cloud.wherobots.com/task-runs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cloud.wherobots.com/task-runs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "items": [
    {
      "taskRunId": "<string>",
      "taskName": "<string>",
      "state": "PENDING",
      "region": "<string>",
      "submittedAt": "2023-11-07T05:31:56Z",
      "taskId": "<string>",
      "taskTriggerId": "<string>",
      "type": "uniontask",
      "runSource": "manual",
      "batchTime": "2023-11-07T05:31:56Z",
      "rerunOfId": "<string>",
      "batchKind": "tick",
      "windowStart": "2023-11-07T05:31:56Z",
      "windowEnd": "2023-11-07T05:31:56Z",
      "noComputeReason": "cancelled",
      "failureClass": "QUOTA_REJECTED",
      "runAsId": "<string>",
      "requestedById": "<string>",
      "workload": {
        "type": "uniontask",
        "jobRunId": "<string>",
        "kubeAppId": "<string>",
        "unionExecutionId": "<string>"
      },
      "cancelRequestedAt": "2023-11-07T05:31:56Z",
      "startedAt": "2023-11-07T05:31:56Z",
      "endedAt": "2023-11-07T05:31:56Z",
      "durationSeconds": 123
    }
  ],
  "total": 1,
  "limit": 2,
  "offset": 1
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

GET

task-runs

List task runs

curl --request GET \
  --url https://api.cloud.wherobots.com/task-runs \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.cloud.wherobots.com/task-runs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cloud.wherobots.com/task-runs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "items": [
    {
      "taskRunId": "<string>",
      "taskName": "<string>",
      "state": "PENDING",
      "region": "<string>",
      "submittedAt": "2023-11-07T05:31:56Z",
      "taskId": "<string>",
      "taskTriggerId": "<string>",
      "type": "uniontask",
      "runSource": "manual",
      "batchTime": "2023-11-07T05:31:56Z",
      "rerunOfId": "<string>",
      "batchKind": "tick",
      "windowStart": "2023-11-07T05:31:56Z",
      "windowEnd": "2023-11-07T05:31:56Z",
      "noComputeReason": "cancelled",
      "failureClass": "QUOTA_REJECTED",
      "runAsId": "<string>",
      "requestedById": "<string>",
      "workload": {
        "type": "uniontask",
        "jobRunId": "<string>",
        "kubeAppId": "<string>",
        "unionExecutionId": "<string>"
      },
      "cancelRequestedAt": "2023-11-07T05:31:56Z",
      "startedAt": "2023-11-07T05:31:56Z",
      "endedAt": "2023-11-07T05:31:56Z",
      "durationSeconds": 123
    }
  ],
  "total": 1,
  "limit": 2,
  "offset": 1
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

taskName

string | null

Only return runs of this task. Exact name, or a prefix followed by '*'.

Maximum string length: 255

Pattern: ^[a-zA-Z0-9_\-\.]+\*?$

type

enum<string> | null

Only return runs of this type. Concrete task polymorphic identities.

Available options:

uniontask,

scripttask

state

enum<string>[] | null

Only return runs in these states. Repeat the parameter to pass several; a run matches if it is in any of them.

Available options:

PENDING,

SUBMITTED,

RUNNING,

SUCCEEDED,

FAILED,

TIMED_OUT,

CANCELLING,

CANCELLED,

UNKNOWN,

SKIPPED,

MISSED,

REJECTED

createdAfter

string<date-time> | null

Only return runs submitted after this instant.

taskId

string | null

taskTriggerId

string | null

runSource

enum<string> | null

Origin of a run, independent of its backend.

Available options:

manual,

schedule,

rerun

batchTimeFrom

string<date-time> | null

Inclusive nominal tick lower bound; excludes manual runs.

batchTimeTo

string<date-time> | null

Exclusive nominal tick upper bound; excludes manual runs.

userId

string | null

Only return runs this user submitted or that run as this user.

Required string length: 1 - 200

region

string | null

limit

integer

default:50

Page size limit

Required range: 1 <= x <= 100

offset

integer

default:0

Page offset

Required range: x >= 0

Response

Successful Response

items

TaskRunSummary · object[]

required

Show child attributes

total

integer

required

Required range: x >= 0

limit

integer

required

Required range: x >= 1

offset

integer

required

Required range: x >= 0