v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1338139174.7 KB
projects

Gets the metadata and configuration for a Field.

get/v1/{+name}

Path parameters

namestring required

Required. A name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

Query parameters

mask.fieldPathsstring[]

The list of field paths in the mask. See Document.fields for a field path syntax reference.

readTimestring

Reads the version of the document at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

requestOptions.requestTagsstring[]

Optional. The request tags for the request.

transactionstring

Reads the document in a transaction.

Response

Successful response