Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Comment:
Version published after converting to the new editor
API URL to get KR grades (metric & to do)
Use below endpoint to get KR grades
- Syntax - <Jira base URL>/rest/amoeboids-upraise/1.0/okr/keyresult/{ket result id}/getgrades
- Example - jira.amoeboids.com/rest/amoeboids-upraise/1.0/okr/keyresult/11/getgrades
This API returns data about KR grades. If KR is deleted or its id is incorrect, relevant message will be displayed.
Request
KR id is needed as input in the endpoint URL.
Response
- Hire a Chief Revenue Officer
- Increase repeat sales by 7% year on year
| Parent | Parameter | Type | Description | Possible values |
|---|---|---|---|---|
| dateTimeFormat | String | Format definition of date fields returned in response. | ||
| dateFormat | Date | Format definition of date fields returned in response. | ||
| keyResult | Object | This object consists of all data points of key result | ||
| keyResult | id | Number | Key result id in UpRaise | 1, 2, 3, 4, etc |
| keyResult | key | String | Key result key in UpRaise | KR-1, KR-2, etc |
| keyResult | 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 (Only To do & Metric type KRs in UpRaise) |
|
| keyResult | title | String | Key result title |
|
| keyResult | description | String | Key result description |
|
| keyResult | owner | Object | This object consists of all data points of key result owner | |
| keyResult | originalValue | Number | Original value for a metric type key result | 10,20,20.80, etc |
| keyResult | targetValue | Number | Target value for a metric type key result | 50, 500, 52.58, etc |
| keyResult | currentValue | Number | Current value for a metric type key result | 25, 52.58,900, etc |
| keyResult | progress | Object | 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, 50.55. 7.56, etc |
| keyResult | dueDate | Date | Due date of Key result | 08/Jan/18 |
| keyResult | 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 |
| keyResult | orderIndex | Number | Priority of the current key result as compared to other key results under its parent objective. |
|
| keyResult | lastPunchedIn | Date | Date & time on which this key result was last punched in. | 08/Jan/18 8:36 PM |
| keyResult | totalActions | Number | Number of Jira issue actions in key result | 2, 5,10,12, etc |
| keyResult | gradeApiUrl | String | Url endpoint to retrieve grades associated with this key result. | For example - jira.amoeboids.com/rest/amoeboids-upraise/1.0/okr/keyresult/100/getgrades |
| keyResult | grades | Object | This object consists of details about grades of the current key result. | |
| grades | gradesBy | Object | This object consists of details about the user who has provided grades on current key result. | |
| grades | 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 | 04/Jun/19 3:54 PM |
| grades | grade | Number | Grades given on objective | 5, 5.5, 7.5, etc |
| grades | comment | String | Any comment added as remark while adding grades |
|
On this page
| Table of Contents |
|---|
In this section
| Child pages (Children Display) | ||
|---|---|---|
|