Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

https://eu.okr-jira-prod.appfire.comThe base url for all API calls is:

if you are in EU region:
https://eu.okr-for-jira-prod-eu.herokuappappfire.com

everywhere else:
https://okr-for-jira-prod.herokuappappfire.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.

...

Create update for specified objective with.

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

description

A description to appear on created update.

Example request:

POST https://okr-for-jira-prod.herokuapp.com/api/v2/api-update/objectives
Request body:

...

Create update for specified key result.

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

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.

description

A description to appear on created update.

Example request:

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

...