Menu

API reference

Goals and tasks

Business goals and the tasks that serve them.

get

/v1/goals

Goals in the caller's outlets and the tenant-wide ones

operationId listGoals

Auth

Member token+Tenant header

Parameters

  • outletin querystring (uuid)optional
  • statusin queryenum (4)optional
    activeachievedmissedcancelled

Response 200

V1Goalscontract v1.goals
  • itemsarray of objectrequired
    • idUuid7required
    • outlet_idUuid7 | nullrequired
    • metricenum (2)required
      net_salesorders
    • target_valueintegerrequired
      > 0≤ 9007199254740991
    • currencystring | nullrequired
      pattern ^[A-Z]{3}$
    • period_fromstring (date)required
      pattern ^(?:(?:[0-9][0-9][2468][048]|[0-9][0-9][13579][26]|[0-9][0-9]0[48]|[02468][048]00|[13579][26]00)-02-29|[0-9]{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12][0-9]|3[01])|(?:0[469]|11)-(?:0[1-9]|[12][0-9]|30)|(?:02)-(?:0[1-9]|1[0-9]|2[0-8])))$
    • due_onstring (date)required
      pattern ^(?:(?:[0-9][0-9][2468][048]|[0-9][0-9][13579][26]|[0-9][0-9]0[48]|[02468][048]00|[13579][26]00)-02-29|[0-9]{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12][0-9]|3[01])|(?:0[469]|11)-(?:0[1-9]|[12][0-9]|30)|(?:02)-(?:0[1-9]|1[0-9]|2[0-8])))$
    • statusenum (4)required
      activeachievedmissedcancelled
    • basis_snapshot_idUuid7 | nullrequired

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

post

/v1/goals

goals.goal.create.v1 — set a goal (intel may draft it)

operationId createGoal

Auth

Member token+Tenant header

Request body

object
  • command_idUuid7required
  • idempotency_keystringrequired
    pattern ^[A-Za-z0-9_.:-]{8,100}$
  • typeconst "goals.goal.create.v1"required
  • payloadGoalsGoalCreateV1required

Response 200

CommandResultcontract command-result
  • command_idUuid7required
  • typestringrequired
    pattern ^[a-z][a-z_]*(\.[a-z][a-z_]*)+\.v[1-9][0-9]*$
  • entity_idUuid7required
  • committed_atIsoDatetimerequired

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

post

/v1/goals/update

goals.goal.update.v1 — close a goal as achieved, missed or cancelled

operationId updateGoal

Auth

Member token+Tenant header

Request body

object
  • command_idUuid7required
  • idempotency_keystringrequired
    pattern ^[A-Za-z0-9_.:-]{8,100}$
  • typeconst "goals.goal.update.v1"required
  • payloadGoalsGoalUpdateV1required

Response 200

CommandResultcontract command-result
  • command_idUuid7required
  • typestringrequired
    pattern ^[a-z][a-z_]*(\.[a-z][a-z_]*)+\.v[1-9][0-9]*$
  • entity_idUuid7required
  • committed_atIsoDatetimerequired

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

get

/v1/tasks

Tasks in the caller's outlets and the tenant-wide ones

operationId listTasks

Auth

Member token+Tenant header

Parameters

  • outletin querystring (uuid)optional
  • assigneein querystring (uuid)optional
  • statusin queryenum (3)optional
    opendonecancelled
  • due_beforein querystring (date)optional

Response 200

V1Taskscontract v1.tasks
  • itemsarray of objectrequired
    • idUuid7required
    • outlet_idUuid7 | nullrequired
    • title_keystringrequired
      pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
    • assignee_member_idUuid7required
    • due_onstring (date)required
      pattern ^(?:(?:[0-9][0-9][2468][048]|[0-9][0-9][13579][26]|[0-9][0-9]0[48]|[02468][048]00|[13579][26]00)-02-29|[0-9]{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12][0-9]|3[01])|(?:0[469]|11)-(?:0[1-9]|[12][0-9]|30)|(?:02)-(?:0[1-9]|1[0-9]|2[0-8])))$
    • finding_idUuid7 | nullrequired
    • cares_listing_idUuid7 | nullrequired
    • statusenum (3)required
      opendonecancelled
    • done_atIsoDatetime | nullrequired
    • done_byUuid7 | nullrequired

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

post

/v1/tasks

goals.task.create.v1 — assign a task (intel may draft it)

operationId createTask

Auth

Member token+Tenant header

Request body

object
  • command_idUuid7required
  • idempotency_keystringrequired
    pattern ^[A-Za-z0-9_.:-]{8,100}$
  • typeconst "goals.task.create.v1"required
  • payloadGoalsTaskCreateV1required

Response 200

CommandResultcontract command-result
  • command_idUuid7required
  • typestringrequired
    pattern ^[a-z][a-z_]*(\.[a-z][a-z_]*)+\.v[1-9][0-9]*$
  • entity_idUuid7required
  • committed_atIsoDatetimerequired

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

post

/v1/tasks/update

goals.task.update.v1 — close or reassign a task

operationId updateTask

Auth

Member token+Tenant header

Request body

object
  • command_idUuid7required
  • idempotency_keystringrequired
    pattern ^[A-Za-z0-9_.:-]{8,100}$
  • typeconst "goals.task.update.v1"required
  • payloadGoalsTaskUpdateV1required

Response 200

CommandResultcontract command-result
  • command_idUuid7required
  • typestringrequired
    pattern ^[a-z][a-z_]*(\.[a-z][a-z_]*)+\.v[1-9][0-9]*$
  • entity_idUuid7required
  • committed_atIsoDatetimerequired

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.