Method: operations.list

  • This document describes how to list operations using a GET request to a specific URL, following gRPC Transcoding syntax.

  • The request URL requires a name path parameter, specifying the parent resource of the operations to be listed.

  • The request supports filter, pageSize, and pageToken as query parameters for refining the list.

  • The request body must be empty, and the response body will contain a JSON object with an array of operations that match the specified filter, alongside a potential nextPageToken.

  • Authorization for this operation requires the https://www.googleapis.com/auth/cloud-platform OAuth scope.

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