ข้อมูลอ้างอิง API: กระบวนการ

Endpoint เหล่านี้ทำงานใน workspace ของคุณเอง เริ่มทดลองใช้ฟรี เพื่อสร้าง workspace และเรียกใช้ API ครั้งแรก.

แสดงรายการกระบวนการ

ปลายทาง: GET /v1/tenant/{tenantId}/processes

การยืนยันตัวตน: API key ที่กำหนดขอบเขตตาม tenant · scope read

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
limit	integer	query	ไม่	จำนวนรายการสูงสุดที่ส่งกลับ
offset	integer	query	ไม่	จำนวนรายการที่ข้ามไป

การตอบกลับ (200):

รายการกระบวนการ

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"treeParentId": "00000000-0000-0000-0000-000000000000",
		"treeNodeType": "Process",
		"displayName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"designerModelId": "00000000-0000-0000-0000-000000000000"
	}
]

ข้อผิดพลาด:

• 401 ไม่มี API key, key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ

สร้างกระบวนการ (พร้อมโมเดลเปล่า)

ปลายทาง: POST /v1/tenant/{tenantId}/processes

การยืนยันตัวตน: API key ที่กำหนดขอบเขตตาม tenant · scope write

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid

เนื้อหาคำขอ:

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
displayName	string	ใช่	ชื่อกระบวนการที่แสดงในแผนผังกระบวนการ ความยาวสูงสุด: 128
treeParentId	string	ไม่	รหัสโฟลเดอร์หลัก (null = ระดับบนสุด) รูปแบบ: uuid
treeNodeType	Process | TreeGroup	ไม่	กระบวนการหรือ TreeGroup (โฟลเดอร์) ค่าที่ใช้ได้: Process, TreeGroup ค่าเริ่มต้น: Process

การตอบกลับ (201):

สร้างกระบวนการแล้ว

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"designerModelId": "00000000-0000-0000-0000-000000000000"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
id	string	ใช่	รูปแบบ: uuid
treeParentId	string	ใช่	รูปแบบ: uuid
treeNodeType	Process | TreeGroup	ใช่	ค่าที่อนุญาต: Process, TreeGroup ค่าเริ่มต้น: Process
displayName	string	ใช่	ค่าเริ่มต้น: New Process ความยาวสูงสุด: 128
createdAt	string	ใช่	รูปแบบ: date-time
updatedAt	string	ใช่	รูปแบบ: date-time
designerModelId	string	ใช่	รูปแบบ: uuid

ข้อผิดพลาด:

• 401 ไม่มี API key, key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 500 เกิดข้อผิดพลาดที่ไม่คาดคิดบนเซิร์ฟเวอร์ คุณส่งคำขอซ้ำได้อย่างปลอดภัย

ดูข้อมูลกระบวนการ

ปลายทาง: GET /v1/tenant/{tenantId}/processes/{processId}

การยืนยันตัวตน: API key ที่กำหนดขอบเขตตาม tenant · scope read

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
processId	string	path	ใช่	รูปแบบ: uuid

การตอบกลับ (200):

กระบวนการ

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"designerModelId": "00000000-0000-0000-0000-000000000000"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
id	string	ใช่	รูปแบบ: uuid
treeParentId	string	ใช่	รูปแบบ: uuid
treeNodeType	Process | TreeGroup	ใช่	ค่าที่อนุญาต: Process, TreeGroup ค่าเริ่มต้น: Process
displayName	string	ใช่	ค่าเริ่มต้น: New Process ความยาวสูงสุด: 128
createdAt	string	ใช่	รูปแบบ: date-time
updatedAt	string	ใช่	รูปแบบ: date-time
designerModelId	string	ใช่	รูปแบบ: uuid

ข้อผิดพลาด:

• 401 ไม่มี API key, key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 404 ไม่พบทรัพยากร

อัปเดตกระบวนการ

ปลายทาง: PUT /v1/tenant/{tenantId}/processes/{processId}

