Skip to main content

Tasks

SDK methods for the Tasks module, accessed via soat.tasks. See the Tasks module docs for permissions and data model, and each method's REST page for the full request/response schema.

soat.tasks.listTasks()​

List tasks

  • Method: GET
  • Path: /api/v1/tasks
await soat.tasks.listTasks({
  query: { /* + optional */ },
});

→ Request & response schema

soat.tasks.createTask()​

Create a task

  • Method: POST
  • Path: /api/v1/tasks
await soat.tasks.createTask({
  body: { workflow_id, title, /* + optional */ },
});

→ Request & response schema

soat.tasks.getTask()​

Get a task

  • Method: GET
  • Path: /api/v1/tasks/{task_id}
await soat.tasks.getTask({
  path: { task_id },
});

→ Request & response schema

soat.tasks.updateTask()​

Update a task

  • Method: PATCH
  • Path: /api/v1/tasks/{task_id}
await soat.tasks.updateTask({
  path: { task_id },
  body: { /* + optional */ },
});

→ Request & response schema

soat.tasks.deleteTask()​

Delete a task

  • Method: DELETE
  • Path: /api/v1/tasks/{task_id}
await soat.tasks.deleteTask({
  path: { task_id },
});

→ Request & response schema

soat.tasks.transitionTask()​

Transition a task

  • Method: POST
  • Path: /api/v1/tasks/{task_id}/transitions
await soat.tasks.transitionTask({
  path: { task_id },
  body: { transition, /* + optional */ },
});

→ Request & response schema

soat.tasks.getTaskHistory()​

Get task history

  • Method: GET
  • Path: /api/v1/tasks/{task_id}/history
await soat.tasks.getTaskHistory({
  path: { task_id },
});

→ Request & response schema