ข้อมูลอ้างอิง API: องค์กร

องค์กรใช้รวม Tenant หลายรายการไว้ภายใต้นิติบุคคลเดียวกัน.

ดูข้อมูลองค์กรของ tenant

อ่านข้อมูลได้ด้วยคีย์ API ที่กำหนดขอบเขตไว้ที่ Tenant และใช้คีย์ที่กำหนดขอบเขตไว้ที่องค์กรได้เช่นกัน.

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

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

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

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

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

รายละเอียดองค์กร

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"contactEmail": "string",
	"isActive": true,
	"allowedLogins": {
		"Microsoft": true,
		"Google": true,
		"LinkedIn": true
	},
	"createdBy": "00000000-0000-0000-0000-000000000000"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
id	string	ใช่	รูปแบบ: uuid
displayName	string	ใช่	ค่าเริ่มต้น: "" ความยาวสูงสุด: 128
createdAt	string	ใช่	รูปแบบ: date-time
contactEmail	string	ใช่	รูปแบบ: email
isActive	boolean	ใช่	ค่าเริ่มต้น: true
allowedLogins	object	ใช่
createdBy	string	ใช่	รูปแบบ: uuid

ข้อผิดพลาด:

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

ดูจำนวนไลเซนส์ขององค์กรและนโยบายซิงค์อัตโนมัติ

ส่งคืนจำนวนที่นั่งผู้ใช้ที่ซื้อและที่ใช้งานอยู่ทั่วทั้งองค์กร แยกตามระดับ (Process Foundation, Process Architecture, Process Intelligence) พร้อมจำนวนที่นั่งผู้ใช้แบบ Viewer ฟรี เป้าหมายการซิงค์อัตโนมัติ คำอธิบายส่วนต่างของที่นั่งผู้ใช้ (ระบบจะดำเนินการอย่างไรและเมื่อใด) รอบการเรียกเก็บเงิน และ externalApiSeatPolicy อ่านข้อมูลได้ด้วยคีย์ API ที่กำหนดขอบเขตไว้ที่ Tenant พารามิเตอร์เส้นทาง {tenantId} หมายถึง Tenant ที่ใช้เป็นบริบท (องค์กรของคีย์ที่กำหนดขอบเขตไว้ที่องค์กร) ไม่ใช่เป้าหมายของการดำเนินการ.

ปลายทาง: GET /v1/tenant/{tenantId}/organization/billing/seats

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

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

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

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

จำนวนที่นั่งผู้ใช้

{
	"contractType": "free",
	"isTrial": true,
	"purchased": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"inUseBillable": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"inUseFree": 0,
	"inUseDashboardViewers": 0,
	"totalBillable": 0,
	"freeViewerAllowance": 0,
	"freeViewerOverAllowance": 0,
	"dashboardViewerAllowance": 0,
	"dashboardViewerOverAllowance": 0,
	"fixedOverage": 0,
	"target": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"drift": [
		{
			"rung": "foundation",
			"paid": 0,
			"actual": 0,
			"state": "equal",
			"buffer": 0
		}
	],
	"interval": "month",
	"nextBilledAt": "string",
	"externalApiSeatPolicy": "autoBill"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
contractType	free | selfServe | fixed | unlimited	ใช่	ค่าที่อนุญาต: free, selfServe, fixed, unlimited
isTrial	boolean	ใช่
purchased	object	ใช่
inUseBillable	object	ใช่
inUseFree	number	ใช่
inUseDashboardViewers	number	ใช่
totalBillable	number	ใช่
freeViewerAllowance	number	ใช่
freeViewerOverAllowance	number	ใช่
dashboardViewerAllowance	number	ใช่
dashboardViewerOverAllowance	number	ใช่
fixedOverage	number	ใช่
target	object	ใช่
drift	object[]	ใช่
interval	month | year	ใช่	ค่าที่อนุญาต: month, year
nextBilledAt	string	ใช่
externalApiSeatPolicy	autoBill | requireCapacity	ใช่	ค่าที่อนุญาต: autoBill, requireCapacity

ข้อผิดพลาด:

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

ดูสถิติภาพรวมขององค์กร

พารามิเตอร์เส้นทาง {tenantId} หมายถึง Tenant ที่ใช้เป็นบริบท (องค์กรของคีย์ที่กำหนดขอบเขตไว้ที่องค์กร) ไม่ใช่เป้าหมายของการดำเนินการ.

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

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

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

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

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

สถิติองค์กร

{
	"userCount": 0,
	"tenantCount": 0,
	"tenantStatistics": [
		{
			"tenantId": "00000000-0000-0000-0000-000000000000",
			"uploadedDataSize": 0,
			"uploadedDataCount": 0,
			"modelCount": 0,
			"simulationCount": 0,
			"userCount": 0
		}
	]
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
userCount	number	ใช่
tenantCount	number	ใช่
tenantStatistics	object[]	ใช่

ข้อผิดพลาด:

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

แสดง tenant ทั้งหมดในองค์กร

พารามิเตอร์เส้นทาง {tenantId} หมายถึง Tenant ที่ใช้เป็นบริบท (องค์กรของคีย์ที่กำหนดขอบเขตไว้ที่องค์กร) ไม่ใช่เป้าหมายของการดำเนินการ.

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

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

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

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

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

รายการ tenant

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"createdBy": "00000000-0000-0000-0000-000000000000",
		"createdAt": "2024-03-15T16:30:00Z",
		"displayName": "string",
		"contactEmail": "string",
		"isActive": true,
		"shortName": "string",
		"useOrganizationTheme": true,
		"description": "string",
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"allowedLogins": {
			"Microsoft": true,
			"Google": true,
			"LinkedIn": true
		},
		"tenantType": "normal",
		"url": "string"
	}
]

