Skip to main content
POST
BatchGetSemanticModels

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
entityIds
string[]

Opaque ids of the entities to read. Get an id from another response, or resolve an identifier with synq.entities.resolve.v1.IdentifierResolveService first.

Required array length: 1 - 100 elements
Required string length: 1 - 1024
fieldNames
string[]

Return only the fields with these names. Empty returns every field. A group with no field left is left out. Ignored for SEMANTIC_MODEL_FORMAT_OSI, which always returns the whole model.

Maximum array length: 1000
Required string length: 1 - 1024
includeDefinitions
boolean

Return the definition of each field: its expression, aggregation and the rest. False returns the structure only, which keeps the response small for a large model. Ignored for SEMANTIC_MODEL_FORMAT_OSI, which always returns the definitions.

format
enum<string>

The form of the model in the response.

Available options:
SEMANTIC_MODEL_FORMAT_UNSPECIFIED,
SEMANTIC_MODEL_FORMAT_OSI

Response

200 - application/json

Success

semanticModels
SemanticModelEntry · object[]

One entry for each asked entity id, in request order.

SemanticModelEntry is the answer for one asked entity.