younifyd
Menu

Firestore.projects.databases.documents.begin Transaction

Starts a new transaction.

POST/v1/{database}/documents:beginTransaction

Use it in a workflow

  1. Add a step and choose the Firestore connector.
  2. Pick the Firestore.projects.databases.documents.begin Transaction action (under projects).
  3. Fill in the fields below, then reference the result from later steps as {{firestoreProjectsDatabasesDocumentsBeginTransaction.response.data}}.

Request

Path parameters

databasestringrequired

Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`.

Query parameters

$.xgafvstring

V1 error format.

One of12

access_tokenstring

OAuth access token.

altstring

Data format for response.

One ofjsonmediaproto

callbackstring

JSONP

fieldsstring

Selector specifying which fields to include in a partial response.

keystring

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_tokenstring

OAuth 2.0 token for the current user.

prettyPrintboolean

Returns response with indentations and line breaks.

quotaUserstring

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_protocolstring

Upload protocol for media (e.g. "raw", "multipart").

uploadTypestring

Legacy upload protocol for media (e.g. "media", "multipart").

Request body

Enter the body as JSON in the step's Body field.

optionsobject

Options for creating a new transaction.

readOnlyobject1 fields

Options for a transaction that can only be used to read documents.

readWriteobject1 fields

Options for a transaction that can be used to read and write documents.

json
{
  "options": {
    "readOnly": {
      "readTime": "string"
    },
    "readWrite": {
      "retryTransaction": "string"
    }
  }
}

Response

Returns 200 with an object. Read it in later steps with {{firestoreProjectsDatabasesDocumentsBeginTransaction.response.data.<field>}}.

transactionstring (byte)

The transaction that was started.

json
{
  "transaction": "string"
}

Need more? See the Firestore guide for connection setup and behaviour shared by every action.