Progressions allow your team to intelligently move records between statuses. The Public API currently supports automatic progressions, which skip over details requiring user interaction.
Endpoints
| METHOD | ENDPOINT | DESCRIPTION |
|---|---|---|
| GET | /:resource/:resource_id/progressions | Returns an array of available progression actions. An ID from this response can be used to progress the object to the specified status. |
| [PUT|POST] | /:resource/:resource_id/progressions/:progression_id/auto | Automatically progresses the resource to the progressions next status if applicable. The updated resource is returned upon success. |
For more information, please click on the endpoint's links.
Sample
To perform an automatic progression you should:
...
1. Determine what status progressions are available for the given object by hitting
...
the list resource progressions
...
endpoint. For example
| Code Block | ||||
|---|---|---|---|---|
| ||||
<data>
<meta message="Everything executed as expected." more_info="https://affinitylive.jira.com/wiki/display/APIS/Status+Codes#ok" status="ok"/>
<response id="133" title="New Ticket">
<status id="2" color="yellow" standing="open" title="Open"/>
</response>
<response id="139" title="Close Ticket">
<status id="4" color="blue" standing="closed" title="Closed"/>
</response>
<response id="140" title="Waiting For Client">
<status id="6" color="orange" standing="open" title="Waiting for Client"/>
</response>
</data> |
2. By looking at the title and status details, determine the appropriate progression for your action. Keep track of the progression's id. In this case, we want to run "New Ticket" Progression #133.
3. Update the resource by posting the auto-progression ID to the
...
...
for the resource.
| Code Block | ||||
|---|---|---|---|---|
| ||||
<data>
<meta message="Everything executed as expected." more_info="https://affinitylive.jira.com/wiki/display/APIS/Status+Codes#ok" status="ok"/>
<response id="3071" title="Billing Issues Monthly to 3rd Party (Google)">
<status id="2" title="Open"/>
</response>
</data> |
Endpoints
| METHOD | ENDPOINT | DESCRIPTION |
|---|---|---|
| GET | /:resource/:resource_id/progressions | Returns an array of available progression actions. An ID from this response can be used to progress the object to the specified status. |
| [PUT|POST] | /:resource/:resource_id/progressions/:progression_id/auto | Automatically progresses the resource to the progressions next status if applicable. The updated resource is returned upon success. |
...