Items - Get Semantic Model Definition
Retourneert de openbare definitie van het opgegeven semantische model.
Deze API ondersteunt langlopende bewerkingen (LRO).
Wanneer u de openbare definitie van een semantisch model krijgt, maakt het vertrouwelijkheidslabel geen deel uit van de definitie.
Machtigingen
De aanroeper moet lees- en schrijfmachtigingen hebben voor het semantische model.
Vereiste gedelegeerde bereiken
SemanticModel.ReadWrite.All of Item.ReadWrite.All
Beperkingen
Als u de definitie van een semantisch modelitem wilt ophalen dat wordt beveiligd door een versleuteld vertrouwelijkheidslabel, moet de aanroeper over voldoende gebruiksrechten beschikken om het label te verwijderen, zoals geconfigureerd in Microsoft Purview.
Door Microsoft Entra ondersteunde identiteiten
Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.
| Identiteit | Ondersteuning |
|---|---|
| Gebruiker | Ja |
| serviceprincipal en beheerde identiteiten | Ja |
gebruikersinterface
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/semanticModels/{semanticModelId}/getDefinition
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/semanticModels/{semanticModelId}/getDefinition?format={format}
URI-parameters
| Naam | In | Vereist | Type | Description |
|---|---|---|---|---|
|
semantic
|
path | True |
string (uuid) |
De semantische model-id. |
|
workspace
|
path | True |
string (uuid) |
De werkruimte-ID. |
|
format
|
query |
string |
De indeling van de definitie van het semantische model. De volgende indelingen zijn toegestaan (hoofdlettergevoelig)
Als dit niet is opgegeven, is de standaardwaarde 'TMDL'. |
Antwoorden
| Naam | Type | Description |
|---|---|---|
| 200 OK |
De aanvraag is voltooid. |
|
| 202 Accepted |
Aanvraag geaccepteerd. Het ophalen van de definitie wordt uitgevoerd. Kopteksten
|
|
| 429 Too Many Requests |
De servicesnelheidslimiet is overschreden. De server retourneert een Kopteksten Retry-After: integer |
|
| Other Status Codes |
Veelvoorkomende foutcodes:
|
Voorbeelden
Get a semantic model definition example
Voorbeeldaanvraag
POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/semanticModels/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition
Voorbeeldrespons
{
"definition": {
"parts": [
{
"path": "definition/database.tmdl",
"payload": "<base64 encoded string>",
"payloadType": "InlineBase64"
},
{
"path": "definition/model.tmdl",
"payload": "<base64 encoded string>",
"payloadType": "InlineBase64"
},
{
"path": "definition/tables/Table1.tmdl",
"payload": "<base64 encoded string>",
"payloadType": "InlineBase64"
},
{
"path": "definition.pbism",
"payload": "<base64 encoded string>",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30
Definities
| Naam | Description |
|---|---|
|
Error |
Een gestructureerde parameter die extra machineleesbare context biedt over een fout. |
|
Error |
Het foutgerelateerde resourcedetailsobject. |
|
Error |
Het foutbericht. |
|
Error |
De details van het foutbericht. |
|
Payload |
Het type nettolading van het definitieonderdeel. Er kunnen in de loop van de tijd extra typen nettoladingen worden toegevoegd. |
|
Semantic |
openbare Semantische modeldefinitie object. Raadpleeg dit artikel voor meer informatie over de structuur van de Semantische modeldefinitie. |
|
Semantic |
Semantisch modeldefinitieonderdeelobject. |
|
Semantic |
Antwoord op openbare definitie van Semantisch model. |
ErrorParameter
Een gestructureerde parameter die extra machineleesbare context biedt over een fout.
| Naam | Type | Description |
|---|---|---|
| message |
string |
Een door mensen leesbare beschrijving van de betekenis van de parameter. |
| name |
string |
De parameter-id. |
| value |
string |
De waarde van de parameter. |
ErrorRelatedResource
Het foutgerelateerde resourcedetailsobject.
| Naam | Type | Description |
|---|---|---|
| resourceId |
string |
De resource-id die betrokken is bij de fout. |
| resourceType |
string |
Het type resource dat betrokken is bij de fout. |
ErrorResponse
Het foutbericht.
| Naam | Type | Description |
|---|---|---|
| errorCode |
string |
Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is. |
| isRetriable |
boolean |
Wanneer waar, kan de aanvraag opnieuw worden geprobeerd. Gebruik de |
| message |
string |
Een leesbare weergave van de fout. |
| moreDetails |
Lijst met aanvullende foutdetails. |
|
| parameters |
Gestructureerde parameters die extra machineleesbare context bieden over de fout. |
|
| relatedResource |
De foutgerelateerde resourcedetails. |
|
| requestId |
string (uuid) |
Id van de aanvraag die is gekoppeld aan de fout. |
ErrorResponseDetails
De details van het foutbericht.
| Naam | Type | Description |
|---|---|---|
| errorCode |
string |
Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is. |
| message |
string |
Een leesbare weergave van de fout. |
| parameters |
Gestructureerde parameters die extra machineleesbare context bieden over de fout. |
|
| relatedResource |
De foutgerelateerde resourcedetails. |
PayloadType
Het type nettolading van het definitieonderdeel. Er kunnen in de loop van de tijd extra typen nettoladingen worden toegevoegd.
| Waarde | Description |
|---|---|
| InlineBase64 |
Inline base 64. |
SemanticModelDefinition
openbare Semantische modeldefinitie object. Raadpleeg dit artikel voor meer informatie over de structuur van de Semantische modeldefinitie.
| Naam | Type | Description |
|---|---|---|
| format |
string |
De indeling van de definitie van het semantische model. |
| parts |
Een lijst met definitieonderdelen. |
SemanticModelDefinitionPart
Semantisch modeldefinitieonderdeelobject.
| Naam | Type | Description |
|---|---|---|
| path |
string |
Het pad naar het semantische modelonderdeel. |
| payload |
string |
De nettolading van het semantische modelonderdeel. |
| payloadType |
Het nettoladingstype. |
SemanticModelDefinitionResponse
Antwoord op openbare definitie van Semantisch model.
| Naam | Type | Description |
|---|---|---|
| definition |
openbare Semantische modeldefinitie object. Raadpleeg dit artikel voor meer informatie over de structuur van de Semantische modeldefinitie. |