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.
Add artifacts to a map. Currently only target collection artifacts may be added. If unknown artifacts or artifacts that don't satisfy the security requirements are provided, the entire request will fail. For each request, a new layer is created for each artifact, thus not idempotent. Returns the IDs of the layers created.
booleanRepresents a boolean value that restricts an endpoint to preview mode when set to true.
objectThe request body to add artifacts to a map
list<ArtifactGid>The GIDs of the artifacts to be added to the map.
stringThe globally unique identifier of an artifact.
stringThe name of the layer to be created
objectSuccess response.
list<GaiaLayerId>stringThe ID of a layer in a Gaia map.
1
2
3
4
5
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/gotham/v1/maps/ri.gaia..map.a1A2bcD3e45fg6h7ij/layers/artifacts?preview=true" \
-d '{"artifactGids":["ri.gotham-artifact.instance.service-type.a1A2bcD3e45fg6h7ij"],"label":"Example layer name."}'1
2
3
4
5
{
"dataLayerIds": [
"exampleLayerId"
]
}