Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
comment

Post a comment

post/v1/org/{orgId}/comment

Path parameters

orgIdstring required

Org identifier (either id or slug)

Request body

parentEntityIdstring

parent entity id that this comment belongs to, should be used with entityId

entityIdstring required

entity the comment was posted on

entityType'CHANGE' | 'ASSESSMENT' | 'SCENARIO' | 'FORM_RESPONSE' | 'APPROVAL_APPROVE' | 'APPROVAL_REJECT' | 'APPROVAL_REASSIGN' | 'APPROVAL_WITHDRAW' required

type of entity the comment was posted on

commentAction'APPROVE' | 'REJECT' | 'REQUEST_CHANGES'

action that happened together with the comment

Example request

{
  "parentEntityId": "588f7ee98f138b19220041a7",
  "entityId": "588f7ee98f138b19220041a7"
}

Response

comment created

idstring required

globally unique id

orgIdstring required

org id the comment belongs to

parentEntityIdstring

parent entity id that this comment belongs to, should be used with entityId

entityIdstring required

entity the comment was posted on

entityType'CHANGE' | 'ASSESSMENT' | 'SCENARIO' | 'FORM_RESPONSE' | 'APPROVAL_APPROVE' | 'APPROVAL_REJECT' | 'APPROVAL_REASSIGN' | 'APPROVAL_WITHDRAW' required

type of entity the comment was posted on

commentAction'APPROVE' | 'REJECT' | 'REQUEST_CHANGES'

action that happened together with the comment

createAtstring required

timestamp that the comment was posted

createIdstring required

user id who posted the comment

createBehalfIdstring

created on behalf of user id

updateAtstring

timestamp that the comment was edited

updateIdstring

user id who edited the comment

updateBehalfIdstring

last updated on behalf of user id

deleteAtstring

deleted timestamp

deleteIdstring

user who deleted the comment

deleteBehalfIdstring

deleted on behalf of user id

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "parentEntityId": "588f7ee98f138b19220041a7",
  "entityId": "588f7ee98f138b19220041a7",
  "createAt": "2017-01-24T13:57:52Z",
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "updateAt": "2017-01-24T13:57:52Z",
  "updateId": "588f7ee98f138b19220041a7",
  "updateBehalfId": "588f7ee98f138b19220041a7",
  "updateAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "deleteAt": "2017-01-24T13:57:52Z",
  "deleteId": "588f7ee98f138b19220041a7",
  "deleteBehalfId": "588f7ee98f138b19220041a7",
  "deleteAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  }
}