Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Current »

API URL to get KR grades (Jira issue & Jira issue via JQL)

Use below endpoint to get KR grades 

  • Syntax - <Jira base URL>/rest/amoeboids-upraise/1.0/okr/keyresult/{linked id}/getgrades-jira-jql

  • Example -  jira.amoeboids.com/rest/amoeboids-upraise/1.0/okr/keyresult/11/getgrades-jira-jql

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 

ParentParameterTypeDescriptionpossible values

dateTimeFormatStringFormat definition of dateTime fields returned in response.

dateFormat
Format definition of dateTime fields returned in response.

keyResultObjectThis object consists of all data points of key result
keyResultlinkIdNumberJira issue linked in in UpRaise1245, 56, 78, 99, etc
keyResulttypeObjectThis object consists of all data points of key result type in UpRaise
  • id
  • name
typeidNumberKey result type id in UpRaise 
  • 3
  • 4
typenameStringKey result type name in UpRaise (Only Jira issue & Jira issue (via JQL) type KR in UpRaise)
  • Jira issue
  • Jira issue (via JQL)
keyResulttitleStringJQL key result title or Jira issue summary in case of Jira issue key result
keyResultprogressObjectThis object consists of details about current progress of the current key result.
  • percent
progresspercentNumberThis returns the current progress of key result20.0, 50.55. 7.56, etc
progressweightageNumberAny non-decimal number between 0-10 as weight of the key result, in relation to its parent objectiveAny non-decimal number between 0-10
keyResultorderIndexNumberPriority of the current key result as compared to other key results under its parent objective.
  • 1
  • 2
  • 3
  • etc
keyResultjqlStringThis 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
keyResultgradeApiUrlStringUrl endpoint to retrieve grades associated with this key result.

For example - 

http://upraise-jira7.amoeboids.com/rest/amoeboids-upraise/1.0/okr/keyresult/1665/getgrades-jira-jql

keyResultgradesObjectThis object consists of details about grades of the current key result.
gradesgradesByObjectThis object consists of details about the user who has provided grades on current key result.
gradesgradeNumberGrades given on key result
  • 5, 5.5, 7.5, etc (OR)
  • Achieved, Not Achieved, etc


gradesgradedOn
Date on which graded are added in UpRaise04/Jun/19 3:54 PM
gradescomment
Any comment added as remark while adding grades
  • Overall progress percentage of the this key result is average. We expected more progress on this. 
  • Good job on this key result, keep it up!
  • No labels