แชร์ผ่าน


Items - Get Item Definition

แสดงข้อกําหนดหน่วยข้อมูลที่ระบุ
API นี้ได้รับการสนับสนุนสําหรับจํานวนของชนิดรายการ ค้นหาชนิดหน่วยข้อมูลที่สนับสนุนและข้อมูลเกี่ยวกับโครงสร้างข้อกําหนดของหน่วยข้อมูลในภาพรวมข้อกําหนดรายการ เมื่อคุณได้รับข้อกําหนดของหน่วยข้อมูล ป้ายชื่อระดับความลับไม่ใช่ส่วนหนึ่งของข้อกําหนด

API นี้สนับสนุน การดําเนินการที่ใช้เวลานาน (LRO)

สิทธิ์

ผู้เรียกต้องมีสิทธิ์ ในการอ่านและเขียน สําหรับรายการ

จําเป็นต้องมีขอบเขตที่ได้รับมอบสิทธิ์

สําหรับรายการ API ใช้ชนิดขอบเขตเหล่านี้:

  • ขอบเขตทั่วไป: Item.ReadWrite.All
  • ขอบเขตเฉพาะ: itemTypeReadWrite.All (ตัวอย่างเช่น: Notebook.ReadWrite.All)

สําหรับข้อมูลเพิ่มเติมเกี่ยวกับขอบเขต ให้ดูบทความ ขอบเขต

ข้อจำกัด

API นี้ถูกบล็อกสําหรับรายการที่มีป้ายชื่อระดับความลับที่ได้รับการป้องกัน เว้นแต่ว่าผู้เรียกมีสิทธิ์การใช้งานในการลบป้ายชื่อระดับความลับ

ข้อมูลประจําตัวที่สนับสนุนของ Microsoft Entra

API นี้สนับสนุนข้อมูลประจําตัวของ Microsoft แสดงรายการในส่วนนี้

เอกลักษณ์ สนับสนุน
ผู้ใช้ ใช่
บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ เมื่อชนิดรายการในการเรียกใช้ได้รับการสนับสนุน ตรวจสอบ API ที่สอดคล้องกันสําหรับชนิดรายการที่คุณกําลังเรียกใช้ เพื่อดูว่าการเรียกใช้ของคุณรองรับหรือไม่ ตัวอย่างเช่น แบบจําลองความหมายได้รับการสนับสนุน

อิน เทอร์ เฟซ

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}

พารามิเตอร์ URI

ชื่อ ใน จำเป็น พิมพ์ คำอธิบาย
itemId
path True

string (uuid)

รหัสสินค้า

workspaceId
path True

string (uuid)

ID พื้นที่ทํางาน

format
query

string

รูปแบบของข้อกําหนดหน่วยข้อมูล

การตอบสนอง

ชื่อ พิมพ์ คำอธิบาย
200 OK

ItemDefinitionResponse

คําขอเสร็จสมบูรณ์

202 Accepted

คําขอได้รับการยอมรับ กําลังดําเนินการเรียกข้อกําหนด

ส่วนหัว

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

ErrorResponse

รหัสข้อผิดพลาดทั่วไป:

  • OperationNotSupportedForItem - การดําเนินการไม่ได้รับการสนับสนุนสําหรับรายการที่ร้องขอ

ตัวอย่าง

Get an item definition example

คำขอตัวอย่าง

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

คำตอบตัวอย่าง

{
  "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

คำจำกัดความ

ชื่อ คำอธิบาย
ErrorRelatedResource

ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponse

การตอบสนองข้อผิดพลาด

ErrorResponseDetails

รายละเอียดการตอบสนองข้อผิดพลาด

ItemDefinition

วัตถุข้อกําหนดรายการ

ItemDefinitionPart

ออบเจ็กต์ส่วนของข้อกําหนดหน่วยข้อมูล

ItemDefinitionResponse

การตอบกลับข้อกําหนดสาธารณะของรายการ

PayloadType

ชนิดของส่วนข้อกําหนดส่วนข้อมูล อาจมีการเพิ่มชนิดของส่วนข้อมูลเพิ่มเติมเมื่อเวลาผ่านไป

ErrorRelatedResource

ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
resourceId

string

ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

resourceType

string

ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponse

การตอบสนองข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
errorCode

string

ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้

message

string

การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้

moreDetails

ErrorResponseDetails[]

รายการรายละเอียดข้อผิดพลาดเพิ่มเติม

relatedResource

ErrorRelatedResource

รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

requestId

string

รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponseDetails

รายละเอียดการตอบสนองข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
errorCode

string

ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้

message

string

การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้

relatedResource

ErrorRelatedResource

รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ItemDefinition

วัตถุข้อกําหนดรายการ

ชื่อ พิมพ์ คำอธิบาย
format

string

รูปแบบของข้อกําหนดหน่วยข้อมูล

parts

ItemDefinitionPart[]

รายการของส่วนข้อกําหนด

ItemDefinitionPart

ออบเจ็กต์ส่วนของข้อกําหนดหน่วยข้อมูล

ชื่อ พิมพ์ คำอธิบาย
path

string

เส้นทางของหน่วยข้อมูล

payload

string

ส่วนข้อมูลของหน่วยข้อมูล

payloadType

PayloadType

ชนิดของส่วนข้อมูล

ItemDefinitionResponse

การตอบกลับข้อกําหนดสาธารณะของรายการ

ชื่อ พิมพ์ คำอธิบาย
definition

ItemDefinition

วัตถุข้อกําหนดรายการ

PayloadType

ชนิดของส่วนข้อกําหนดส่วนข้อมูล อาจมีการเพิ่มชนิดของส่วนข้อมูลเพิ่มเติมเมื่อเวลาผ่านไป

ค่า คำอธิบาย
InlineBase64

ฐานแบบอินไลน์ 64