Write a transactional row

Buffers an insert-or-replace of one row in the transaction; it becomes visible to others only after commit.

POST /v1/tenants/{tenant}/tx/{tx_id}/rows/{schema}

Stage a row write for later commitShape checks happen now; constraints are checked at commit.

Prepare a valid rowUse the transaction ID and registered table.
Buffer insertion or replacementKeep the write inside the transaction.
Finish with commit or rollbackOther transactions see the change only after commit.

Before you start

Use your database bearer token.

Connection setup

Begin a transaction and replace TX_ID with its returned tx_id. Finish the transaction with commit or rollback.

Path parameters

Field	Type	Required
`tenant`	`string`	Required
`tx_id`	`string`	Required
`schema`	`string`	Required

Headers

Field	Type	Required	Description
`x-oc-db-user`	`string`	Optional	Acting database user (role, grant and row-policy checks). Send with x-oc-db-key.
`x-oc-db-key`	`string`	Optional	API key of the x-oc-db-user user.

Request body

application/json

Limits and accepted values

The row as a JSON object keyed by column name, including its primary key.
Columns are user-defined by the table.
Shape and types are validated now (400);
constraints are enforced at commit.

Field	Type	Required	Description
`Fields`	`object`	Optional	The row as a JSON object keyed by column name, including its primary key. Columns are user-defined by the table. Shape and types are validated now (400); constraints are enforced at commit.

Read the result

buffered: true means the row passed shape/type validation and was staged. Constraints are checked at commit; this response alone does not confirm a committed write.

Response statuses

HTTP status reference

Status	What to do
200	OK
400	Correct the request before retrying.
401	Check the credential and Authorization header.
402	Check feature access or available credits.
403	Check tenant access, roles and permissions.
404	Check the resource ID and API route.
409	Resolve the conflict before retrying.
413	Split or reduce the request body.
415	Send the required Content-Type.
422	Correct the values or unsupported combination.
429	Honor Retry-After when present; back off.
500	Check the outcome before retrying a write.
501	Check deployment support for this operation.
503	Honor Retry-After when present; check write outcomes.

Request example

curl --include --request POST "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/tx/%3CTX_ID%3E/rows/demo.people" \
  --header "Authorization: Bearer ${OC_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary '{
  "id": "u1",
  "follows_id": "u2",
  "score": 11
}'

Response example

Examples use synthetic values to show the response format.

Response status

{
  "tx_id": "11111111-1111-4111-8111-111111111111",
  "op": "put",
  "buffered": true,
  "_preview": true
}

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

HeadersCopy Anchor Link

Request bodyCopy Anchor Link