Method: caseComments.list

Full name: projects.locations.instances.cases.caseComments.list

Lists CaseComments.

HTTP request


Path parameters

Parameters
parent

string

Required. The instance to list CaseComments for. Format: projects/{project}/locations/{location}/instances/{instance}/cases/{case}/caseComments

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of CaseComments to return. The service may return fewer than this value. If unspecified, at most 50 CaseComments 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 caseComments.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBooks must match the call that provided the page token.
filter

string

Optional. A filter to apply to the list of CaseComments. Supported filter fields: * createTime: Filter by the create time. * updateTime: Filter by the update time. * user: Filter by the user. * comment: Filter by the comment. * deletionInvoker: Filter by the deletion invoker. * favorite: Filter by the favorite. * alert: Filter by the alert. * deleted: Filter by the deleted.

Example: filter="comment='some_comment'"
orderBy

string

Optional. Configures ordering of CaseComments in the response. If not specified, CaseComments 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. Supported sort fields: * createTime * updateTime * user * comment * deletionInvoker * favorite * alert * deleted

For example: "comment desc, favorite"
expand

string

Optional. Expand the response to include the full comment object. Supported values: * caseAttachment example: "?expand=caseAttachment"

Request body

The request body must be empty.

Response body

Response message for caseComments.list.

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

JSON representation 
{
  "caseComments": [
    {
      object (CaseComment)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Fields
caseComments[]

object (CaseComment)

The list of CaseComments.
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.
totalSize

integer

The total number of CaseComments.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.