Items - Get Report Definition

บริการ:: Report

เวอร์ชัน API:: v1

แสดงข้อกําหนดสาธารณะของรายงานที่ระบุ
API นี้สนับสนุน การดําเนินการที่ใช้เวลานาน (LRO)

เมื่อคุณได้รับคําจํากัดความสาธารณะของรายงาน ป้ายชื่อระดับความลับไม่ได้เป็นส่วนหนึ่งของข้อกําหนด

สิทธิ์

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

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

Report.ReadWrite.All หรือ Item.ReadWrite.All

ข้อจำกัด

API นี้ถูกบล็อกสําหรับรายงานที่มีป้ายชื่อระดับความลับที่เข้ารหัสลับไว้

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

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

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

อิน เทอร์ เฟซ

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/reports/{reportId}/getDefinition

ด้วยพารามิเตอร์ที่เลือกได้:

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

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

ชื่อ	ใน	จำเป็น	พิมพ์	คำอธิบาย
reportId	path	True	string (uuid)	ID รายงาน
workspaceId	path	True	string (uuid)	ID พื้นที่ทํางาน
format	query		string	รูปแบบของข้อกําหนดสาธารณะของรายงาน

การตอบสนอง

ชื่อ	พิมพ์	คำอธิบาย
200 OK	ReportDefinitionResponse	คําขอเสร็จสมบูรณ์
202 Accepted		คําขอได้รับการยอมรับ กําลังดําเนินการเรียกข้อกําหนด ส่วนหัว Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	เกินขีดจํากัดอัตราการบริการ เซิร์ฟเวอร์จะส่งกลับ `Retry-After` ส่วนหัวที่ระบุ ภายในไม่กี่วินาที ระยะเวลาที่ไคลเอ็นต์ต้องรอก่อนที่จะส่งคําขอเพิ่มเติม ส่วนหัว Retry-After: integer
Other Status Codes	ErrorResponse	รหัสข้อผิดพลาดทั่วไป: OperationNotSupportedForItem - การดําเนินการไม่ได้รับการสนับสนุนสําหรับรายการที่ร้องขอ

ตัวอย่าง

Get a report definition example

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

HTTP

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

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

รหัสสถานะ:: 200

{
  "definition": {
    "parts": [
      {
        "path": "report.json",
        "payload": "QmFzZTY0U3RyaW5n",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition.pbir",
        "payload": "QW5vdGhlckJhc2U2NFN0cmluZw",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

รหัสสถานะ:: 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

คำจำกัดความ

ชื่อ	คำอธิบาย
ErrorParameter	พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด
ErrorRelatedResource	ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse	การตอบสนองข้อผิดพลาด
ErrorResponseDetails	รายละเอียดการตอบสนองข้อผิดพลาด
PayloadType	ชนิดของส่วนข้อกําหนดส่วนข้อมูล อาจมีการเพิ่มชนิดของส่วนข้อมูลเพิ่มเติมเมื่อเวลาผ่านไป
ReportDefinition	รายงานวัตถุข้อกําหนดสาธารณะ โปรดดู บทความนี้ สําหรับรายละเอียดเพิ่มเติมเกี่ยวกับโครงสร้างของข้อกําหนดของรายงาน
ReportDefinitionPart	ออบเจ็กต์ส่วนของข้อกําหนดรายงาน
ReportDefinitionResponse	รายงานการตอบสนองข้อกําหนดสาธารณะ

ErrorParameter

วัตถุ

พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด

ชื่อ	พิมพ์	คำอธิบาย
message	string	คําอธิบายที่มนุษย์สามารถอ่านได้ของความหมายของพารามิเตอร์
name	string	ตัวระบุพารามิเตอร์
value	string	ค่าพารามิเตอร์

ErrorRelatedResource

วัตถุ

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

ชื่อ	พิมพ์	คำอธิบาย
resourceId	string	ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
resourceType	string	ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponse

วัตถุ

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

ชื่อ	พิมพ์	คำอธิบาย
errorCode	string	ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
isRetriable	boolean	เมื่อเป็นจริง สามารถลองคําขอใหม่ได้ ใช้ส่วนหัวการตอบสนอง `Retry-After` เพื่อกําหนดความล่าช้า ถ้ามี
message	string	การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
moreDetails	ErrorResponseDetails[]	รายการรายละเอียดข้อผิดพลาดเพิ่มเติม
parameters	ErrorParameter[]	พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด
relatedResource	ErrorRelatedResource	รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
requestId	string (uuid)	รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponseDetails

วัตถุ

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

ชื่อ	พิมพ์	คำอธิบาย
errorCode	string	ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message	string	การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
parameters	ErrorParameter[]	พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด
relatedResource	ErrorRelatedResource	รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

PayloadType

การแจงนับ

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

ค่า	คำอธิบาย
InlineBase64	ฐานแบบอินไลน์ 64

ReportDefinition

วัตถุ

รายงานวัตถุข้อกําหนดสาธารณะ โปรดดู บทความนี้ สําหรับรายละเอียดเพิ่มเติมเกี่ยวกับโครงสร้างของข้อกําหนดของรายงาน

ชื่อ	พิมพ์	คำอธิบาย
format	string	รูปแบบของข้อกําหนดของรายงาน
parts	ReportDefinitionPart[]	รายการของส่วนข้อกําหนด

ReportDefinitionPart

วัตถุ

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

ชื่อ	พิมพ์	คำอธิบาย
path	string	เส้นทางส่วนของรายงาน
payload	string	ส่วนรายงานส่วนข้อมูล
payloadType	PayloadType	ชนิดของส่วนข้อมูล

ReportDefinitionResponse

วัตถุ

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

ชื่อ	พิมพ์	คำอธิบาย
definition	ReportDefinition	รายงานวัตถุข้อกําหนดสาธารณะ โปรดดู บทความนี้ สําหรับรายละเอียดเพิ่มเติมเกี่ยวกับโครงสร้างของข้อกําหนดของรายงาน