Namespace Reference

Tasks and approvals

Curated JQL namespaces and examples for tasks and approvals.

Tasks namespaces cover workbench tasks, subtasks, comments, task files, schedules, rotas, form schema, approvals, metrics, and status transitions.

Key namespaces and models

  • tasks.Category
  • tasks.Task
  • tasks.Approval
  • tasks.SubTask
  • tasks.TaskFile
  • tasks.TaskComment
  • tasks.TaskLog
  • tasks.Section
  • tasks.Question
  • tasks.ScheduleCategory
  • tasks.Schedule
  • tasks.ScheduleTask
  • tasks.Rota
  • tasks.RotaTask
  • tasks.TaskMetricsSnapshot
  • tasks.TaskStatusTransition
  • tasks.TaskAssigneeMetrics

Common controller intents

  • tasks.Task.saveTask
  • tasks.Task.reassignTask
  • tasks.Task.retrieveTasks
  • tasks.Task.getQuickStats
  • tasks.Task.getMyQuickStats
  • tasks.Task.getMyBadgeCount
  • tasks.Task.getActivityTimeline
  • tasks.Task.pendingDocumentApprovals

Common model intents

Most listed model namespaces support retrieve, retrieveOne, retrieveV2, create, update/patch, deleteOne, metadata, and aggregate subject to model permissions. Use consequence only for models that implement an on_<consequence> hook.

Retrieve example

json
1{ 2 "__meta__": { 3 "schema": "model", 4 "namespace": "tasks.Task", 5 "intent": "retrieve", 6 "authenticationClass": "jwt", 7 "ordering": "-created", 8 "limit": 20 9 }, 10 "id": null, 11 "created": null 12}

Create example

json
1{ 2 "__meta__": { 3 "schema": "model", 4 "namespace": "tasks.Category", 5 "intent": "create", 6 "authenticationClass": "jwt", 7 "return": { 8 "id": null, 9 "name": null, 10 "alias": null 11 } 12 }, 13 "name": "Onboarding", 14 "alias": "onboarding" 15}

For examples that include foreign keys, numeric ids must refer to records in the same tenant and visible to the authenticated user.