Search documentation
karat

+

K

User Documentation ↗

Rendering Foundry Objects

PUT/api/gotham/v1/maprendering/render
Warning

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.

Stateless api to fetch a snapshot of renderables for a given object set. Only includes initial renderable values in snapshot, does not reflect changes made while rendering.

Query parameters

preview
boolean
optional

Represents a boolean value that restricts an endpoint to preview mode when set to true.

Request body

RenderObjectsRequest
object

Request to render Foundry objects. A request is considered as a single session, thus the invocations included should have unique invocation IDs.

Hide child attributes

Hide child attributes

capabilities
object

The render capability of the client. Renderables will be returned in the best possible format that's supported by the client.

Show child attributes

Show child attributes

invocations
list<Invocation>
optional
Show child attributes

Show child attributes

Response body

RenderObjectsResponse
object

A successful load layers response.

Hide child attributes

Hide child attributes

renderables
list<Renderable>
optional
Show child attributes

Show child attributes

sourcings
list<Sourcing>
optional
Show child attributes

Show child attributes

Examples

Request

Copied!
1 2 3 4 5 curl -X PUT \ -H "Content-type: application/json" \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/gotham/v1/maprendering/render?preview=true" \ -d '{"capabilities":{"supportedRenderableContent":["GEOMETRY"]},"invocations":[{"id":"InvocationOne","sourcingOnly":false,"objects":{"type":"objectSet","objectSetRid":"ri.object-set.main.object-set.5958b23c-88f7-4f0e-a844-c3027f93705d"},"renderer":{"type":"standard"}},{"id":"InvocationTwo","objects":{"type":"objectSet","objectSetRid":"ri.object-set.main.object-set.6bdee6b7-c501-47bc-8e34-dba162dfa505"},"renderer":{"type":"standard"}}]}'

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 { "renderables": [ { "id": "6BwZj7AL19-cQDMlpgQy2SPudRbTCjKQ2IHxKIQK8V8", "invocation": "InvocationOne", "sourcing": "vXYotEA3rVgfK2otPbQsDD4RM_WudkatTqOoiJuLqJM", "content": { "": { "type": "geometry", "geometry": { "type": "Point", "coordinates": [ -78.63919, 35.78043 ] }, "style": { "symbolStyle": { "symbol": { "type": "generic", "id": "ePkllYLiI7HHUFwC7Gyk5haAZvwB3ioZ3w" }, "size": 8, "opacity": 255 } } } } } ], "sourcings": [ { "id": "vXYotEA3rVgfK2otPbQsDD4RM_WudkatTqOoiJuLqJM", "content": { "type": "object", "objectType": "ri.ontology.main.object-type.dd1d04a7-10ee-429c-b0a6-69b3302633af", "primaryKey": { "ri.ontology.main.property.774274be-7074-4e61-b9ac-88a5d268b4f3": "3d0b48c8-3748-4f52-b6da-5d049a31be15" } } } ] }