Versions Compared

Old Version 5

changes.mady.by.user Derya Özdemir

Saved on

compared with

New Version Current

changes.mady.by.user Derya Özdemir

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
panelIconIdatlassian-info
panelIcon:info:
panelIconText:info:
bgColor#F4F5F7

This page is about OKR for Jira Cloud. Using Data Center? Click here.

Base URL for all API calls

Prerequisites

  • All update methods are carried out using the POST HTTP method, and necessitate a JSON object with specified properties in the request body.

  • Authentication is executed in the same manner as for query methods, by utilizing the API-Token: {token} header along with your authentication token.

  • Additionally, the Content-Type: application/json header is mandatory to ensure that the server correctly interprets your request.

Contents

Table of Contents
minLevel3
maxLevel6
outlinefalse
typelist
printablefalse

1. Update objective

Create updates for specified objectives.

POST /api/v2/api-update/objectives

Property

Description

Mandatory

objectiveId

ID of objective to update.

(tick)

status

New state of the objective. Allowed statuses:
NOT STARTED, ON TRACK, AT RISK, OFF TRACK

(error)

description

A description to appear on created update.

(error)

Example request

POST https://okr-jira-prod.appfire.com/api/v2/api-update/objectives

Request body

Code Block
languagejson
{
  "objectiveId": "62334eac00ee2b102e34fdb7",
  "status" : "ON TRACK",
  "description" : "Spaceship assembly docks are delivering on time"
}
Expand
titlecurl
Code Block
languagebash
curl -X POST https://okr-jira-prod.appfire.com/api/v2/api-update/objectives \
-H 'Content-Type: application/json' \
-H 'API-Token: {token}' \
-d '{"objectiveId":"62334eac00ee2b102e34fdb7", "status":"ON TRACK", "description":"Spaceship assembly docks are delivering on time"}'
Expand
titleExample response:
Code Block
languagejson
{
	"entityId": "62334eac00ee2b102e34fdb7",
	"status": "ON TRACK",
	"created": "2022-05-20T09:58:09+0000",
	"value": null,
	"description": "Spaceship assembly docks are delivering on time"
}

2. Update key result

Create updates for the specified key results.

POST /api/v2/api-update/keyResults

Property

Description

Mandatory

keyResultId

ID of key result to update.

(tick)

status

New state of the key result. Allowed statuses:
NOT STARTED, ON TRACK, AT RISK, OFF TRACK

(error)

newValue

Progress value to set in update.
Can not be set for auto key results, as their value comes from JQL query.

In case KR progress unit is currency, value should still be a number, without currency symbol.

(error)

description

A description to appear on created update.

(error)

Example request:

POST https://okr-jira-prod.appfire.com/api/v2/api-update/keyResults

Request body:

Code Block
languagejson
{
  "keyResultId": "62384a6942adda046598b3bd",
  "status" : "AT RISK",
  "newValue" : 13500.5,
  "description" : "Reduction in ship hull output is caused by Unobtainium supply disruptions."
}
Expand
titlecurl
Code Block
languagebash
curl -X POST https://okr-jira-prod.appfire.com/api/v2/api-update/keyResults \
-H 'Content-Type: application/json' \
-H 'API-Token: {token}' \
-d '{"keyResultId":"62384a6942adda046598b3bd","status":"AT RISK","newValue":13500.5,"description":"Spaceship assembly docks are delivering on time"}'
Expand
titleExample response:
Code Block
languagejson
{
	"entityId": "62384a6942adda046598b3bd",
	"status": "AT RISK",
	"created": "2022-05-20T13:01:35+0000",
	"value": 13500.5,
	"description": "Reduction in ship hull output is caused by Unobtainium supply disruptions."
}