getObjectiveComments/getKeyResultComments

Background

This REST API is meant to provide all comments on 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	To get objective comments - https://employee-success.upraise.io/rest/upraise/public/1.0/okr/objective/{id}/comment To get KR comments - https://employee-success.upraise.io/rest/upraise/public/1.0/okr/keyresults/{id}/comment
UpRaise People	To get objective comments - https://people.upraise.io/rest/upraise/public/1.0/okr/objective/{id}/comment To get KR comments - https://people.upraise.io/rest/upraise/public/1.0/okr/keyresults/{id}/comment

On this page

On this page
1 Background 2 API Details 3 Request 4 Sample JSON for objective comments 5 Response parameters for objective comments 6 Sample JSON for KR comments 7 Response parameters for KR comments

Sample JSON for objective comments

{
  "startAt": 0,
  "maxResults": 10,
  "total": 3,
  "results": [
    {
      "dateTimeFormat": "d/MM/yyyy h:mm a",
      "dateFormat": "dd/MM/yyyy",
      "objective": {
        "id": 131519,
        "key": "OBJ-4719",
        "objectiveApiUrl": "<baseURL>/rest/upraise/public/1.0/okr/objective/131519"
      },
      "comments": [
        {
          "id": 38133,
          "message": "Please check the attached files",
          "messageInHtml": "<div><p>Please check the attached files</p></div>",
          "creator": {
            "id": 67276,
            "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63f32afafb3ac4003fa1c778"
          },
          "created": "24/04/2024 2:17 PM",
          "modified": "24/04/2024 2:17 PM",
          "eventType": "Comment",
          "modifiedBy": {
            "id": 67276,
            "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63f32afafb3ac4003fa1c778"
          }
        },
        {
          "id": 38134,
          "message": "It seems the progress has not been updated for past 3 weeks, please update",
          "messageInHtml": "<div><p>It seems the progress has not been updated for past 3 weeks, please update</p></div>",
          "creator": {
            "id": 67253,
            "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
          },
          "created": "24/04/2024 2:18 PM",
          "modified": "24/04/2024 2:18 PM",
          "eventType": "Comment",
          "modifiedBy": {
            "id": 67253,
            "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
          }
        },
        {
          "id": 38135,
          "message": "Noted, we will add this to logs",
          "messageInHtml": "<div><p>Noted, we will add this to logs</p></div>",
          "creator": {
            "id": 67322,
            "jiraUserRestApiUrl": "<baseURL>/api/2/user?accountId=63f31b61526117e1514b2b03"
          },
          "created": "24/04/2024 2:19 PM",
          "modified": "24/04/2024 2:19 PM",
          "eventType": "Comment",
          "modifiedBy": {
            "id": 67322,
            "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63f31b61526117e1514b2b03"
          }
        }
      ]
    }
  ]
}

Response parameters for objective comments

Parent	Parameter	Type	Description	Possible values

Parent	Parameter	Type	Description	Possible values
	StartAt	Numeric	Page number whose results are returned in the response.	0, 1, 2, 3, etc.
	maxResults	Numeric	This will show the max number of results on any given page.	Maximum allowed value of 50. If more than 50 value is sent in the request, the app will consider 50.
	total	Numeric	This will indicate how many results in total exist for the given search.	Any number
	dateTimeFormat	String	Format definition of date fields returned in response.	Format definition of dateTime fields returned in response.
	dateFormat	String	Format definition of date fields returned in response.	Format definition of dateTime fields returned in response.
	objective	Array	This array contains the parameters for objective	id key objectiveApiUrl
objective	id	Number	Objective ID	89, 78, etc.
objective	key	String	UpRaise objective key	OBJ-67, OBJ-90, etc.
objective	objectiveApiUrl	String	Objective API URL	<baseURL>/rest/upraise/public/1.0/okr/objective/131519
	comments	Array	This array contains the parameters related to comments	id message messageInHtml creator
comments	id	Number	Comment ID	99828, 5656, etc.
comments	message	String	Actual comment	Any comment
comments	messageInHtml	String	Comment in HTML format	Same comment in HTML format
comments	creator	Array	Creator of the comment	id jiraUserRestApiUrl
creator	id	Number	UpRaise user ID of the comment creator	8976, 90, etc.
creator	jiraUserRestApiUrl	String	Jira user rest API URL of the user who created the comment	<baseURL>/rest/api/2/user?accountId=63f32afafb3ac4003fa1c778
	created	String	Date when the comment was created	24/04/2024 2:17 PM
	modified	String	Date when the comment was modified	27/04/2024 2:17 PM
	eventType	String	Type of the event in UpRaise	comment
	modifiedBy	String	This parameter contains the details of the user who modified the comment	id jiraUserRestApiUrl