ข้อผิดพลาด:

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

สร้าง tenant ใหม่ในองค์กร (ต้องใช้ API key ที่กำหนดขอบเขตตามองค์กร)

พารามิเตอร์เส้นทาง {tenantId} หมายถึง Tenant ที่ใช้เป็นบริบท (องค์กรของคีย์ที่กำหนดขอบเขตไว้ที่องค์กร) ไม่ใช่เป้าหมายของการดำเนินการ.

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

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

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

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

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

{
	"displayName": "string",
	"shortName": "string",
	"description": "string",
	"timezone": "string",
	"tenantType": "normal"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
displayName	string	ไม่	ความยาวสูงสุด: 128
shortName	string	ใช่
description	string	ไม่	ความยาวสูงสุด: 200
timezone	string	ไม่	ความยาวสูงสุด: 64
tenantType	normal | sandbox | demo	ไม่	ค่าที่อนุญาต: normal, sandbox, demo

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

สร้าง tenant แล้ว

{
	"id": "00000000-0000-0000-0000-000000000000",
	"createdBy": "00000000-0000-0000-0000-000000000000",
	"createdAt": "2024-03-15T16:30:00Z",
	"displayName": "string",
	"contactEmail": "string",
	"isActive": true,
	"shortName": "string",
	"useOrganizationTheme": true,
	"description": "string",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"allowedLogins": {
		"Microsoft": true,
		"Google": true,
		"LinkedIn": true
	},
	"tenantType": "normal",
	"url": "string"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
id	string	ใช่	รูปแบบ: uuid
createdBy	string	ใช่	รูปแบบ: uuid
createdAt	string	ใช่	รูปแบบ: date-time
displayName	string	ใช่	ค่าเริ่มต้น: "" ความยาวสูงสุด: 128
contactEmail	string	ใช่	รูปแบบ: email
isActive	boolean	ใช่	ค่าเริ่มต้น: true
shortName	string	ใช่
useOrganizationTheme	boolean	ใช่	ค่าเริ่มต้น: true
description	string	ใช่	ความยาวสูงสุด: 200
organizationId	string	ใช่	รูปแบบ: uuid
allowedLogins	object	ใช่
tenantType	normal | sandbox | demo	ใช่	ค่าที่อนุญาต: normal, sandbox, demo ค่าเริ่มต้น: normal
url	string	ใช่	รูปแบบ: uri

ข้อผิดพลาด:

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

ลบ tenant ในองค์กรแบบไม่ถาวร (ต้องใช้ API key ที่กำหนดขอบเขตตามองค์กร)

การเข้าถึง Tenant ผ่าน API จะหยุดทันที ระบบจะเก็บ Tenant และข้อมูลไว้ในช่วงเวลาคุ้มครองก่อนลบ จากนั้นระบบจะลบทั้งหมดโดยอัตโนมัติ คุณไม่สามารถลบ Tenant ที่กำลังใช้งานอยู่ (Tenant ที่ใช้เป็นบริบท).

ปลายทาง: DELETE /v1/tenant/{tenantId}/organization/tenants/{targetId}

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

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

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

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

ลบ tenant แล้ว

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

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

ข้อผิดพลาด:

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

กู้คืน tenant ที่ลบแบบไม่ถาวรในองค์กร (ต้องใช้ API key ที่กำหนดขอบเขตตามองค์กร)

ยกเลิกการลบแบบไม่ถาวรได้ภายในช่วงเวลาคุ้มครองก่อนลบ ระบบจะกู้คืน Tenant และข้อมูลให้เหมือนเดิมทุกประการ พร้อมเปิดให้เข้าถึงผ่าน API อีกครั้ง พารามิเตอร์เส้นทาง {tenantId} หมายถึง Tenant ที่ใช้เป็นบริบท (องค์กรของคีย์ที่กำหนดขอบเขตไว้ที่องค์กร) ไม่ใช่เป้าหมายของการดำเนินการ.

ปลายทาง: POST /v1/tenant/{tenantId}/organization/tenants/{targetId}/restore

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

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

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

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

กู้คืน tenant แล้ว

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

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

ข้อผิดพลาด:

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

แสดงผู้ใช้ทั้งหมดในองค์กร

พารามิเตอร์เส้นทาง {tenantId} หมายถึง Tenant ที่ใช้เป็นบริบท (องค์กรของคีย์ที่กำหนดขอบเขตไว้ที่องค์กร) ไม่ใช่เป้าหมายของการดำเนินการ.

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

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

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

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

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

รายการผู้ใช้ในองค์กร

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"email": "string",
		"firstName": "string",
		"lastName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"lastLoginAt": "2024-03-15T16:30:00Z",
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"isActiveInOrganization": true,
		"isAdminInOrganization": true
	}
]