การยืนยันตัวตน: API key ที่กำหนดขอบเขตตาม tenant · scope write

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
processId	string	path	ใช่	รูปแบบ: uuid

เนื้อหาคำขอ:

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
displayName	string	ไม่	ชื่อกระบวนการที่แสดงในแผนผังกระบวนการ ความยาวสูงสุด: 128
treeParentId	string	ไม่	ID ของโฟลเดอร์หลัก (null = ระดับบนสุด) รูปแบบ: uuid

การตอบกลับ (200):

อัปเดตกระบวนการแล้ว

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"designerModelId": "00000000-0000-0000-0000-000000000000"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
id	string	ใช่	รูปแบบ: uuid
treeParentId	string	ใช่	รูปแบบ: uuid
treeNodeType	Process | TreeGroup	ใช่	ค่าที่อนุญาต: Process, TreeGroup ค่าเริ่มต้น: Process
displayName	string	ใช่	ค่าเริ่มต้น: New Process ความยาวสูงสุด: 128
createdAt	string	ใช่	รูปแบบ: date-time
updatedAt	string	ใช่	รูปแบบ: date-time
designerModelId	string	ใช่	รูปแบบ: uuid

ข้อผิดพลาด:

• 401 ไม่มี API key, key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 404 ไม่พบทรัพยากร
• 500 เกิดข้อผิดพลาดที่ไม่คาดคิดบนเซิร์ฟเวอร์ คุณส่งคำขอซ้ำได้อย่างปลอดภัย

ลบกระบวนการแบบไม่ถาวร

ปลายทาง: DELETE /v1/tenant/{tenantId}/processes/{processId}

การยืนยันตัวตน: API key ที่กำหนดขอบเขตตาม tenant · scope write

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
processId	string	path	ใช่	รูปแบบ: uuid

การตอบกลับ (200):

ลบกระบวนการแล้ว

