Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Render Invocation Object

PUT/api/v2/mapRendering/invocationObject/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.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:map-read.

Query parameters

preview
boolean
optional

Enables the use of preview functionality.

Request body

RenderInvocationObjectRequest
object
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
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 \ \t-H "Content-type: application/json" \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/mapRendering/invocationObject/render?preview=true" \ -d '{"capabilities":{"supportedRenderableContent":["GEOMETRY"]},"invocations":[{"id":"InvocationOne","sourcingOnly":false,"objects":{"type":"objectSet","objectSetRid":"ri.object-set.main.versioned-object-set.51060b6a-42de-4a2c-8a03-cc5e80a1b610"},"renderer":{"type":"standard","get":{}}}]}'

Error responses

Error Name
RenderInvocationObjectPermissionDeniedError CodePERMISSION_DENIED
Status Code403
DescriptionCould not render the InvocationObject.
Parameters