ข้อผิดพลาด:

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

แก้ไขการตั้งค่าผู้ใช้ในองค์กร (ต้องใช้ API key ที่กำหนดขอบเขตตามองค์กร)

ระบบจะใช้ค่าสถานะบทบาทใน body (isAdminInOrganization, isActiveInOrganization) ตามที่ระบุทุกประการ ออกคีย์ที่กำหนดขอบเขตไว้ที่องค์กรให้เฉพาะผู้ดูแลระบบองค์กรเท่านั้น พารามิเตอร์เส้นทาง {tenantId} หมายถึง Tenant ที่ใช้เป็นบริบท (องค์กรของคีย์ที่กำหนดขอบเขตไว้ที่องค์กร) ไม่ใช่เป้าหมายของการดำเนินการ.

ปลายทาง: PUT /v1/tenant/{tenantId}/organization/users/{userId}

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

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

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

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

{
	"isActiveInOrganization": true,
	"isAdminInOrganization": true
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
isActiveInOrganization	boolean	ไม่	ผู้ใช้เปิดใช้งานอยู่ในองค์กรหรือไม่
isAdminInOrganization	boolean	ไม่	สิทธิ์ผู้ดูแลระบบองค์กร (ใช้ค่าตามที่ระบุทุกประการ: ออก API key ที่กำหนดขอบเขตตามองค์กรให้เฉพาะผู้ดูแลระบบองค์กร)

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

อัปเดตแล้ว

{
	"message": "string"
}

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

ข้อผิดพลาด:

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

นำผู้ใช้ออกจากองค์กร (ต้องใช้ API key ที่กำหนดขอบเขตตามองค์กร)

พารามิเตอร์เส้นทาง {tenantId} หมายถึง Tenant ที่ใช้เป็นบริบท (องค์กรของคีย์ที่กำหนดขอบเขตไว้ที่องค์กร) ไม่ใช่เป้าหมายของการดำเนินการ.

ปลายทาง: DELETE /v1/tenant/{tenantId}/organization/users/{userId}

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

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

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

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

นำผู้ใช้ออกแล้ว

{
	"message": "string"
}

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

ข้อผิดพลาด:

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