Skip to main content
POST
Link a project to an objective
Records that a project contributes to an objective, with a weight and an optional note. The body is strict: id, objectiveId, a finite weight and note. Linking a pair that is already linked replaces its weight and note (a link without a note clears the stored note), so repeating a completed link is harmless. A project holds at most 1,000 links; a link that would add one more is 409 conflict, and nothing is written. The change touches two resources and authorizes both inside the write. The project: 404 unless the caller holds projects:read at its home, 403 without projects:manage there. The objective: the caller must be able to read objectives (objectives:read, decided at the deployment root, otherwise 403 naming it), and a missing or malformed objective is 404. The credential’s scopes must include projects:read and objectives:read as well as projects:manage, because the success returns the links; otherwise 403 naming the missing one, and nothing is written. Success is 200 with a ProjectObjectiveLinkSet: the projectId and all its links, in the order List project objectives pages them after the change, including the primary objective. A same-key retry within 24 hours returns the recorded result only while all of the above still hold; otherwise 409 idempotency_result_unavailable.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Headers

Idempotency-Key
string

Optional logical intent key. A same-key retry within 24 hours returns the recorded result without writing again.

Required string length: 1 - 255

Path Parameters

projectId
string
required

The project ID, as GET /api/v2/projects/get returns it.

Minimum string length: 1

Body

application/json

Link a project to an objective it contributes to, or re-weight the existing link. Unknown fields are refused.

objectiveId
string
required

The objective ID, as GET /api/v2/objectives/get returns it.

Minimum string length: 1
weight
number
required

The project's contribution weight to the objective; a repeat replaces it.

note
string

Why the project contributes. A re-weight without a note clears the stored note.

Response

Success

data
object
required
meta
object
required