Page Comparison

Background

This REST API meant to provide Objective or KR’s grades to the current user. Users are granted as many permissions as they have through their UpRaise roles.

API Details

This API will require valid authentication & will expect the user API token in the request.
Read Create User API token for more details
Base URL - <baseUrl>/rest/upraise/public/1.0/okr/objective/{id}/getgrades
Below are the sample endpoints for this API based on which UpRaise app you are using

App name	Endpoint
UpRaise for Employee Success	To get Objective grades - https://employee-success.upraise.io/rest/upraise/public/1.0/okr/objective/{idobjectiveid}/getgrades To get KR grades - https://employee-success.upraise.io/rest/upraise/public/1.0/okr/keyresult/{idobjectiveid}/getgrades
UpRaise People	To get Objective grades - https://people.upraise.io/rest/upraise/public/1.0/okr/objective/{idkeyResultId}/getgrades To get KR grades - https://people.upraise.io/rest/upraise/public/1.0/okr/keyresult/{idKeyResultid}/getgrades

Request parameters

Objective or KR id is needed as input in the relevant endpoint URL.

On this page

Table of Contents

minLevel	1
maxLevel	6
outline	false
style	disc
type	list
printable	false

Expand

title	Get KR objective grades

Sample JSON response for

KR

objective

Code Block

{
  "dateTimeFormat": "dd/MM/yy hh:mm a",
  "dateFormat": "dd/MM/yy",
  "keyResultobjective": {
    "id": 2936543513,
    "key": "KROBJ-47612056",
    "keyResultApiUrlobjectiveApiUrl": "<baseURL>/rest/upraise/public/1.0/okr/keyresultobjective/2936543513"
  },
  "keyResultGradesobjectiveGrades": [
    {
      "gradeBy": {
        "id": 5857,
        "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=5fb4a9df0dd553006f342981"
      },
      "gradedOn": "27/03/24 06:33 AM",
      "averageGrade": "9.0",
      "remarks": "TheOverall teamprogress successfully increased MAU by 18% over the quarter, falling slightly short of the 20% target. While the goal wasn't fully met, it's commendable that significant growth was achievedis good.",
      "gradedModifiedOn": "27/03/24 06:33 AM"
    }
  ]
}

KR

Objective grade response parameters

Parent	Parameter	Type	Description	Possible values
	dateTimeFormat	String	Format definition of date fields returned in response.	d/MMM/yy h:mm a
	dateFormat	String	Format definition of date fields returned in response.	d/MMM/yy

keyResult

objective

Object

This object contains all the

KR

objective related parameters

id
key

keyResultApiUrl

objectiveApiUrl

keyResult

objective

id

Number

KR

Objective id that was provided in request

12, 71818, etc.

keyResult

objective

key

String

UpRaise key of the

KR

objective

KR

Obj-12,

KR

Obj-89, etc.

keyResult

objective

keyResultApiUrl

objectiveApiUrl

String

KR

Objective Rest API URL

<baseURL>/rest/upraise/public/1.0/okr/

keyresult

objective/

29365

43513

keyResultGrades

objectiveGrades

Object

This object contains

KR

objective grade relted parameters

gradeBy
gradedOn
averageGrade
remarks
gradedModifiedOn

keyResultGrades

objectiveGrades

gradeBy

String

This parameter contains details of the user who graded the

KR

objective

id

jiraRestApiUrl

jiraUserRestApiUrl
gradeBy	id	id	UpRaise Id of the user who graded

KR

objective	1234, 56161, etc.
gradeBy	jiraUserRestApiUrl	String	Jira UserRest Api Url	<baseURL>/rest/api/2/user?accountId=5fb4a9df0dd553006f342981

keyResultGrades

objectiveGrades

gradedOn

Date

Date when

KR

objective was graded

25/03/24 06:33 AM

keyResultGrades

objectiveGrades

averageGrade

Number/String

Average gade are displayed based on the grading type settings in UpRaise that is opinion scale or Radio button

Opinion scale - 0-10 numbers (could be in decimals too)
Radio button - Eg. Achieved, Partially acheived, etc.

keyResultGrades

objectiveGrades

remarks

String

The grading

reamarks

