Outcomes (API)

Owned by Matt Kepple
Last updated: Jan 24, 2024 by Chaitanya Varu
1 min read

Outcomes

Desc: Get all outcomes

url: /outcomes

params: default params

response example: default response example (multiple records)

Get a single outcome

  • Endpoint: GET /api/v2/outcomes/:id

  • Authentication: Requires valid authentication token

  • Response Format: JSON

  • Query Parameter

    • id (integer): The unique identifier for the outcome

Response Attributes

  • id: (Integer) The unique identifier for the outcome.

  • title: (String) The title of the outcome.

  • icon: (String) The URL for the icon associated with the outcome.

  • updated_at (string): Timestamp of last update.

  • created_at (string): Timestamp of creation.

Front-end documentation

Rules & Relationships

  • An outcome can have one or more Indicators

  • An indicator must have one or more outcomes

  • Every outcome must have a single official stage which determines where it appears on a progress panel, i.e. in the Short-term outcomes, Medium term outcomes or Long-term outcomes column

Notes

  • Progress is not shown towards outcomes directly. Instead, progress is shown towards the indicators of an outcome. This progress is captured in stories.

Similar to Changes:

  • an Indicator can have progress added to it in a story. This is called Story Indicator

  • on a project page, it displays the total Story Indicator value from the stories within that project