This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Loads the structure and basic metadata of a Gaia map, given a map GID. Metadata includes the map's title and layer labels.
The response contains a mapping of all layers contained in the map. The map's layer hierarchy can be recreated
by using the rootLayerIds in the response along with the subLayerIds field in the layer's metadata.
booleanRepresents a boolean value that restricts an endpoint to preview mode when set to true.
objectA successful map load response.
stringThe title of the loaded Gaia map.
list<GaiaLayerId>The root layers of the loaded Gaia map. This does not include sub-layers, i.e. layers nested within a parent layer in a Gaia map.
stringThe ID of a layer in a Gaia map.
map<GaiaLayerId, GaiaLayerMetadata>A mapping of all the layers contained in the Gaia map. Includes layers nested under the root layers.
stringThe ID of a layer in a Gaia map.
objectstringThe ID of a layer in a Gaia map.
list<GaiaLayerId>A list of layer IDs nested under this layer.
stringThe ID of a layer in a Gaia map.
string1
2
3
curl \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/gotham/v1/maps/load/ri.gotham-artifact.0-1.gaia-map.a1A2bcD3e45fg6h7ij?preview=true"1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
"title": "Example Gaia Map Title",
"rootLayerIds": [
"exampleRootLayerId"
],
"layers": {
"exampleRootLayerId": {
"id": "exampleRootLayerId",
"subLayerIds": [
"exampleNestedLayerId"
],
"label": "Root layer label"
},
"exampleNestedLayerId": {
"id": "exampleNestedLayerId",
"label": "Nested layer label"
}
}
}