Method: projects.locations.attributes.list

List all attributes.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent resource for Attribute. Format: projects/{project}/locations/{location}

Query parameters

Parameters
filter

string

Optional. An expression that filters the list of Attributes.

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 Attribute are eligible for filtering:

  • displayName - The display name of the Attribute. Allowed comparison operators: =.
  • definitionType - The definition type of the attribute. Allowed comparison operators: =.
  • scope - The scope of the attribute. Allowed comparison operators: =.
  • dataType - The type of the data of the attribute. Allowed comparison operators: =.
  • mandatory - Denotes whether the attribute is mandatory or not. Allowed comparison operators: =.
  • createTime - The time at which the Attribute 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:

  • displayName = production - - The display name of the attribute is production.
  • (displayName = production) AND (createTime < \"2021-08-15T14:50:00Z\") AND (createTime > \"2021-08-10T12:00:00Z\") - The display name of the attribute is production and the attribute was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC.
  • displayName = production OR scope = api - The attribute where the display name is production or the scope is api.
pageSize

integer

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

When paginating, all other parameters provided to attributes.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

The attributes.list method's response.

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

JSON representation 
{
  "attributes": [
    {
      object (Attribute)
    }
  ],
  "nextPageToken": string
}
Fields
attributes[]

object (Attribute)

The list of all attributes.
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.attributes.list

For more information, see the IAM documentation.