Items - Get Dataflow Definition
แสดงข้อกําหนดสาธารณะของกระแสข้อมูลที่ระบุ
API นี้สนับสนุน การดําเนินการที่ใช้เวลานาน (LRO)
เมื่อคุณได้รับคําจํากัดความสาธารณะของกระแสข้อมูล ป้ายชื่อระดับความลับไม่ได้เป็นส่วนหนึ่งของข้อกําหนด
การอนุญาต
ผู้เรียกต้องมีสิทธิ์ ในการอ่านและเขียน สําหรับกระแสข้อมูล
จําเป็นต้องมีขอบเขตที่ได้รับมอบสิทธิ์
Dataflow.ReadWrite.All หรือ Item.ReadWrite.All
ข้อมูลประจําตัวที่สนับสนุนของ Microsoft Entra
API นี้สนับสนุนข้อมูลประจําตัวของ Microsoft แสดงรายการในส่วนนี้
| เอกลักษณ์ | สนับสนุน |
|---|---|
| ผู้ใช้ | ใช่ |
| บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ | ใช่ |
อิน เทอร์ เฟซ
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataflows/{dataflowId}/getDefinition
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataflows/{dataflowId}/getDefinition?format={format}
พารามิเตอร์ URI
| ชื่อ | ใน | จำเป็น | พิมพ์ | คำอธิบาย |
|---|---|---|---|---|
|
dataflow
|
path | True |
string (uuid) |
ID กระแสข้อมูล |
|
workspace
|
path | True |
string (uuid) |
ID พื้นที่ทํางาน |
|
format
|
query |
string |
รูปแบบของข้อกําหนดสาธารณะของกระแสข้อมูล |
การตอบสนอง
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| 200 OK |
คําขอเสร็จสมบูรณ์ |
|
| 202 Accepted |
คําขอได้รับการยอมรับ กําลังดําเนินการเรียกข้อกําหนด ส่วนหัว
|
|
| 429 Too Many Requests |
เกินขีดจํากัดอัตราการบริการ เซิร์ฟเวอร์จะส่งกลับ ส่วนหัว Retry-After: integer |
|
| Other Status Codes |
รหัสข้อผิดพลาดทั่วไป:
|
ตัวอย่าง
Get a Dataflow public definition example
คำขอตัวอย่าง
POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/dataflows/5b218778-e7a5-4d73-8187-f10824047715/getDefinition
คำตอบตัวอย่าง
{
"definition": {
"parts": [
{
"path": "queryMetadata.json",
"payload": "ewogICJmb3JtYXRWZXJzaW9uIjogIjIwMjUwMiIsCiAgImNvbXB1dGVFbmdpbmVTZXR0aW5ncyI6IHt9LAogICJuYW1lIjogIlRlc3REYXRhZmxvdyIsCiAgInF1ZXJ5R3JvdXBzIjogW10sCiAgImRvY3VtZW50TG9jYWxlIjogImVuLVVTIiwKICAicXVlcmllc01ldGFkYXRhIjogewogICAgInF1ZXJ5IjogewogICAgICAicXVlcnlJZCI6ICJiZTE3MjEwZi01YWNhLTQyMWEtOGMwYS1iZjYzMTQ4N2JiOGUiLAogICAgICAicXVlcnlOYW1lIjogIlF1ZXJ5IgogICAgfSwKICAgICJNREYgdHJhbnNmb3JtIjogewogICAgICAicXVlcnlJZCI6ICI5YzZkN2M4Ny04M2RiLTQ3MTgtYjM4Mi1jMGMxYWExNjM2ZDciLAogICAgICAicXVlcnlOYW1lIjogIk1ERiB0cmFuc2Zvcm0iLAogICAgICAibG9hZEVuYWJsZWQiOiBmYWxzZQogICAgfQogIH0sCiAgImNvbm5lY3Rpb25zIjogW10KfQ==",
"payloadType": "InlineBase64"
},
{
"path": "mashup.pq",
"payload": "W1N0YWdpbmdEZWZpbml0aW9uID0gW0tpbmQgPSAiRmFzdENvcHkiXV0Kc2VjdGlvbiBTZWN0aW9uMTsKc2hhcmVkIFF1ZXJ5ID0gbGV0CiAgU291cmNlID0gVGFibGUuRnJvbVJvd3MoSnNvbi5Eb2N1bWVudChCaW5hcnkuRGVjb21wcmVzcyhCaW5hcnkuRnJvbVRleHQoImk0NVdNbFRTVVhMT3p5bk56VE9LUjdDTmdleFluV2dsSXlSWkl5UlpJNlhZV0FBPSIsIEJpbmFyeUVuY29kaW5nLkJhc2U2NCksIENvbXByZXNzaW9uLkRlZmxhdGUpKSwgbGV0IF90ID0gKCh0eXBlIG51bGxhYmxlIHRleHQpIG1ldGEgW1NlcmlhbGl6ZWQuVGV4dCA9IHRydWVdKSBpbiB0eXBlIHRhYmxlIFtDb2x1bW4xID0gX3QsIENvbHVtbjIgPSBfdCwgQ29sdW1uMyA9IF90XSksCiAgIyJDaGFuZ2VkIGNvbHVtbiB0eXBlIiA9IFRhYmxlLlRyYW5zZm9ybUNvbHVtblR5cGVzKFNvdXJjZSwge3siQ29sdW1uMSIsIEludDY0LlR5cGV9LCB7IkNvbHVtbjIiLCB0eXBlIHRleHR9LCB7IkNvbHVtbjMiLCB0eXBlIHRleHR9fSkKaW4KICAjIkNoYW5nZWQgY29sdW1uIHR5cGUiOwpbSXRlbVR5cGUgPSAiTURGIl0Kc2hhcmVkICMiTURGIHRyYW5zZm9ybSIgPSAiX19fRXh0ZXJuYWxSZXNvdXJjZS1QbGFjZWhvbGRlcl9fXyI7Cg==",
"payloadType": "InlineBase64"
},
{
"path": "MDF transform.mdf",
"payload": "ewogICAgIm5hbWUiOiAiTURGIiwKICAgICJwcm9wZXJ0aWVzIjogewogICAgICAgICJ0eXBlIjogIk1hcHBpbmdEYXRhRmxvdyIsCiAgICAgICAgInR5cGVQcm9wZXJ0aWVzIjogewogICAgICAgICAgICAic291cmNlcyI6IFsKICAgICAgICAgICAgICAgIHsKICAgICAgICAgICAgICAgICAgICAibmFtZSI6ICJzb3VyY2UxIiwKICAgICAgICAgICAgICAgICAgICAiZXh0ZXJuYWxSZWZlcmVuY2VzIjogewogICAgICAgICAgICAgICAgICAgICAgICAiY29ubmVjdGlvbiI6ICI8c291cmNlMUNvbm5lY3Rpb25JZD4iCiAgICAgICAgICAgICAgICAgICAgfQogICAgICAgICAgICAgICAgfQogICAgICAgICAgICBdLAogICAgICAgICAgICAic2lua3MiOiBbCiAgICAgICAgICAgICAgICB7CiAgICAgICAgICAgICAgICAgICAgIm5hbWUiOiAic2luazEiLAogICAgICAgICAgICAgICAgICAgICJleHRlcm5hbFJlZmVyZW5jZXMiOiB7CiAgICAgICAgICAgICAgICAgICAgICAgICJjb25uZWN0aW9uIjogIjxzaW5rMUNvbm5lY3Rpb25JZD4iCiAgICAgICAgICAgICAgICAgICAgfQogICAgICAgICAgICAgICAgfQogICAgICAgICAgICBdLAogICAgICAgICAgICAidHJhbnNmb3JtYXRpb25zIjogWwogICAgICAgICAgICAgICAgewogICAgICAgICAgICAgICAgICAgICJuYW1lIjogImRlcml2ZWRDb2x1bW4xIgogICAgICAgICAgICAgICAgfQogICAgICAgICAgICBdLAogICAgICAgICAgICAic2NyaXB0TGluZXMiOiBbCiAgICAgICAgICAgICAgICAic291cmNlKG91dHB1dCgiLAogICAgICAgICAgICAgICAgIiAgICAgICAgICBDb2x1bW4xIGFzIHNob3J0LCIsCiAgICAgICAgICAgICAgICAiICAgICAgICAgIENvbHVtbjIgYXMgc3RyaW5nLCIsCiAgICAgICAgICAgICAgICAiICAgICAgICAgIENvbHVtbjMgYXMgZGF0ZSwiLAogICAgICAgICAgICAgICAgIiAgICAgICAgICBDb2x1bW40IGFzIGJvb2xlYW4sIiwKICAgICAgICAgICAgICAgICIgICAgICAgICAgQ29sdW1uNSBhcyBzdHJpbmcsIiwKICAgICAgICAgICAgICAgICIgICAgICAgICAgQ29sdW1uNiBhcyBkb3VibGUiLAogICAgICAgICAgICAgICAgIiAgICAgKSwiLAogICAgICAgICAgICAgICAgIiAgICAgdXNlU2NoZW1hOiBmYWxzZSwiLAogICAgICAgICAgICAgICAgIiAgICAgYWxsb3dTY2hlbWFEcmlmdDogdHJ1ZSwiLAogICAgICAgICAgICAgICAgIiAgICAgdmFsaWRhdGVTY2hlbWE6IGZhbHNlLCIsCiAgICAgICAgICAgICAgICAiICAgICBpZ25vcmVOb0ZpbGVzRm91bmQ6IGZhbHNlLCIsCiAgICAgICAgICAgICAgICAiICAgICBmb3JtYXQ6ICdkZWxpbWl0ZWQnLCIsCiAgICAgICAgICAgICAgICAiICAgICBmaWxlU3lzdGVtOiAnZm9sZGVyMScsIiwKICAgICAgICAgICAgICAgICIgICAgIGZpbGVOYW1lOiAnZmlsZTEuY3N2JywiLAogICAgICAgICAgICAgICAgIiAgICAgY29sdW1uRGVsaW1pdGVyOiAnLCcsIiwKICAgICAgICAgICAgICAgICIgICAgIGVzY2FwZUNoYXI6ICdcXFxcJywiLAogICAgICAgICAgICAgICAgIiAgICAgcXVvdGVDaGFyOiAnXFxcIicsIiwKICAgICAgICAgICAgICAgICIgICAgIGNvbHVtbk5hbWVzQXNIZWFkZXI6IHRydWUpIH4+IHNvdXJjZTEiLAogICAgICAgICAgICAgICAgInNvdXJjZTEgZGVyaXZlKGlzQ29sdW1uNkdyZWF0ZXJUaGFuMTAgPSBDb2x1bW42PjEwKSB+PiBkZXJpdmVkQ29sdW1uMSIsCiAgICAgICAgICAgICAgICAiZGVyaXZlZENvbHVtbjEgc2luayhhbGxvd1NjaGVtYURyaWZ0OiB0cnVlLCIsCiAgICAgICAgICAgICAgICAiICAgICB2YWxpZGF0ZVNjaGVtYTogZmFsc2UsIiwKICAgICAgICAgICAgICAgICIgICAgIGZvcm1hdDogJ2pzb24nLCIsCiAgICAgICAgICAgICAgICAiICAgICBmaWxlU3lzdGVtOiAnb3V0cHV0MScsIiwKICAgICAgICAgICAgICAgICIgICAgIHVtYXNrOiAwMDIyLCIsCiAgICAgICAgICAgICAgICAiICAgICBwcmVDb21tYW5kczogW10sIiwKICAgICAgICAgICAgICAgICIgICAgIHBvc3RDb21tYW5kczogW10sIiwKICAgICAgICAgICAgICAgICIgICAgIHNraXBEdXBsaWNhdGVNYXBJbnB1dHM6IHRydWUsIiwKICAgICAgICAgICAgICAgICIgICAgIHNraXBEdXBsaWNhdGVNYXBPdXRwdXRzOiB0cnVlKSB+PiBzaW5rMSIKICAgICAgICAgICAgXQogICAgICAgIH0KICAgIH0KfQ==",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIkRhdGFmbG93IiwKICAgICJkaXNwbGF5TmFtZSI6ICJUZXN0RGF0YWZsb3ciCiAgfSwKICAiY29uZmlnIjogewogICAgInZlcnNpb24iOiAiMi4wIiwKICAgICJsb2dpY2FsSWQiOiAiZjU4ZDJmODMtYTMwMC1iMTM1LTQ3ODgtMDU5NjgzY2Q1NzFjIgogIH0KfQ==",
"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
คำจำกัดความ
| ชื่อ | คำอธิบาย |
|---|---|
|
Dataflow |
วัตถุข้อกําหนดสาธารณะของกระแสข้อมูล โปรดดู บทความนี้ สําหรับรายละเอียดเพิ่มเติมเกี่ยวกับโครงสร้างของข้อกําหนดกระแสข้อมูล |
|
Dataflow |
ออบเจ็กต์ส่วนของข้อกําหนดกระแสข้อมูล |
|
Dataflow |
การตอบสนองข้อกําหนดสาธารณะของกระแสข้อมูล |
|
Error |
ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
|
Error |
การตอบสนองข้อผิดพลาด |
|
Error |
รายละเอียดการตอบสนองข้อผิดพลาด |
|
Payload |
ชนิดของส่วนข้อกําหนดส่วนข้อมูล อาจมีการเพิ่มชนิดของส่วนข้อมูลเพิ่มเติมเมื่อเวลาผ่านไป |
DataflowDefinition
วัตถุข้อกําหนดสาธารณะของกระแสข้อมูล โปรดดู บทความนี้ สําหรับรายละเอียดเพิ่มเติมเกี่ยวกับโครงสร้างของข้อกําหนดกระแสข้อมูล
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| format |
string |
รูปแบบของข้อกําหนดโฟลว์ข้อมูล |
| parts |
รายการของส่วนข้อกําหนด |
DataflowDefinitionPart
ออบเจ็กต์ส่วนของข้อกําหนดกระแสข้อมูล
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| path |
string |
เส้นทางส่วนข้อกําหนดสาธารณะของกระแสข้อมูล |
| payload |
string |
ส่วนข้อกําหนดสาธารณะของกระแสข้อมูล |
| payloadType |
ชนิดของส่วนข้อมูล |
DataflowDefinitionResponse
การตอบสนองข้อกําหนดสาธารณะของกระแสข้อมูล
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| definition |
วัตถุข้อกําหนดสาธารณะของกระแสข้อมูล โปรดดู บทความนี้ สําหรับรายละเอียดเพิ่มเติมเกี่ยวกับโครงสร้างของข้อกําหนดกระแสข้อมูล |
ErrorRelatedResource
ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| resourceId |
string |
ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
| resourceType |
string |
ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
ErrorResponse
การตอบสนองข้อผิดพลาด
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| errorCode |
string |
ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้ |
| isRetriable |
boolean |
เมื่อเป็นจริง สามารถลองคําขอใหม่ได้ ใช้ส่วนหัวการตอบสนอง |
| message |
string |
การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้ |
| moreDetails |
รายการรายละเอียดข้อผิดพลาดเพิ่มเติม |
|
| relatedResource |
รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
|
| requestId |
string (uuid) |
รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด |
ErrorResponseDetails
รายละเอียดการตอบสนองข้อผิดพลาด
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| errorCode |
string |
ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้ |
| message |
string |
การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้ |
| relatedResource |
รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
PayloadType
ชนิดของส่วนข้อกําหนดส่วนข้อมูล อาจมีการเพิ่มชนิดของส่วนข้อมูลเพิ่มเติมเมื่อเวลาผ่านไป
| ค่า | คำอธิบาย |
|---|---|
| InlineBase64 |
ฐานแบบอินไลน์ 64 |