Pull a scenario document

One scenario of the session’s workspace as the editor stores it (simforge scenario pull). Unknown and inaccessible ids are the same 404.

GET /api/cli/scenarios/{documentId}

Pull a scenario document

cURL

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

200

{
  "content": "<unknown>",
  "mapVersionId": "<string>",
  "mapXodrSha256": "<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

documentId · string · required

Pattern: ^[A-Za-z0-9_-]{1,128}$

Response

200

application/json

The scenario.

One scenario of the session's workspace, as the editor stores it.

content · any

The scenario document as the editor stores it.

mapVersionId · string | null

mapXodrSha256 · string | null

{key} · any