{
	"success": true,
	"message": "string"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
success	boolean	ใช่
message	string	ใช่

ข้อผิดพลาด:

• 401 ไม่มี API key, key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 404 ไม่พบทรัพยากร

ส่งออกโมเดลกระบวนการเป็น BPMN 2.0 XML

ปลายทาง: GET /v1/tenant/{tenantId}/processes/{processId}/bpmn

การยืนยันตัวตน: API key ที่กำหนดขอบเขตตาม tenant · scope read

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
processId	string	path	ใช่	รูปแบบ: uuid

การตอบกลับ (200):

BPMN XML

{
	"bpmnXml": "string"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
bpmnXml	string	ใช่	BPMN 2.0 XML

ข้อผิดพลาด:

• 401 ไม่มี API key, key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 403 API key ไม่มี scope หรือสิทธิ์เข้าถึงองค์กรตามที่กำหนด, tenant ไม่ได้เปิดใช้งาน หรือแพ็กเกจไม่รองรับไฟล์ประเภทนี้
• 404 ไม่พบทรัพยากร
• 500 เกิดข้อผิดพลาดที่ไม่คาดคิดบนเซิร์ฟเวอร์ คุณส่งคำขอซ้ำได้อย่างปลอดภัย

นำเข้าโมเดล BPMN 2.0 สำหรับกระบวนการ (แทนที่โมเดลปัจจุบัน)

ปลายทาง: PUT /v1/tenant/{tenantId}/processes/{processId}/bpmn

การยืนยันตัวตน: API key ที่กำหนดขอบเขตตาม tenant · scope write

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
processId	string	path	ใช่	รูปแบบ: uuid

เนื้อหาคำขอ:

{
	"bpmnXml": "string"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
bpmnXml	string	ใช่	BPMN 2.0 XML

การตอบกลับ (200):

อัปโหลด BPMN แล้ว

{
	"message": "string"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
message	string	ใช่

ข้อผิดพลาด:

• 400 คำขอไม่ถูกต้อง เช่น นิพจน์ตัวกรองไม่ถูกต้อง, กระบวนการไม่มีโมเดล, ประเภทไฟล์ที่อัปโหลดไม่รองรับ หรือไม่มีฟิลด์ที่จำเป็น
• 401 ไม่มี API key, key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 404 ไม่พบทรัพยากร

การจับคู่ข้อมูลใช้เชื่อมตารางข้อมูลกับกระบวนการ เพื่อให้คุณดูและวิเคราะห์ข้อมูลในบันทึกเหตุการณ์บนโมเดลกระบวนการได้.

แสดงรายการการแมปข้อมูลของกระบวนการ

ปลายทาง: GET /v1/tenant/{tenantId}/processes/{processId}/mappings

การยืนยันตัวตน: API key ที่กำหนดขอบเขตตาม tenant · scope read

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
processId	string	path	ใช่	รูปแบบ: uuid
limit	integer	query	ไม่	จำนวนรายการสูงสุดที่ส่งกลับ
offset	integer	query	ไม่	จำนวนรายการที่ข้ามไป

การตอบกลับ (200):

รายการการแมป

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"dataTableId": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"color": {
			"id": "data-1"
		},
		"showByDefault": true,
		"mappingRole": "primary",
		"sortOrder": 0
	}
]

ข้อผิดพลาด:

• 400 คำขอไม่ถูกต้อง เช่น นิพจน์ตัวกรองไม่ถูกต้อง กระบวนการไม่มีโมเดล ประเภทไฟล์ที่อัปโหลดไม่รองรับ หรือไม่มีฟิลด์ที่จำเป็น
• 401 ไม่มี API key, API key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 404 ไม่พบทรัพยากร

แมป datatable เข้ากับกระบวนการ (เริ่มประมวลผลบันทึกเหตุการณ์)

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/mappings

การยืนยันตัวตน: API key ที่จำกัดขอบเขตตาม tenant · write scope

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
processId	string	path	ใช่	รูปแบบ: uuid

เนื้อหาคำขอ:

{
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
dataTableId	string	ใช่	Datatable ที่จะแมปเข้ากับกระบวนการ รูปแบบ: uuid
displayName	string	ไม่	ชื่อที่แสดงของการแมป ความยาวสูงสุด: 128
color	object	ไม่	สีเน้น
showByDefault	boolean	ไม่	แสดงการแมปนี้เป็นค่าเริ่มต้นในมุมมองกระบวนการ ค่าเริ่มต้น: true
mappingRole	primary | comparison	ไม่	บทบาทของข้อมูลที่แมปในโมเดล ค่าที่ใช้ได้: primary, comparison

การตอบกลับ (201):

สร้างการแมปแล้ว

{
	"id": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000",
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
id	string	ใช่	รูปแบบ: uuid
modelId	string	ใช่	รูปแบบ: uuid
dataTableId	string	ใช่	รูปแบบ: uuid
displayName	string	ใช่	ความยาวสูงสุด: 128
color	object	ใช่
showByDefault	boolean	ใช่	ค่าเริ่มต้น: true
mappingRole	primary | comparison	ใช่	ค่าที่ใช้ได้: primary, comparison ค่าเริ่มต้น: comparison
sortOrder	integer	ใช่	ค่าเริ่มต้น: 0 ค่าต่ำสุด: -9007199254740991 ค่าสูงสุด: 9007199254740991

ข้อผิดพลาด:

• 400 คำขอไม่ถูกต้อง เช่น นิพจน์ตัวกรองไม่ถูกต้อง กระบวนการไม่มีโมเดล ประเภทไฟล์ที่อัปโหลดไม่รองรับ หรือไม่มีฟิลด์ที่จำเป็น
• 401 ไม่มี API key, API key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 403 API key ไม่มี scope หรือสิทธิ์เข้าถึงองค์กรที่จำเป็น, tenant ไม่ได้เปิดใช้งาน หรือแพ็กเกจไม่อนุญาตไฟล์ประเภทนี้
• 404 ไม่พบทรัพยากร

อัปเดตการแมป

Endpoint: PUT /v1/tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

การยืนยันตัวตน: API key ที่จำกัดขอบเขตตาม tenant · write scope

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
processId	string	path	ใช่	รูปแบบ: uuid
mappingId	string	path	ใช่	รูปแบบ: uuid

เนื้อหาคำขอ:

{
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
displayName	string	ไม่	ความยาวสูงสุด: 128
color	object	ไม่
showByDefault	boolean	ไม่
mappingRole	primary | comparison	ไม่	ค่าที่ใช้ได้: primary, comparison
sortOrder	integer	ไม่	ค่าต่ำสุด: -9007199254740991 ค่าสูงสุด: 9007199254740991

การตอบกลับ (200):

อัปเดตการแมปแล้ว

{
	"id": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000",
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
id	string	ใช่	รูปแบบ: uuid
modelId	string	ใช่	รูปแบบ: uuid
dataTableId	string	ใช่	รูปแบบ: uuid
displayName	string	ใช่	ความยาวสูงสุด: 128
color	object	ใช่
showByDefault	boolean	ใช่	ค่าเริ่มต้น: true
mappingRole	primary | comparison	ใช่	ค่าที่ใช้ได้: primary, comparison ค่าเริ่มต้น: comparison
sortOrder	integer	ใช่	ค่าเริ่มต้น: 0 ค่าต่ำสุด: -9007199254740991 ค่าสูงสุด: 9007199254740991

ข้อผิดพลาด:

• 400 คำขอไม่ถูกต้อง เช่น นิพจน์ตัวกรองไม่ถูกต้อง กระบวนการไม่มีโมเดล ประเภทไฟล์ที่อัปโหลดไม่รองรับ หรือไม่มีฟิลด์ที่จำเป็น
• 401 ไม่มี API key, API key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 404 ไม่พบทรัพยากร

ลบการแมป

Endpoint: DELETE /v1/tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

การยืนยันตัวตน: API key ที่จำกัดขอบเขตตาม tenant · write scope

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
processId	string	path	ใช่	รูปแบบ: uuid
mappingId	string	path	ใช่	รูปแบบ: uuid

การตอบกลับ (200):

ลบการแมปแล้ว

{
	"success": true,
	"message": "string"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
success	boolean	ใช่
message	string	ใช่

ข้อผิดพลาด:

• 400 คำขอไม่ถูกต้อง เช่น นิพจน์ตัวกรองไม่ถูกต้อง กระบวนการไม่มีโมเดล ประเภทไฟล์ที่อัปโหลดไม่รองรับ หรือไม่มีฟิลด์ที่จำเป็น
• 401 ไม่มี API key, API key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 404 ไม่พบทรัพยากร

Endpoint เหล่านี้ใช้ AI สร้างโมเดลกระบวนการ BPMN โดยอัตโนมัติจากคำอธิบายภาษาธรรมชาติ.

สร้างโมเดลกระบวนการจากคำสั่งภาษาธรรมชาติ (ทำงานแบบอะซิงโครนัส ให้เรียก endpoint สถานะเพื่อตรวจสอบ)

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/generate-model

การยืนยันตัวตน: API key ที่จำกัดขอบเขตตาม tenant · write scope · จำกัดอัตรา 2 req/s (สูงสุดชั่วขณะ 4)

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
processId	string	path	ใช่	รูปแบบ: uuid

เนื้อหาคำขอ:

{
	"prompt": "string"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
prompt	string	ใช่

การตอบกลับ (200):

เริ่มสร้างแล้ว / ผลลัพธ์

{
	"message": "string"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
message	string	ใช่

ข้อผิดพลาด:

• 401 ไม่มี API key, API key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 404 ไม่พบทรัพยากร

ตรวจสอบสถานะการสร้างโมเดล

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/generate-model/status

การยืนยันตัวตน: API key ที่จำกัดขอบเขตตาม tenant · write scope

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
processId	string	path	ใช่	รูปแบบ: uuid

การตอบกลับ (200):

สถานะการสร้าง

{
	"message": "string"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
message	string	ใช่

ข้อผิดพลาด:

• 401 ไม่มี API key, API key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 404 ไม่พบทรัพยากร

ตัวชี้วัดรายเคสของโมเดลล่าสุดในกระบวนการ: หนึ่งแถวต่อเคส พร้อมลำดับกิจกรรมและตัวชี้วัดสุขภาพที่คำนวณแล้ว.

ดูเมตริกระดับเคสของกระบวนการ (โมเดลล่าสุด แบ่งหน้า)

ส่งคืนหนึ่งแถวต่อเคส พร้อมตัวชี้วัดกระบวนการที่คำนวณแล้ว (ระยะเวลาเคส ความยาว ความสอดคล้อง การทำงานซ้ำ คะแนนสุขภาพ รูปแบบ และอื่นๆ) สำหรับโมเดลล่าสุดของกระบวนการ ระบบไม่กรองแถวผลลัพธ์ ผลลัพธ์แบ่งเป็นหน้า ใช้ limit (ค่าเริ่มต้น 1000 สูงสุด 10000) และ offset แล้วเรียกดูหน้าถัดไปต่อไปตราบใดที่ hasMore เป็น true ระหว่างที่ระบบยังคำนวณตัวชี้วัดไม่เสร็จ การตอบกลับจะมีสถานะ preprocessing.

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/data/case-features

การยืนยันตัวตน: API key ที่จำกัดขอบเขตตาม tenant · read scope

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
processId	string	path	ใช่	รูปแบบ: uuid
limit	integer	query	ไม่	จำนวนแถวเคสสูงสุดที่ส่งกลับ (ค่าเริ่มต้น 1000, สูงสุด 10000)
offset	integer	query	ไม่	จำนวนแถวเคสที่ข้าม (ค่าเริ่มต้น 0)

การตอบกลับ (200):

เมตริกเคส

{
	"state": "ready",
	"processId": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000",
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"rowCount": 0,
	"hasMore": true,
	"rows": [
		{}
	]
}

ข้อผิดพลาด:

• 400 คำขอไม่ถูกต้อง เช่น นิพจน์ตัวกรองไม่ถูกต้อง กระบวนการไม่มีโมเดล ประเภทไฟล์ที่อัปโหลดไม่รองรับ หรือไม่มีฟิลด์ที่จำเป็น
• 401 ไม่มี API key, API key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 404 ไม่พบทรัพยากร
• 503 Data pipeline ยังไม่พร้อม หรือการค้นหาข้อมูลจากระบบต้นทางล้มเหลว

แสดงเวอร์ชันของกระบวนการ

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/versions

การยืนยันตัวตน: API key ที่จำกัดขอบเขตตาม tenant · read scope

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
processId	string	path	ใช่	รูปแบบ: uuid
limit	integer	query	ไม่	จำนวนรายการสูงสุดที่ส่งกลับ
offset	integer	query	ไม่	จำนวนรายการที่ข้าม

การตอบกลับ (200):

รายการเวอร์ชัน

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
]

ข้อผิดพลาด:

• 401 ไม่มี API key, API key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 404 ไม่พบทรัพยากร

สร้างสแนปชอตเวอร์ชันของกระบวนการ

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/versions

การยืนยันตัวตน: API key ที่จำกัดขอบเขตตาม tenant · write scope

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
processId	string	path	ใช่	รูปแบบ: uuid

เนื้อหาคำขอ:

{
	"displayName": "string",
	"description": "string",
	"versionType": "manual",
	"restoreFromVersionId": "00000000-0000-0000-0000-000000000000"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
displayName	string	ไม่	ป้ายกำกับเวอร์ชัน ค่าเริ่มต้น: "" ความยาวสูงสุด: 128
description	string	ไม่	คำอธิบายเวอร์ชัน (ไม่บังคับ)
versionType	manual | auto	ไม่	ทำด้วยตนเอง = ผู้ใช้สร้าง, auto = ระบบสร้าง ค่าที่ใช้ได้: manual, auto
restoreFromVersionId	string	ไม่	เวอร์ชันที่จะใช้กู้คืนเมื่อสร้างสแนปชอตนี้ รูปแบบ: uuid

การตอบกลับ (201):

สร้างเวอร์ชันแล้ว

{
	"version": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	},
	"restoredFrom": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
version	object	ใช่
restoredFrom	object	ใช่

ข้อผิดพลาด:

• 401 ไม่มี API key, API key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 404 ไม่พบทรัพยากร

ดูเวอร์ชันของกระบวนการ

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

การยืนยันตัวตน: API key ที่จำกัดขอบเขตตาม tenant · read scope

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
processId	string	path	ใช่	รูปแบบ: uuid
versionId	string	path	ใช่	รูปแบบ: uuid

การตอบกลับ (200):

เวอร์ชัน

{
	"version": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
version	object	ใช่

ข้อผิดพลาด:

• 401 ไม่มี API key, API key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 404 ไม่พบทรัพยากร

เปลี่ยนชื่อหรืออัปเดตเวอร์ชันของกระบวนการ

Endpoint: PUT /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

การยืนยันตัวตน: API key ที่จำกัดขอบเขตตาม tenant · write scope

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
processId	string	path	ใช่	รูปแบบ: uuid
versionId	string	path	ใช่	รูปแบบ: uuid

เนื้อหาคำขอ:

{
	"displayName": "string",
	"description": "string"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
displayName	string	ไม่	ป้ายกำกับเวอร์ชัน ความยาวสูงสุด: 128
description	string	ไม่	คำอธิบายเวอร์ชัน (ไม่บังคับ)

การตอบกลับ (200):

อัปเดตเวอร์ชันแล้ว

{
	"version": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
version	object	ใช่

ข้อผิดพลาด:

• 401 ไม่มี API key, API key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 404 ไม่พบทรัพยากร

ลบเวอร์ชันของกระบวนการ

Endpoint: DELETE /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

การยืนยันตัวตน: API key ที่จำกัดขอบเขตตาม tenant · write scope

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
processId	string	path	ใช่	รูปแบบ: uuid
versionId	string	path	ใช่	รูปแบบ: uuid

การตอบกลับ (200):

ลบเวอร์ชันแล้ว

{
	"deleted": true
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
deleted	boolean	ใช่

ข้อผิดพลาด:

• 401 ไม่มี API key, API key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 404 ไม่พบทรัพยากร

ดูไฟล์แนบ

Endpoint: GET /v1/tenant/{tenantId}/artifacts/{artifactId}

การยืนยันตัวตน: API key ที่จำกัดขอบเขตตาม tenant · read scope

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
artifactId	string	path	ใช่	รูปแบบ: uuid

การตอบกลับ (200):

ไฟล์แนบ

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"description": "string",
	"originalFileName": "string",
	"mimeType": "string",
	"kind": "Image",
	"artifactType": "modelIcon",
	"uploadState": "Uploading",
	"hasThumbnail": true,
	"sizeBytes": 0,
	"createdAt": "2024-03-15T16:30:00Z",
	"createdBy": "00000000-0000-0000-0000-000000000000"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
id	string	ใช่	รูปแบบ: uuid
displayName	string	ใช่	ค่าเริ่มต้น: "" ความยาวสูงสุด: 500
description	string	ใช่	ความยาวสูงสุด: 2000
originalFileName	string	ใช่	ค่าเริ่มต้น: "" ความยาวสูงสุด: 500
mimeType	string	ใช่	ค่าเริ่มต้น: "" ความยาวสูงสุด: 200
kind	Image | Pdf | Docx | Xlsx | Pptx | Text | Video	ใช่	ค่าที่ใช้ได้: Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType	modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage	ใช่	ค่าที่ใช้ได้: modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage ค่าเริ่มต้น: modelIcon
uploadState	Uploading | Ready | Failed | Deleted	ใช่	ค่าที่ใช้ได้: Uploading, Ready, Failed, Deleted ค่าเริ่มต้น: Uploading
hasThumbnail	boolean	ใช่	ค่าเริ่มต้น: false
sizeBytes	number	ใช่	ค่าเริ่มต้น: 0
createdAt	string	ใช่	รูปแบบ: date-time
createdBy	string	ไม่	รูปแบบ: uuid

ข้อผิดพลาด:

• 401 ไม่มี API key, API key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 404 ไม่พบทรัพยากร

อัปเดตชื่อที่แสดงหรือคำอธิบายของไฟล์แนบ

Endpoint: PUT /v1/tenant/{tenantId}/artifacts/{artifactId}

การยืนยันตัวตน: API key ที่จำกัดขอบเขตตาม tenant · write scope

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
artifactId	string	path	ใช่	รูปแบบ: uuid

เนื้อหาคำขอ:

{
	"displayName": "string",
	"description": "string"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
displayName	string	ไม่	ชื่อไฟล์แนบ ความยาวสูงสุด: 500
description	string	ไม่	คำอธิบายไฟล์แนบ (ไม่บังคับ) ความยาวสูงสุด: 2000

การตอบกลับ (200):

อัปเดตไฟล์แนบแล้ว

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"description": "string",
	"originalFileName": "string",
	"mimeType": "string",
	"kind": "Image",
	"artifactType": "modelIcon",
	"uploadState": "Uploading",
	"hasThumbnail": true,
	"sizeBytes": 0,
	"createdAt": "2024-03-15T16:30:00Z",
	"createdBy": "00000000-0000-0000-0000-000000000000"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
id	string	ใช่	รูปแบบ: uuid
displayName	string	ใช่	ค่าเริ่มต้น: "" ความยาวสูงสุด: 500
description	string	ใช่	ความยาวสูงสุด: 2000
originalFileName	string	ใช่	ค่าเริ่มต้น: "" ความยาวสูงสุด: 500
mimeType	string	ใช่	ค่าเริ่มต้น: "" ความยาวสูงสุด: 200
kind	Image | Pdf | Docx | Xlsx | Pptx | Text | Video	ใช่	ค่าที่ใช้ได้: Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType	modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage	ใช่	ค่าที่ใช้ได้: modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage ค่าเริ่มต้น: modelIcon
uploadState	Uploading | Ready | Failed | Deleted	ใช่	ค่าที่ใช้ได้: Uploading, Ready, Failed, Deleted ค่าเริ่มต้น: Uploading
hasThumbnail	boolean	ใช่	ค่าเริ่มต้น: false
sizeBytes	number	ใช่	ค่าเริ่มต้น: 0
createdAt	string	ใช่	รูปแบบ: date-time
createdBy	string	ไม่	รูปแบบ: uuid

ข้อผิดพลาด:

• 401 ไม่มี API key, API key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 404 ไม่พบทรัพยากร

ลบไฟล์แนบ

Endpoint: DELETE /v1/tenant/{tenantId}/artifacts/{artifactId}

การยืนยันตัวตน: API key ที่จำกัดขอบเขตตาม tenant · write scope

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
artifactId	string	path	ใช่	รูปแบบ: uuid

การตอบกลับ (200):

ลบไฟล์แนบแล้ว

{
	"deleted": true
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
deleted	boolean	ใช่

ข้อผิดพลาด:

• 401 ไม่มี API key, API key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 404 ไม่พบทรัพยากร

เปลี่ยนเส้นทางไปยัง URL ที่ลงนามล่วงหน้าเพื่อดาวน์โหลดไฟล์แนบ

Endpoint: GET /v1/tenant/{tenantId}/artifacts/{artifactId}/open

การยืนยันตัวตน: API key ที่จำกัดขอบเขตตาม tenant · read scope

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
artifactId	string	path	ใช่	รูปแบบ: uuid

ข้อผิดพลาด:

• 302 เปลี่ยนเส้นทางไปยัง URL ดาวน์โหลดที่ลงนามล่วงหน้า
• 401 ไม่มี API key, API key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 404 ไม่พบทรัพยากร

แสดงไฟล์แนบที่เชื่อมโยงกับกระบวนการ

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/artifacts

การยืนยันตัวตน: API key ที่จำกัดขอบเขตตาม tenant · read scope

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
processId	string	path	ใช่	รูปแบบ: uuid
limit	integer	query	ไม่	จำนวนรายการสูงสุดที่ส่งกลับ
offset	integer	query	ไม่	จำนวนรายการที่ข้าม

การตอบกลับ (200):

รายการไฟล์แนบของกระบวนการ

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"artifactId": "00000000-0000-0000-0000-000000000000",
		"section": "string",
		"artifact": {
			"id": "00000000-0000-0000-0000-000000000000",
			"displayName": "string",
			"description": "string",
			"originalFileName": "string",
			"mimeType": "string",
			"kind": "Image",
			"artifactType": "modelIcon",
			"uploadState": "Uploading",
			"hasThumbnail": true,
			"sizeBytes": 0,
			"createdAt": "2024-03-15T16:30:00Z",
			"createdBy": "00000000-0000-0000-0000-000000000000"
		}
	}
]

ข้อผิดพลาด:

• 401 ไม่มี API key, API key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 404 ไม่พบทรัพยากร

ขอ URL อัปโหลด S3 ที่ลงนามล่วงหน้าสำหรับไฟล์แนบใหม่ของกระบวนการ

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/artifacts/uploads/presigned-url

การยืนยันตัวตน: API key ที่จำกัดขอบเขตตาม tenant · write scope

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
processId	string	path	ใช่	รูปแบบ: uuid

เนื้อหาคำขอ:

{
	"fileName": "string",
	"mimeType": "string",
	"sizeBytes": 0,
	"artifactType": "modelIcon"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
fileName	string	ใช่
mimeType	string	ใช่
sizeBytes	number	ใช่
artifactType	modelIcon | processArtifact | doc | levelFrontPageImage	ไม่	ค่าที่ใช้ได้: modelIcon, processArtifact, doc, levelFrontPageImage ค่าเริ่มต้น: processArtifact

การตอบกลับ (200):

URL อัปโหลดที่ลงนามล่วงหน้า

{
	"artifactId": "00000000-0000-0000-0000-000000000000",
	"originalUrl": "string",
	"thumbnailUrl": "string"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
artifactId	string	ใช่	รูปแบบ: uuid
originalUrl	string	ใช่
thumbnailUrl	string	ใช่

ข้อผิดพลาด:

• 400 คำขอไม่ถูกต้อง เช่น นิพจน์ตัวกรองไม่ถูกต้อง กระบวนการไม่มีโมเดล ประเภทไฟล์ที่อัปโหลดไม่รองรับ หรือไม่มีฟิลด์ที่จำเป็น
• 401 ไม่มี API key, API key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 403 API key ไม่มี scope หรือสิทธิ์เข้าถึงองค์กรที่จำเป็น, tenant ไม่ได้เปิดใช้งาน หรือแพ็กเกจไม่อนุญาตไฟล์ประเภทนี้
• 404 ไม่พบทรัพยากร
• 409 คำขอขัดแย้งกับสถานะปัจจุบัน (เช่น ติดข้อจำกัดจำนวนที่นั่งผู้ใช้ หรือใช้ id ซ้ำ)