Copy a scenario

Copy a scenario: an independent copy of its current draft (map pin, actors, timeline, settings and render rig) as a fresh draft whose lineage names the original; renders, runs and transfers are not copied. It lands in datasetId, else the original’s dataset when the caller may write there, else the caller’s default dataset (a read-only dataset is never written), named <name> (copy) ((copy 2), … when taken) unless name is given. An Idempotency-Key header makes it one copy per key: a repeat answers the same copy with 200, and a key already used for another scenario’s copy is 409 idempotency_conflict. A map version that is no longer its map’s latest is 409 conflict (detail.code: scenario_map_version_not_latest).

POST /api/v1/scenarios/{id}/copy

Copy a scenario

cURL

curl --request POST \
  --url https://dev.simforge.ai/api/v1/scenarios/{id}/copy \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "datasetId": "<string>",
  "name": "<string>"
}
'

200

{
  "id": "<string>",
  "name": "<string>",
  "mapId": "<string>",
  "mapVersionId": "<string>",
  "latestRevisionId": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "tags": [
    "<string>"
  ],
  "datasetIds": [
    "<string>"
  ],
  "revisions": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "contentSha256": "<string>",
      "mapVersionId": "<string>",
      "mapClosureSha256": "<string>"
    }
  ],
  "copiedFrom": {
    "id": "<string>",
    "name": "<string>"
  },
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "subject": "<string>",
      "detail": {}
    }
  ]
}

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.

Headers

Idempotency-Key · string

Required string length: 1 - 200

Path Parameters

id · string · required

Body

application/json

datasetId · string

Minimum string length: 1

name · string

Required string length: 1 - 200

Response

200

application/json

The copy an earlier request with this Idempotency-Key made.

id · string · required

Minimum string length: 1

name · string · required

mapId · string | null · required

mapVersionId · string | null · required

latestRevisionId · string | null · required

updatedAt · string<date-time> · required

createdBy · string | null · required

tags · string[] · required

datasetIds · string[] · required

revisions · object[] · required

Show child attributes

copiedFrom · object · required

Show child attributes

warnings · object[]

Show child attributes