Discover a map

GET /api/v1/authoring/maps/{mapVersionId}/discovery

Discover a map

cURL

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

200

{
  "mapPin": {
    "versionId": "<string>",
    "mapId": "<string>",
    "xodrSha256": "<string>",
    "closureSha256": "<string>",
    "assetCatalogVersionId": "<string>",
    "assetCatalogSha256": "<string>",
    "releaseDigest": "<string>"
  },
  "kind": "locations",
  "total": 1,
  "records": [
    {}
  ],
  "nextCursor": "<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.

Path Parameters

mapVersionId · string · required

Query Parameters

kind · enum<string> · default: lanes

Available options: locations, lanes, movements, catalogue

limit · integer · default: 20

Required range: 1 <= x <= 100

x · number | null

z · number | null

withinM · number

roadId · string

Required string length: 1 - 256

type · string

Required string length: 1 - 256

cursor · string

Required string length: 1 - 1024

Response

200

application/json

One page of semantic map discovery; no map package bytes.

mapPin · object · required

Show child attributes

kind · enum<string> · required

Available options: locations, lanes, movements, catalogue

total · integer · required

Required range: x >= 0

records · object[] · required

Show child attributes

nextCursor · string | null · required

warnings · object[] · required

Show child attributes