Items - Get Item Definition
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
Aby pobrać definicję elementu chronionego przez zaszyfrowaną etykietę poufności, obiekt wywołujący musi mieć wystarczające prawa użytkowania, aby usunąć etykietę zgodnie z konfiguracją w Microsoft Purview.
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
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/getDefinition?format={format}
Parametry identyfikatora URI
| Nazwisko | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
item
|
path | True |
string (uuid) |
Identyfikator elementu. |
|
workspace
|
path | True |
string (uuid) |
Identyfikator przestrzeni roboczej. |
|
format
|
query |
string |
Format definicji elementu. |
Odpowiedzi
| Nazwisko | Typ | Opis |
|---|---|---|
| 200 OK |
Żądanie zostało ukończone pomyślnie. |
|
| 202 Accepted |
Zaakceptowano żądanie. Pobieranie definicji jest w toku. Nagłówki
|
|
| 429 Too Many Requests |
Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący Nagłówki Retry-After: integer |
|
| Other Status Codes |
Typowe kody błędów:
|
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ź
{
"definition": {
"parts": [
{
"path": "report.json",
"payload": "QmFzZTY0U3RyaW5n",
"payloadType": "InlineBase64"
},
{
"path": "definition.pbir",
"payload": "QW5vdGhlckJhc2U2NFN0cmluZw",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
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
| Nazwisko | Opis |
|---|---|
|
Error |
Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie. |
|
Error |
Obiekt szczegółów zasobu powiązanego z błędem. |
|
Error |
Odpowiedź na błąd. |
|
Error |
Szczegóły odpowiedzi na błąd. |
|
Item |
Obiekt definicji elementu. |
|
Item |
Obiekt części definicji elementu. |
|
Item |
Odpowiedź definicji publicznej elementu. |
|
Payload |
Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie. |
ErrorParameter
Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.
| Nazwisko | Typ | Opis |
|---|---|---|
| message |
string |
Czytelny dla człowieka opis znaczenia parametru. |
| name |
string |
Identyfikator parametru. |
| value |
string |
Wartość parametru. |
ErrorRelatedResource
Obiekt szczegółów zasobu powiązanego z błędem.
| Nazwisko | 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
Odpowiedź na błąd.
| Nazwisko | 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. |
| isRetriable |
boolean |
Jeśli to prawda, żądanie można ponowić. Użyj nagłówka |
| message |
string |
Czytelna reprezentacja błędu przez człowieka. |
| moreDetails |
Lista dodatkowych szczegółów błędu. |
|
| parameters |
Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie. |
|
| relatedResource |
Szczegóły zasobu powiązanego z błędem. |
|
| requestId |
string (uuid) |
Identyfikator żądania skojarzonego z błędem. |
ErrorResponseDetails
Szczegóły odpowiedzi na błąd.
| Nazwisko | 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. |
| parameters |
Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie. |
|
| relatedResource |
Szczegóły zasobu powiązanego z błędem. |
ItemDefinition
Obiekt definicji elementu.
| Nazwisko | Typ | Opis |
|---|---|---|
| format |
string |
Format definicji elementu. |
| parts |
Lista części definicji. |
ItemDefinitionPart
Obiekt części definicji elementu.
| Nazwisko | Typ | Opis |
|---|---|---|
| path |
string |
Ścieżka części elementu. |
| payload |
string |
Ładunek części elementu. |
| payloadType |
Typ ładunku. |
ItemDefinitionResponse
Odpowiedź definicji publicznej elementu.
| Nazwisko | Typ | Opis |
|---|---|---|
| definition |
Obiekt definicji elementu. |
PayloadType
Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.
| Wartość | Opis |
|---|---|
| InlineBase64 |
Śródliniowa baza 64. |