Goal

Set the objective (north star) for a project

Singleton per (tenant, project) — repeated calls update the same node.

post/api/goal/objective

Request

  • Base URL: http://localhost:38200
  • URL: http://localhost:38200/api/goal/objective
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Request body

project_idinteger nullable
titlestring required
whystring

Response

Created/updated objective node.

idinteger
tenantIdinteger
projectIdinteger nullable
parentIdinteger nullable
kindstring

objective | milestone | goal | work_item | relay

ownerRolestring nullable
statusstring

draft | not_started | ready | in_progress | blocked | done | superseded

originstring nullable

greenfield | leverage | migrate | unknown

titlestring
contextIdinteger nullable
verifyCmdstring nullable
evidencestring nullable
targetWeeksinteger nullable
startsAtstring date-time nullable
endsAtstring date-time nullable
sizestring nullable
effortWeeksnumber nullable
externalRefobject
orderIndexinteger
fromRolestring nullable

Relay routing (kind='relay' only).

toRolestring nullable

Relay routing (kind='relay' only).

claimedBySessionIdinteger nullable
nudgeCountinteger
lastNudgedAtstring date-time nullable
nudgedBySessionIdinteger nullable
payloadobject
doneAtstring date-time nullable
archivedAtstring date-time nullable
createdAtstring date-time
updatedAtstring date-time
syncOwnedboolean

Server-only marker set exclusively by POST /api/goal/sync.

objectiveRunIdstring nullable

Example response

{
  "kind": "work_item",
  "status": "not_started"
}

Changes

No recorded changes to this operation across all 1 revision of this API.