本页内容

API参考:流程

这些端点适用于您自己的工作空间。开始免费试用即可创建工作空间并发起首次API调用。

列出流程

端点: GET /v1/tenant/{tenantId}/processes

**身份验证:**环境范围的API密钥 · read范围

参数:

名称 类型 位置 必填 说明
tenantId string 路径 是 格式:uuid
limit integer 查询参数 否 返回项目的最大数量
offset integer 查询参数 否 跳过的项目数量

响应(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密钥

创建流程(空模型)

端点: POST /v1/tenant/{tenantId}/processes

**身份验证:**环境范围的API密钥 · write范围

参数:

名称 类型 位置 必填 说明
tenantId string 路径 是 格式:uuid

请求正文:

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process"
}
字段 类型 必填 说明
displayName string 是 流程树中显示的流程名称
最大长度:128
treeParentId string 否 父文件夹ID(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密钥
  • 500意外的服务器错误:可以安全地重试请求

获取流程

端点: GET /v1/tenant/{tenantId}/processes/{processId}

**身份验证:**环境范围的API密钥 · read范围

参数:

名称 类型 位置 必填 说明
tenantId string 路径 是 格式:uuid
processId string 路径 是 格式: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密钥
  • 404未找到资源

更新流程

端点: PUT /v1/tenant/{tenantId}/processes/{processId}

**身份验证:**环境范围的API密钥 · write范围

参数:

名称 类型 位置 必填 说明
tenantId string 路径 是 格式:uuid
processId string 路径 是 格式: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密钥
  • 404未找到资源
  • 500意外的服务器错误:可以安全地重试请求

软删除流程

端点: DELETE /v1/tenant/{tenantId}/processes/{processId}

**身份验证:**环境范围的API密钥 · write范围

参数:

名称 类型 位置 必填 说明
tenantId string 路径 是 格式:uuid
processId string 路径 是 格式:uuid

响应(200):

已删除流程

{
	"success": true,
	"message": "string"
}
字段 类型 必填 说明
success boolean 是
message string 是

错误:

  • 401缺少、无效、已停用或已过期的API密钥
  • 404未找到资源

将流程模型导出为BPMN 2.0 XML

端点: GET /v1/tenant/{tenantId}/processes/{processId}/bpmn

**身份验证:**环境范围的API密钥 · read范围

参数:

名称 类型 位置 必填 说明
tenantId string 路径 是 格式:uuid
processId string 路径 是 格式:uuid

响应(200):

BPMN XML

{
	"bpmnXml": "string"
}
字段 类型 必填 说明
bpmnXml string 是 BPMN 2.0 XML

错误:

  • 401缺少、无效、已停用或已过期的API密钥
  • 403API密钥缺少所需权限范围或组织访问权限、环境未激活,或套餐不支持该文件类型
  • 404未找到资源
  • 500意外的服务器错误:可以安全地重试请求

为流程导入BPMN 2.0模型(替换当前模型)

端点: PUT /v1/tenant/{tenantId}/processes/{processId}/bpmn

**身份验证:**环境范围的API密钥 · write范围

参数:

名称 类型 位置 必填 说明
tenantId string 路径 是 格式:uuid
processId string 路径 是 格式:uuid

请求正文:

{
	"bpmnXml": "string"
}
字段 类型 必填 说明
bpmnXml string 是 BPMN 2.0 XML

响应(200):

BPMN已上传

{
	"message": "string"
}
字段 类型 必填 说明
message string 是

错误:

  • 400请求错误,例如筛选表达式无效、流程没有模型、上传类型不受支持或缺少必填字段
  • 401缺少、无效、已停用或已过期的API密钥
  • 404未找到资源

数据映射将数据表关联到流程,以便您在流程模型中查看和分析事件日志数据。

列出流程的数据映射

端点: GET /v1/tenant/{tenantId}/processes/{processId}/mappings

**身份验证:**环境范围的API密钥 · read范围

参数:

名称 类型 位置 必填 说明
tenantId string 路径 是 格式:uuid
processId string 路径 是 格式:uuid
limit integer 查询参数 否 返回项目的最大数量
offset integer 查询参数 否 跳过的项目数量

响应(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密钥
  • 404未找到资源

将数据表映射到流程(开始处理事件日志)

端点: POST /v1/tenant/{tenantId}/processes/{processId}/mappings

**身份验证:**环境范围的API密钥 · write范围

参数:

名称 类型 位置 必填 说明
tenantId string 路径 是 格式:uuid
processId string 路径 是 格式:uuid

请求正文:

{
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary"
}
字段 类型 必填 说明
dataTableId string 是 要映射到流程的数据表
格式: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密钥
  • 403API密钥缺少所需权限范围或组织访问权限、环境未激活,或套餐不支持该文件类型
  • 404未找到资源

更新映射

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

**身份验证:**环境范围的API密钥 · write范围

参数:

名称 类型 位置 必填 说明
tenantId string 路径 是 格式:uuid
processId string 路径 是 格式:uuid
mappingId string 路径 是 格式: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密钥
  • 404未找到资源

删除映射

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

**身份验证:**环境范围的API密钥 · write范围

参数:

名称 类型 位置 必填 说明
tenantId string 路径 是 格式:uuid
processId string 路径 是 格式:uuid
mappingId string 路径 是 格式:uuid

响应(200):

已删除映射

{
	"success": true,
	"message": "string"
}
字段 类型 必填 说明
success boolean 是
message string 是

错误:

  • 400请求错误,例如筛选表达式无效、流程没有模型、上传类型不受支持或缺少必填字段
  • 401缺少、无效、已停用或已过期的API密钥
  • 404未找到资源

这些端点使用AI,根据自然语言描述自动生成BPMN流程模型。

根据自然语言提示生成流程模型(异步;轮询状态端点)

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

**身份验证:**环境范围的API密钥 · write范围 · 速率限制为2 req/s(突发上限4)

参数:

名称 类型 位置 必填 说明
tenantId string 路径 是 格式:uuid
processId string 路径 是 格式:uuid

请求正文:

{
	"prompt": "string"
}
字段 类型 必填 说明
prompt string 是

响应(200):

生成已启动 / 结果

{
	"message": "string"
}
字段 类型 必填 说明
message string 是

错误:

  • 401缺少、无效、已停用或已过期的API密钥
  • 404未找到资源

查询模型生成状态

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

**身份验证:**环境范围的API密钥 · write范围

参数:

名称 类型 位置 必填 说明
tenantId string 路径 是 格式:uuid
processId string 路径 是 格式:uuid

响应(200):

生成状态

{
	"message": "string"
}
字段 类型 必填 说明
message string 是

错误:

  • 401缺少、无效、已停用或已过期的API密钥
  • 404未找到资源

流程最新模型的单案例指标:每个案例占一行,包含计算得出的顺序和健康度指标。

获取流程的单案例指标(最新模型,分页)

返回流程最新模型中每个案例的计算指标(案例持续时间、长度、一致性检查、返工、健康度评分、变体等)。结果不进行行筛选,并采用分页方式返回:使用limit(默认值为1000,最大值为10000)和offset;当hasMore为true时继续获取下一页。指标仍在计算时,响应状态为preprocessing。

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

**身份验证:**环境范围的API密钥 · read范围

参数:

名称 类型 位置 必填 说明
tenantId string 路径 是 格式:uuid
processId string 路径 是 格式:uuid
limit integer 查询参数 否 返回案例行的最大数量(默认值为1000,最大值为10000)
offset integer 查询参数 否 跳过的案例行数(默认值为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密钥
  • 404未找到资源
  • 503数据管道尚未就绪,或上游查询失败

列出流程版本

端点: GET /v1/tenant/{tenantId}/processes/{processId}/versions

**身份验证:**环境范围的API密钥 · read范围

参数:

名称 类型 位置 必填 说明
tenantId string 路径 是 格式:uuid
processId string 路径 是 格式:uuid
limit integer 查询参数 否 返回项目的最大数量
offset integer 查询参数 否 跳过的项目数量

响应(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密钥
  • 404未找到资源

创建流程版本快照

端点: POST /v1/tenant/{tenantId}/processes/{processId}/versions

**身份验证:**环境范围的API密钥 · write范围

参数:

名称 类型 位置 必填 说明
tenantId string 路径 是 格式:uuid
processId string 路径 是 格式: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密钥
  • 404未找到资源

获取流程版本

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

**身份验证:**环境范围的API密钥 · read范围

参数:

名称 类型 位置 必填 说明
tenantId string 路径 是 格式:uuid
processId string 路径 是 格式:uuid
versionId string 路径 是 格式: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密钥
  • 404未找到资源

重命名或更新流程版本

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

**身份验证:**环境范围的API密钥 · write范围

参数:

名称 类型 位置 必填 说明
tenantId string 路径 是 格式:uuid
processId string 路径 是 格式:uuid
versionId string 路径 是 格式: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密钥
  • 404未找到资源

删除流程版本

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

**身份验证:**环境范围的API密钥 · write范围

参数:

名称 类型 位置 必填 说明
tenantId string 路径 是 格式:uuid
processId string 路径 是 格式:uuid
versionId string 路径 是 格式:uuid

响应(200):

已删除版本

{
	"deleted": true
}
字段 类型 必填 说明
deleted boolean 是

错误:

  • 401缺少、无效、已停用或已过期的API密钥
  • 404未找到资源

获取工件

端点: GET /v1/tenant/{tenantId}/artifacts/{artifactId}

**身份验证:**租户范围的API密钥 · read权限范围

参数:

名称 类型 位置 必填 说明
tenantId string 路径 是 格式:uuid
artifactId string 路径 是 格式: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密钥
  • 404未找到资源

更新工件的显示名称或说明

端点: PUT /v1/tenant/{tenantId}/artifacts/{artifactId}

**身份验证:**租户范围的API密钥 · write权限范围

参数:

名称 类型 位置 必填 说明
tenantId string 路径 是 格式:uuid
artifactId string 路径 是 格式: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密钥
  • 404未找到资源

删除工件

端点: DELETE /v1/tenant/{tenantId}/artifacts/{artifactId}

**身份验证:**租户范围的API密钥 · write权限范围

参数:

名称 类型 位置 必填 说明
tenantId string 路径 是 格式:uuid
artifactId string 路径 是 格式:uuid

响应(200):

工件已删除

{
	"deleted": true
}
字段 类型 必填 说明
deleted boolean 是

错误:

  • 401缺少、无效、已停用或已过期的API密钥
  • 404未找到资源

重定向到预签名URL以下载工件

端点: GET /v1/tenant/{tenantId}/artifacts/{artifactId}/open

**身份验证:**租户范围的API密钥 · read权限范围

参数:

名称 类型 位置 必填 说明
tenantId string 路径 是 格式:uuid
artifactId string 路径 是 格式:uuid

错误:

  • 302重定向到预签名下载URL
  • 401缺少、无效、已停用或已过期的API密钥
  • 404未找到资源

列出关联到流程的工件

端点: GET /v1/tenant/{tenantId}/processes/{processId}/artifacts

**身份验证:**租户范围的API密钥 · read权限范围

参数:

名称 类型 位置 必填 说明
tenantId string 路径 是 格式:uuid
processId string 路径 是 格式:uuid
limit integer 查询参数 否 返回条目的最大数量
offset integer 查询参数 否 跳过的条目数

响应(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密钥
  • 404未找到资源

获取新流程工件的预签名S3上传URL

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

**身份验证:**租户范围的API密钥 · write权限范围

参数:

名称 类型 位置 必填 说明
tenantId string 路径 是 格式:uuid
processId string 路径 是 格式: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密钥
  • 403API密钥缺少所需权限范围或组织访问权限、租户未激活,或套餐不支持该文件类型
  • 404未找到资源
  • 409请求与当前状态冲突(例如席位限制或重复使用ID)

优化流程,构建互联架构,掌控全局。

无需信用卡,也无需等待,即刻开始。将组织的实际工作方式转化为清晰、互联的流程设计。

构建流程架构,明确职责归属与管控措施,并在各层级统一角色分工。

开始免费试用,为流程治理、管理和持续改进建立可靠的统一基础。