Method: operations.list

  • This page details how to list operations using a GET request to a specific URL, which includes a path parameter for the operation's parent resource name.

  • The request utilizes query parameters for filtering, setting page size, and managing pagination with a page token.

  • The request body must be empty, and it returns an UNIMPLEMENTED error if this method is not supported.

  • The response body, upon a successful request, will include an array of operations matching the request's filter criteria and a next page token if available for a paginated list.

  • Authorization requires the https://www.googleapis.com/auth/cloud-platform OAuth scope to perform the operations listed.

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

HTTP request

GET https://routeoptimization.googleapis.com/v1/{name}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

The name of the operation's parent resource.

Query parameters

Parameters
filter

string

The standard list filter.

pageSize

integer

The standard list page size.

pageToken

string

The standard list page token.

Request body

The request body must be empty.

Response body

The response message for Operations.ListOperations.

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

JSON representation
{
  "operations": [
    {
      object (Operation)
    }
  ],
  "nextPageToken": string
}
Fields
operations[]

object (Operation)

A list of operations that matches the specified filter in the request.

nextPageToken

string

The standard List next-page token.

Authorization scopes

Requires the following OAuth scope:

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