firestore.projects.databases.collection Groups.fields.list
GET {{baseUrl}}/v1/:parent/fields?filter=<string>&pageSize=<integer>&pageToken=<string>&$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>"aUser=<string>&upload_protocol=<string>&uploadType=<string>
Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to indexConfig.usesAncestorConfig:false.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
filter | string | The filter to apply to list results. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to indexConfig.usesAncestorConfig:false. | |
pageSize | string | The number of results to return. | |
pageToken | string | A page token, returned from a previous call to FirestoreAdmin.ListFields, that may be used to get the next page of results. | |
$.xgafv | string | V1 error format. | |
access_token | string | OAuth access token. | |
alt | string | Data format for response. | |
callback | string | JSONP | |
fields | string | Selector specifying which fields to include in a partial response. | |
key | string | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | |
oauth_token | string | OAuth 2.0 token for the current user. | |
prettyPrint | string | Returns response with indentations and line breaks. | |
quotaUser | string | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. | |
upload_protocol | string | Upload protocol for media (e.g. "raw", "multipart"). | |
uploadType | string | Legacy upload protocol for media (e.g. "media", "multipart"). |
RESPONSES
status: OK
{"fields":[{"indexConfig":{"ancestorField":"pariatur","indexes":[{"fields":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"name":"velit Ut","queryScope":"COLLECTION","state":"NEEDS_REPAIR"},{"fields":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"name":"adipisicing aliqua commodo","queryScope":"QUERY_SCOPE_UNSPECIFIED","state":"READY"}],"reverting":true,"usesAncestorConfig":false},"name":"amet occaecat ipsum"},{"indexConfig":{"ancestorField":"irure ut sed","indexes":[{"fields":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"name":"ullamco","queryScope":"COLLECTION","state":"CREATING"},{"fields":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"name":"velit ad qui esse","queryScope":"COLLECTION_GROUP","state":"READY"}],"reverting":true,"usesAncestorConfig":true},"name":"dolor vel"}],"nextPageToken":"sit est voluptate commodo"}