The Open API specification for Synapse is now available for download!

Download Open API Spec

GET /entity/{id}/json

Get the raw JSON for the given entity. The resulting JSON can be used for the validation of a entity against a JsonSchema.

Note: The caller must be granted the ACCESS_TYPE.READ permission on the Entity.

The includeDerivedAnnotations parameters allows to include in the response annotations that are derived from a bound schema, the derived annotations are not persistent and the client must make sure to exclude the derived annotation keys when updating the entity JSON.

Resource URL

https://repo-prod.prod.sagebase.org/repo/v1/entity/{id}/json

Resource URL Variables
{id}
Parameters
includeDerivedAnnotations

optional

true if annotations that are derived from a bound schema should be included in the response, false otherwise (default false)
Resource Information
Authentication Required
Required OAuth Scopes view
HTTP Method GET
Request Object None
Response Object None