Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
API URL to get objective grades
Use below endpoint to get objective grades
Syntax - <Jira base URL>/rest/amoeboids-upraise/1.0/okr/objective/{objective id}/getgrades
Example - jira jira.amoeboids.com/rest/amoeboids-upraise/1.0/okr/objective/1045/getgrades
If the objective is deleted or its id is incorrect, relevant message will be displayed.
Request
Objective id is needed as input in the endpoint URL.
Response
Parent | Parameter | Type | Description | Possible values |
---|---|---|---|---|
dateTimeFormat | Object | Format definition of dateTime fields returned in response. | ||
dateFormat | Object | Format definition of dateTime fields returned in response. | ||
grades | Object | This object consists of all data points of objective grades in UpRaise |
| |
grades | gradedBy | Object | This object consists of all data points related to user who has provided grades |
|
gradedBy | user | Object | This object consists of all data points related to user who has provided grades | |
objective | Object | This object consists of all data points of current objective |
| |
objective | id | Number | Objective id | 1, 2 ,3, 350, etc |
objective | name | String | Objective name/objective title |
|
objective | grades | Object | This object consists of details |
about grades of the current key result. |
| |||
grades | gradedOn | Date | Date on which graded are added in UpRaise | Any date |
grades | averageGrade | Number | Average grades on current objective | 6.5, 8, 10, 5, etc |
grades | remarks | String | Any remarks added with grades/while grading |
|
keyResults | Object | This object consists of all data points of key result | ||
keyResults | id | Number | Key result id in UpRaise | 23, 54, 85, 96, etc |
keyResults | key | String | Key result key in UpRaise | KR-23, KR-54, KR-85, KR-96, etc |
keyResults | type | Object | This object consists of all data points of key result type in UpRaise |
|
type | id | Number | Key result type id in UpRaise |
|
type | name | String | Key result type name in UpRaise |
|
keyResults | title | String | Key result title in UpRaise |
|
keyResults | description | String | Key result |
description in UpRaise |
| |||
keyResults | owner | Object | This object consists of all data points of key result owner | Any UpRaise user's name who |
owns current key result | |||
keyResults | originalValue | Number | Original value |
for a metric type key result | 10,20,20.80, etc | ||
keyResults | targetValue | Number | Target value |
for a metric type key result | 50, 500, 52.58, etc | ||
keyResults | currentValue | Number | Current value |
for a metric type key result | 25, 52.58,900, etc | ||
keyResults | progress | Number | This object consists of details |
about current progress of the current key result. |
| |
progress | percent | Number |
This returns the current progress % key result | 20.0,30.25,56.85, etc | |||
keyResults | dueDate | Date | Due date of Key result | Any date |
keyResults | weightage | Number | Any non-decimal number between 0-10 as weight |
of the key result, in relation to its parent objective | Any non-decimal number between 0-10 | |||
keyResults | orderIndex | Number | Priority of the current key result as compared to other key results under its parent objective. |
|
keyResults | lastPunchedIn | Date | Date & time on which this key result was last punched in. | 08/Jan/18 8:36 PM |
keyResults | totalActions | Number | Number of Jira issue actions in key result | 2, 5,10,12, etc |
keyResults | grades | Object | This object consists of details |
about grades of the current objective. |
| |||
grades | gradedOn | Date | Date on which graded are added in UpRaise | Any date |
grades | grade | Number | Grades provided on current key result |
|
keyResults | gradeApiUrl | String | Url endpoint to retrieve grades associated with this key result. | jira.amoeboids.com/rest/amoeboids-upraise/1.0/okr/keyresult/100/getgrades |
On this page
Table of Contents |
---|
In this section
Child pages (Children Display) | ||
---|---|---|
|