Items - Update Semantic Model Definition

Palvelu:: SemanticModel

Ohjelmointirajapinnan versio:: v1

Ohittaa määritetyn semanttisen mallin määrityksen.
Tämä ohjelmointirajapinta tukee pitkäkestoisia toimintoja.

Semanttisen mallin määrityksen päivittäminen ei vaikuta sen luottamuksellisuustunnistetta.

Oikeudet

Soittajalla on oltava semanttisen mallin luku- ja kirjoitusoikeudet .

Vaaditut delegoidut vaikutusalueet

SemanticModel.ReadWrite.All tai Item.ReadWrite.All

Microsoft Entran tukemat käyttäjätiedot

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.

Identiteetti	Tuki
Käyttäjä	Kyllä
palvelun päänimen ja Hallittujen käyttäjätietojen	Kyllä

Käyttöliittymä

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

Valinnaisilla parametreilla:

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

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Kuvaus
semanticModelId	path	True	string (uuid)	Semanttinen mallin tunnus.
workspaceId	path	True	string (uuid)	Työtilan tunnus.
updateMetadata	query		boolean	Kun asetuksena on tosi ja .platform-tiedosto annetaan osana määritystä, kohteen metatiedot päivitetään käyttämällä .platform-tiedoston metatietoja.

Pyynnön leipäteksti

Nimi	Pakollinen	Tyyppi	Kuvaus
definition	True	SemanticModelDefinition	semanttisen mallin julkinen määritys objekti. Lisätietoja semanttisen mallin määrityksen rakenteesta on tässä artikkelissa .
options		SemanticModelDefinitionOptions	Vaihtoehdot semanttisille mallille, jonka määritystä päivitetään.

Vastaukset

Nimi	Tyyppi	Kuvaus
200 OK		Pyynnön valmistuttua.
202 Accepted		Pyyntö hyväksytty. Päivitysmääritys on meneillään. Otsikot Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka `Retry-After` ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään. Otsikot Retry-After: integer
Other Status Codes	ErrorResponse	Yleiset virhekoodit: OperationNotSupportedForItem – Toimintoa ei tueta pyydetylle kohteelle. VioittunutPayload – Annetut tiedot ovat vioittuneet.

Esimerkit

Update a semantic model definition example

Mallipyyntö

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"
      }
    ]
  }
}

Mallivastaus

Tilakoodi:: 200

Tilakoodi:: 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

Määritelmät

Nimi	Kuvaus
ErrorParameter	Jäsennetty parametri, joka antaa koneluettavaa lisäkontekstia virheestä.
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
PayloadType	Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa.
SemanticModelDefinition	semanttisen mallin julkinen määritys objekti. Lisätietoja semanttisen mallin määrityksen rakenteesta on tässä artikkelissa .
SemanticModelDefinitionOptions	Asetukset, joita käytetään luotaessa semanttista mallia määrityksen tai semanttisen mallin määrityksen päivittämisen yhteydessä.
SemanticModelDefinitionPart	Semanttisen mallin määrityksen osaobjekti.
UpdateSemanticModelDefinitionRequest	Päivitä semanttisen mallin julkisen määrityksen pyynnön tiedot.

ErrorParameter

Kohde

Jäsennetty parametri, joka antaa koneluettavaa lisäkontekstia virheestä.

Nimi	Tyyppi	Kuvaus
message	string	Ihmisen luettavissa oleva kuvaus parametrin merkityksestä.
name	string	Parametritunniste.
value	string	Parametriarvo.

ErrorRelatedResource

Kohde

Virheeseen liittyvä resurssitieto-objekti.

Nimi	Tyyppi	Kuvaus
resourceId	string	Virheestä liittyvä resurssitunnus.
resourceType	string	Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi	Tyyppi	Kuvaus
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
isRetriable	boolean	Kun arvo on tosi, pyyntöä voidaan yrittää uudelleen. Määritä viive vastausotsikon `Retry-After` avulla, jos se on käytettävissä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
moreDetails	ErrorResponseDetails[]	Luettelo virheiden lisätiedoista.
parameters	ErrorParameter[]	Jäsennettyjä parametreja, jotka antavat koneluettavaa lisäkontekstia virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.
requestId	string (uuid)	Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Kohde

Virheen vastauksen tiedot.

Nimi	Tyyppi	Kuvaus
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
parameters	ErrorParameter[]	Jäsennettyjä parametreja, jotka antavat koneluettavaa lisäkontekstia virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.

PayloadType

Luettelointi

Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa.

Arvo	Kuvaus
InlineBase64	Inline Base 64.

SemanticModelDefinition

Kohde

semanttisen mallin julkinen määritys objekti. Lisätietoja semanttisen mallin määrityksen rakenteesta on tässä artikkelissa .

Nimi	Tyyppi	Kuvaus
format	string	Semanttisen mallin määrityksen muoto.
parts	SemanticModelDefinitionPart[]	Luettelo määritysosista.

SemanticModelDefinitionOptions

Kohde

Asetukset, joita käytetään luotaessa semanttista mallia määrityksen tai semanttisen mallin määrityksen päivittämisen yhteydessä.

Nimi	Tyyppi	Kuvaus
allowPurgeData	boolean	Semanttisen mallin olemassa olevien tietojen puhdistaminen, kun päivitettyä määritystä sovelletaan. Jotkin määritelmän muutokset edellyttävät olemassa olevien tietojen tyhjentämistä. tämän arvoksi määritetään True, jotta näitä muutoksia voidaan jatkaa, jolloin kaikki tiedot, joita ei voi säilyttää uudessa määrityksessä, tyhjenetään. Kun toiminto on valmis, lataa tiedot uudelleen päivittämään semanttinen malli. Oletusarvo on false.

SemanticModelDefinitionPart

Kohde

Semanttisen mallin määrityksen osaobjekti.

Nimi	Tyyppi	Kuvaus
path	string	Semanttisen mallin osapolku.
payload	string	Semanttisen mallin osakuorma.
payloadType	PayloadType	Hyötykuorman tyyppi.

UpdateSemanticModelDefinitionRequest

Kohde

Päivitä semanttisen mallin julkisen määrityksen pyynnön tiedot.

Nimi	Tyyppi	Kuvaus
definition	SemanticModelDefinition	semanttisen mallin julkinen määritys objekti. Lisätietoja semanttisen mallin määrityksen rakenteesta on tässä artikkelissa .
options	SemanticModelDefinitionOptions	Vaihtoehdot semanttisille mallille, jonka määritystä päivitetään.