Method: investigationComments.list

Full name: projects.locations.instances.investigations.investigationComments.list

investigationComments.list is used to retrieve existing investigation comments for a given investigation.

HTTP request


GET https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{parent}/investigationComments

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of comments. Format: projects/{project}/locations/{location}/instances/{instance}/investigations/{investigation}

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of comments to return. The service may return fewer than this value. If unspecified, at most 100 comments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

Optional. A page token, received from a previous investigationComments.list call. Provide this to retrieve the subsequent page.
orderBy

string

Optional. Configures ordering of comments in the response. If not specified, comments are returned in descending order of their create time. The default ordering is by create time in descending order. The orderBy string is a comma separated list of fields. For example: "createdTime desc" Supported fields: * createdTime

Request body

The request body must be empty.

Response body

Response message for investigationComments.list method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "investigationComments": [
    {
      object (InvestigationComment)
    }
  ],
  "nextPageToken": string
}
Fields
investigationComments[]

object (InvestigationComment)

The investigation comments from the specified investigation.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.