Condividi tramite

Item Lifecycle - On Create Item

Servizio:
Workload Development
Versione API:
v1

Chiamato da Microsoft Fabric per la creazione di un nuovo elemento.
Al momento della creazione dell'elemento Fabric esegue convalide di base, crea l'elemento in uno stato di provisioning e chiama questa API per notificare il carico di lavoro. Si prevede che il carico di lavoro esegua le convalide necessarie, archivii i metadati dell'elemento, allochi le risorse necessarie e aggiorni la cache dei metadati degli elementi di Fabric con relazioni tra elementi e ETag.

Questa API deve accettare l'autenticazione SubjectAndApp.

Autorizzazioni

Le autorizzazioni vengono controllate da Microsoft Fabric.

POST https://be.myWorkload.contoso.com/workload-api-path-placeholder/workspaces/{workspaceId}/items/{itemType}/{itemId}/OnCreateItem

Parametri dell'URI

Nome In Necessario Tipo Descrizione
itemId
 path True

string (uuid)

ID elemento.
itemType
 path True

string

Tipo di elemento.
workspaceId
 path True

string (uuid)

L’ID dell’area di lavoro.

Intestazione della richiesta

Nome Necessario Tipo Descrizione
ActivityId True

string (uuid)

ID univoco per correlare la richiesta con il sistema quando un utente interagisce con il carico di lavoro.
RequestId True

string (uuid)

ID univoco globale che consente a Fabric di correlare la richiesta con i log. Specificare questo ID quando si segnala un problema.
Authorization True

string

Intestazione di autorizzazione del token doppio che consente al carico di lavoro di convalidare l'origine della richiesta, fornire il contesto utente e chiamare altri servizi. Questa intestazione ha il formato seguente: SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token".
x-ms-client-tenant-id True

string (uuid)

ID tenant del client che effettua la richiesta.

Corpo della richiesta

Nome Tipo Descrizione
definition

ItemDefinition

Rappresenta la definizione inline di un elemento.

Risposte

Nome Tipo Descrizione
200 OK

Creazione completata.
Other Status Codes

ErrorResponse

Per le condizioni di errore, il carico di lavoro deve restituire un codice di stato di errore HTTP appropriato (4xx, 5xx) con informazioni dettagliate sull'errore nel corpo della risposta.

Esempio

Create item example

Esempio di richiesta

POST https://be.myWorkload.contoso.com/workload-api-path-placeholder/workspaces/e5ef604d-e14f-4a59-9133-75d5a0cb9334/items/Contoso.FinanceAnalytics.Forecast/b14cb7e7-d346-4751-9cfd-8c2767d53111/OnCreateItem

{
  "definition": {
    "parts": [
      {
        "path": ".platform",
        "payload": "eyJuYW1lIjogIk15IERhdGEgV2FyZWhvdXNlIn0=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Risposta di esempio

Codice di stato:
200

Definizioni

Nome Descrizione
ErrorExtendedInformation

Informazioni estese sull'errore.
ErrorResponse

Risposta di errore.
ErrorSource

Indica l'origine dell'errore.
ItemDefinition

Rappresenta la definizione inline di un elemento.
ItemDefinitionPart

Rappresenta una parte di una definizione di elemento.
NameValuePair

Coppia nome-valore.
OnCreateItemRequest

Corpo della richiesta per la creazione di una definizione di elemento in un carico di lavoro remoto.

ErrorExtendedInformation

Oggetto

Informazioni estese sull'errore.

Nome Tipo Descrizione
additionalParameters

NameValuePair[]

Elenco di parametri aggiuntivi specifici dell'errore.
errorCode

string

Codice di errore.
message

string

Messaggio di errore.
messageParameters

string[]

Elenco di parametri per la formattazione di un messaggio localizzato.

ErrorResponse

Oggetto

Risposta di errore.

Nome Tipo Descrizione
errorCode

string

Codice di errore.
isPermanent

boolean

Indica se l'errore è permanente o se l'operazione può essere ritentata.
message

string

Messaggio di errore.
messageParameters

string[]

Elenco di parametri per la formattazione di un messaggio localizzato.
moreDetails

ErrorExtendedInformation[]

Elenco di dettagli aggiuntivi sull'errore.
source

ErrorSource

Indica l'origine dell'errore.

ErrorSource

Enumerazione

Indica l'origine dell'errore.

Valore Descrizione
System

Errore originato dal sistema.
User

Errore originato dall'input dell'utente.
External

Errore originato da un'origine esterna.

ItemDefinition

Oggetto

Rappresenta la definizione inline di un elemento.

Nome Tipo Descrizione
parts

ItemDefinitionPart[]

Parti della definizione.

ItemDefinitionPart

Oggetto

Rappresenta una parte di una definizione di elemento.

Nome Tipo Descrizione
path

string

Percorso della parte ,ad esempio '.platform'.
payload

string

Payload (contenuto Inline Base64).
payloadType

string

Tipo di payload ,ad esempio 'InlineBase64'.

NameValuePair

Oggetto

Coppia nome-valore.

Nome Tipo Descrizione
name

string

Nome.
value

string

Valore .

OnCreateItemRequest

Oggetto

Corpo della richiesta per la creazione di una definizione di elemento in un carico di lavoro remoto.

Nome Tipo Descrizione
definition

ItemDefinition

Rappresenta la definizione inline di un elemento.