EnumerateExtendedApisRequest
Stay organized with collections
Save and categorize content based on your preferences.
The [EnumerateExtendedApis][InsightsService.EnumerateExtendedApis] method's request.
| JSON representation |
{
"parent": string,
"filter": string,
"pageSize": integer,
"pageToken": string
} |
| Fields |
parent |
string
Required. The parent resource name. Format: projects/{project}/locations/{location}.
|
filter |
string
Optional. The filter expression. The following fields in the Api are eligible for filtering:
api.display_name - The display name of the Api. Allowed comparison operators: =.
api.owner.email - The email of the team which owns the Api. Allowed comparison operators: =.
api.create_time - The time at which the Api was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and <.
api.target_user.enum_values.values.id - The allowed value id of the target users attribute associated with the Api. Allowed comparison operator is :.
api.target_user.enum_values.values.display_name - The allowed value display name of the target users attribute associated with the Api. Allowed comparison operator is :.
api.team.enum_values.values.id - The allowed value id of the team attribute associated with the Api. Allowed comparison operator is :.
api.team.enum_values.values.display_name - The allowed value display name of the team attribute associated with the Api. Allowed comparison operator is :.
api.business_unit.enum_values.values.id - The allowed value id of the business unit attribute associated with the Api. Allowed comparison operator is :.
api.business_unit.enum_values.values.display_name - The allowed value display name of the business unit attribute associated with the Api. Allowed comparison operator is :.
api.maturity_level.enum_values.values.id - The allowed value id of the maturity level attribute associated with the Api. Allowed comparison operator is :.
api.maturity_level.enum_values.values.display_name - The allowed value display name of the maturity level attribute associated with the Api. Allowed comparison operator is :.
api.api_style.enum_values.values.id - The allowed value id of the api style attribute associated with the Api. Allowed comparison operator is :.
api.api_style.enum_values.values.display_name - The allowed value display name of the api style attribute associated with the Api. Allowed comparison operator is :.
- specCount - The number of specs associated with the API. Allowed comparison operator is
=.
- lintErrorCount - The number of lint errors associated with the API. Allowed comparison operator is
=.
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. A filter function isNull is also supported which can check whether a field is null or not. Here are a few examples:
owner.email = \"apihub@google.com\" - - The owner team email is _apihub@google.com_.
owner.email = \"apihub@google.com\" AND createTime <
\"2021-08-15T14:50:00Z\" AND createTime > \"2021-08-10T12:00:00Z\" - The owner team email is _apihub@google.com_ and the api was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC.
owner.email = \"apihub@google.com\" OR team.enum_values.values.id:
apihub-team-id - The filter string specifies the APIs where the owner team email is _apihub@google.com_ or the id of the allowed value associated with the team attribute is apihub-team-id.
owner.email = \"apihub@google.com\" OR
team.enum_values.values.display_name: ApiHub Team - The filter string specifies the APIs where the owner team email is _apihub@google.com_ or the display name of the allowed value associated with the team attribute is ApiHub Team.
isNull(\"team\") = \"true\" - The filter string specifies the APIs where the team attribute is null.
|
pageSize |
integer
Optional. The maximum number of results to return. Default to 100.
|
pageToken |
string
Optional. A page token, received from a previous EnumerateExtendedApis call. Provide this to retrieve the subsequent page.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-28 UTC.
[null,null,["Last updated 2025-07-28 UTC."],[],[]]