Udostępnij przez

Items - Get Item Definition

Usługa:
Core
Wersja interfejsu API:
v1

Zwraca określoną definicję elementu.
Ten interfejs API jest obsługiwany w przypadku wielu typów elementów, znajdź obsługiwane typy elementów i informacje o ich strukturze definicji w temacie Omówienie definicji elementu. Po otrzymaniu definicji elementu etykieta poufności nie jest częścią definicji.

Ten interfejs API obsługuje długotrwałych operacji (LRO).

Uprawnienia

Obiekt wywołujący musi mieć uprawnienia do odczytu i zapisu dla elementu.

Wymagane zakresy delegowane

W przypadku interfejsów API elementów użyj następujących typów zakresów:

  • Zakres ogólny: Item.ReadWrite.All
  • Określony zakres: itemType. ReadWrite.All (na przykład: Notebook.ReadWrite.All)

Aby uzyskać więcej informacji na temat zakresów, zobacz artykuł Zakresy.

Ograniczenia

Ten interfejs API jest blokowany dla elementu z chronioną etykietą poufności, chyba że obiekt wywołujący ma prawa użytkowania do usunięcia etykiety poufności.

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Tożsamość Wsparcie
Użytkownik Tak
Główne usługi i Tożsamości zarządzane Gdy typ elementu w wywołaniu jest obsługiwany. Sprawdź odpowiedni interfejs API dla wywoływanego typu elementu, aby sprawdzić, czy wywołanie jest obsługiwane. Na przykład modele semantyczne są obsługiwane.

Interfejs

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
itemId
 path True

string (uuid)

Identyfikator elementu.
workspaceId
 path True

string (uuid)

Identyfikator przestrzeni roboczej.
format
 query

string

Format definicji elementu.

Odpowiedzi

Nazwa Typ Opis
200 OK

ItemDefinitionResponse

Żądanie zostało ukończone pomyślnie.
202 Accepted

Zaakceptowano żądanie. Pobieranie definicji jest w toku.

Nagłówki

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Typowe kody błędów:

  • OperationNotSupportedForItem — operacja nieobsługiwana dla żądanego elementu.

Przykłady

Get an item definition example

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
200 
{
  "definition": {
    "parts": [
      {
        "path": "report.json",
        "payload": "QmFzZTY0U3RyaW5n",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition.pbir",
        "payload": "QW5vdGhlckJhc2U2NFN0cmluZw",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
Kod stanu:
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

Definicje

Nazwa Opis
ErrorRelatedResource

Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse

Odpowiedź na błąd.
ErrorResponseDetails

Szczegóły odpowiedzi na błąd.
ItemDefinition

Obiekt definicji elementu.
ItemDefinitionPart

Obiekt części definicji elementu.
ItemDefinitionResponse

Odpowiedź definicji publicznej elementu.
PayloadType

Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa Typ Opis
resourceId

string

Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType

string

Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
moreDetails

ErrorResponseDetails[]

Lista dodatkowych szczegółów błędu.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.
requestId

string

Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.

ItemDefinition

Objekt

Obiekt definicji elementu.

Nazwa Typ Opis
format

string

Format definicji elementu.
parts

ItemDefinitionPart[]

Lista części definicji.

ItemDefinitionPart

Objekt

Obiekt części definicji elementu.

Nazwa Typ Opis
path

string

Ścieżka części elementu.
payload

string

Ładunek części elementu.
payloadType

PayloadType

Typ ładunku.

ItemDefinitionResponse

Objekt

Odpowiedź definicji publicznej elementu.

Nazwa Typ Opis
definition

ItemDefinition

Obiekt definicji elementu.

PayloadType

Wyliczanie

Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.

Wartość Opis
InlineBase64

Śródliniowa baza 64.