Item Lifecycle - On Create Item

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

เรียกโดย Microsoft Fabric สําหรับการสร้างรายการใหม่
เมื่อสร้างรายการ Fabric จะดําเนินการตรวจสอบพื้นฐาน ให้สร้างรายการในสถานะการเตรียมใช้งานและเรียกใช้ API นี้เพื่อแจ้งปริมาณงาน คาดว่าจะดําเนินการตรวจสอบความถูกต้องที่จําเป็น จัดเก็บเมตาดาต้าของหน่วยข้อมูล จัดสรรทรัพยากรที่จําเป็น และอัปเดตแคชเมตาดาต้าของรายการ Fabric ด้วยความสัมพันธ์ของรายการและ ETag

API นี้ควรยอมรับการรับรองความถูกต้อง SubjectAndApp

การอนุญาต

สิทธิ์จะถูกตรวจสอบโดย Microsoft Fabric

POST https://be.myWorkload.contoso.com/workload-api-path-placeholder/workspaces/{workspaceId}/items/{itemType}/{itemId}/OnCreateItem

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

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

string (uuid)

รหัสสินค้า
itemType
 path True

string

ชนิดหน่วยข้อมูล
workspaceId
 path True

string (uuid)

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

ส่วนหัวของคำขอ

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

string (uuid)

ID ที่ไม่ซ้ํากันสําหรับความสัมพันธ์ของคําขอกับระบบของคุณเมื่อผู้ใช้โต้ตอบกับปริมาณงานของคุณ
RequestId True

string (uuid)

ID ที่ไม่ซ้ํากันทั่วโลกที่ช่วยให้ Fabric สัมพันธ์กับคําขอของคุณกับบันทึกของเรา ระบุ ID นี้เมื่อรายงานปัญหา
Authorization True

string

ส่วนหัวการอนุญาตโทเค็นคู่ที่อนุญาตให้ปริมาณงานตรวจสอบแหล่งที่มาของคําขอ ให้บริบทของผู้ใช้ และเรียกบริการอื่น ๆ ส่วนหัวนี้มีรูปแบบต่อไปนี้: SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token"
x-ms-client-tenant-id True

string (uuid)

ID ผู้เช่าของไคลเอ็นต์ที่ทําการร้องขอ

เนื้อความของคำขอ

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

ItemDefinition

แสดงข้อกําหนดแบบอินไลน์ของรายการ

การตอบสนอง

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

สร้างเสร็จเรียบร้อยแล้ว
Other Status Codes

ErrorResponse

สําหรับเงื่อนไขของข้อผิดพลาด ปริมาณงานควรส่งกลับรหัสสถานะข้อผิดพลาด HTTP ที่เหมาะสม (4xx, 5xx) พร้อมข้อมูลข้อผิดพลาดโดยละเอียดในเนื้อความการตอบสนอง

ตัวอย่าง

Create item example

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

POST https://be.myWorkload.contoso.com/workload-api-path-placeholder/workspaces/e5ef604d-e14f-4a59-9133-75d5a0cb9334/items/Contoso.FinanceAnalytics.Forecast/b14cb7e7-d346-4751-9cfd-8c2767d53111/OnCreateItem

{
  "definition": {
    "parts": [
      {
        "path": ".platform",
        "payload": "eyJuYW1lIjogIk15IERhdGEgV2FyZWhvdXNlIn0=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

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

รหัสสถานะ:
200

คำจำกัดความ

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

ข้อมูลข้อผิดพลาดเพิ่มเติม
ErrorResponse

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

แหล่งข้อมูลของข้อผิดพลาด
ItemDefinition

แสดงข้อกําหนดแบบอินไลน์ของรายการ
ItemDefinitionPart

แสดงส่วนของข้อกําหนดหน่วยข้อมูล
NameValuePair

คู่ชื่อ-ค่า
OnCreateItemRequest

เนื้อความของการร้องขอสําหรับการสร้างข้อกําหนดรายการในปริมาณงานระยะไกล

ErrorExtendedInformation

วัตถุ

ข้อมูลข้อผิดพลาดเพิ่มเติม

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

NameValuePair[]

รายการพารามิเตอร์เพิ่มเติมเฉพาะสําหรับข้อผิดพลาด
errorCode

string

รหัสข้อผิดพลาด
message

string

ข้อความแสดงข้อผิดพลาด
messageParameters

string[]

รายการพารามิเตอร์สําหรับการจัดรูปแบบข้อความที่มีการแปลเป็นภาษาท้องถิ่น

ErrorResponse

วัตถุ

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

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

string

รหัสข้อผิดพลาด
isPermanent

boolean

ระบุว่าข้อผิดพลาดเป็นแบบถาวรหรือสามารถลองดําเนินการใหม่ได้
message

string

ข้อความแสดงข้อผิดพลาด
messageParameters

string[]

รายการพารามิเตอร์สําหรับการจัดรูปแบบข้อความที่มีการแปลเป็นภาษาท้องถิ่น
moreDetails

ErrorExtendedInformation[]

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

ErrorSource

แหล่งข้อมูลของข้อผิดพลาด

ErrorSource

การแจงนับ

แหล่งข้อมูลของข้อผิดพลาด

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

ข้อผิดพลาดมาจากระบบ
User

ข้อผิดพลาดเกิดจากการป้อนข้อมูลของผู้ใช้
External

ข้อผิดพลาดมาจากแหล่งข้อมูลภายนอก

ItemDefinition

วัตถุ

แสดงข้อกําหนดแบบอินไลน์ของรายการ

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

ItemDefinitionPart[]

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

ItemDefinitionPart

วัตถุ

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

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

string

เส้นทางของส่วน (เช่น '.platform')
payload

string

ส่วนข้อมูล (เนื้อหา Base64 แบบอินไลน์)
payloadType

string

ชนิดของส่วนข้อมูล (เช่น 'InlineBase64')

NameValuePair

วัตถุ

คู่ชื่อ-ค่า

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

string

ชื่อ
value

string

ค่า

OnCreateItemRequest

วัตถุ

เนื้อความของการร้องขอสําหรับการสร้างข้อกําหนดรายการในปริมาณงานระยะไกล

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

ItemDefinition

แสดงข้อกําหนดแบบอินไลน์ของรายการ