Authoring Administration

GET getSemanticModelShallow

GET /ssot/semantic/models/{modelApiNameOrId}/shallow

Operation ID: getSemanticModelShallow. Tags: Authoring - Administration.

This endpoint retrieves a shallow version of a semantic model, meaning it excludes any definitions that are inherited from extended models. Extended models are models that are built upon a base model by adding additional layers of data or logic. This is useful when you need a lightweight version of the model with only the essential base structure and no additional inherited definitions.

This endpoint retrieves a shallow version of a semantic model, meaning it excludes any definitions that are inherited from extended models. Extended models are models that are built upon a base model by adding additional layers of data or logic. This is useful when you need a lightweight version of the model with only the essential base structure and no additional inherited definitions.

Parameters

  • modelApiNameOrId (path, string, required)
  • allowUnmapped (query, boolean) If set to True, includes unmapped semantic definitions in the response.
  • fieldName (query, string) Returns only fields that contain the specified substring in their label.
  • fineGrainSecurity (query, boolean) If enabled, applies fine-grained security rules and returns a partial semantic model that respects access restrictions.
  • includeModelContent (query, boolean) If set, enriches the response with the model’s full content.

Responses

  • 200 A semantic model in shallow form is returned.

    Media type: application/json. Schema: SemanticModelOutputRepresentation.