แชร์ผ่าน

Items - Get Digital Twin Builder Definition

บริการ:
DigitalTwinBuilder
เวอร์ชัน API:
v1

แสดงข้อกําหนดสาธารณะ DigitalTwinBuilder ที่ระบุ

Note

รายการ Digital Twin Builder อยู่ในการแสดงตัวอย่าง (เรียนรู้เพิ่มเติม)

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

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

Permissions

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

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

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

Limitations

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

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

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

Identity Support
User Yes
บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ No

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/digitaltwinbuilders/{digitaltwinbuilderId}/getDefinition
ด้วยพารามิเตอร์ที่เลือกได้: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/digitaltwinbuilders/{digitaltwinbuilderId}/getDefinition?format={format}

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

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

string (uuid)

รหัส digitaltwinbuilder
workspaceId
 path True

string (uuid)

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

string

รูปแบบของข้อกําหนดสาธารณะ DigitalTwinBuilder

การตอบสนอง

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

DigitalTwinBuilderDefinitionResponse

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

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

ส่วนหัว

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

ErrorResponse

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

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

ตัวอย่าง

Get a digitaltwinbuilder definition example

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

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/digitaltwinbuilders/5b218778-e7a5-4d73-8187-f10824047715/getDefinition

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

รหัสสถานะ:
200 
{
  "definition": {
    "parts": [
      {
        "path": "definition.json",
        "payload": "ew0KICAibGFrZWhvdXNlSWQiOiAiYjliNWQzNmYtNDQ0NS00MDNiLWFjODctMDE2YjFjZDIwMjExIg0KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
รหัสสถานะ:
202 
Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

คำจำกัดความ

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

วัตถุนิยามสาธารณะ DigitalTwinBuilder
DigitalTwinBuilderDefinitionPart

วัตถุส่วนข้อกําหนด DigitalTwinBuilder
DigitalTwinBuilderDefinitionResponse

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

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

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

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

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

DigitalTwinBuilderDefinition

ออบเจ็กต์

วัตถุนิยามสาธารณะ DigitalTwinBuilder

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

string

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

DigitalTwinBuilderDefinitionPart[]

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

DigitalTwinBuilderDefinitionPart

ออบเจ็กต์

วัตถุส่วนข้อกําหนด DigitalTwinBuilder

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

string

เส้นทางของส่วน DigitalTwinBuilder
payload

string

ส่วน DigitalTwinBuilder
payloadType

PayloadType

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

DigitalTwinBuilderDefinitionResponse

ออบเจ็กต์

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

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

DigitalTwinBuilderDefinition

วัตถุนิยามสาธารณะ DigitalTwinBuilder

ErrorRelatedResource

ออบเจ็กต์

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

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

string

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

string

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

ErrorResponse

ออบเจ็กต์

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

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

string

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

string

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

ErrorResponseDetails[]

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

ErrorRelatedResource

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

string

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

ErrorResponseDetails

ออบเจ็กต์

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

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

string

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

string

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

ErrorRelatedResource

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

PayloadType

การแจงนับ

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

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

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