文档列表
本页内容

接口文档:流程

流程端点

列出所有流程

获取指定 tenant 下的全部流程。

Endpoint: GET /tenant/{tenantId}/processes

参数说明:

名称类型位置是否必需说明
tenantIdstringpathtenant 的唯一标识符

响应:

[
	{
		"id": "b8c9d0e1-f2a3-4567-bcd8-901234567890",
		"displayName": "Order to Cash",
		"treeNodeType": "Process",
		"treeParentId": null,
		"designerModelId": "c9d0e1f2-a3b4-5678-cde9-012345678901",
		"createdAt": "2024-03-01T09:00:00Z",
		"updatedAt": "2024-03-15T16:30:00Z"
	}
]

创建流程

在 tenant 中新建一个流程。

Endpoint: POST /tenant/{tenantId}/processes

参数说明:

名称类型位置是否必需说明
tenantIdstringpathtenant 的唯一标识符

请求体:

{
	"displayName": "My New Process",
	"treeNodeType": "Process",
	"treeParentId": null
}
字段类型是否必需说明
displayNamestring流程名称
treeNodeTypestring必须为 Process(默认)或 TreeGroup
treeParentIdstring流程的父目录 ID

响应: 返回新建流程对象。


获取流程详情

查询指定流程的详细信息。

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

参数说明:

名称类型位置是否必需说明
tenantIdstringpathtenant 的唯一标识符
processIdstringpath流程的唯一标识符

响应:

{
	"id": "b8c9d0e1-f2a3-4567-bcd8-901234567890",
	"displayName": "Order to Cash",
	"treeNodeType": "Process",
	"treeParentId": null,
	"designerModelId": "c9d0e1f2-a3b4-5678-cde9-012345678901",
	"createdAt": "2024-03-01T09:00:00Z",
	"updatedAt": "2024-03-15T16:30:00Z"
}

更新流程

更新流程(如重命名或移动到新目录)。

Endpoint: PUT /tenant/{tenantId}/processes/{processId}

参数说明:

名称类型位置是否必需说明
tenantIdstringpathtenant 的唯一标识符
processIdstringpath流程的唯一标识符

请求体:

{
	"displayName": "Updated Process Name",
	"treeParentId": "d0e1f2a3-b4c5-6789-def0-123456789012"
}
字段类型是否必需说明
displayNamestring新流程名称
treeParentIdstring新父目录 ID

响应: 返回更新后的流程对象。


删除流程

删除指定流程及其关联数据。

Endpoint: DELETE /tenant/{tenantId}/processes/{processId}

参数说明:

名称类型位置是否必需说明
tenantIdstringpathtenant 的唯一标识符
processIdstringpath流程的唯一标识符

响应:

{
	"success": true
}

上传 BPMN

上传 BPMN XML 文件来定义或更新流程模型。

Endpoint: PUT /tenant/{tenantId}/processes/{processId}/bpmn

参数说明:

名称类型位置是否必需说明
tenantIdstringpathtenant 的唯一标识符
processIdstringpath流程的唯一标识符

请求体:

{
	"bpmnXml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>..."
}
字段类型是否必需说明
bpmnXmlstringBPMN 2.0 XML 内容字符串

响应: 返回带有新模型的流程对象。


流程数据映射端点

数据映射将数据表与流程连接,方便你在流程模型中可视化和分析 event log 数据。

列出流程映射

查询流程下全部数据映射。

Endpoint: GET /tenant/{tenantId}/processes/{processId}/mappings

参数说明:

名称类型位置是否必需说明
tenantIdstringpathtenant 的唯一标识符
processIdstringpath流程的唯一标识符

响应:

[
	{
		"id": "e1f2a3b4-c5d6-7890-efa1-234567890123",
		"modelId": "c9d0e1f2-a3b4-5678-cde9-012345678901",
		"dataTableId": "a7b8c9d0-e1f2-3456-abc7-890123456789",
		"displayName": "Sales Data 2024",
		"color": { "id": "data-1" },
		"showByDefault": true,
		"createdAt": "2024-03-10T11:00:00Z"
	}
]

创建流程映射

为流程添加数据表映射。

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

参数说明:

名称类型位置是否必需说明
tenantIdstringpathtenant 的唯一标识符
processIdstringpath流程的唯一标识符

请求体:

{
	"dataTableId": "a7b8c9d0-e1f2-3456-abc7-890123456789",
	"displayName": "Sales Data 2024",
	"color": { "id": "data-1" },
	"showByDefault": true
}
字段类型是否必需说明
dataTableIdstring要映射的数据表 ID
displayNamestring映射显示名称
colorobject颜色对象,id 可选 data-1 到 data-11
showByDefaultboolean是否默认显示(默认:true)

响应: 返回新建的映射对象。


更新流程映射

修改已有数据映射的显示设置。

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

参数说明:

名称类型位置是否必需说明
tenantIdstringpathtenant 的唯一标识符
processIdstringpath流程的唯一标识符
mappingIdstringpath映射的唯一标识符

请求体:

{
	"displayName": "Updated Name",
	"color": { "id": "data-2" },
	"showByDefault": false
}
字段类型是否必需说明
displayNamestring新映射显示名称
colorobject颜色对象,id 可选 data-1 到 data-11
showByDefaultboolean是否默认显示

响应: 返回更新后的映射对象。


删除流程映射

从流程中移除某个数据映射。

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

参数说明:

名称类型位置是否必需说明
tenantIdstringpathtenant 的唯一标识符
processIdstringpath流程的唯一标识符
mappingIdstringpath映射的唯一标识符

响应:

{
	"success": true
}