Sdílet prostřednictvím

Items - Get Dataflow Definition

Služba:
Dataflow
Verze rozhraní API:
v1

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

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

Povolení

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

Požadované delegovaná rozsahy

Dataflow.ReadWrite.All nebo Item.ReadWrite.All

Podporované identity v Microsoft Entra

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

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

Rozhraní

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataflows/{dataflowId}/getDefinition

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
dataflowId
 path True

string (uuid)

ID toku dat.
workspaceId
 path True

string (uuid)

Identifikátor pracovního prostoru.

Odpovědi

Name Typ Description
200 OK

DataflowDefinitionResponse

Žá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 Dataflow public definition example

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
200 
{
  "definition": {
    "parts": [
      {
        "path": "queryMetadata.json",
        "payload": "ewogICJmb3JtYXRWZXJzaW9uIjogIjIwMjUwMiIsCiAgImNvbXB1dGVFbmdpbmVTZXR0aW5ncyI6IHt9LAogICJuYW1lIjogIlRlc3REYXRhZmxvdyIsCiAgInF1ZXJ5R3JvdXBzIjogW10sCiAgImRvY3VtZW50TG9jYWxlIjogImVuLVVTIiwKICAicXVlcmllc01ldGFkYXRhIjogewogICAgInF1ZXJ5IjogewogICAgICAicXVlcnlJZCI6ICJiZTE3MjEwZi01YWNhLTQyMWEtOGMwYS1iZjYzMTQ4N2JiOGUiLAogICAgICAicXVlcnlOYW1lIjogIlF1ZXJ5IgogICAgfQogIH0sCiAgImNvbm5lY3Rpb25zIjogW10KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "mashup.pq",
        "payload": "W1N0YWdpbmdEZWZpbml0aW9uID0gW0tpbmQgPSAiRmFzdENvcHkiXV0Kc2VjdGlvbiBTZWN0aW9uMTsKc2hhcmVkIFF1ZXJ5ID0gbGV0CiAgU291cmNlID0gVGFibGUuRnJvbVJvd3MoSnNvbi5Eb2N1bWVudChCaW5hcnkuRGVjb21wcmVzcyhCaW5hcnkuRnJvbVRleHQoImk0NVdNbFRTVVhMT3p5bk56VE9LUjdDTmdleFluV2dsSXlSWkl5UlpJNlhZV0FBPSIsIEJpbmFyeUVuY29kaW5nLkJhc2U2NCksIENvbXByZXNzaW9uLkRlZmxhdGUpKSwgbGV0IF90ID0gKCh0eXBlIG51bGxhYmxlIHRleHQpIG1ldGEgW1NlcmlhbGl6ZWQuVGV4dCA9IHRydWVdKSBpbiB0eXBlIHRhYmxlIFtDb2x1bW4xID0gX3QsIENvbHVtbjIgPSBfdCwgQ29sdW1uMyA9IF90XSksCiAgIyJDaGFuZ2VkIGNvbHVtbiB0eXBlIiA9IFRhYmxlLlRyYW5zZm9ybUNvbHVtblR5cGVzKFNvdXJjZSwge3siQ29sdW1uMSIsIEludDY0LlR5cGV9LCB7IkNvbHVtbjIiLCB0eXBlIHRleHR9LCB7IkNvbHVtbjMiLCB0eXBlIHRleHR9fSkKaW4KICAjIkNoYW5nZWQgY29sdW1uIHR5cGUiOwo=",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIkRhdGFmbG93IiwKICAgICJkaXNwbGF5TmFtZSI6ICJUZXN0RGF0YWZsb3ciCiAgfSwKICAiY29uZmlnIjogewogICAgInZlcnNpb24iOiAiMi4wIiwKICAgICJsb2dpY2FsSWQiOiAiZjU4ZDJmODMtYTMwMC1iMTM1LTQ3ODgtMDU5NjgzY2Q1NzFjIgogIH0KfQ==",
        "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
DataflowDefinition

Objekt veřejné definice toku dat Další podrobnosti o struktuře definice toku dat najdete v tomto článku .
DataflowDefinitionPart

Objekt části definice toku dat
DataflowDefinitionResponse

Odpověď na veřejnou definici toku dat
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í.

DataflowDefinition

Objekt

Objekt veřejné definice toku dat Další podrobnosti o struktuře definice toku dat najdete v tomto článku .

Name Typ Description
parts

DataflowDefinitionPart[]

Seznam částí definice.

DataflowDefinitionPart

Objekt

Objekt části definice toku dat

Name Typ Description
path

string

Cesta části veřejné definice toku dat.
payload

string

Datová část veřejné definice toku dat.
payloadType

PayloadType

Typ datové části.

DataflowDefinitionResponse

Objekt

Odpověď na veřejnou definici toku dat

Name Typ Description
definition

DataflowDefinition

Objekt veřejné definice toku dat Další podrobnosti o struktuře definice toku dat najdete v tomto článku .

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.
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.