Work with objectives
You can use the planning_info entity to work with objectives, which are used to define and track high-level goals.
Overview
Objectives can be defined separately for each combination of release and milestone, sprint, program, and team. To enable objectives, you must define one or more user-defined-fields (UDFs) for the Objectives entity.
For details, see Create release objectives.
POST: Create an objective
Request:
POST …/api/shared_spaces/<space_id>/workspaces/<workspace_id>/planning_info/create_or_return
Body:
{"release":"{id}","milestone":"{id}","sprint":"{id}","program":"{id}","team":"{id}"}
Note that release is mandatory, other entities are optional.
Response (in JSON format):
{ "type":"planning_info", "milestone":{…}, "program":{…}, "release":{…}, "sprint":{…}, "team":{…}, "name":"Objective for {Release… / Milestone… / Sprint… / Program… / Team…}", "workspace_id":{workspace_id}, "id":"{objective_id}" }
PUT: Update an objective
Request:
PUT …/api/shared_spaces/<space_id>/workspaces/<workspace_id>/planning_info/<objective_id>?fields=…
Body:
{"udf_name":"udf_value","{objective _id}":"2002"}