白皮书下载
流程管理
一、创建流程
接口说明
此接口用于使用Z-Factory设计后导出的XXX.ZIP进行流程的创建。流程的名称、版本都由解析ZIP包所获得。收到请求后响应创建成功对应的流程的UUID以及流程版本的UUID信息。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/process
HTTP method: POST
Content-Type: multipart/form-data
请求参数
注意：请求参数包括 [通用请求参数] 和下表中的参数。
|
参数 |
类型 |
必填 |
说明 |
|
file |
File |
是 |
流程 ZIP 包,由 Z-Factory 导出。 |
|
isPublish |
Integer |
是 |
流程是否发布 1-已发布 0-未发布 |
响应样例
{
"msg": "success",
"code": 0,
"data": {
"processUUID": "4d7e17f0e4084802a789fa998120c8fe",//流程UUID
"processDetailUUID": "667a6265459c435e9f65d23bd8148860"// 流程版本UUID
}
}
二、流程详情
接口说明
此接口用于通过流程的名称查询出流程的状态，以及该流程对应的所有版本信息。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/process/{processName}
HTTP method: GET
请求样例
GET http://commander-manager.dev.ii-ai.tech/openAPI/v1/process/演示流程
响应样例
{
"msg": "success",
"code": 0,
"data": {
"processUUID": "f12ca4f4049f474ab53831aaac071a15", \\流程UUID
"processName": "演示流程",\\演示流程
"processLastVersion": "0.0.3",\\流程最新版本
"processDetailCount": 3,\\流程版本数
"isPublish": 1,\\是否发布 1-已发布 0-未发布
"processCreateTime": "2021-03-29 17:29:57",\\流程创建时间
"processDetails": [
{
"processDetailUUID": "1bfae53474d44eeca747b5e1cd111e5c",\\流程版本UUID
"processName": "演示流程",\\流程名称
"processVersion": "0.0.3",\\流程版本
"isPublish":0,\\是否发布 1-已发布 0-未发布
"processCreateTime": "2021-03-29 17:36:50" \\流程创建时间
"inputParam": {"input": "12", "radio": "选项1", "table": [{"姓名": "张三", "年龄": "24"}], "select": "选项1", "switch": 1},\\任务入参
"isReference": true,\\是否引用类型，false-否，true-是
"template":[{"number":2,"name":"textarea","label":"文本域","type":"TextArea","value":"12","tips":"请输入文本内容","height":70},{"number":3,"name":"select","options":["选项1","选项2"],"label":"下拉列表","type":"DropdownList","value":"选项1"}],\\任务模版
},
{
"processDetailUUID": "7684f5d15ca24d40bcd200e8bc0d58b5",
"processName": "演示流程",
"processVersion": "0.0.2",
"isPublish": 1,
"processCreateTime": "2021-03-29 17:29:57"
"inputParam": null,\\任务入参
"isReference": false,\\是否引用类型，false-否，true-是
"template": null,\\任务模版
}
]
}
}
三、获取流程版本信息
接口说明
此接口用于通过流程的名称和流程的版本查询出流程版本的相关信息。
URL:https://z-commander-api.ai-indeed.com/openAPI/v1/process/{processName}/{processVersion}
HTTP method: GET
请求样例
GET http://commander-manager.dev.ii-ai.tech/openAPI/v1/process/演示流程/1.0.1
响应样例
{
"msg": "success",
"code": 0,
"data": {
"processDetailUUID": "1bfae53474d44eeca747b5e1cd111e5c", //流程版本UUID
"processName": "新建空白项目模版",//流程名称
"processVersion": "0.0.3",//流程版本
"isPublish": 0,//是否发布 0-未发布 1-已发布
"processCreateTime": "2021-03-29 17:36:50"// 流程创建
"inputParam": {"input": "12", "radio": "选项1", "table": [{"姓名": "张三", "年龄": "24"}], "select": "选项1", "switch": 1},\\任务入参
"isReference": true,\\是否引用类型，false-否，true-是
"template":[{"number":2,"name":"textarea","label":"文本域","type":"TextArea","value":"12","tips":"请输入文本内容","height":70},{"number":3,"name":"select","options":["选项1","选项2"],"label":"下拉列表","type":"DropdownList","value":"选项1"}],\\任务模版
}
}
四、发布/取消发布流程版本
接口说明
只有发布了的版本，才可以使用该版本进行任务/作业的创建，此功能是为了对部分流程的版本进行发布/取消发布去控制使用.
URL:https://z-commander-api.ai-indeed.com/openAPI/v1/processDetail/{processDetailUUID}/{isPublished}
HTTP method: PUT
Content-Type: application/json
请求样例
PUT
http://commander-manager.dev.ii-ai.tech/openAPI/v1/processDetail/6ec1a6166ab5233/false
响应样例
{
"msg": "success",
"code": 0,// 0为成功
"data": true
}
五、删除流程版本
接口说明
该接口是为了初次上传流程后发现流程包使用错误进行删除所提供的功能，如果流程已经被使用则无法删除。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/processDetail/{processDetailUUID}
HTTP method: DELETE
Content-Type: application/json
请求样例
DELETE
http://commander-manager.dev.ii-ai.tech/openAPI/v1/processDetail/6ecd9c1a6166ab523
响应样例
{
"msg": "success",
"code": 0,
"data": true
}
六、流程详情-包含流程管理以及企业市场
接口说明
此接口用于通过流程的名称查询出流程的状态，以及该流程对应的所有版本信息。 包含流程管理以及企业市场
URL: https://z-commander-api.ai-indeed.com/openAPI/v2/process
HTTP method: POST
Content-Type: application/json
请求样例
POST https://z-commander-api.ai-indeed.com/openAPI/v2/process
|
参数 |
类型 |
必填 |
说明 |
|
processName |
String |
是 |
流程名称 |
|
processChannel |
Integer |
否 |
0:应用管理 1:企业市场 不传则代表都搜索 |
响应样例
{
"msg": "success",
"code": 0,
"data":[ {
"processUUID": "f12ca4f4049f474ab53831aaac071a15", \\流程UUID
"processName": "演示流程",\\演示流程
"processLastVersion": "0.0.3",\\流程最新版本
"processDetailCount": 3,\\流程版本数
"isPublish": 1,\\是否发布 1-已发布 0-未发布
"processChannel":"1",// 流程包来源 0:流程管理 1:企业市场 since1.7.3.1
"processPackageInnerId":"zxc",// 流程包内id. 目前只有企业市场有,流程管理为null
"processCreateTime": "2021-03-29 17:29:57",\\流程创建时间
"processDetails": [
{
"processDetailUUID": "1bfae53474d44eeca747b5e1cd111e5c",\\流程版本UUID
"processChannel":"1",// 流程包来源 0:流程管理 1:企业市场 since1.7.3.1
"processPackageInnerId":"zxc",// 流程包内id. 目前只有企业市场有 ,流程管理为null
"processName": "演示流程",\\流程名称
"processVersion": "0.0.3",\\流程版本
"isPublish":0,\\是否发布 1-已发布 0-未发布
"processCreateTime": "2021-03-29 17:36:50" \\流程创建时间
"inputParam": {"input": "12", "radio": "选项1", "table": [{"姓名": "张三", "年龄": "24"}], "select": "选项1", "switch": 1},\\任务入参
"isReference": true,\\是否引用类型，false-否，true-是
"template":[{"number":2,"name":"textarea","label":"文本域","type":"TextArea","value":"12","tips":"请输入文本内容","height":70},{"number":3,"name":"select","options":["选项1","选项2"],"label":"下拉列表","type":"DropdownList","value":"选项1"}],\\任务模版
},
{
"processDetailUUID": "7684f5d15ca24d40bcd200e8bc0d58b5",
"processName": "演示流程",
"processVersion": "0.0.2",
"isPublish": 1,
"processCreateTime": "2021-03-29 17:29:57"
"inputParam": null,\\任务入参
"isReference": false,\\是否引用类型，false-否，true-是
"template": null,\\任务模版
}
]
}]
}
七、获取流程版本信息-包含流程管理以及企业市场
接口说明
此接口用于通过流程的名称和流程的版本查询出流程版本的相关信息。 包含流程管理以及企业市场
URL:https://z-commander-api.ai-indeed.com/openAPI/v2/process/details
HTTP method: POST
Content-Type: application/json
请求样例
PSOT https://z-commander-api.ai-indeed.com/openAPI/v2/process/details
|
参数 |
类型 |
必填 |
说明 |
|
processName |
String |
是 |
流程名称 |
|
processChannel |
Integer |
否 |
0:应用管理 1:企业市场 不传则代表都搜索 |
|
processVersion |
String |
是 |
流程版本 |
响应样例
{
"msg": "success",
"code": 0,
"data": [{
"processDetailUUID": "1bfae53474d44eeca747b5e1cd111e5c", //流程版本UUID
"processName": "新建空白项目模版",//流程名称
"processVersion": "0.0.3",//流程版本
"processChannel":"1",// 流程包来源 0:流程管理 1:企业市场 since1.7.3.1
"processPackageInnerId":"zxc",// 流程包内id. 目前只有企业市场有 ,流程管理为null
"isPublish": 0,//是否发布 0-未发布 1-已发布
"processCreateTime": "2021-03-29 17:36:50"// 流程创建
"inputParam": {"input": "12", "radio": "选项1", "table": [{"姓名": "张三", "年龄": "24"}], "select": "选项1", "switch": 1},\\任务入参
"isReference": true,\\是否引用类型，false-否，true-是
"template":[{"number":2,"name":"textarea","label":"文本域","type":"TextArea","value":"12","tips":"请输入文本内容","height":70},{"number":3,"name":"select","options":["选项1","选项2"],"label":"下拉列表","type":"DropdownList","value":"选项1"}],\\任务模版
}]
}
