Git - List Workspace Relations

บริการ:: Core

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

แสดงรายการของความสัมพันธ์ของพื้นที่ทํางานสําหรับพื้นที่ทํางานที่ระบุ

Note

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

API นี้สนับสนุน การแบ่งหน้า

Permissions

ผู้เรียกต้องมีบทบาทพื้นที่ทํางาน ของผู้ชม หรือสูงกว่า

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

Workspace.Read.All หรือ Workspace.ReadWrite.All

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

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

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

อินเตอร์เฟซ

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/workspaceRelations

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

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/workspaceRelations?continuationToken={continuationToken}

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

ชื่อ	ใน	จำเป็น	พิมพ์	คำอธิบาย
workspaceId	path	True	string (uuid)	ID พื้นที่ทํางาน
continuationToken	query		string	โทเค็นสําหรับการเรียกใช้หน้าถัดไปของผลลัพธ์

การตอบสนอง

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

200 OK

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

WorkspaceRelations

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

429 Too Many Requests

ErrorResponse

เกินขีดจํากัดอัตราการบริการ เซิร์ฟเวอร์จะส่งกลับ Retry-After ส่วนหัวที่ระบุ ภายในไม่กี่วินาที ระยะเวลาที่ไคลเอ็นต์ต้องรอก่อนที่จะส่งคําขอเพิ่มเติม

ส่วนหัว

Retry-After: integer

Other Status Codes

ErrorResponse

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

ไม่เพียงพอ Privileges - ผู้เรียกไม่มีสิทธิ์พื้นที่ทํางานเพียงพอ
WorkspaceNotFound - ไม่พบพื้นที่ทํางานที่ระบุ

ตัวอย่าง

List workspace relations example

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

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/66666666-6666-6666-6666-666666666666/git/workspaceRelations

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

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

{
  "value": [
    {
      "id": "ffffffff-ffff-ffff-ffff-ffffffffffff",
      "workspaceId": "66666666-6666-6666-6666-666666666666",
      "relatedWorkspaceId": "88888888-8888-8888-8888-888888888888",
      "relationType": "Base"
    },
    {
      "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "workspaceId": "66666666-6666-6666-6666-666666666666",
      "relatedWorkspaceId": "22222222-2222-2222-2222-222222222222",
      "relationType": "RelatedWorkspace"
    },
    {
      "id": "cccccccc-cccc-cccc-cccc-cccccccccccc",
      "workspaceId": "66666666-6666-6666-6666-666666666666",
      "relatedWorkspaceId": "44444444-4444-4444-4444-444444444444",
      "relationType": "RelatedWorkspace"
    }
  ]
}

คำจำกัดความ

ชื่อ	คำอธิบาย
ErrorRelatedResource	ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse	การตอบสนองข้อผิดพลาด
ErrorResponseDetails	รายละเอียดการตอบสนองข้อผิดพลาด
WorkspaceRelation	ออบเจ็กต์ความสัมพันธ์ของพื้นที่ทํางาน
WorkspaceRelations	รายการความสัมพันธ์ของพื้นที่ทํางาน
WorkspaceRelationType	ชนิดของพื้นที่ทํางานที่เกี่ยวข้องในความสัมพันธ์ คุณสามารถเพิ่มประเภทพื้นที่ทํางานที่เกี่ยวข้องเพิ่มเติมเมื่อเวลาผ่านไป

ErrorRelatedResource

วัตถุ

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

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

ErrorResponse

วัตถุ

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

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

ErrorResponseDetails

วัตถุ

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

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

WorkspaceRelation

วัตถุ

ออบเจ็กต์ความสัมพันธ์ของพื้นที่ทํางาน

ชื่อ	พิมพ์	คำอธิบาย
id	string (uuid)	รหัสความสัมพันธ์ของพื้นที่ทํางาน
relatedWorkspaceId	string (uuid)	ID พื้นที่ทํางานที่เกี่ยวข้อง
relationType	WorkspaceRelationType	ชนิดของพื้นที่ทํางานที่เกี่ยวข้องในความสัมพันธ์
workspaceId	string (uuid)	ID พื้นที่ทํางาน

WorkspaceRelations

วัตถุ

รายการความสัมพันธ์ของพื้นที่ทํางาน

ชื่อ	พิมพ์	คำอธิบาย
continuationToken	string	โทเค็นสําหรับชุดผลลัพธ์ชุดถัดไป ถ้าไม่มีระเบียนเพิ่มเติม จะถูกลบออกจากการตอบสนอง
continuationUri	string	URI ของชุดงานชุดผลลัพธ์ถัดไป ถ้าไม่มีระเบียนเพิ่มเติม จะถูกลบออกจากการตอบสนอง
value	WorkspaceRelation[]	รายการความสัมพันธ์ของพื้นที่ทํางาน

WorkspaceRelationType

การแจงนับ

ชนิดของพื้นที่ทํางานที่เกี่ยวข้องในความสัมพันธ์ คุณสามารถเพิ่มประเภทพื้นที่ทํางานที่เกี่ยวข้องเพิ่มเติมเมื่อเวลาผ่านไป

ค่า	คำอธิบาย
Base	พื้นที่ทํางานที่เกี่ยวข้องคือพื้นที่ทํางานพื้นฐาน (แหล่งที่มา)
Branch	พื้นที่ทํางานที่เกี่ยวข้องเป็นพื้นที่ทํางานสาขา
RelatedWorkspace	พื้นที่ทํางานที่เกี่ยวข้องมีความสัมพันธ์ทั่วไป