Get a scenario

Get a scenario in the current workspace

GET /api/v1/scenarios/{id}

Get a scenario

cURL

curl --request GET \
  --url https://dev.simforge.ai/api/v1/scenarios/{id} \
  --header 'Authorization: Bearer <token>'

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>"
    }
  ]
}

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

Response

200

application/json

Scenario.

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