Commit a batch of operations atomically, and/or register durable premises

POST/v1/commits

Header parameters

Idempotency-Keystring

Replay identity. Reuse the same key only for an identical request.

max length 255

Request body

requiredapplication/json

operationsobject[]required

min items 1

Show properties

Array of object

idstring | any

Show properties

Any of:

string

string

any

any

transactionIdstring | any

Show properties

Any of:

string

string

any

any

claimIdstring | any

Show properties

Any of:

string

string

any

any

readAtinteger | any

Show properties

Any of:

integer

integer

any

any

fenceTokennumber | any

Show properties

Any of:

number

number

any

any

actionstringrequired

Allowed:createupdatedeletearchiveunarchive

modelstringrequired

dataobject | any

Show properties

Any of:

object

object

any

any

whereobject | any

Show properties

Any of:

object

object

any

any

readsobject[] | any

Show properties

Any of:

object[]

Array of object

Any of:

object

modelstringrequired

idstringrequired

fieldsstring[]

readAtintegerrequired

min 0 · max 9007199254740991

object

groupstringrequired

matches ^[a-z][a-z0-9_]*:[\s\S]{1,}$

readAtintegerrequired

min 0 · max 9007199254740991

any

any

Responses

200Commit receipt

One of:

object

statusstringrequired

statusAtstring<date-time>required

matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

lastSyncIdnumberrequired

correlationIdstringrequired

min length 1 · max length 255

objectstringrequired

idstring

min length 1

clientTxIdstringrequired

min length 1

serverTxIdstringrequired

min length 1

createdAtstring<date-time>required

successbooleanrequired

opsintegerrequired

min 0 · max 9007199254740991

authorityobjectrequired

Show properties

organizationIdstringrequired

min length 1

projectIdstring | anyrequired

default: null

Show properties

Any of:

string

string

any

any

branchIdstring | anyrequired

default: null

Show properties

Any of:

string

string

any

any

syncGroupsstring[]required

operationsstring[]required

participantKindstringrequired

Allowed:useragentsystem

participantIdstringrequired

min length 1

deliveryPartitionobject | anyrequired

default: null

Show properties

Any of:

object

indexintegerrequired

min 0 · max 9007199254740991

countintegerrequired

min 2 · max 9007199254740991

any

any

missingIdsstring[]

operationResultsobject[]

min items 1

Show properties

Array of object

transactionIdstringrequired

min length 1

outcomestringrequired

Allowed:createdupdateddeletedarchivedunarchived

rowobjectrequired

object

statusstringrequired

statusAtstring<date-time>required

lastSyncIdintegerrequired

min 0 · max 9007199254740991

correlationIdstring

min length 1 · max length 255

objectstringrequired

idstring

min length 1

clientTxIdstringrequired

min length 1

serverTxIdstringrequired

min length 1

createdAtstring<date-time>required

successbooleanrequired

opsintegerrequired

min 0 · max 9007199254740991

authorityobjectrequired

Show properties

organizationIdstringrequired

min length 1

projectIdstring | anyrequired

default: null

Show properties

Any of:

string

string

any

any

branchIdstring | anyrequired

default: null

Show properties

Any of:

string

string

any

any

syncGroupsstring[]required

operationsstring[]required

participantKindstringrequired

Allowed:useragentsystem

participantIdstringrequired

min length 1

deliveryPartitionobject | anyrequired

default: null

Show properties

Any of:

object

indexintegerrequired

min 0 · max 9007199254740991

countintegerrequired

min 2 · max 9007199254740991

any

any

missingIdsstring[]

operationResultsobject[]

min items 1

Show properties

Array of object

transactionIdstringrequired

min length 1

outcomestringrequired

Allowed:createdupdateddeletedarchivedunarchived

rowobjectrequired

400The request did not satisfy the published contract.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

event_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

401The Bearer credential is missing, malformed, or expired.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

event_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

403The credential does not authorize this operation.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

event_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

404The addressed resource does not exist in the credential scope.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

event_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

409The request conflicts with current claim, version, or idempotency state.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

event_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

429The caller exceeded an enforced rate limit.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

event_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

500The server could not complete the request.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

event_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

503A required service is temporarily unavailable.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

event_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

defaultAn HTTP error not otherwise listed; decoded through the canonical envelope.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

event_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

Request

curl -X POST "https://api.abloatai.com/api/v1/commits" \
  -H "Content-Type: application/json" \
  -d '{
  "operations": [
    {
      "id": "string",
      "transactionId": "string",
      "claimId": "string",
      "readAt": 0,
      "fenceToken": 0,
      "action": "create",
      "model": "string",
      "data": {},
      "where": {}
    }
  ],
  "reads": [
    {
      "model": "string",
      "id": "string",
      "fields": [
        "string"
      ],
      "readAt": 0
    }
  ]
}'

const response = await fetch("https://api.abloatai.com/api/v1/commits", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "operations": [
    {
      "id": "string",
      "transactionId": "string",
      "claimId": "string",
      "readAt": 0,
      "fenceToken": 0,
      "action": "create",
      "model": "string",
      "data": {},
      "where": {}
    }
  ],
  "reads": [
    {
      "model": "string",
      "id": "string",
      "fields": [
        "string"
      ],
      "readAt": 0
    }
  ]
})
});

import requests

response = requests.post(
    "https://api.abloatai.com/api/v1/commits",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "operations": [
    {
      "id": "string",
      "transactionId": "string",
      "claimId": "string",
      "readAt": 0,
      "fenceToken": 0,
      "action": "create",
      "model": "string",
      "data": {},
      "where": {}
    }
  ],
  "reads": [
    {
      "model": "string",
      "id": "string",
      "fields": [
        "string"
      ],
      "readAt": 0
    }
  ]
},
)

Response

{
  "status": "queued",
  "statusAt": "2024-01-01T00:00:00Z",
  "lastSyncId": 0,
  "correlationId": "string",
  "object": "commit_receipt",
  "id": "string",
  "clientTxId": "string",
  "serverTxId": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "success": true,
  "ops": 0,
  "authority": {
    "organizationId": "string",
    "projectId": null,
    "branchId": null,
    "syncGroups": [
      "string"
    ],
    "operations": [
      "string"
    ],
    "participantKind": "user",
    "participantId": "string",
    "deliveryPartition": null
  },
  "missingIds": [
    "string"
  ],
  "operationResults": [
    {
      "transactionId": "string",
      "outcome": "created",
      "row": {}
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "event_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "event_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "event_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "event_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "event_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "event_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "event_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "event_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "event_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}