punchInObjective/punchInKeyResults

Background

This REST API is meant to punch in the Objectives and KRs.

API Details

This API will require valid authentication & will expect the user API token in the request.
- Read Create User API token for more details

Request

Below are the endpoints for this API based on which UpRaise app you are using -

App name	Endpoint

App name	Endpoint
UpRaise for Employee Success	Punch in on objective - https://employee-success.upraise.io/rest/upraise/public/1.0/okr/objective/{id}/punchin Punch in on KR - https://employee-success.upraise.io/rest/upraise/public/1.0/okr/keyresult/{id}/punchin
UpRaise People	To get objective comments - https://people.upraise.io/rest/upraise/public/1.0/okr/objective/{id}/punchin To get KR comments - https://people.upraise.io/rest/upraise/public/1.0/okr/keyresult/{id}/punchin

On this page

On this page
1 Background 2 API Details 3 Request 4 Request Payload for objective punch-in 5 Request parameters 6 Response 7 Request Payload for objective punch-in 8 Request parameters 9 Response

Request Payload for objective punch-in

//To share with all users use 1 against "sharedWith"
{
  "progressPercent": 10,
  "comment": {
    "message": "new with objective punchin",
    "sharedWith": 1
    },
  "confidenceScore": 6
}

//To share with selected users use 3 against "sharedWith" & email id of users against with "sharedWithUsers"
{
  "progressPercent": 10,
  "comment": {
    "message": "new with objective punchin",
    "sharedWith": 3,
    "sharedWithUsers": ["emailid-1","emailid-2"]
    },
  "confidenceScore": 6
}

Request parameters

Parent	Parameter	Type	Description	Possible values

Parameter	Type	Description	Possible values
progressPercent	Number	The progress percentage of the objective	Any decimal or non-decimal number
comment	String	This object contains the parameters related to comments	message
message	String	Actual punch in the comment	Any punch in comment
shareWith	String	This defines whether the punch-in comment is shared with all or selected users	To share with all users use 1 against "sharedWith" To share with selected users use 3 against "sharedWith"
sharedWithUsers	String	Add email ID of users against this parameter	john.doe@acme.com, peter.shaw@acme.com
confidenceScore	Number	Any number between 0-10 as confidence score. No decimal numbers are accepted.	Any number between 0-10 as confidence score. No decimal numbers are accepted.

Response

"Objective is updated successfully."

Request Payload for objective punch-in

//To share with all users use 1 against "sharedWith"
{
  "currentValue": 23,
  "comment": {
    "message": "improve performance",
    "sharedWith": 1
    },
  "confidenceScore": 4
}
//To share with selected users use 3 against "sharedWith" & email id of users against with "sharedWithUsers"
{
  "currentValue": 10,
  "comment": {
    "message": "I have completed task assigned to me on time",
    "sharedWith": 3,
    "sharedWithUsers": ["emailid-1","emailid-2"]
    },
  "confidenceScore": 6
}

Request parameters

Parent	Parameter	Type	Description	Possible values

Parameter	Type	Description	Possible values
currentValue	Number	The current progress number of the KR	Any number
comment	String	This contains the mandatory comment that needs to be added while doing progress punch-in	message
message	String	The actual punch-in comment	Any punch in comment
sharedwith	Number	This defines whether the punch-in comment is shared with all or selected users	To share with all users use 1 against "sharedWith" To share with selected users use 3 against "sharedWith"
sharedWithUsers	String	Add email ID of users against this parameter to share punch-in update and comment with selected users	john.doe@acme.com, peter.shaw@acme.com
confidenceScore	Number	Any number between 0-10 as confidence score. No decimal numbers are accepted.	Any number between 0-10 as confidence score. No decimal numbers are accepted.