Method: projects.locations.apis.versions.operations.list

List operations in an API version.

HTTP request

GET https://apihub.googleapis.com/v1/{parent=projects/*/locations/*/apis/*/versions/*}/operations

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent which owns this collection of operations i.e., the API version. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

Query parameters

Parameters
filter

string

Optional. An expression that filters the list of ApiOperations.

A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string or a boolean. The comparison operator must be one of: <, > or =. Filters are not case sensitive.

The following fields in the ApiOperation are eligible for filtering: * name - The ApiOperation resource name. Allowed comparison operators: =. * details.http_operation.path.path - The http operation's complete path relative to server endpoint. Allowed comparison operators: =. * details.http_operation.method - The http operation method type. Allowed comparison operators: =. * details.deprecated - Indicates if the ApiOperation is deprecated. Allowed values are True / False indicating the deprycation status of the ApiOperation. Allowed comparison operators: =. * createTime - The time at which the ApiOperation was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and <.

Expressions are combined with either AND logic operator or OR logical operator but not both of them together i.e. only one of the AND or OR operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then INVALID_ARGUMENT error is returned by the API.

Here are a few examples:

  • details.deprecated = True - The ApiOperation is deprecated.
  • details.http_operation.method = GET AND createTime < \"2021-08-15T14:50:00Z\" AND createTime > \"2021-08-10T12:00:00Z\" - The method of the http operation of the ApiOperation is GET and the spec was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC.
  • details.http_operation.method = GET OR details.http_operation.method = POST. - The http operation of the method of ApiOperation is GET or POST.
pageSize

integer

Optional. The maximum number of operations to return. The service may return fewer than this value. If unspecified, at most 50 operations 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 operations.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters (except pageSize) provided to operations.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

The operations.list method's response.

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

JSON representation 
{
  "apiOperations": [
    {
      object (ApiOperation)
    }
  ],
  "nextPageToken": string
}
Fields
apiOperations[]

object (ApiOperation)

The operations corresponding to an API version. Only following field will be populated in the response: name, spec, details.deprecated, details.http_operation.path.path, details.http_operation.method and details.documentation.external_uri.
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

IAM Permissions

Requires the following IAM permission on the parent resource:

  • apihub.apiOperations.list

For more information, see the IAM documentation.