Skip to main content

Tasks Commands

See Tasks module docs for permissions and data model.

soat list-tasks​

List tasks

  • Method: GET
  • Path: /api/v1/tasks

Usage​

soat list-tasks

Options​

--project-id​

—

  • Source: query
  • Required: no
  • Type: string
--workflow-id​

—

  • Source: query
  • Required: no
  • Type: string
--state​

—

  • Source: query
  • Required: no
  • Type: string
--status​

—

  • Source: query
  • Required: no
  • Type: enum("open", "closed")
--assignee​

—

  • Source: query
  • Required: no
  • Type: string
--limit​

Maximum number of results to return

  • Source: query
  • Required: no
  • Type: integer
  • Default: 50
--offset​

Number of results to skip

  • Source: query
  • Required: no
  • Type: integer
  • Default: 0

soat create-task​

Create a task

  • Method: POST
  • Path: /api/v1/tasks

Usage​

soat create-task --workflow-id <string> --title <string>

Options​

--project-id​

—

  • Source: body
  • Required: no
  • Type: string
--workflow-id​

—

  • Source: body
  • Required: yes
  • Type: string
--title​

—

  • Source: body
  • Required: yes
  • Type: string
--payload​

—

  • Source: body
  • Required: no
  • Type: object
--assignee​

—

  • Source: body
  • Required: no
  • Type: string \| null

soat get-task​

Get a task

  • Method: GET
  • Path: /api/v1/tasks/{task_id}

Usage​

soat get-task --task-id <string>

Options​

--task-id​

—

  • Source: path
  • Required: yes
  • Type: string

soat update-task​

Update a task

  • Method: PATCH
  • Path: /api/v1/tasks/{task_id}

Usage​

soat update-task --task-id <string>

Options​

--task-id​

—

  • Source: path
  • Required: yes
  • Type: string
--title​

—

  • Source: body
  • Required: no
  • Type: string
--payload​

Partial payload, shallow-merged over the existing payload. Omitted keys are preserved; provided keys overwrite. The merged result must satisfy the workflow's payload_schema.

  • Source: body
  • Required: no
  • Type: object
--assignee​

—

  • Source: body
  • Required: no
  • Type: string \| null

soat delete-task​

Delete a task

  • Method: DELETE
  • Path: /api/v1/tasks/{task_id}

Usage​

soat delete-task --task-id <string>

Options​

--task-id​

—

  • Source: path
  • Required: yes
  • Type: string

soat transition-task​

Transition a task

  • Method: POST
  • Path: /api/v1/tasks/{task_id}/transitions

Usage​

soat transition-task --task-id <string> --transition <string>

Options​

--task-id​

—

  • Source: path
  • Required: yes
  • Type: string
--transition​

—

  • Source: body
  • Required: yes
  • Type: string
--note​

—

  • Source: body
  • Required: no
  • Type: string \| null

soat get-task-history​

Get task history

  • Method: GET
  • Path: /api/v1/tasks/{task_id}/history

Usage​

soat get-task-history --task-id <string>

Options​

--task-id​

—

  • Source: path
  • Required: yes
  • Type: string