API URL to get objective comments & related details
Use below endpoint to get objective comments & related details.
- Syntax - <Jira base URL>/rest/amoeboids-upraise/1.0/okr/objective/{objective id}/comment
- Example - jira.amoeboids.com/rest/amoeboids-upraise/1.0/okr/objective/{1044}/comment
Request
Enter objective id as input to request details.
If the objective is deleted or its's id is incorrect, relevant messages will be displayed.
Response
| Parent | Parameter | Type | Description | Possible values |
|---|---|---|---|---|
| dateTimeFormat | Date | Format definition of date fields returned in response | ||
| dateFormat | Date | Format definition of date fields returned in response | ||
| comments | Object | This object consists details about comments on the objective in UpRaise. | ||
| comments | id | Number | Comment id | 1, 2, 3, 4, etc |
| comments | message | String | Entire message added as a comment by UpRaise user. | Example comment - Progress updated to 40% from 35%. |
| comments | creator | Object | This consists of the user object for user who created the comment. | |
| comments | created | Date | Date on which the 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 define whether the comment was added while punching in the KR or it was just a comment. |
|
On this page
In this section
Past versions