Items - Update Semantic Model Definition

Tjeneste:: SemanticModel

API-version:: v1

Tilsidesætter definitionen for den angivne semantiske model.
Denne API understøtter LRO-handlinger (Long Running Operations).

Opdatering af definitionen af den semantiske model påvirker ikke dens følsomhedsmærkat.

Tilladelser

Kalderen skal have læse- og skrivetilladelser til den semantiske model.

Påkrævede delegerede områder

SemanticModel.ReadWrite.All eller Item.ReadWrite.All

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Ja

Grænseflade

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/semanticModels/{semanticModelId}/updateDefinition

Med valgfrie parametre:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/semanticModels/{semanticModelId}/updateDefinition?updateMetadata={updateMetadata}

URI-parametre

Navn	I	Påkrævet	Type	Beskrivelse
semanticModelId	path	True	string (uuid)	Det semantiske model-id.
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.
updateMetadata	query		boolean	Når den er angivet til true, og .platform-filen er angivet som en del af definitionen, opdateres elementets metadata ved hjælp af metadataene i .platform-filen

Brødtekst for anmodning

Navn	Påkrævet	Type	Beskrivelse
definition	True	SemanticModelDefinition	offentlig definition af semantisk model objekt. Se denne artikel for at få flere oplysninger om strukturen i definitionen af semantisk model.
options		SemanticModelDefinitionOptions	Indstillinger for den semantiske model, hvis definition opdateres.

Svar

Navn	Type	Beskrivelse
200 OK		Anmodningen blev fuldført.
202 Accepted		Anmodningen blev accepteret. Opdateringsdefinitionen er i gang. Headere Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en `Retry-After` header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: OperationNotSupportedForItem – Handlingen understøttes ikke for det ønskede element. CorruptedPayload – Den angivne nyttedata er beskadiget.

Eksempler

Update a semantic model definition example

Eksempelanmodning

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/semanticModels/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "parts": [
      {
        "path": "model.bim",
        "payload": "ewogICJjb21wYXRpYmlsaXR5TGV2ZW..GVzIjogWyBdDQogIH0NCn0",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition.pbism",
        "payload": "ewogICJ2ZXJzaW9uIjogIjQuMC..HRpbmdzIjoge30KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Eksempelsvar

Statuskode:: 200

Statuskode:: 202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Definitioner

Navn	Beskrivelse
ErrorParameter	En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
PayloadType	Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.
SemanticModelDefinition	offentlig definition af semantisk model objekt. Se denne artikel for at få flere oplysninger om strukturen i definitionen af semantisk model.
SemanticModelDefinitionOptions	Indstillinger, der gælder, når du opretter en semantisk model med en definition eller opdaterer definitionen af en semantisk model.
SemanticModelDefinitionPart	Semantisk modeldefinitionsdelsobjekt.
UpdateSemanticModelDefinitionRequest	Opdater nyttedata for offentlige definitionsanmodninger for semantisk model.

ErrorParameter

Objekt

En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.

Navn	Type	Beskrivelse
message	string	En læsevenlig beskrivelse af parameterens betydning.
name	string	Parameter-id'et.
value	string	Parameterens værdi.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Navn	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Navn	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
isRetriable	boolean	Når sand, kan anmodningen prøves igen. Brug svarheaderen `Retry-After` til at bestemme forsinkelsen, hvis den er tilgængelig.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
parameters	ErrorParameter[]	Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Navn	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
parameters	ErrorParameter[]	Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

PayloadType

Optælling

Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.

Værdi	Beskrivelse
InlineBase64	Indbygget grundlinje 64.

SemanticModelDefinition

Objekt

offentlig definition af semantisk model objekt. Se denne artikel for at få flere oplysninger om strukturen i definitionen af semantisk model.

Navn	Type	Beskrivelse
format	string	Formatet af definitionen af den semantiske model.
parts	SemanticModelDefinitionPart[]	En liste over definitionsdele.

SemanticModelDefinitionOptions

Objekt

Indstillinger, der gælder, når du opretter en semantisk model med en definition eller opdaterer definitionen af en semantisk model.

Navn	Type	Beskrivelse
allowPurgeData	boolean	Om det er tilladt at fjerne den semantiske models eksisterende data, når den opdaterede definition anvendes. Nogle definitionsændringer kræver, at eksisterende data ryddes. Angiv dette til true for at tillade, at disse ændringer fortsætter, i hvilket tilfælde alle data, der ikke kan bevares under den nye definition, fjernes. Når handlingen er fuldført, skal du opdatere den semantiske model for at genindlæse dataene. Standardværdien er false.

SemanticModelDefinitionPart

Objekt

Semantisk modeldefinitionsdelsobjekt.

Navn	Type	Beskrivelse
path	string	Stien til den semantiske modeldel.
payload	string	Den semantiske modeldels nyttedata.
payloadType	PayloadType	Nyttedatatypen.

UpdateSemanticModelDefinitionRequest

Objekt

Opdater nyttedata for offentlige definitionsanmodninger for semantisk model.

Navn	Type	Beskrivelse
definition	SemanticModelDefinition	offentlig definition af semantisk model objekt. Se denne artikel for at få flere oplysninger om strukturen i definitionen af semantisk model.
options	SemanticModelDefinitionOptions	Indstillinger for den semantiske model, hvis definition opdateres.