https://eu.okr-jira-prod.appfire.comThe base url for all API calls is:
if you are in EU region:
https://eu.okr-jira-prod.appfire.com
everywhere else:
https://okr-jira-prod.appfire.com
Prerequisites
All update methods are POST, and require JSON object with specified properties in body of the request.
Authentication is performed in the same way, as for query methods - using API-Token: {token}
header with your authentication token.
Also Content-Type: application/json
header is mandatory for server to correctly parse your request.
Update objective
Create update for specified objective with.
POST /api/v2/api-update/objectives
Property | Description | Mandatory |
---|---|---|
| Id of objective to update. |
|
| New state of the objective. Allowed statuses: | ❎ |
| A description to appear on created update. | ❎ |
Example request:
POST https://okr-for-jira-prod.herokuapp.com/api/v2/api-update/objectives
Request body:
{ "objectiveId": "62334eac00ee2b102e34fdb7", "status" : "ON TRACK", "description" : "Spaceship assembly docks are delivering on time" }
Update key result
Create update for specified key result.
POST /api/v2/api-update/keyResults
Property | Description | Mandatory |
---|---|---|
| Id of key result to update. |
|
| New state of the key result. Allowed statuses: | ❎ |
| Progress value to set in update. In case KR progress unit is currency, value should still be a number, without currency symbol. | ❎ |
| A description to appear on created update. | ❎ |
Example request:
POST https://okr-for-jira-prod.herokuapp.com/api/v2/api-update/keyResults
Request body:
{ "keyResultId": "62384a6942adda046598b3bd", "status" : "AT RISK", "newValue" : 13500.5, "description" : "Reduction in ship hull output is caused by Unobtainium supply disruptions." }