KR punch in

  • Navigate to Jira REST API Browser.

  • Add this link ↓ to search field at the left corner.

    • amoeboids-upraise/1.0/okr/keyresult/{id}/punchin

  • Enter an objective id and JSON body for the request with the following format.

1 2 3 4 5 6 7 8 { "currentValue": 19.2, "comment": { "message": "comment message goes here", "sharedWith": 2, "sharedWithUsers": ["user-key1", "user-key2"] } }
1
  • Current Value: Current value of KR.

    • Any decimal/ non-decimal value if it's a Metric type KR

    • Only 0 or 1 for ToDo type of KR

  • Comment message: Comment about the progress update

  • Shared with: 1 to share with all users, 2 to share with selected users

  • Shared with users: Add usernames in double quotes separated by a comma only when sharing it with selected users. 



 

Once you send KR id and JSON request, this API updates the progress of the KR and that will be shared with given users. Otherwise returns appropriate errors for invalid id/ KR deleted or user has no access to view that KR, invalid progress percentage depending on the KR type.

This punch in activity also send necessary email notifications to KR owners, selected users in share with the list, and KR watchers(if any). 

 

KR punch in through REST API can be done only for Metric & ToDo type of KRs.



In this section