Item Lifecycle - Get Item Payload

Hizmet:

Workload Development

API Sürümü:

v1

Bir öğenin iş yükü yükünü almak için Microsoft Fabric tarafından çağrılır.
Öğe düzenleyicisi <iframe> bir öğe istediğinde, Doku temel doğrulamalar gerçekleştirir ve yükü iş yükünden almak için bu API'yi çağırır.

Bu API, SubjectAndApp kimlik doğrulamayı kabul eder.

İzinler

İzinler Microsoft Fabric tarafından denetleniyor.

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

URI Parametreleri

Veri Akışı Adı	İçinde	Gerekli	Tür	Description
itemId	path	True	string (uuid)	Öğe kimliği.
itemType	path	True	string	Öğe türü.
workspaceId	path	True	string (uuid)	Çalışma alanı kimliği.

İstek Başlığı

Veri Akışı Adı	Gerekli	Tür	Description
ActivityId	True	string	Kullanıcı iş yükünüzle etkileşime geçtiğinde isteği sisteminizle ilişkilendirmek için benzersiz bir kimlik.
RequestId	True	string	Fabric'in isteğinizi günlüklerimizle ilişkilendirmelerine yardımcı olan genel olarak benzersiz bir kimlik. Sorun bildirirken bu kimliği belirtin.
Authorization	True	string	İş yükünün istek kaynağını doğrulamasını, kullanıcı bağlamı sağlamasını ve diğer hizmetleri çağırmasını sağlayan çift belirteçli yetkilendirme üst bilgisi. Bu üst bilgi şu biçimdedir: SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token".
x-ms-client-tenant-id	True	string	İsteği yapan istemcinin kiracı kimliği.

Yanıtlar

Veri Akışı Adı	Tür	Description
200 OK	GetItemPayloadResponse	Başarıyla tamamlandı.
Other Status Codes	ErrorResponse	Hata koşulları için iş yükü, yanıt gövdesinde ayrıntılı hata bilgileriyle birlikte uygun bir HTTP hata durum kodu (4xx, 5xx) döndürmelidir.

Örnekler

Get item content example

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:

200

{
  "itemPayload": {
    "algorithm": "ExponentialSmoothing"
  }
}

Tanımlar

Veri Akışı Adı	Description
ErrorExtendedInformation	Genişletilmiş hata bilgileri.
ErrorResponse	Hata yanıtı.
ErrorSource	Hatanın kaynağı.
GetItemPayloadResponse	Öğe düzenleyicisi için öğe yükü.
NameValuePair	Ad-değer çifti.

ErrorExtendedInformation

Nesne

Genişletilmiş hata bilgileri.

Veri Akışı Adı	Tür	Description
additionalParameters	NameValuePair[]	Hataya özgü ek parametrelerin listesi.
errorCode	string	Hata kodu.
message	string	Hata iletisi.
messageParameters	string[]	Yerelleştirilmiş iletiyi biçimlendirmeye yönelik parametrelerin listesi.

ErrorResponse

Nesne

Hata yanıtı.

Veri Akışı Adı	Tür	Description
errorCode	string	Hata kodu.
isPermanent	boolean	Hatanın kalıcı olup olmadığını veya işlemin yeniden denenip denenemeyeceğini gösterir.
message	string	Hata iletisi.
messageParameters	string[]	Yerelleştirilmiş iletiyi biçimlendirmeye yönelik parametrelerin listesi.
moreDetails	ErrorExtendedInformation[]	Ek hata ayrıntılarının listesi.
source	ErrorSource	Hata kaynağı.

ErrorSource

Numaralandırma

Hatanın kaynağı.

Değer	Description
System
User
External

GetItemPayloadResponse

Nesne

Öğe düzenleyicisi için öğe yükü.

Veri Akışı Adı	Tür	Description
itemPayload	object	İş yüküne ve öğe türüne özgü yük.

NameValuePair

Nesne

Ad-değer çifti.

Veri Akışı Adı	Tür	Description
name	string	Adı.
value	string	Değer.