Sample JSON response| Code Block |
|---|
{
"id": 350824,
"key": "KR-31",
"type": {
"id": 0,
"name": "Metric"
},
"title": "Increase test case automation coverage to 80% in current quarter.",
"description": "",
"keyResultOwner": {
"upRaiseInfo": {
"id": 98136,
"ownerDesignation": {
"id": 901,
"name": "Tester"
},
"ownerTeams": [
{
"id": 2802,
"name": "Testing Team"
},
{
"id": 2805,
"name": "Attlasian Team"
},
{
"id": 2804,
"name": "Product Team"
}
]
},
"jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=6327fe4c61dbef2805bb9a62"
},
"startDate": "19/Mar/24",
"dueDate": "31/Mar/24",
"weightageInPercent": "25.0",
"behavior": {
"id": 1,
"name": "Increase/Decrease"
},
"originalValue": 0.0,
"targetValue": 100.0,
"currentValue": 0.0,
"progress": {
"percent": 0.0,
"confidenceStatus": {
"id": 1901,
"name": "ON TRACK"
},
"confidenceScore": 8.0
},
"progressCalculation": {
"mode": "Manual"
},
"orderIndex": 0,
"lastPunchedIn": "19/Mar/24 12:57 PM",
"creator": {
"id": 98136,
"jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=6327fe4c61dbef2805bb9a62"
},
"created": "19/Mar/24 12:49 PM",
"modifiedBy": {
"id": 98136,
"jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=6327fe4c61dbef2805bb9a62"
},
"modified": "20/Mar/24 7:07 AM",
"customFields": [
{
"id": 67,
"name": "Company Name",
"type": "Text field (single line)",
"textValue": "ABC Pvt. Ltd."
},
{
"id": 89,
"name": "Business Unit",
"type": "Select list (single choice)",
"option": {
"id": 81,
"name": "Healthcare"
}
},
{
"id": 90,
"name": "Technologies Used",
"type": "Select list (multiple choice)",
"options": [
{
"id": 85,
"name": "Cypress"
},
{
"id": 83,
"name": "Selenium"
},
{
"id": 86,
"name": "Playwright"
}
]
},
{
"id": 81,
"name": "Evaluatee",
"type": "User picker (multiple select)",
"userValues": [
{
"id": 98136,
"jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=6327fe4c61dbef2805bb9a62"
},
{
"id": 98147,
"jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
}
]
},
{
"id": 88,
"name": "Remarks",
"type": "Text field (multiple line)",
"textValue": "Keep up the progress.\nWell done."
}
],
"isAbandoned": false,
"isArchived": false,
"watchers": [
{
"upRaiseInfo": {
"id": 98136,
"ownerDesignation": {
"id": 901,
"name": "Tester"
}
},
"jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=6327fe4c61dbef2805bb9a62"
}
],
"parentObjective": {
"id": 131359,
"key": "OBJ-13",
"objectiveApiUrl": "https://employee-success-qa.upraise.io/rest/upraise/public/1.0/okr/objective/131359"
},
"krActions": [
{
"linkId": 40409,
"key": "TP-18",
"type": {
"id": 0,
"name": "Jira Issue"
},
"issueId": 10017,
"jiraIssueRestApiUrl": "<baseURL>/rest/api/2/issue/TP-18"
},
{
"linkId": 40410,
"type": {
"id": 1,
"name": "Jql"
},
"title": "JQL for tracking Company Directory automation cases completion",
"jql": "project = TP AND status = Done"
}
],
"dateTimeFormat": "d/MMM/yy h:mm a",
"dateFormat": "d/MMM/yy"
} |
Response parameters detailsParent | Parameter | Type | Description | Possible values |
|---|
| id | | KR id in UpRaise | 12,45,78, etc | | key | | KR key in UpRaise | KR-12, KR-45, KR-78, etc | | type | Object | This object consists of details about KR types available in UpRaise that is relevant to the given KR id. | | type | id | Number | Key result type id. | 1,2 | type | name | String | Key result name in UpRaise. | Currently APIs do nit support for Jira issue KR and Jira issue KR via (JQL). | | title | String | KR title | | | description | String | Key result description. | This KR is meant to improve our CSAT rate. We will take necessary actions for the same…..so on. | | keyResultOwner | Object | This object consists of details about KR owner. | | keyResultOwner | upRaiseInfo | String | This paramenter contains user’s information | All the parameters related to user info like id, designation, team, etc. | upRaiseInfo | id | Number | | | upRaiseInfo | ownerDesignation | String | Deatisl of KR owner’s designation | | ownerDesignation | id | Number | KR Owner’s designation id | 1, 2, 3, 4, etc. | ownerDesignation | name | String | KR Owner’s designation | Sales Manager QA lead, etc.
| upRaiseInfo | ownerTeams | String | KR Owner’s details | | ownerTeams | id | Number | KR owner’s team id | 1, 2023, 26, etc. | ownerTeams | name | String | KR owner’s team name | Sales, Operations, etc. | | jiraUserRestApiUrl | String | API URL for Jira user Rest API | | | startDate | String | KR start date | | | endDate | String | KR end date | | | weightageInPercent | Number | KR weightage % | 25%, 50%, etc. | | behavior | Object | This object consists all details of the current KR’s behavior | | behavior | id | Number | Id of the behavior | 1, 2 | behavior | name | String | Name of the behavior | Maintain Increase/Decrease
| | originalValue | Number | Original value of current metric KR | | | targetValue | Number | Target value of current metric KR | | | currentValue | Number | Current value of current metric KR | | | minTargetValue | Number | Mimimum target value of current metric KR when Maintain behavior is selected | 7, 90, 878, etc. | | maxTargetValue | Number | Maximum target value of current metric KR when Maintain behavior is selected | 90, 100, etc. | progress | Object | This object consists of details about KR progress. | percent confidenceStatus confidenceScore
| | progress | percent | Number | This returns the current progress of the key result. | 10%, 20%, 23.55%, etc. | percent | confidenceStatus | String | KR confidence status | At risk, On track, etc. | | id | Number | Confidence status type id in UpRaise | 1,2,3,4,5, etc | | name | String | Confidence display 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) | percent | confidenceScore | Number | Any number from 0-10. Only non-decimal numbers. | | | progressCalculation | Object | This object consists of details about KR progress calculation type | mode | progressCalculation | mode | String | Manual Jira issues Other Key results
| | | orderIndex | | Priority of the current key result as compared to other KRs under its parent objective. | 1, 2, 3, 4, etc. | | lastPunchedIn | Date | Last punch in date of KR | 19/Mar/24 12:57 PM | | creator | Object | This object consists of details about user who created the KR | | creator | id | Number | UpRaise user id of the the KR creator | 1, 23, etc. | creator | jiraUserRestApiUrl | String | Jira user Rest API URL | <baseURL>/rest/api/2/user?accountId=6327fe4c61dbef2805bb9a62 | | created | Date | Date and time when KR is created | 19/Mar/24 12:51 PM | | modifiedBy | String | This object consists of details about user who modified the KR | | modifiedBy | id | Number | UpRaise user id who modified KR | 1, 2, 3, 4, etc. | modifiedBy | jiraUserRestApiUrl | String | Jira User API URL who modified the KR | <baseURL>/rest/api/2/user?accountId=6327fe4c61dbef2805bb9a62 | | modified | Object | Date when KR is modified | 20/Mar/24 7:01 AM | customFields | Object | This object consists of details about custom fields assciated with KR based on the progress calculation set up | id name type option userValues numberValue
| | customFields | id | | Id of the custom field | 1, 2, 3, 4, etc. | customFields | name | | Name of the custom field | Story points, time spent, etc. | customFields | type | String | The type of selected custom field | Type parameter is to define different type of cutom fields - Single select Multiple select Single line text Multiline text Singel user picker Multiple user picker Numeric
| customFields | textValue | String | This shows the actual text values of the text field type custom fields | Any text value in the field | customFields | numberValue | Number | This shows the actual number values of the number field type custom fields | Any numeric value in the field | customFields | options | String | Multiple options in case of fields types like multi-select/multi-user | Any text or numeric options under the multi select fields | options | id | Number | Id of the given options | 1, 2, 3, 4, etc. | options | name | String | Name of the options | Option A Option B Option C Option D
| | isAbandoned | String | This defines whether KR is Abandoned | | | isArchived | String | This defines whether KR is Archived | | | Watchers | Object | This object consists of details about KR watchers | UserInfo ownerDesignation jiraUserRestApiUrl
| Watchers | userInfo | String | This consists all details of the user who is watching KR | id ownerDesignation jiraUserRestApiUrl
| userInfo | id | Number | Id of the user who is watching KR | 1, 2, 3, 4, etc. | watchers | ownerDesignation | String | Details of KR watcher’s designation | | ownerDesignation | id | Number | Designation id of the user who is watching KR | 1, 2, 3, 4, etc. | ownerDesignation | name | String | Designation of the user who is watching KR | | watchers | jiraUserRestApiUrl | String | Jira user API URL of the user who is watchimg KR | <baseURL>/rest/api/2/user?accountId=6327fe4c61dbef2805bb9a62 | | parentObjective | Object | This object consists all details of the parent objective of the KR | | parentObjective | id | Number | Id of the parent objective | 1, 23415, 2324, 56, etc. | parentObjective | key | String | UpRaise key of the parent objective | obj-1, obj-2, obj-3, obj-4, etc. | parentObjective | objectiveApiUrl | String | API URL of the parent objective | <baseURL>/rest/upraise/public/1.0/okr/objective/131359 | | krActions | Object | This object consits all details of the KR actions within current KR | | krActions | linkeid | Number | Jira issue linked id in UpRaise | 1099, 29, 3456, 40412, etc. | krActions | key | String | Jira issue key | AR-12, PG-1315, etc. | key | type | String | KR action type | Jira issue Jira issue (via JQL)
| type | id | Numebr | KR action type id | 0 for Jira issue 1 for jql
| type | name | String | Name of the KR action type | | type | title | String | Title of the JQL type KR actions | Any title | type | jql | String | Actual JQL added to fetch Jira issues | project = TP AND status = Done (any such JQL) | | 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 |
|