/
Get objective details

Get objective details

Use below endpoint to get details of an objective. 

  • Syntax - <Jira base URL>/rest/amoeboids-upraise/1.0/okr/objective/{objective id}

  • Example -  jira.amoeboids.com/rest/amoeboids-upraise/1.0/okr/objective/1599

This API returns data about an objective. If the objective is deleted or its id is incorrect, relevant message is returned. 

Request

Objective id is needed as input in the endpoint URL.

Response 

Parent

Parameter

Type

Description

Possible values

Parameters related to objective



id

Number

Objective id in UpRaise

1, 2, 3, 4, etc



key

String

Objective key in UpRaise

OKR-1, OKR-2, etc



title

String

Objective title

  • By end of this year, all of our leaders should become our high potential employees

  • Open a new office in India by 2022

  • etc



Description

String

Objective description

  • This objective is all about rolling up HIPO program for our leaders

  • Business expansion in other countries

  • etc



objectiveCycle

Object

This object consists of details about the cycle that is associated with current objective.

  • id

  • name

objectiveCycle

id

Number

Objective cycle id in UpRaise.

  • 1, 5, 4, 10, etc

objectiveCycle

name

String

User facing objective cycle name.

  • July to sept 2019

  • Q3 2019

  • Annual objective cycle

  • etc



level

Object

This object consists of data points of the objective level. 

  • id

  • name

Level

id

Number

Objective level id

  • 1, 2, 3, 4, etc

Level

name

String

Objective level name

  • Individual

  • Team

  • Company

  • Above are the default objective level display names, UpRaise admins can add their own display names in their Upraise instances. 



owner

Object

This object consists of data points related to objective owner

  • upRaiseInfo

  • jiraInfo

owner

upRaiseInfo

Object

This object consists of data points related to owner's UpRaise user details

  • ownerTeams

  • ownerDesignation

upRaiseInfo

ownerDesignation

Object

This object consists of all data points of objective owner's designation

  • id

  • name

ownerDesignation

id

Number

Designation id 

1, 2, 3, 4, etc

ownerDesignation

name

String

Designation of objective owner

Software developer, Sales executive, etc

upRaiseInfo

ownerTeams

Object

This object consists of all data points related to owner's team in UpRaise

  • ownerTeams

ownerTeams

id

Number

Objective owner's team id

1, 2, 3, 4, etc



name

Number

Objective owner's team name

Sales, Operations, etc



startDate

Date 

Objective start date

01/Oct/19



dueDate

Date

Objective due date

28/Jan/20



unit

Object

This object consists of all data points related to the team's unit in UpRaise

  • id

  • name

unit

id

Number

Unit id in UpRaise

2, 3, 4, 5, etc

unit

name

Number

Unit name in UpRaise

Any unit name according every organization's structure



status

Object

This object consists of all data points related to current objective status

  • id

  • name

status

id

Number

Objective status id

1,2,3,4, etc

status

name

String

Objective status in UpRaise

  • Ready for grading

  • Active

  • Scheduled

  • Closed

  • Archived

  • Ready to close



progress

Object

This object cosists of details about current progress percent of the parent objective in UpRaise.

  • percent

progress

percent

Number

Objective progress percentage

50.0, 60.0, 45.5, etc

progress

confidenceStatus

Object

This object consists of all data points related to objective confidence status in UpRaise

  • id

  • name

confidenceStatus

id

Number

Confidence status type id in UpRaise.

1,2,3,4, etc

confidenceStatus

name

String

Confidence status type name in UpRaise.

  • On track 

  • Lagging

  • At risk

  • Not applicable

  • Not available

(First three confidence statuses are customizable and can be anything as per user requirements, last two are system default)

progress

confidenceScore

Number

Any number from 0-10. Only non-decimal numbers. 

0,1,2,3.....10



visibility

Object

This object consists of all data points of objective visibility in UpRaise

  • type

visibility

type

String

Visibility type

  • All users

  • All users in the unit

  • Visible to selected teams or users



labels

Object

This object consists of all data points of objective labels

  • id

  • name

labels

id

Number

Objective label id

1, 2, 3, 4, etc

labels

name

String

Objective label name

Labels are customizable, it can be anything that is used by UpRaise users to classify their objective. Example - CSAT, team building, etc



creator

Object

This object consists of all data points of objective creator 





created

Date

The date on which objective is created

28/Aug/19 6:43 PM



modifiedBy

Object

This object consists of all data points of the user who has modified the objective 





modified

Date

The date on which objective is modified

23/Oct/19 11:08 AM

Parameters related to key results



keyResults

Object

This object consists of all data points of key result



keyResults

id

Number

Key result id in UpRaise

1, 2, 3, 4, etc

keyResults

key

String

Key result key in UpRaise

KR-1, KR-2, etc

keyResults

type

Object



  • id

  • name

type

id

Number

Key result type id 

  • 1

  • 2

  • 3

  • 4

type

name

String

Key result name in UpRaise

  • To do

  • Metric

  • Jira issue

  • Jira issue (via JQL)

keyResults

title

String

Key result title

  • Increase CSAT rate from 60%-70% 

  • Complete Jira administration certification by end of this year

keyResults

description

String

Key result description in UpRaise