Items - Get Item Definition

Service:: Core

Versione API:: v1

Restituisce la definizione dell'elemento specificata.
Questa API è supportata per diversi tipi di elemento, trovare i tipi di elemento supportati e informazioni sulla relativa struttura di definizione in Panoramica della definizione dell'elemento. Quando si ottiene la definizione di un elemento, l'etichetta di riservatezza non fa parte della definizione.

Questa API supporta operazioni con esecuzione prolungata (LRO).

Autorizzazioni

Il chiamante deve disporre delle autorizzazioni di lettura e scrittura per l'elemento.

Ambiti delegati obbligatori

Per le API degli elementi, usare questi tipi di ambito:

Ambito generico: Item.ReadWrite.All
Ambito specifico: itemType. ReadWrite.All (ad esempio: Notebook.ReadWrite.All)

Per altre informazioni sugli ambiti, vedere l'articolo Ambiti.

Limitazioni

Per recuperare la definizione di un elemento protetto da un'etichetta di riservatezza crittografata, il chiamante deve disporre di diritti di utilizzo sufficienti per rimuovere l'etichetta, come configurato in Microsoft Purview.

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità	Assistenza
Utente	Sì
Principale del servizio e Identità gestite	Quando il tipo di elemento nella chiamata è supportato. Controllare l'API corrispondente per il tipo di elemento che si sta chiamando per verificare se la chiamata è supportata. Ad esempio, i modelli semantici sono supportati.

Interfaccia

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/getDefinition

Con parametri facoltativi:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/getDefinition?format={format}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
itemId	path	True	string (uuid)	ID elemento.
workspaceId	path	True	string (uuid)	L’ID dell’area di lavoro.
format	query		string	Formato della definizione dell'elemento.

Risposte

Nome	Tipo	Descrizione
200 OK	ItemDefinitionResponse	Richiesta completata correttamente.
202 Accepted		Richiesta accettata. Il recupero della definizione è in corso. Intestazioni Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione `Retry-After` che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive. Intestazioni Retry-After: integer
Other Status Codes	ErrorResponse	Codici di errore comuni: OperationNotSupportedForItem: operazione non supportata per l'elemento richiesto.

Esempio

Get an item definition example

Esempio di richiesta

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/items/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

Risposta di esempio

Codice di stato:: 200

{
  "definition": {
    "parts": [
      {
        "path": "report.json",
        "payload": "QmFzZTY0U3RyaW5n",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition.pbir",
        "payload": "QW5vdGhlckJhc2U2NFN0cmluZw",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Codice di stato:: 202

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

Definizioni

Nome	Descrizione
ErrorParameter	Parametro strutturato che fornisce un contesto aggiuntivo leggibile dal computer relativo a un errore.
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
ItemDefinition	Oggetto definizione dell'elemento.
ItemDefinitionPart	Oggetto parte di definizione dell'elemento.
ItemDefinitionResponse	Risposta alla definizione pubblica dell'elemento.
PayloadType	Tipo del payload della parte di definizione. È possibile aggiungere altri tipi di payload nel tempo.

ErrorParameter

Oggetto

Parametro strutturato che fornisce un contesto aggiuntivo leggibile dal computer relativo a un errore.

Nome	Tipo	Descrizione
message	string	Descrizione leggibile del significato del parametro.
name	string	L'identificatore dei parametri.
value	string	Valore del parametro.

ErrorRelatedResource

Oggetto

Oggetto dettagli risorsa correlato all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Oggetto

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
isRetriable	boolean	Se true, la richiesta può essere ritentata. Usare l'intestazione della `Retry-After` risposta per determinare il ritardo, se disponibile.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
parameters	ErrorParameter[]	Parametri strutturati che forniscono un contesto aggiuntivo leggibile dal computer sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string (uuid)	ID della richiesta associata all'errore.

ErrorResponseDetails

Oggetto

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
parameters	ErrorParameter[]	Parametri strutturati che forniscono un contesto aggiuntivo leggibile dal computer sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

ItemDefinition

Oggetto

Oggetto definizione dell'elemento.

Nome	Tipo	Descrizione
format	string	Formato della definizione dell'elemento.
parts	ItemDefinitionPart[]	Elenco di parti di definizione.

ItemDefinitionPart

Oggetto

Oggetto parte di definizione dell'elemento.

Nome	Tipo	Descrizione
path	string	Percorso della parte dell'elemento.
payload	string	Payload della parte dell'elemento.
payloadType	PayloadType	Tipo di payload.

ItemDefinitionResponse

Oggetto

Risposta alla definizione pubblica dell'elemento.

Nome	Tipo	Descrizione
definition	ItemDefinition	Oggetto definizione dell'elemento.

PayloadType

Enumerazione

Tipo del payload della parte di definizione. È possibile aggiungere altri tipi di payload nel tempo.

Valore	Descrizione
InlineBase64	Inline Base 64.