Item Lifecycle - Create Item

Usługa:

Workload Development

Wersja interfejsu API:

v1

Wywoływana przez usługę Microsoft Fabric do tworzenia nowego elementu.
Po utworzeniu elementu sieć szkieletowa przeprowadza podstawowe walidacje, tworzy element w stanie aprowizacji i wywołuje ten interfejs API w celu powiadomienia obciążenia. Oczekuje się, że obciążenie będzie wykonywać wymagane walidacje, przechowywać metadane elementu, przydzielać wymagane zasoby i aktualizować pamięć podręczną metadanych elementu sieci szkieletowej za pomocą relacji elementów i elementu ETag.

Ten interfejs API powinien zaakceptować uwierzytelnianie SubjectAndApp.

Uprawnienia

Uprawnienia są sprawdzane przez usługę Microsoft Fabric.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
itemId	path	True	string uuid	Identyfikator elementu.
itemType	path	True	string	Typ elementu.
workspaceId	path	True	string uuid	Identyfikator obszaru roboczego.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
ActivityId	True	string	Unikatowy identyfikator korelowania żądania z systemem, gdy użytkownik wchodzi w interakcję z obciążeniem.
RequestId	True	string	Globalnie unikatowy identyfikator, który ułatwia usłudze Fabric skorelowanie żądania z naszymi dziennikami. Podaj ten identyfikator podczas zgłaszania problemu.
Authorization	True	string	Nagłówek autoryzacji podwójnego tokenu, który umożliwia obciążeniu weryfikowanie źródła żądania, podawanie kontekstu użytkownika i wywoływanie innych usług. Ten nagłówek ma następujący format: SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token".
x-ms-client-tenant-id	True	string	Identyfikator dzierżawy klienta wysyłającego żądanie.

Treść żądania

Nazwa	Wymagane	Typ	Opis
displayName	True	string	Nazwa wyświetlana elementu. Nie można przekroczyć 256 znaków.
creationPayload		object	Ładunek tworzenia specyficzny dla obciążenia i typu elementu. Przekazane przez edytor elementów lub jako parametr interfejsu API automatyzacji sieci szkieletowej.
description		string	Opis elementu.

Odpowiedzi

Nazwa	Typ	Opis
200 OK		Pomyślnie utworzono.
Other Status Codes	ErrorResponse	W przypadku warunków błędów obciążenie powinno zwrócić odpowiedni kod stanu błędu HTTP (4xx, 5xx) ze szczegółowymi informacjami o błędzie w treści odpowiedzi.

Przykłady

Create item example

Przykładowe żądanie

HTTP

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

{
  "displayName": "Forecast 1",
  "description": "The 1st forecast item",
  "creationPayload": {
    "algorithm": "ExponentialSmoothing"
  }
}

Przykładowa odpowiedź

Kod stanu:

200

Definicje

Nazwa	Opis
CreateItemRequest	Utwórz zawartość żądania elementu.
ErrorExtendedInformation	Rozszerzone informacje o błędzie.
ErrorResponse	Odpowiedź na błąd.
ErrorSource	Źródło błędu.
NameValuePair	Para name-value.

CreateItemRequest

Objekt

Utwórz zawartość żądania elementu.

Nazwa	Typ	Opis
creationPayload	object	Ładunek tworzenia specyficzny dla obciążenia i typu elementu. Przekazane przez edytor elementów lub jako parametr interfejsu API automatyzacji sieci szkieletowej.
description	string	Opis elementu.
displayName	string	Nazwa wyświetlana elementu. Nie można przekroczyć 256 znaków.

ErrorExtendedInformation

Objekt

Rozszerzone informacje o błędzie.

Nazwa	Typ	Opis
additionalParameters	NameValuePair[]	Lista dodatkowych parametrów specyficznych dla błędu.
errorCode	string	Kod błędu.
message	string	Komunikat o błędzie.
messageParameters	string[]	Lista parametrów formatowania zlokalizowanego komunikatu.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa	Typ	Opis
errorCode	string	Kod błędu.
isPermanent	boolean	Wskazuje, czy błąd jest trwały, czy można ponowić operację.
message	string	Komunikat o błędzie.
messageParameters	string[]	Lista parametrów formatowania zlokalizowanego komunikatu.
moreDetails	ErrorExtendedInformation[]	Lista dodatkowych szczegółów błędu.
source	ErrorSource	Źródło błędu.

ErrorSource

Wyliczanie

Źródło błędu.

Wartość	Opis
External
System
User

NameValuePair

Objekt

Para name-value.

Nazwa	Typ	Opis
name	string	Nazwa.
value	string	Wartość.