Method: projects.locations.orders.comments.list

Lists the comments on an order.

HTTP request

GET https://gdchardwaremanagement.googleapis.com/v1alpha/{parent=projects/*/locations/*/orders/*}/comments

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The order to list comments on. Format: projects/{project}/locations/{location}/orders/{order}

Query parameters

Parameters
pageSize

integer

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

pageToken

string

Optional. A token identifying a page of results the server should return.

filter

string

Optional. Filtering condition. See AIP-160.

orderBy

string

Optional. Hint for how to order the results.

Request body

The request body must be empty.

Response body

A request to list comments.

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

JSON representation
{
  "comments": [
    {
      object (Comment)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Fields
comments[]

object (Comment)

The list of comments.

nextPageToken

string

A token identifying a page of results the server should return.

unreachable[]

string

Locations that could not be reached.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • gdchardwaremanagement.comments.list

For more information, see the IAM documentation.