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, in this case, "Youth star scales."

• icon: (String) The URL for the icon associated with the outcome. The icon is stored at the specified path.

• updated_at (string): Timestamp of last update.

• created_at (string): Timestamp of creation.

Front-end documentation

• Outcomes have the same name in the back-end and the front-end.

• Front-end documentation on Outcomes.

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