Method: customFieldValues.list

Full name: projects.locations.instances.cases.customFieldValues.list

Lists CustomFieldValues.

HTTP request


Path parameters

Parameters
parent

string

Required. The parent CustomField, which owns this collection of custom field values.

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of custom field values to return. The service may return fewer than this value. If unspecified, at most 50 custom field values 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 customFieldValues.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to customFieldValues.list must match the call that provided the page token.
filter

string

Optional. A filter to apply to the list of custom field values. Supported filter fields: * customFieldId: Filter by the custom field id. * identifier: Filter by the identifier. Example: filter="customFieldId='some_id'"
orderBy

string

Optional. Configures ordering of CustomFieldValues in the response. If not specified, CustomFieldValues are returned in descending order of their create time. The default ordering is by create time in descending order. The orderBy string is a comma separated list of fields. Supported sort fields: * customFieldId * identifier example: "customFieldId desc"

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ListCustomFieldValuesResponse.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.