If the key result is deleted or its id is incorrect, relevant message is returned.
Request
Linked id is needed as input in the endpoint URL
how to get linked id?
To get linked id of Jira issue KR and Jira issue via JQL, use response id in 'linkedId' parameter in Get objective details API by. In get objective details API, use the parent objective id of respective Jira KR.
Response
Parent
Parameter
Type
Description
possible values
dateTimeFormat
String
Format definition of dateTime fields returned in response.
dateFormat
Format definition of dateTime fields returned in response.
keyResult
Object
This object consists of all data points of key result
keyResult
linkId
Number
Jira issue linked in in UpRaise
1245, 56, 78, 99, etc
keyResult
type
Object
This object consists of all data points of key result type in UpRaise
id
name
type
id
Number
Key result type id in UpRaise
3
4
type
name
String
Key result type name in UpRaise (Only Jira issue & Jira issue (via JQL) type KR in UpRaise)
Jira issue
Jira issue (via JQL)
keyResult
title
String
JQL key result title or Jira issue summary in case of Jira issue key result
keyResult
progress
Object
This object consists of details aboutcurrentprogress ofthe current key result.
percent
progress
percent
Number
Thisreturnsthe current progressof key result
20.0, 50.55. 7.56, etc
progress
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.
1
2
3
etc
keyResult
jql
String
This parameter is applicable only in case of Jira issue via JQL.
project = UPW AND issuetype = bug AND assignee = JohnB
Project = UPW AND sprint = 3 AND status = done
keyResult
gradeApiUrl
String
Url endpoint to retrieve grades associated with this key result.