Freeze a revision

POST /api/v1/drafts/{id}/freeze-revision

Freeze a revision

cURL

curl --request POST \
  --url https://dev.simforge.ai/api/v1/drafts/{id}/freeze-revision \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "expectedVersion": 4503599627370495,
  "expectedDigest": "<string>",
  "name": "<string>"
}
'

200

{
  "documentId": "<string>",
  "workspaceId": "<string>",
  "datasetId": "<string>",
  "draftVersion": 1,
  "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,
  "revisionId": "<string>",
  "revisionContentDigest": "<string>",
  "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}$

name · string

Required string length: 1 - 256

Response

200

application/json

Atomic authoring result; save returns an immutable revision.

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: x >= 0

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

revisionId · string · required

Required string length: 1 - 256

revisionContentDigest · string · required

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

warnings · object[]

Show child attributes

upgradedFrom · object

Show child attributes

{key} · any