Retrieve comments, their timestamps & creators from key result

Use below endpoint to get all comments on a key result & related data. 

Request

Enter KR id as input to request details. If the KR is deleted or the KR id is incorrect, relevant response is returned. 

Response 

Parent

Parameter

Type

Description

Possible value

Parent

Parameter

Type

Description

Possible value

 

dateTimeFormat

String

Format definition of date fields returned in response

 

 

dateFormat

Date

Format definition of date fields returned in response

 

 

comments

Object

This object consists of details about comments on the current KR.

 

comments

id

Number

Comment id 

1, 2, 3, 4, etc

comments

message

String

Entire message added as a comment.

Example comment - @sameer please add the progress of this KR before end of today. 

comments

creator

Object

This consists of the user object for user who created the comment.

 

comments

created

Date

Date on which comment is created.

Any date

comments

modified

Date

Date on which the comment was last modified. If the created & modified date are same, that means the comment was never modified

Any date

comments

eventType

String

Event name to identify whether the comment was added while punching in or was a normal comment.

  • Punch-in

  • Comment