Sign in

v1

latestOpenAPI 3.1.0Elastic 2.02026-07-179371211.2 KB
Cases

Get Case Comments

Searches for all comments assigned to the given case ID and returns the matching comments, if any. If the case does not exist, this method will respond with a 200 status and an empty list.

get/connect/case/comments/{id}

Path parameters

idstring required

The case ID to use for searching all related comments

Response

The array of case comments, or an empty array if no matching comments found

caseIdstring required

The case ID for which this comment is to be attached, or is already attached.

createTimestring

The date and time that this object was created. This is a read-only field.

descriptionstring required

The comment content itself. Can contain limited markdown syntax.

hoursnumber

The number of hours spent on the work referenced in this comment. Can be a decimal value.

idstring

The ID assigned to this object by the server. This is a read-only field.

kindstring

The kind of object. This is a read-only field.

operationstring

The operation that was applied to the object. This is a read-only field.

updateTimestring

The date and time that this object was last modified. This is a read-only field.

userIdstring

The user ID (or API client ID) that initiated this event. This is a read-only field.

Example response

[
  {
    "caseId": "PdFc-JIBLkNJ8-bDfz47",
    "createTime": "2024-11-14T15:03:22Z",
    "description": "Discovered another anomaly around the same time involving missing logs on server xyz.",
    "hours": 2.5,
    "id": "PdFc-JIBLkNJ8-bDfz47",
    "kind": "case",
    "operation": "create",
    "updateTime": "2024-11-14T15:33:02Z",
    "userId": "socl_my_new_client"
  }
]