modifiedBy	id	Number	UpRaise ID of the user who modified the comment	782, 67, etc.
modifiedBy	jiraUserRestApiUrl	String	Jira user rest API URL of the user who modified the comment	<baseURL>/rest/api/2/user?accountId=63f32afafb3ac4003fa1c778

Sample JSON for KR comments

{
  "startAt": 0,
  "maxResults": 10,
  "total": 4,
  "results": [
    {
      "dateTimeFormat": "d/MM/yyyy h:mm a",
      "dateFormat": "dd/MM/yyyy",
      "keyResult": {
        "id": 351063,
        "key": "KR-6181",
        "keyResultApiUrl": "<baseURL>/rest/upraise/public/1.0/okr/keyresult/351063"
      },
      "comments": [
        {
          "id": 38136,
          "message": "Please update the log",
          "messageInHtml": "<div><p>Please update the log</p></div>",
          "creator": {
            "id": 67253,
            "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
          },
          "created": "24/04/2024 2:24 PM",
          "modified": "24/04/2024 2:24 PM",
          "eventType": "Comment",
          "modifiedBy": {
            "id": 67253,
            "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
          }
        },
        {
          "id": 38138,
          "message": "Punch in comment by for this KR",
          "messageInHtml": "<div><p>Punch in comment by for this KR</p></div>",
          "creator": {
            "id": 67253,
            "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
          },
          "created": "25/04/2024 12:19 PM",
          "modified": "25/04/2024 12:19 PM",
          "eventType": "Punch In",
          "modifiedBy": {
            "id": 67253,
            "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
          }
        },
        {
          "id": 38139,
          "message": "This progress is updated by mistake",
          "messageInHtml": "<div><p>This progress is updated by mistake</p></div>",
          "creator": {
            "id": 67276,
            "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63f32afafb3ac4003fa1c778"
          },
          "created": "25/04/2024 12:19 PM",
          "modified": "25/04/2024 12:19 PM",
          "eventType": "Comment",
          "modifiedBy": {
            "id": 67276,
            "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63f32afafb3ac4003fa1c778"
          }
        },
        {
          "id": 38140,
          "message": "Check the file attatched in this KR",
          "messageInHtml": "<div><p>Check the file attatched in this KR</p></div>",
          "creator": {
            "id": 67322,
            "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63f31b61526117e1514b2b03"
          },
          "created": "25/04/2024 12:20 PM",
          "modified": "25/04/2024 12:20 PM",
          "eventType": "Comment",
          "modifiedBy": {
            "id": 67322,
            "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63f31b61526117e1514b2b03"
          }
        }
      ]
    }
  ]
}

Response parameters for KR comments

Parent	Parameter	Type	Description	Possible values

Parent	Parameter	Type	Description	Possible values
	StartAt	Numeric	Page number whose results are returned in the response.	0, 1, 2, 3, etc.
	maxResults	Numeric	This will show the max number of results on any given page.	Maximum allowed value of 50. If more than 50 value is sent in the request, the app will consider 50.
	total	Numeric	This will indicate how many results in total exist for the given search.	Any number
	dateTimeFormat	String	Format definition of date fields returned in response.	Format definition of dateTime fields returned in response.
	dateFormat	String	Format definition of date fields returned in response.	Format definition of dateTime fields returned in response.
	keyResult	Array	This array contains the parameters for KR	id key keyResultsApiUrl
keyResult	id	Number	KR ID	89, 78, etc.
keyResult	key	String	UpRaise KR key	KR-6790, KR-8984, etc.
keyResult	keyResultApiUrl	String	Key result API URL	<baseURL>/upraise/public/1.0/okr/keyresult/351063
	comments	Array	This array contains the parameters related to comments	id message messageInHtml creator
comments	id	Number	Comment ID	99828, 5656, etc.
comments	message	String	Actual comment	Any comment
comments	messageInHtml	String	Comment in HTML format	Same comment in HTML format
comments	creator	Array	Creator of the comment	id jiraUserRestApiUrl
creator	id	Number	UpRaise user ID of the comment creator	8976, 90, etc.
creator	jiraUserRestApiUrl	String	Jira user rest API URL of the user who created the comment	<baseURL>/rest/api/2/user?accountId=63f32afafb3ac4003fa1c778
	created	String	Date when the comment was created	24/04/2024 2:17 PM
	modified	String	Date when the comment was modified	27/04/2024 2:17 PM
	eventType	String	Type of the event in UpRaise	comment
	modifiedBy	Array	This parameter contains the details of the user who modified the comment	id jiraUserRestApiUrl
modifiedBy	id	Number	UpRaise ID of the user who modified the comment	782, 67, etc.
modifiedBy	jiraUserRestApiUrl	String	Jira user rest API URL of the user who modified the comment	<baseURL>/rest/api/2/user?accountId=63f32afafb3ac4003fa1c778