Get a map

Get a map visible in the current workspace (its id, name or name@vN), with its packs and their sizes. Without a credential: a map of the public catalogue

GET /api/v1/maps/{id}

Get a map

cURL

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

200

{
  "id": "<string>",
  "name": "<string>",
  "version": "<string>",
  "displayName": "<string>",
  "public": true,
  "capabilities": {
    "render2d": true,
    "render3d": true
  },
  "packs": [
    {
      "variant": "3d",
      "version": "<string>",
      "downloadBytes": 1,
      "installedBytes": 1
    }
  ]
}

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

Map.

id · string · required

Minimum string length: 1

name · string · required

version · string | null · required

displayName · string · required

public · boolean · required

capabilities · object · required

Show child attributes

packs · object[] · required

Show child attributes