Items - Get User Data Function Definition

Služba:: UserDataFunction

Verze rozhraní API:: v1

Vrátí zadanou veřejnou definici UserDataFunction.
Toto rozhraní API podporuje dlouhotrvajících operací (LRO).

Když získáte veřejnou definici UserDataFunction, popisek citlivosti není součástí definice.

Povolení

Volající musí mít oprávnění ke čtení a zápisu pro UserDataFunction.

Požadované delegovaná rozsahy

Item.ReadWrite.All

Microsoft Entra podporované identity

Toto rozhraní API podporuje identity Microsoft uvedené v této části.

Identita	Support
Uživatel	Ano
Hlavní služba a Spravované identity	Ne

Rozhraní

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/userDataFunctions/{userDataFunctionId}/getDefinition

S volitelnými parametry:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/userDataFunctions/{userDataFunctionId}/getDefinition?format={format}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
userDataFunctionId	path	True	string (uuid)	ID UserDataFunction.
workspaceId	path	True	string (uuid)	Identifikátor pracovního prostoru.
format	query		string	Formát veřejné definice UserDataFunction.

Odpovědi

Name	Typ	Description
200 OK	UserDataFunctionDefinitionResponse	Žádost byla úspěšně dokončena.
202 Accepted		Žádost byla přijata. Probíhá načítání definice. Hlavičky Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Byl překročen limit přenosové rychlosti služby. Server vrátí hlavičku označující `Retry-After` , jak dlouho musí klient čekat před odesláním dalších požadavků. Hlavičky Retry-After: integer
Other Status Codes	ErrorResponse	Běžné kódy chyb: OperationNotSupportedForItem – Operace není podporována pro požadovanou položku.

Příklady

Get a UserDataFunction public definition example

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 200

{
  "definition": {
    "parts": [
      {
        "path": "UserDataFunctionV1.json",
        "payload": "ew0KICAiZXhlY3V0YW..OWRmNDhhY2ZmZTgifQ",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Stavový kód:: 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

Definice

Name	Description
ErrorRelatedResource	Chyba související s objektem podrobností o prostředku.
ErrorResponse	Odpověď na chybu.
ErrorResponseDetails	Podrobnosti o odpovědi na chybu.
PayloadType	Typ datové části definice. V průběhu času je možné přidat další typy datových částí.
UserDataFunctionDefinitionResponse	Odpověď veřejné definice UserDataFunction
UserDataFunctionPublicDefinition	UserDataFunction veřejný definiční objekt. Další podrobnosti o struktuře definice UserDataFunction najdete v tomto článku .
UserDataFunctionPublicDefinitionPart	UserDataFunction definition part object.

ErrorRelatedResource

Objekt

Chyba související s objektem podrobností o prostředku.

Name	Typ	Description
resourceId	string	ID prostředku, které je součástí chyby.
resourceType	string	Typ prostředku, který je součástí chyby.

ErrorResponse

Objekt

Odpověď na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
isRetriable	boolean	Pokud je hodnota true, je možné požadavek opakovat. Pomocí hlavičky `Retry-After` odpovědi určete zpoždění, pokud je k dispozici.
message	string	Lidské čitelné vyjádření chyby.
moreDetails	ErrorResponseDetails[]	Seznam dalších podrobností o chybě
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou
requestId	string (uuid)	ID požadavku přidruženého k chybě.

ErrorResponseDetails

Objekt

Podrobnosti o odpovědi na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou

PayloadType

Výčet

Typ datové části definice. V průběhu času je možné přidat další typy datových částí.

Hodnota	Description
InlineBase64	Vložená základna 64.

UserDataFunctionDefinitionResponse

Objekt

Odpověď veřejné definice UserDataFunction

Name	Typ	Description
definition	UserDataFunctionPublicDefinition	UserDataFunction veřejný definiční objekt. Další podrobnosti o struktuře definice UserDataFunction najdete v tomto článku .

UserDataFunctionPublicDefinition

Objekt

UserDataFunction veřejný definiční objekt. Další podrobnosti o struktuře definice UserDataFunction najdete v tomto článku .

Name	Typ	Description
format	string	Formát definice funkce uživatelských dat.
parts	UserDataFunctionPublicDefinitionPart[]	Seznam částí definice.

UserDataFunctionPublicDefinitionPart

Objekt

UserDataFunction definition part object.

Name	Typ	Description
path	string	Cesta části veřejné definice UserDataFunction.
payload	string	Datová část veřejné definice UserDataFunction.
payloadType	PayloadType	Typ datové části.