Apply a transaction

POST /api/v1/drafts/{id}/transactions

Apply a transaction

cURL

curl --request POST \
  --url https://dev.simforge.ai/api/v1/drafts/{id}/transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "expectedVersion": 4503599627370495,
  "expectedDigest": "<string>",
  "operations": [
    {
      "type": "addActor",
      "id": "<string>",
      "catalogId": "<string>",
      "laneRsl": "<string>",
      "s": 1,
      "movementRsl": "<string>",
      "beforeM": 250.5,
      "x": 123,
      "z": 123,
      "y": 123,
      "headingRad": 123,
      "lateralM": 123,
      "overlapOverride": false,
      "opposing": false,
      "static": false,
      "speedKph": 80,
      "bodyColor": "<string>",
      "label": "<string>"
    }
  ],
  "label": "CLI authoring transaction"
}
'

200

{
  "document": {},
  "version": 2,
  "digest": "<string>",
  "changedPaths": [
    "<string>"
  ],
  "entityIds": [
    "<string>"
  ],
  "diagnostics": [
    {
      "code": "<string>",
      "severity": "error",
      "path": "<string>",
      "message": "<string>",
      "actorId": "<string>"
    }
  ],
  "inverseDocument": {},
  "documentId": "<string>",
  "workspaceId": "<string>",
  "datasetId": "<string>",
  "draftVersion": 4503599627370495,
  "contentDigest": "<string>",
  "operationDigest": "<string>",
  "content": {},
  "mapPin": {
    "versionId": "<string>",
    "mapId": "<string>",
    "xodrSha256": "<string>",
    "closureSha256": "<string>",
    "assetCatalogVersionId": "<string>",
    "assetCatalogSha256": "<string>",
    "releaseDigest": "<string>"
  },
  "actorPins": [
    {
      "actorId": "<string>",
      "catalogId": "<string>",
      "class": "<string>",
      "catalogueDigest": "<string>"
    }
  ],
  "recordingPins": [
    {
      "id": "<string>",
      "sha256": "<string>"
    }
  ],
  "provisional": true,
  "scene": {
    "ego": {},
    "actors": [
      {}
    ]
  },
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "subject": "<string>",
      "detail": {}
    }
  ],
  "upgradedFrom": {
    "scenarioVersion": 123,
    "contentDigest": "<string>"
  }
}

Authorizations

Authorization · string · header · required

A sfc_at_… access token from simforge login, or an sfk_… API key. An operation's security lists the scopes the credential must hold.

Path Parameters

id · string · required

Body

application/json

expectedVersion · integer · required

Required range: 0 <= x <= 9007199254740991

expectedDigest · string · required

Pattern: ^[a-f0-9]{64}$

operations · object[] · required

Required array length: 1 - 128 elements

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Option 9

Option 10

Option 11

Option 12

Option 13

Option 14

Option 15

Option 16

Option 17

Option 18

Option 19

Option 20

Option 21

Option 22

Option 23

Show child attributes

label · string · default: CLI authoring transaction

Required string length: 1 - 256

Response

200

application/json

Atomic authoring result; save returns an immutable revision.

document · object · required

version · integer · required

Required range: x >= 1

digest · string · required

Pattern: ^[0-9a-f]{64}$

changedPaths · string[] · required

entityIds · string[] · required

diagnostics · object[] · required

Show child attributes

inverseDocument · object · required

documentId · string · required

Required string length: 1 - 256

workspaceId · string · required

Required string length: 1 - 256

datasetId · string · required

Required string length: 1 - 256

draftVersion · integer · required

Required range: 0 <= x <= 9007199254740991

contentDigest · string · required

Pattern: ^[a-f0-9]{64}$

operationDigest · string · required

Pattern: ^[a-f0-9]{64}$

content · object · required

Show child attributes

mapPin · object · required

Show child attributes

actorPins · object[] · required

Show child attributes

recordingPins · object[] · required

Show child attributes

provisional · boolean · required

scene · object

Where every actor is relative to the ego: lane, metres ahead along the ego's route, lateral offset, when the ego reaches it, its events and any encounter expectation. Absent without an ego or a map.

Show child attributes

warnings · object[]

Show child attributes

upgradedFrom · object

Show child attributes