cases

Find case comments

Spaces method and path for this operation:

<div><span class="operation-verb get">get</span>&nbsp;<span class="operation-path">/s/{space_id}/api/cases/{caseId}/comments/_find</span></div>

Refer to Spaces for more information.

Retrieves a paginated list of comments for a case. You must have read privileges for the Cases feature in the Management, Observability, or Security section of the Kibana feature privileges, depending on the owner of the cases with the comments you're seeking.

get/api/cases/{caseId}/comments/_find

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/cases/{caseId}/comments/_find
  • Auth
    • API key in header Authorization
    • or HTTP basic

Path parameters

caseIdstring required
Example:9c235210-6834-11ea-a78c-6ffb38a34414

The identifier for the case. To retrieve case IDs, use the search cases (_find) API. All non-ASCII characters must be URL encoded.

Query parameters

pageinteger

The page number to return.

perPageinteger

The number of items to return. Limited to 100 items.

sortOrder'asc' | 'desc'

Determines the sort order.

Response

Indicates a successful call.

pageinteger required

The current page index.

per_pageinteger required

The number of items per page.

totalinteger required

The total number of comments.

Example response

{
  "comments": [
    {
      "comment": "A new comment.",
      "created_at": "2022-05-13T09:16:17.416Z",
      "created_by": {
        "profile_uid": "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
        "username": "elastic"
      },
      "id": "8af6ac20-74f6-11ea-b83a-553aecdb28b6",
      "owner": "cases",
      "pushed_by": {
        "profile_uid": "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
        "username": "elastic"
      },
      "type": "user",
      "updated_by": {
        "profile_uid": "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
        "username": "elastic"
      },
      "version": "WzIwNDMxLDFd"
    }
  ]
}

Changes

No operation changes recorded.