--- schema_version: "1" id: de663900674a3b8fda7f9011555c31e371c3612cc3f12d152434339aee18d409 title: Authoring Administration collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/data-cloud/semantic-layer/references/generated-api-specs/authoring-administration-operations-2.md canonical_url: https://developer.salesforce.com/docs/data/semantic-layer/references/authoring-administration-operations-2 source_site: developer.salesforce.com content_type: documentation content_hash: aee495448041aca65b03387a27451b7df5ae7ce1a6c9c338f3e61827c0e5c130 products: - Tableau Semantics Layer APIs - Data 360 Developer Documentation --- Authoring Administration # Authoring Administration The Tableau Next Authoring API allows you to create and edit semantic models and definitions, as well as customize existing ones as needed. **Version:** v65.0 ## Servers * `/services/data/v65.0` ## Operations ### 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`. ### POST postSemanticModelClone `POST /ssot/semantic/models/{modelApiNameOrId}/clone` Operation ID: `postSemanticModelClone`. Tags: Authoring - Administration. Clone an existing semantic model Create a new semantic model by cloning an existing one. creates an exact duplicate of the model. After cloning, you can modify the new model independently of the original one. This is helpful for creating variations or experimenting with a model without affecting the original. #### Parameters * `modelApiNameOrId` (path, string, required) #### Responses * **200** A new semantic model has been successfully cloned. Media type: `application/json`. Schema: `SemanticModelOutputRepresentation`. ### GET getSemanticModelValidation `GET /ssot/semantic/models/{modelApiNameOrId}/validate` Operation ID: `getSemanticModelValidation`. Tags: Authoring - Administration. Validate a semantic model This endpoint validates a semantic model to ensure its structure and configuration are correct. It checks for errors or inconsistencies in the model's design and provides a detailed report on the validation results. This is essential for ensuring the model is properly configured before it is used in production. #### Parameters * `modelApiNameOrId` (path, string, required) #### Responses * **200** Validation completed. The response includes validation details for the semantic model. Media type: `application/json`. Schema: `SemanticModelValidationOutputRepresentation`. ### GET getSemanticModel `GET /ssot/semantic/models/{modelApiNameOrId}` Operation ID: `getSemanticModel`. Tags: Authoring - Administration. Update specific fields of a semantic model Retrieve a complete semantic model. #### Parameters * `modelApiNameOrId` (path, string, required) * `allowUnmapped` (query, boolean) Include unmapped semantic definitions in the response. * `fieldName` (query, string) Filter results to fields whose labels contain the specified text. * `fineGrainSecurity` (query, boolean) Apply fine-grained security filtering for a partial semantic model. * `includeModelContent` (query, boolean) Enrich the model with its content in the response. * `includeTableKeys` (query, boolean) Include information about key qualifiers and primary key indicators in the response. #### Responses * **200** The semantic model is returned. Media type: `application/json`. Schema: `SemanticModelOutputRepresentation`. ### PUT putSemanticModel `PUT /ssot/semantic/models/{modelApiNameOrId}` Operation ID: `putSemanticModel`. Tags: Authoring - Administration. Update specific fields of a semantic model This endpoint replaces the entire configuration of a semantic model with the new definition provided in the request body. Unlike PATCH, which only updates specific fields, PUT replaces the entire model, including all fields, relationships, and dependencies. This is useful when you want to fully redefine a model’s structure. #### Parameters * `modelApiNameOrId` (path, string, required) * `allowUnmapped` (query, boolean) Include unmapped semantic definitions in the response. #### Request body Media type: `application/json`. Schema: `SemanticModelInputRepresentation`. #### Responses * **200** Success Media type: `application/json`. Schema: `SemanticModelOutputRepresentation`. ### DELETE deleteSemanticModel `DELETE /ssot/semantic/models/{modelApiNameOrId}` Operation ID: `deleteSemanticModel`. Tags: Authoring - Administration. Update specific fields of a semantic model This endpoint deletes a semantic model. Once deleted, the model is permanently removed from the system and can no longer be accessed or used. Be sure to review the model before deletion, as this action is irreversible. #### Parameters * `modelApiNameOrId` (path, string, required) #### Responses * **200** The semantic model is deleted. ### PATCH patchSemanticModel `PATCH /ssot/semantic/models/{modelApiNameOrId}` Operation ID: `patchSemanticModel`. Tags: Authoring - Administration. Update specific fields of a semantic model This endpoint updates specific fields of a semantic model. Unlike the PUT method, this operation modifies only the fields you specify, leaving the rest of the model and its relationships intact. This is useful when you need to make small adjustments without changing the entire model structure. #### Parameters * `modelApiNameOrId` (path, string, required) * `allowUnmapped` (query, boolean) If set to True, includes unmapped semantic definitions in the response. #### Request body Media type: `application/json`. Schema: `SemanticModelInputRepresentation`. #### Responses * **200** The semantic model is updated with the specified field changes. Media type: `application/json`. Schema: `SemanticModelOutputRepresentation`. ## Schemas ### SemanticModelOutputRepresentation The output representation of a specific semantic model. Includes all fields of `SemanticAbstractModelPartialOutputRepresentation`. * `fieldsOverrides` (_array of SemanticOverrideOutputRepresentation_) The semantic overrides belonging to this model. * `hasUnmapped` (_boolean_) The semantic model contains unmapped semantic definition. * `isPartialSdm` (_boolean_) Indicates if the model is partial because of Data Gov. * `semanticCalculatedDimensions` (_array of SemanticCalculatedDimensionOutputRepresentation_) The semantic calculated dimensions belonging to this model. * `semanticCalculatedMeasurements` (_array of SemanticCalculatedMeasurementOutputRepresentation_) The semantic calculated measurements belonging to this model. * `semanticDataObjects` (_array of SemanticDataObjectOutputRepresentation_) The list of semantic data objects belonging to the semantic model. * `semanticGroupings` (_array of SemanticGroupingOutputRepresentation_) The semantic groupings belonging to this model. * `semanticLogicalViews` (_array of SemanticLogicalViewOutputRepresentation_) The semantic logical views belonging to this model. * `semanticMetrics` (_array of SemanticMetricOutputRepresentation_) The semantic metrics belonging to this model. * `semanticModelInfo` (_SemanticModelInfoOutputRepresentation_) * `semanticParameters` (_array of SemanticParameterOutputRepresentation_) The list of parameters belonging to the semantic model. * `semanticRelationships` (_array of SemanticRelationshipOutputRepresentation_) The list of relationships belonging to the semantic model. ### SemanticModelValidationOutputRepresentation The output representation of a semantic model validation response. * `isValid` (_boolean_, required) The validated semantic model. * `semanticModel` (_SemanticModelOutputRepresentation_, required) * `validation` (_SemanticResourceValidationOutputRepresentation_, required) ### SemanticModelInputRepresentation Input representation for creating semantic model Includes all fields of `SemanticModelPartialInputRepresentation`. * `baseModels` (_array of SemanticBaseModelInputRepresentation_) Base semantic models * `externalConnections` (_array of SemanticModelExternalConnectionInputRepresentation_) External connections * `fieldsOverrides` (_array of SemanticOverrideInputRepresentation_) Semantic field overrides within the model. * `semanticCalculatedDimensions` (_array of SemanticCalculatedDimensionInputRepresentation_) Semantic calculated dimensions within the model. * `semanticCalculatedMeasurements` (_array of SemanticCalculatedMeasurementInputRepresentation_) Semantic calculated measurements within the model. * `semanticDataObjects` (_array of SemanticDataObjectInputRepresentation_) Semantic data objects within the model. * `semanticGroupings` (_array of SemanticGroupingInputRepresentation_) Semantic groupings within the model. * `semanticLogicalViews` (_array of SemanticLogicalViewInputRepresentation_) Semantic logical views within the model. * `semanticMetrics` (_array of SemanticMetricInputRepresentation_) Semantic metrics within the model. * `semanticParameters` (_array of SemanticParameterInputRepresentation_) Semantic parameters within the model. * `semanticRelationships` (_array of SemanticRelationshipInputRepresentation_) Semantic relationships within the model. ### SemanticAbstractModelPartialOutputRepresentation A partial semantic abstract model. Includes all fields of `SemanticEntityOutputRepresentation`. * `agentEnabled` (_boolean_) Indicates whether agent features are enabled for this model. * `app` (_string_) App to which the Semantic Model belongs. * `baseModels` (_array of SemanticBaseModelOutputRepresentation_) List of base models, the current model is extending. * `businessPreferences` (_string_) Allow Analysts to include business-specific preferences or context. * `categories` (_array of SemanticCategoryEnum_) Product category of the Semantic Model. Valid values are Marketing, Commerce, Sales, Service, and Other. * `currency` (_SemanticModelCurrencyOutputRepresentation_) * `dataspace` (_string_) Required. Dataspace in which the Semantic Model is located. * `externalConnections` (_array of SemanticModelExternalConnectionOutputRepresentation_) List of external connections of the model. * `isLocked` (_boolean_) Is the model locked for edit/ delete. * `lastDraftModifiedDate` (_string_) Indicates last modified date of the draft version. * `lastPublishedModifiedDate` (_string_) Indicates last modified date of the published version. * `lockedActions` (_object_) A mapping of actions to their corresponding lock reasons. Each key represents an action (e.g., 'edit', 'delete', 'clone'), and the value is a list of reasons indicating why the action is restricted. Additional properties: `array of string`. * `queryUnrelatedDataObjects` (_SemanticQueryUnrelatedDataObjectsTypeEnum_) * `semanticCalculatedDimensionsUrl` (_string (url)_) The URL that references the Semantic Calculated Dimensions. * `semanticCalculatedMeasurementsUrl` (_string (url)_) The URL that references the Semantic Calculated Measurements. * `semanticDataObjectsUrl` (_string (url)_) The URL that references the Semantic Data Objects. * `semanticGroupingsUrl` (_string (url)_) The URL that references the Semantic Groupings. * `semanticParametersUrl` (_string (url)_) The URL that references the Semantic Parameters. * `semanticRelationshipsUrl` (_string (url)_) The URL that references the Semantic Relationships. * `sourceCreation` (_SemanticModelSourceCreationTypeEnum_) * `sourceCreationName` (_string_) The source identifier name * `versionState` (_SemanticModelVersionStateEnum_) ### SemanticOverrideOutputRepresentation Semantic override output representation ### SemanticCalculatedDimensionOutputRepresentation Semantic calculated dimension output representation ### SemanticCalculatedMeasurementOutputRepresentation Semantic calculated measurement output representation ### SemanticDataObjectOutputRepresentation Semantic data object output representation ### SemanticGroupingOutputRepresentation Semantic grouping output representation ### SemanticLogicalViewOutputRepresentation Semantic logical view output representation ### SemanticMetricOutputRepresentation Semantic metric output representation ### SemanticModelInfoOutputRepresentation Semantic model info output representation ### SemanticParameterOutputRepresentation Semantic parameter output representation ### SemanticRelationshipOutputRepresentation Semantic relationship output representation ### SemanticResourceValidationOutputRepresentation Semantic resource validation output representation ### SemanticModelPartialInputRepresentation Semantic model partial input representation ### SemanticBaseModelInputRepresentation Semantic base model input representation ### SemanticModelExternalConnectionInputRepresentation Semantic model external connection input representation ### SemanticOverrideInputRepresentation Semantic override input representation ### SemanticCalculatedDimensionInputRepresentation Semantic calculated dimension input representation ### SemanticCalculatedMeasurementInputRepresentation Semantic calculated measurement input representation ### SemanticDataObjectInputRepresentation Semantic data object input representation ### SemanticGroupingInputRepresentation Semantic grouping input representation ### SemanticLogicalViewInputRepresentation Semantic logical view input representation ### SemanticMetricInputRepresentation Semantic metric input representation ### SemanticParameterInputRepresentation Semantic parameter input representation ### SemanticRelationshipInputRepresentation Semantic relationship input representation ### SemanticEntityOutputRepresentation Base Semantic Entity output representation * `apiName` (_string_) The API name of the semantic entity. * `baseModelApiName` (_string_) The origin model of the semantic entity. * `cacheKey` (_string (url)_) The Canonical URL of the collection for caching purposes only. * `createdBy` (_string_) The user who created the semantic entity. * `createdDate` (_string_) The date in which the semantic entity was created. * `description` (_string_) The Description of the semantic entity. * `externalConnectionApiName` (_string_) The externalConnectionApiName property references the external connection details for external definition * `id` (_string (Id)_) The object ID of the semantic entity. * `isQueryable` (_SemanticEntityQueryableEnum_) * `label` (_string_) The display name of the semantic entity to be used in the ui. * `lastModifiedBy` (_string_) The user who last modified the semantic entity. * `lastModifiedDate` (_string_) The date in which the semantic entity was last modified. ### SemanticBaseModelOutputRepresentation Semantic base model output representation ### SemanticCategoryEnum Type: `string`. Allowed values: `Marketing`, `Commerce`, `Sales`, `Service`, `Other`. ### SemanticModelCurrencyOutputRepresentation Semantic model currency output representation ### SemanticModelExternalConnectionOutputRepresentation Semantic model external connection output representation ### SemanticQueryUnrelatedDataObjectsTypeEnum Type: `string`. Allowed values: `Allow`, `Disallow`. ### SemanticModelSourceCreationTypeEnum Type: `string`. Allowed values: `Manual`, `Import`. ### SemanticModelVersionStateEnum Type: `string`. Allowed values: `Draft`, `Published`, `PublishedWithDraft`. ### SemanticEntityQueryableEnum Type: `string`. Allowed values: `Queryable`, `NonQueryable`.