remarks given by user

Example -

The team successfully increased MAU by 18% over the quarter, falling slightly short of the 20% target. While the goal wasn't fully met, it's commendable that significant growth was achieved.

keyResultGrades

objectiveGrades

gradedModifiedOn

Date

If the grades are modified later on, that date will be retuned here

27/03/24 06:33 AM

Expand

title	Get objective KR grades

Sample JSON response for

objective

KR

Code Block

{
  "dateTimeFormat": "dd/MM/yy hh:mm a",
  "dateFormat": "dd/MM/yy",
  "objectivekeyResult": {
    "id": 4351329365,
    "key": "OBJKR-20564761",
    "objectiveApiUrlkeyResultApiUrl": "<baseURL>/rest/upraise/public/1.0/okr/objectivekeyresult/4351329365"
  },
  "objectiveGradeskeyResultGrades": [
    {
      "gradeBy": {
        "id": 5857,
        "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=5fb4a9df0dd553006f342981"
      },
      "gradedOn": "27/03/24 06:33 AM",
      "averageGrade": "9.0",
      "remarks": "Overall progress is goodThe team successfully increased MAU by 18% over the quarter, falling slightly short of the 20% target. While the goal wasn't fully met, it's commendable that significant growth was achieved.",
      "gradedModifiedOn": "27/03/24 06:33 AM"
    }
  ]
}

Objective

KR grade response parameters

Parent	Parameter	Type	Description	Possible values
	dateTimeFormat	String	Format definition of date fields returned in response.

d

dd/

MMM

MM/yy

h

hh:mm

a


	dateFormat	String	Format definition of date fields returned in response.

d

dd/

MMM

MM/yy

objective

keyResult

Object

This object contains all the

objective

KR-related parameters

id
key

objectiveApiUrl

keyResultApiUrl

objective

keyResult

id

Number

Objective id

KR ID that was provided in the request

12, 71818, etc.

objective

keyResult

key

String

UpRaise key of the

objective

KR

Obj

KR-12,

Obj

KR-89, etc.

objective

keyResult

objectiveApiUrl

keyResultApiUrl

String

Objective

KR Rest API URL

<baseURL>/rest/upraise/public/1.0/okr/

objective

keyresult/

43513

29365

objectiveGrades

keyResultGrades

Object

This object contains

objective

KR grade

relted

related parameters

gradeBy
gradedOn
averageGrade
remarks
gradedModifiedOn

objectiveGrades

keyResultGrades

gradeBy

String

This parameter contains details of the user who graded the

objective

KR

id

jiraUserRestApiUrl

jiraRestApiUrl
gradeBy	id	id	UpRaise

Id

ID of the user who graded

objective

KR	1234, 56161, etc.
gradeBy	jiraUserRestApiUrl	String	Jira UserRest Api Url	<baseURL>/rest/api/2/user?accountId=5fb4a9df0dd553006f342981

objectiveGrades

keyResultGrades

gradedOn

Date

Date when

objective

KR was graded

25/03/24 06:33 AM

objectiveGrades

keyResultGrades

averageGrade

Number/String

Average

gade

grades are displayed based on the grading type settings in UpRaise

that

whether it is opinion scale or Radio button

Opinion scale - 0-10 numbers (could be in decimals too)

Radio button - Eg. Achieved, Partially acheived, etc.

objectiveGrades

keyResultGrades

remarks

String

The grading remarks given by user

Example -

The team successfully increased MAU by 18% over the quarter, falling slightly short of the 20% target. While the goal wasn't fully met, it's commendable that significant growth was achieved.

objectiveGrades

keyResultGrades

gradedModifiedOn

Date

If the grades are modified later on, that date will be

retuned

returned here

27/03/24 06:33 AM

Expand

Error handling for Objective and KR grades APIs

HTTP status code	Error message
403 (FORBIDDEN)	This user does not have permission to view OKRs.
404 (NOT_FOUND)	This Objective does not exist.

Versions Compared

Old Version 2

New Version Current

Key

Background

API Details

Request parameters

Sample JSON response for

objective

Objective grade response parameters

Sample JSON response for

KR

KR grade response parameters

Error handling for Objective and KR grades APIs