有生云文档

主题

流程管理后端接口文档 - processAdmin ​

VersionUpdate TimeStatusAuthorDescription
1.02021/5/10创建mengjuhua,zhaobo创建后端接口文档
2.02022/4/10更新qinman,shidaobang,dingzhaojun更新后端接口文档

流程图接口 ​

删除流程图模型 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/bpmnModel/deleteModel

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除流程图模型

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
modelIdstringtrue模型id-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/bpmnModel/deleteModel

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据流程图模型部署流程 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/bpmnModel/deployModel

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程图模型部署流程

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
modelIdstringtrue模型id-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/bpmnModel/deployModel

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

获取流程图字节数据 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/bpmnModel/genProcessDiagram

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取流程图字节数据

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例id-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/bpmnModel/genProcessDiagram

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
datastring操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

获取流程图模型数据 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/bpmnModel/getBpmnModel

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取流程图模型数据

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/bpmnModel/getBpmnModel?tenantId=&processInstanceId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─flowNodeModelListarrayflowNodeModelList-
     └─keystring节点key-
     └─categorystring类别-
     └─textstring节点名称-
     └─figurestring图形-
     └─fillstring填充颜色-
     └─stepTypestringstepType-
     └─locstring位置-
     └─remarkstring评论-
└─linkNodeModelListarraylinkNodeModelList-
     └─fromstring起点-
     └─tostring终点-
└─txtFlowPathstringtxtFlowPath-
└─completedboolean是否办结-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "flowNodeModelList": [
      {
        "key": "",
        "category": "",
        "text": "",
        "figure": "",
        "fill": "",
        "stepType": "",
        "loc": "",
        "remark": ""
      }
    ],
    "linkNodeModelList": [
      {
        "from": "",
        "to": ""
      }
    ],
    "txtFlowPath": "",
    "completed": true
  }
}

获取流程图数据 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/bpmnModel/getFlowChart

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取流程图数据

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/bpmnModel/getFlowChart?tenantId=&processInstanceId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─idstring唯一标示-
└─parentIdstring父节点唯一标示-
└─namestring名称-
└─titlestring标题-
└─classNamestring填充颜色-
└─numint32序号-
└─endTimeint64结束时间-
└─collapsedbooleanNo comments found.-
└─childrenarrayNo comments found.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "parentId": "",
    "name": "",
    "title": "",
    "className": "",
    "num": 0,
    "endTime": 0,
    "collapsed": true,
    "children": [
      {
        "$ref": ".."
      }
    ]
  }
}

获取流程模型列表 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/bpmnModel/getModelList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取流程模型列表

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/bpmnModel/getModelList?tenantId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─idstring流程模型唯一标示-
└─keystring流程模型key-
└─namestring流程模型名称-
└─versionint32版本-
└─createTimestring创建时间-
└─lastUpdateTimestring最后修改时间-
└─xmlstring模型xml信息-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "key": "",
      "name": "",
      "version": 0,
      "createTime": "",
      "lastUpdateTime": "",
      "xml": ""
    }
  ]
}

获取流程设计模型xml ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/bpmnModel/getModelXml

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取流程设计模型xml

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
modelIdstringtrue模型id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/bpmnModel/getModelXml?tenantId=&modelId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─idstring流程模型唯一标示-
└─keystring流程模型key-
└─namestring流程模型名称-
└─versionint32版本-
└─createTimestring创建时间-
└─lastUpdateTimestring最后修改时间-
└─xmlstring模型xml信息-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "key": "",
    "name": "",
    "version": 0,
    "createTime": "",
    "lastUpdateTime": "",
    "xml": ""
  }
}

导入流程模型文件 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/bpmnModel/import

Type: POST

Author: qinman,zhangchongjie

Content-Type: multipart/form-data

Description: 导入流程模型文件

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
userIdstringtrue用户id-
filefiletrue模型文件-

Request-example:

bash
curl -X POST -k -H 'Content-Type: multipart/form-data' -F 'file=' -i https://demo.youshengyun.com/processAdmin/services/rest/bpmnModel/import --data 'tenantId=&userId='

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

保存模型xml ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/bpmnModel/saveModelXml

Type: POST

Author: qinman,zhangchongjie

Content-Type: multipart/form-data

Description: 保存模型xml

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
userIdstringtrue用户id-
modelIdstringtrue模型id-
filefiletrue模型文件-

Request-example:

bash
curl -X POST -k -H 'Content-Type: multipart/form-data' -F 'file=' -i https://demo.youshengyun.com/processAdmin/services/rest/bpmnModel/saveModelXml --data 'tenantId=&userId=&modelId='

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

解析表达式条件接口 ​

解析表达式条件是否满足 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/conditionParser/parser

Type: GET

Author: qinman

Content-Type: application/json

Description: 解析表达式条件是否满足

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
conditionExpressionstringtrue网关上的表达式-

Body-parameters:

ParameterTypeRequiredDescriptionSince
successbooleanfalse操作是否成功-
codeint32false错误代码-
msgstringfalse操作描述-
dataobjectfalse操作成功返回的数据-
└─mapKeyobjectfalseA map key.-
     └─any objectobjectfalseany object.-

Request-example:

bash
curl -X GET -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/processAdmin/services/rest/conditionParser/parser?tenantId=&conditionExpression= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "mapKey": {
      "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
    }
  }
}'

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
databoolean操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": true
}

获取历史节点实例 ​

根据流程实例获取历史节点实例 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/historicActivity/getByProcessInstanceId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例获取历史节点实例

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/historicActivity/getByProcessInstanceId?tenantId=&processInstanceId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─idstring主键-
└─activityIdstring节点id-
└─activityNamestring节点名称-
└─activityTypestring节点类型-
└─processDefinitionIdstring流程定义id-
└─processInstanceIdstring流程实例id-
└─executionIdstring执行实例id-
└─taskIdstring任务id-
└─calledProcessInstanceIdstring调用流程实例id-
└─assigneestring办理人ID-
└─startTimestring开始时间-
└─endTimestring结束时间-
└─durationInMillisint64持续时间-
└─deleteReasonstring删除原因-
└─tenantIdstring租户id-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "activityId": "",
      "activityName": "",
      "activityType": "",
      "processDefinitionId": "",
      "processInstanceId": "",
      "executionId": "",
      "taskId": "",
      "calledProcessInstanceId": "",
      "assignee": "",
      "startTime": "yyyy-MM-dd HH:mm:ss",
      "endTime": "yyyy-MM-dd HH:mm:ss",
      "durationInMillis": 0,
      "deleteReason": "",
      "tenantId": ""
    }
  ]
}

根据年份，流程实例获取历史节点实例 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/historicActivity/getByProcessInstanceIdAndYear

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据年份，流程实例获取历史节点实例

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例id-
yearstringtrue年度-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/historicActivity/getByProcessInstanceIdAndYear?tenantId=&processInstanceId=&year=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─idstring主键-
└─activityIdstring节点id-
└─activityNamestring节点名称-
└─activityTypestring节点类型-
└─processDefinitionIdstring流程定义id-
└─processInstanceIdstring流程实例id-
└─executionIdstring执行实例id-
└─taskIdstring任务id-
└─calledProcessInstanceIdstring调用流程实例id-
└─assigneestring办理人ID-
└─startTimestring开始时间-
└─endTimestring结束时间-
└─durationInMillisint64持续时间-
└─deleteReasonstring删除原因-
└─tenantIdstring租户id-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "activityId": "",
      "activityName": "",
      "activityType": "",
      "processDefinitionId": "",
      "processInstanceId": "",
      "executionId": "",
      "taskId": "",
      "calledProcessInstanceId": "",
      "assignee": "",
      "startTime": "yyyy-MM-dd HH:mm:ss",
      "endTime": "yyyy-MM-dd HH:mm:ss",
      "durationInMillis": 0,
      "deleteReason": "",
      "tenantId": ""
    }
  ]
}

流程实例相关接口 ​

删除流程实例，在办件设为暂停，办结件加删除标识 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/historicProcess/deleteProcessInstance

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除流程实例，在办件设为暂停，办结件加删除标识

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例id-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/historicProcess/deleteProcessInstance

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据流程实例id获取实例 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/historicProcess/getById

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例id获取实例

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/historicProcess/getById?tenantId=&processInstanceId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─idstring主键-
└─processDefinitionIdstring流程定义id-
└─processDefinitionNamestring流程定义名称-
└─processDefinitionKeystring流程定义key-
└─processDefinitionVersionint32流程定义版本-
└─deploymentIdstring部署id-
└─startTimestring开始时间-
└─endTimestring结束时间-
└─durationInMillisint64持续时间-
└─endActivityIdstring结束节点id-
└─startUserIdstring启动用户id-
└─startActivityIdstring启动节点id-
└─deleteReasonstring删除原因-
└─superProcessInstanceIdstring超级流程实例id-
└─namestring名称-
└─descriptionstring描述-
└─variablesmap变量-
     └─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "processDefinitionId": "",
    "processDefinitionName": "",
    "processDefinitionKey": "",
    "processDefinitionVersion": 0,
    "deploymentId": "",
    "startTime": "yyyy-MM-dd HH:mm:ss",
    "endTime": "yyyy-MM-dd HH:mm:ss",
    "durationInMillis": 0,
    "endActivityId": "",
    "startUserId": "",
    "startActivityId": "",
    "deleteReason": "",
    "superProcessInstanceId": "",
    "name": "",
    "description": "",
    "variables": {
      "mapKey": {}
    }
  }
}

根据流程实例id和年度获取实例 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/historicProcess/getByIdAndYear

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例id和年度获取实例

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例id-
yearstringtrue年份-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/historicProcess/getByIdAndYear?tenantId=&processInstanceId=&year=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─idstring主键-
└─processDefinitionIdstring流程定义id-
└─processDefinitionNamestring流程定义名称-
└─processDefinitionKeystring流程定义key-
└─processDefinitionVersionint32流程定义版本-
└─deploymentIdstring部署id-
└─startTimestring开始时间-
└─endTimestring结束时间-
└─durationInMillisint64持续时间-
└─endActivityIdstring结束节点id-
└─startUserIdstring启动用户id-
└─startActivityIdstring启动节点id-
└─deleteReasonstring删除原因-
└─superProcessInstanceIdstring超级流程实例id-
└─namestring名称-
└─descriptionstring描述-
└─variablesmap变量-
     └─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "processDefinitionId": "",
    "processDefinitionName": "",
    "processDefinitionKey": "",
    "processDefinitionVersion": 0,
    "deploymentId": "",
    "startTime": "yyyy-MM-dd HH:mm:ss",
    "endTime": "yyyy-MM-dd HH:mm:ss",
    "durationInMillis": 0,
    "endActivityId": "",
    "startUserId": "",
    "startActivityId": "",
    "deleteReason": "",
    "superProcessInstanceId": "",
    "name": "",
    "description": "",
    "variables": {
      "mapKey": {}
    }
  }
}

根据父流程实例获取所有历史子流程实例 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/historicProcess/getBySuperProcessInstanceId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据父流程实例获取所有历史子流程实例

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
superProcessInstanceIdstringtrue父流程实例id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/historicProcess/getBySuperProcessInstanceId?tenantId=&superProcessInstanceId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─idstring主键-
└─processDefinitionIdstring流程定义id-
└─processDefinitionNamestring流程定义名称-
└─processDefinitionKeystring流程定义key-
└─processDefinitionVersionint32流程定义版本-
└─deploymentIdstring部署id-
└─startTimestring开始时间-
└─endTimestring结束时间-
└─durationInMillisint64持续时间-
└─endActivityIdstring结束节点id-
└─startUserIdstring启动用户id-
└─startActivityIdstring启动节点id-
└─deleteReasonstring删除原因-
└─superProcessInstanceIdstring超级流程实例id-
└─namestring名称-
└─descriptionstring描述-
└─variablesmap变量-
     └─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "processDefinitionId": "",
      "processDefinitionName": "",
      "processDefinitionKey": "",
      "processDefinitionVersion": 0,
      "deploymentId": "",
      "startTime": "yyyy-MM-dd HH:mm:ss",
      "endTime": "yyyy-MM-dd HH:mm:ss",
      "durationInMillis": 0,
      "endActivityId": "",
      "startUserId": "",
      "startActivityId": "",
      "deleteReason": "",
      "superProcessInstanceId": "",
      "name": "",
      "description": "",
      "variables": {
        "mapKey": {}
      }
    }
  ]
}

根据流程实例获取父流程实例 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/historicProcess/getSuperProcessInstanceById

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例获取父流程实例

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue父流程实例id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/historicProcess/getSuperProcessInstanceById?tenantId=&processInstanceId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─idstring主键-
└─processDefinitionIdstring流程定义id-
└─processDefinitionNamestring流程定义名称-
└─processDefinitionKeystring流程定义key-
└─processDefinitionVersionint32流程定义版本-
└─deploymentIdstring部署id-
└─startTimestring开始时间-
└─endTimestring结束时间-
└─durationInMillisint64持续时间-
└─endActivityIdstring结束节点id-
└─startUserIdstring启动用户id-
└─startActivityIdstring启动节点id-
└─deleteReasonstring删除原因-
└─superProcessInstanceIdstring超级流程实例id-
└─namestring名称-
└─descriptionstring描述-
└─variablesmap变量-
     └─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "processDefinitionId": "",
    "processDefinitionName": "",
    "processDefinitionKey": "",
    "processDefinitionVersion": 0,
    "deploymentId": "",
    "startTime": "yyyy-MM-dd HH:mm:ss",
    "endTime": "yyyy-MM-dd HH:mm:ss",
    "durationInMillis": 0,
    "endActivityId": "",
    "startUserId": "",
    "startActivityId": "",
    "deleteReason": "",
    "superProcessInstanceId": "",
    "name": "",
    "description": "",
    "variables": {
      "mapKey": {}
    }
  }
}

恢复流程实例 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/historicProcess/recoveryProcess

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 恢复流程实例

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
userIdstringtrue人员id-
processInstanceIdstringtrue流程实例id-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/historicProcess/recoveryProcess

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

彻底删除流程实例 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/historicProcess/removeProcess

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 彻底删除流程实例

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例id-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/historicProcess/removeProcess

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

设置流程优先级 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/historicProcess/setPriority

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 设置流程优先级

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例id-
prioritystringtrue优先级-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/historicProcess/setPriority

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

历史任务相关接口 ​

根据流程实例id获取历史任务（结束时间升序） ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/historicTask/findTaskByProcessInstanceIdOrByEndTimeAsc

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例id获取历史任务（结束时间升序）

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例id-
yearstringtrue年份-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/historicTask/findTaskByProcessInstanceIdOrByEndTimeAsc?tenantId=&processInstanceId=&year=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─idstring主键-
└─namestring名称-
└─descriptionstring描述-
└─ownerstring拥有者ID-
└─assigneestring办理者ID-
└─processInstanceIdstring流程实例ID-
└─executionIdstring执行实例ID-
└─processDefinitionIdstring流程定义ID-
└─taskDefinitionKeystring任务节点KEY-
└─dueDatestring过期时间-
└─parentTaskIdstring父任务ID-
└─claimTimestring签收时间-
└─deleteReasonstring删除原因-
└─startTimestring开始时间-
└─endTimestring结束时间-
└─tenantIdstring租户ID-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "name": "",
      "description": "",
      "owner": "",
      "assignee": "",
      "processInstanceId": "",
      "executionId": "",
      "processDefinitionId": "",
      "taskDefinitionKey": "",
      "dueDate": "yyyy-MM-dd HH:mm:ss",
      "parentTaskId": "",
      "claimTime": "yyyy-MM-dd HH:mm:ss",
      "deleteReason": "",
      "startTime": "yyyy-MM-dd HH:mm:ss",
      "endTime": "yyyy-MM-dd HH:mm:ss",
      "tenantId": ""
    }
  ]
}

根据流程实例id获取历史任务（开始时间升序） ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/historicTask/findTaskByProcessInstanceIdOrderByStartTimeAsc

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例id获取历史任务（开始时间升序）

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例id-
yearstringfalse年份-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/historicTask/findTaskByProcessInstanceIdOrderByStartTimeAsc?tenantId=&processInstanceId=&year=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─idstring主键-
└─namestring名称-
└─descriptionstring描述-
└─ownerstring拥有者ID-
└─assigneestring办理者ID-
└─processInstanceIdstring流程实例ID-
└─executionIdstring执行实例ID-
└─processDefinitionIdstring流程定义ID-
└─taskDefinitionKeystring任务节点KEY-
└─dueDatestring过期时间-
└─parentTaskIdstring父任务ID-
└─claimTimestring签收时间-
└─deleteReasonstring删除原因-
└─startTimestring开始时间-
└─endTimestring结束时间-
└─tenantIdstring租户ID-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "name": "",
      "description": "",
      "owner": "",
      "assignee": "",
      "processInstanceId": "",
      "executionId": "",
      "processDefinitionId": "",
      "taskDefinitionKey": "",
      "dueDate": "yyyy-MM-dd HH:mm:ss",
      "parentTaskId": "",
      "claimTime": "yyyy-MM-dd HH:mm:ss",
      "deleteReason": "",
      "startTime": "yyyy-MM-dd HH:mm:ss",
      "endTime": "yyyy-MM-dd HH:mm:ss",
      "tenantId": ""
    }
  ]
}

根据任务Id获取任务实例 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/historicTask/getById

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据任务Id获取任务实例

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
taskIdstringtrue任务id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/historicTask/getById?tenantId=&taskId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─idstring主键-
└─namestring名称-
└─descriptionstring描述-
└─ownerstring拥有者ID-
└─assigneestring办理者ID-
└─processInstanceIdstring流程实例ID-
└─executionIdstring执行实例ID-
└─processDefinitionIdstring流程定义ID-
└─taskDefinitionKeystring任务节点KEY-
└─dueDatestring过期时间-
└─parentTaskIdstring父任务ID-
└─claimTimestring签收时间-
└─deleteReasonstring删除原因-
└─startTimestring开始时间-
└─endTimestring结束时间-
└─tenantIdstring租户ID-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "name": "",
    "description": "",
    "owner": "",
    "assignee": "",
    "processInstanceId": "",
    "executionId": "",
    "processDefinitionId": "",
    "taskDefinitionKey": "",
    "dueDate": "yyyy-MM-dd HH:mm:ss",
    "parentTaskId": "",
    "claimTime": "yyyy-MM-dd HH:mm:ss",
    "deleteReason": "",
    "startTime": "yyyy-MM-dd HH:mm:ss",
    "endTime": "yyyy-MM-dd HH:mm:ss",
    "tenantId": ""
  }
}

根据流程实例获取所有历史任务实例（开始时间正序） ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/historicTask/getByProcessInstanceId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例获取所有历史任务实例（开始时间正序）

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例id-
yearstringfalse年份-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/historicTask/getByProcessInstanceId?tenantId=&processInstanceId=&year=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─idstring主键-
└─namestring名称-
└─descriptionstring描述-
└─ownerstring拥有者ID-
└─assigneestring办理者ID-
└─processInstanceIdstring流程实例ID-
└─executionIdstring执行实例ID-
└─processDefinitionIdstring流程定义ID-
└─taskDefinitionKeystring任务节点KEY-
└─dueDatestring过期时间-
└─parentTaskIdstring父任务ID-
└─claimTimestring签收时间-
└─deleteReasonstring删除原因-
└─startTimestring开始时间-
└─endTimestring结束时间-
└─tenantIdstring租户ID-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "name": "",
      "description": "",
      "owner": "",
      "assignee": "",
      "processInstanceId": "",
      "executionId": "",
      "processDefinitionId": "",
      "taskDefinitionKey": "",
      "dueDate": "yyyy-MM-dd HH:mm:ss",
      "parentTaskId": "",
      "claimTime": "yyyy-MM-dd HH:mm:ss",
      "deleteReason": "",
      "startTime": "yyyy-MM-dd HH:mm:ss",
      "endTime": "yyyy-MM-dd HH:mm:ss",
      "tenantId": ""
    }
  ]
}

根据流程实例获取所有历史任务实例（办结时间倒序） ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/historicTask/getByProcessInstanceIdOrderByEndTimeDesc

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例获取所有历史任务实例（办结时间倒序）

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例id-
yearstringfalse年份-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/historicTask/getByProcessInstanceIdOrderByEndTimeDesc?tenantId=&processInstanceId=&year=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─idstring主键-
└─namestring名称-
└─descriptionstring描述-
└─ownerstring拥有者ID-
└─assigneestring办理者ID-
└─processInstanceIdstring流程实例ID-
└─executionIdstring执行实例ID-
└─processDefinitionIdstring流程定义ID-
└─taskDefinitionKeystring任务节点KEY-
└─dueDatestring过期时间-
└─parentTaskIdstring父任务ID-
└─claimTimestring签收时间-
└─deleteReasonstring删除原因-
└─startTimestring开始时间-
└─endTimestring结束时间-
└─tenantIdstring租户ID-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "name": "",
      "description": "",
      "owner": "",
      "assignee": "",
      "processInstanceId": "",
      "executionId": "",
      "processDefinitionId": "",
      "taskDefinitionKey": "",
      "dueDate": "yyyy-MM-dd HH:mm:ss",
      "parentTaskId": "",
      "claimTime": "yyyy-MM-dd HH:mm:ss",
      "deleteReason": "",
      "startTime": "yyyy-MM-dd HH:mm:ss",
      "endTime": "yyyy-MM-dd HH:mm:ss",
      "tenantId": ""
    }
  ]
}

根据执行实例获取已经办理完成的任务数量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/historicTask/getFinishedCountByExecutionId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据执行实例获取已经办理完成的任务数量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
executionIdstringtrue执行实例id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/historicTask/getFinishedCountByExecutionId?tenantId=&executionId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataint64操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

获取当前任务的上一个任务节点，当前任务只可以是正在运行的任务实例 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/historicTask/getThePreviousTask

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取当前任务的上一个任务节点，当前任务只可以是正在运行的任务实例

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
taskIdstringtrue任务id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/historicTask/getThePreviousTask?tenantId=&taskId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─idstring主键-
└─namestring名称-
└─descriptionstring描述-
└─ownerstring拥有者ID-
└─assigneestring办理者ID-
└─processInstanceIdstring流程实例ID-
└─executionIdstring执行实例ID-
└─processDefinitionIdstring流程定义ID-
└─taskDefinitionKeystring任务节点KEY-
└─dueDatestring过期时间-
└─parentTaskIdstring父任务ID-
└─claimTimestring签收时间-
└─deleteReasonstring删除原因-
└─startTimestring开始时间-
└─endTimestring结束时间-
└─tenantIdstring租户ID-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "name": "",
    "description": "",
    "owner": "",
    "assignee": "",
    "processInstanceId": "",
    "executionId": "",
    "processDefinitionId": "",
    "taskDefinitionKey": "",
    "dueDate": "yyyy-MM-dd HH:mm:ss",
    "parentTaskId": "",
    "claimTime": "yyyy-MM-dd HH:mm:ss",
    "deleteReason": "",
    "startTime": "yyyy-MM-dd HH:mm:ss",
    "endTime": "yyyy-MM-dd HH:mm:ss",
    "tenantId": ""
  }
}

获取当前任务的上一个任务节点产生的所有任务，当前任务只可以是正在运行的任务实例 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/historicTask/getThePreviousTasks

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取当前任务的上一个任务节点产生的所有任务，当前任务只可以是正在运行的任务实例

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
taskIdstringtrue任务id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/historicTask/getThePreviousTasks?tenantId=&taskId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─idstring主键-
└─namestring名称-
└─descriptionstring描述-
└─ownerstring拥有者ID-
└─assigneestring办理者ID-
└─processInstanceIdstring流程实例ID-
└─executionIdstring执行实例ID-
└─processDefinitionIdstring流程定义ID-
└─taskDefinitionKeystring任务节点KEY-
└─dueDatestring过期时间-
└─parentTaskIdstring父任务ID-
└─claimTimestring签收时间-
└─deleteReasonstring删除原因-
└─startTimestring开始时间-
└─endTimestring结束时间-
└─tenantIdstring租户ID-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "name": "",
      "description": "",
      "owner": "",
      "assignee": "",
      "processInstanceId": "",
      "executionId": "",
      "processDefinitionId": "",
      "taskDefinitionKey": "",
      "dueDate": "yyyy-MM-dd HH:mm:ss",
      "parentTaskId": "",
      "claimTime": "yyyy-MM-dd HH:mm:ss",
      "deleteReason": "",
      "startTime": "yyyy-MM-dd HH:mm:ss",
      "endTime": "yyyy-MM-dd HH:mm:ss",
      "tenantId": ""
    }
  ]
}

设置历史任务TANENT_ID_字段，存放协办任务是否被强制办结标识 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/historicTask/setTenantId

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 设置历史任务TANENT_ID_字段，存放协办任务是否被强制办结标识

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
taskIdstringtrue任务id-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/historicTask/setTenantId

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

历史变量相关接口 ​

根据流程实例Id,获取历史流程变量集合 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/historicVariable/getByProcessInstanceId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例Id,获取历史流程变量集合

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/historicVariable/getByProcessInstanceId?tenantId=&processInstanceId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─idstring主键-
└─variableNamestring变量名称-
└─variableTypeNamestring变量类型名称-
└─valueobject变量值-
└─processInstanceIdstring流程实例id-
└─taskIdstring任务id-
└─createTimestring创建时间-
└─lastUpdatedTimestring最后更新时间-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "variableName": "",
      "variableTypeName": "",
      "value": {
        "object": "any object"
      },
      "processInstanceId": "",
      "taskId": "",
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "lastUpdatedTime": "yyyy-MM-dd HH:mm:ss"
    }
  ]
}

根据流程实例Id和流程变量的Key,获取历史流程变量的值 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/historicVariable/getByProcessInstanceIdAndVariableName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例Id和流程变量的Key,获取历史流程变量的值

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例id-
variableNamestringtrue变量名-
yearstringfalse年份-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/historicVariable/getByProcessInstanceIdAndVariableName?tenantId=&processInstanceId=&variableName=&year=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─idstring主键-
└─variableNamestring变量名称-
└─variableTypeNamestring变量类型名称-
└─valueobject变量值-
└─processInstanceIdstring流程实例id-
└─taskIdstring任务id-
└─createTimestring创建时间-
└─lastUpdatedTimestring最后更新时间-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "variableName": "",
    "variableTypeName": "",
    "value": {
      "object": "any object"
    },
    "processInstanceId": "",
    "taskId": "",
    "createTime": "yyyy-MM-dd HH:mm:ss",
    "lastUpdatedTime": "yyyy-MM-dd HH:mm:ss"
  }
}

根据任务Id,获取历史任务变量的值集合 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/historicVariable/getByTaskId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据任务Id,获取历史任务变量的值集合

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
taskIdstringtrue任务id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/historicVariable/getByTaskId?tenantId=&taskId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─idstring主键-
└─variableNamestring变量名称-
└─variableTypeNamestring变量类型名称-
└─valueobject变量值-
└─processInstanceIdstring流程实例id-
└─taskIdstring任务id-
└─createTimestring创建时间-
└─lastUpdatedTimestring最后更新时间-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "variableName": "",
      "variableTypeName": "",
      "value": {
        "object": "any object"
      },
      "processInstanceId": "",
      "taskId": "",
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "lastUpdatedTime": "yyyy-MM-dd HH:mm:ss"
    }
  ]
}

根据任务Id和变量Key,获取历史任务变量的值 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/historicVariable/getByTaskIdAndVariableName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据任务Id和变量Key,获取历史任务变量的值

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
taskIdstringtrue任务id-
variableNamestringtrue变量名-
yearstringfalse年份-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/historicVariable/getByTaskIdAndVariableName?tenantId=&taskId=&variableName=&year=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─idstring主键-
└─variableNamestring变量名称-
└─variableTypeNamestring变量类型名称-
└─valueobject变量值-
└─processInstanceIdstring流程实例id-
└─taskIdstring任务id-
└─createTimestring创建时间-
└─lastUpdatedTimestring最后更新时间-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "variableName": "",
    "variableTypeName": "",
    "value": {
      "object": "any object"
    },
    "processInstanceId": "",
    "taskId": "",
    "createTime": "yyyy-MM-dd HH:mm:ss",
    "lastUpdatedTime": "yyyy-MM-dd HH:mm:ss"
  }
}

根据流程实例Id,获取指定的流程变量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/historicVariable/getVariables

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 根据流程实例Id,获取指定的流程变量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例id-

Body-parameters:

ParameterTypeRequiredDescriptionSince
successbooleanfalse操作是否成功-
codeint32false错误代码-
msgstringfalse操作描述-
dataarrayfalse操作成功返回的数据-

Request-example:

bash
curl -X GET -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/processAdmin/services/rest/historicVariable/getVariables?tenantId=&processInstanceId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    "",
    ""
  ]
}'

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─mapKeyobjectA map key.-
     └─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "mapKey": {
      "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
    }
  }
}

流转用户信息接口 ​

获取任务的用户信息 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/identity/getIdentityLinksForTask

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取任务的用户信息

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
taskIdstringtrue任务id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/identity/getIdentityLinksForTask?tenantId=&taskId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─typestring参与者类型-
└─userIdstring参与者ID-
└─groupIdstring参与者组ID-
└─taskIdstring任务ID-
└─processInstanceIdstring流程实例ID-
└─processDefinitionIdstring流程定义ID-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "type": "",
      "userId": "",
      "groupId": "",
      "taskId": "",
      "processInstanceId": "",
      "processDefinitionId": ""
    }
  ]
}

监控流程实例接口 ​

根据流程定义Key获取监控在办件统计数量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/monitor/getDoingCountByProcessDefinitionKey

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程定义Key获取监控在办件统计数量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
processDefinitionKeystringtrue流程定义Key-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/monitor/getDoingCountByProcessDefinitionKey?tenantId=&processDefinitionKey=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataint64操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

根据系统英文名称获取监控在办件数量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/monitor/getDoingCountBySystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据系统英文名称获取监控在办件数量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
systemNamestringtrue系统英文名称-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/monitor/getDoingCountBySystemName?tenantId=&systemName=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataint64操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

根据流程定义Key获取监控在办件 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/monitor/getDoingListByProcessDefinitionKey

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程定义Key获取监控在办件

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
processDefinitionKeystringtrue流程定义Key-
pageint32true页码-
rowsint32true行数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/monitor/getDoingListByProcessDefinitionKey?page=0&rows=0&tenantId=&processDefinitionKey=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─processDefinitionIdstring流程定义id-
     └─processDefinitionNamestring流程定义名称-
     └─processDefinitionKeystring流程定义key-
     └─processDefinitionVersionint32流程定义版本-
     └─deploymentIdstring部署id-
     └─startTimestring开始时间-
     └─endTimestring结束时间-
     └─durationInMillisint64持续时间-
     └─endActivityIdstring结束节点id-
     └─startUserIdstring启动用户id-
     └─startActivityIdstring启动节点id-
     └─deleteReasonstring删除原因-
     └─superProcessInstanceIdstring超级流程实例id-
     └─namestring名称-
     └─descriptionstring描述-
     └─variablesmap变量-
          └─any objectobjectany object.-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "processDefinitionId": "",
        "processDefinitionName": "",
        "processDefinitionKey": "",
        "processDefinitionVersion": 0,
        "deploymentId": "",
        "startTime": "yyyy-MM-dd HH:mm:ss",
        "endTime": "yyyy-MM-dd HH:mm:ss",
        "durationInMillis": 0,
        "endActivityId": "",
        "startUserId": "",
        "startActivityId": "",
        "deleteReason": "",
        "superProcessInstanceId": "",
        "name": "",
        "description": "",
        "variables": {
          "mapKey": {}
        }
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据系统名称获取监控在办件 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/monitor/getDoingListBySystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据系统名称获取监控在办件

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
systemNamestringtrue系统英文名称-
pageint32true页码-
rowsint32true行数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/monitor/getDoingListBySystemName?page=0&rows=0&tenantId=&systemName=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─processDefinitionIdstring流程定义id-
     └─processDefinitionNamestring流程定义名称-
     └─processDefinitionKeystring流程定义key-
     └─processDefinitionVersionint32流程定义版本-
     └─deploymentIdstring部署id-
     └─startTimestring开始时间-
     └─endTimestring结束时间-
     └─durationInMillisint64持续时间-
     └─endActivityIdstring结束节点id-
     └─startUserIdstring启动用户id-
     └─startActivityIdstring启动节点id-
     └─deleteReasonstring删除原因-
     └─superProcessInstanceIdstring超级流程实例id-
     └─namestring名称-
     └─descriptionstring描述-
     └─variablesmap变量-
          └─any objectobjectany object.-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "processDefinitionId": "",
        "processDefinitionName": "",
        "processDefinitionKey": "",
        "processDefinitionVersion": 0,
        "deploymentId": "",
        "startTime": "yyyy-MM-dd HH:mm:ss",
        "endTime": "yyyy-MM-dd HH:mm:ss",
        "durationInMillis": 0,
        "endActivityId": "",
        "startUserId": "",
        "startActivityId": "",
        "deleteReason": "",
        "superProcessInstanceId": "",
        "name": "",
        "description": "",
        "variables": {
          "mapKey": {}
        }
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据流程定义Key获取监控办结件统计数量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/monitor/getDoneCountByProcessDefinitionKey

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程定义Key获取监控办结件统计数量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
processDefinitionKeystringtrue流程定义Key-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/monitor/getDoneCountByProcessDefinitionKey?tenantId=&processDefinitionKey=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataint64操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

根据流程定义Key获取监控回收站统计数量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/monitor/getRecycleCountByProcessDefinitionKey

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程定义Key获取监控回收站统计数量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
processDefinitionKeystringtrue流程定义Key-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/monitor/getRecycleCountByProcessDefinitionKey?tenantId=&processDefinitionKey=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataint64操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

根据系统英文名称获取监控回收站统计数量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/monitor/getRecycleCountBySystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据系统英文名称获取监控回收站统计数量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
systemNamestringtrue系统英文名称-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/monitor/getRecycleCountBySystemName?tenantId=&systemName=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataint64操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

根据人员Id，流程定义Key获取监控回收站统计数量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/monitor/getRecycleCountByUserIdAndProcessDefinitionKey

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据人员Id，流程定义Key获取监控回收站统计数量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
userIdstringtrue人员Id-
processDefinitionKeystringtrue流程定义Key-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/monitor/getRecycleCountByUserIdAndProcessDefinitionKey?tenantId=&userId=&processDefinitionKey=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataint64操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

根据人员id获取监控回收站统计数量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/monitor/getRecycleCountByUserIdAndSystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据人员id获取监控回收站统计数量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
userIdstringtrue人员Id-
systemNamestringtrue系统英文名称-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/monitor/getRecycleCountByUserIdAndSystemName?tenantId=&userId=&systemName=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataint64操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

根据流程定义key获取回收站列表 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/monitor/getRecycleListByProcessDefinitionKey

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程定义key获取回收站列表

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
processDefinitionKeystringtrue流程定义Key-
pageint32true页码-
rowsint32true行数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/monitor/getRecycleListByProcessDefinitionKey?page=0&rows=0&tenantId=&processDefinitionKey=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─processDefinitionIdstring流程定义id-
     └─processDefinitionNamestring流程定义名称-
     └─processDefinitionKeystring流程定义key-
     └─processDefinitionVersionint32流程定义版本-
     └─deploymentIdstring部署id-
     └─startTimestring开始时间-
     └─endTimestring结束时间-
     └─durationInMillisint64持续时间-
     └─endActivityIdstring结束节点id-
     └─startUserIdstring启动用户id-
     └─startActivityIdstring启动节点id-
     └─deleteReasonstring删除原因-
     └─superProcessInstanceIdstring超级流程实例id-
     └─namestring名称-
     └─descriptionstring描述-
     └─variablesmap变量-
          └─any objectobjectany object.-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "processDefinitionId": "",
        "processDefinitionName": "",
        "processDefinitionKey": "",
        "processDefinitionVersion": 0,
        "deploymentId": "",
        "startTime": "yyyy-MM-dd HH:mm:ss",
        "endTime": "yyyy-MM-dd HH:mm:ss",
        "durationInMillis": 0,
        "endActivityId": "",
        "startUserId": "",
        "startActivityId": "",
        "deleteReason": "",
        "superProcessInstanceId": "",
        "name": "",
        "description": "",
        "variables": {
          "mapKey": {}
        }
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据系统英文名称获取回收站列表 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/monitor/getRecycleListBySystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据系统英文名称获取回收站列表

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
systemNamestringtrue系统英文名称-
pageint32true页码-
rowsint32true行数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/monitor/getRecycleListBySystemName?page=0&rows=0&tenantId=&systemName=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─processDefinitionIdstring流程定义id-
     └─processDefinitionNamestring流程定义名称-
     └─processDefinitionKeystring流程定义key-
     └─processDefinitionVersionint32流程定义版本-
     └─deploymentIdstring部署id-
     └─startTimestring开始时间-
     └─endTimestring结束时间-
     └─durationInMillisint64持续时间-
     └─endActivityIdstring结束节点id-
     └─startUserIdstring启动用户id-
     └─startActivityIdstring启动节点id-
     └─deleteReasonstring删除原因-
     └─superProcessInstanceIdstring超级流程实例id-
     └─namestring名称-
     └─descriptionstring描述-
     └─variablesmap变量-
          └─any objectobjectany object.-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "processDefinitionId": "",
        "processDefinitionName": "",
        "processDefinitionKey": "",
        "processDefinitionVersion": 0,
        "deploymentId": "",
        "startTime": "yyyy-MM-dd HH:mm:ss",
        "endTime": "yyyy-MM-dd HH:mm:ss",
        "durationInMillis": 0,
        "endActivityId": "",
        "startUserId": "",
        "startActivityId": "",
        "deleteReason": "",
        "superProcessInstanceId": "",
        "name": "",
        "description": "",
        "variables": {
          "mapKey": {}
        }
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据流程定义Key获取传入用户id相关的回收站列表 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/monitor/getRecycleListByUserIdAndProcessDefinitionKey

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程定义Key获取传入用户id相关的回收站列表

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
userIdstringtrue用户Id-
processDefinitionKeystringtrue流程定义Key-
pageint32true页码-
rowsint32true行数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/monitor/getRecycleListByUserIdAndProcessDefinitionKey?page=0&rows=0&tenantId=&userId=&processDefinitionKey=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─processDefinitionIdstring流程定义id-
     └─processDefinitionNamestring流程定义名称-
     └─processDefinitionKeystring流程定义key-
     └─processDefinitionVersionint32流程定义版本-
     └─deploymentIdstring部署id-
     └─startTimestring开始时间-
     └─endTimestring结束时间-
     └─durationInMillisint64持续时间-
     └─endActivityIdstring结束节点id-
     └─startUserIdstring启动用户id-
     └─startActivityIdstring启动节点id-
     └─deleteReasonstring删除原因-
     └─superProcessInstanceIdstring超级流程实例id-
     └─namestring名称-
     └─descriptionstring描述-
     └─variablesmap变量-
          └─any objectobjectany object.-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "processDefinitionId": "",
        "processDefinitionName": "",
        "processDefinitionKey": "",
        "processDefinitionVersion": 0,
        "deploymentId": "",
        "startTime": "yyyy-MM-dd HH:mm:ss",
        "endTime": "yyyy-MM-dd HH:mm:ss",
        "durationInMillis": 0,
        "endActivityId": "",
        "startUserId": "",
        "startActivityId": "",
        "deleteReason": "",
        "superProcessInstanceId": "",
        "name": "",
        "description": "",
        "variables": {
          "mapKey": {}
        }
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据人员id，系统英文名称获取回收站列表 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/monitor/getRecycleListByUserIdAndSystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据人员id，系统英文名称获取回收站列表

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
userIdstringtrue人员Id-
systemNamestringtrue系统英文名称-
pageint32true当前页-
rowsint32true总条数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/monitor/getRecycleListByUserIdAndSystemName?page=0&rows=0&tenantId=&userId=&systemName=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─processDefinitionIdstring流程定义id-
     └─processDefinitionNamestring流程定义名称-
     └─processDefinitionKeystring流程定义key-
     └─processDefinitionVersionint32流程定义版本-
     └─deploymentIdstring部署id-
     └─startTimestring开始时间-
     └─endTimestring结束时间-
     └─durationInMillisint64持续时间-
     └─endActivityIdstring结束节点id-
     └─startUserIdstring启动用户id-
     └─startActivityIdstring启动节点id-
     └─deleteReasonstring删除原因-
     └─superProcessInstanceIdstring超级流程实例id-
     └─namestring名称-
     └─descriptionstring描述-
     └─variablesmap变量-
          └─any objectobjectany object.-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "processDefinitionId": "",
        "processDefinitionName": "",
        "processDefinitionKey": "",
        "processDefinitionVersion": 0,
        "deploymentId": "",
        "startTime": "yyyy-MM-dd HH:mm:ss",
        "endTime": "yyyy-MM-dd HH:mm:ss",
        "durationInMillis": 0,
        "endActivityId": "",
        "startUserId": "",
        "startActivityId": "",
        "deleteReason": "",
        "superProcessInstanceId": "",
        "name": "",
        "description": "",
        "variables": {
          "mapKey": {}
        }
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据流程定义Key和其他条件搜索在办件 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/monitor/searchDoingListByProcessDefinitionKey

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程定义Key和其他条件搜索在办件

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processDefinitionKeystringtrue流程定义Key-
searchTermstringtrue搜索词-
pageint32true页码-
rowsint32true行数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/monitor/searchDoingListByProcessDefinitionKey?page=0&rows=0&tenantId=&processDefinitionKey=&searchTerm=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─processDefinitionIdstring流程定义id-
     └─processDefinitionNamestring流程定义名称-
     └─processDefinitionKeystring流程定义key-
     └─processDefinitionVersionint32流程定义版本-
     └─deploymentIdstring部署id-
     └─startTimestring开始时间-
     └─endTimestring结束时间-
     └─durationInMillisint64持续时间-
     └─endActivityIdstring结束节点id-
     └─startUserIdstring启动用户id-
     └─startActivityIdstring启动节点id-
     └─deleteReasonstring删除原因-
     └─superProcessInstanceIdstring超级流程实例id-
     └─namestring名称-
     └─descriptionstring描述-
     └─variablesmap变量-
          └─any objectobjectany object.-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "processDefinitionId": "",
        "processDefinitionName": "",
        "processDefinitionKey": "",
        "processDefinitionVersion": 0,
        "deploymentId": "",
        "startTime": "yyyy-MM-dd HH:mm:ss",
        "endTime": "yyyy-MM-dd HH:mm:ss",
        "durationInMillis": 0,
        "endActivityId": "",
        "startUserId": "",
        "startActivityId": "",
        "deleteReason": "",
        "superProcessInstanceId": "",
        "name": "",
        "description": "",
        "variables": {
          "mapKey": {}
        }
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据系统英文名称和其他条件搜索在办件 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/monitor/searchDoingListBySystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据系统英文名称和其他条件搜索在办件

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
systemNamestringtrue系统英文名称-
searchTermstringtrue搜索词-
pageint32true页码-
rowsint32true行数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/monitor/searchDoingListBySystemName?page=0&rows=0&tenantId=&systemName=&searchTerm=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─processDefinitionIdstring流程定义id-
     └─processDefinitionNamestring流程定义名称-
     └─processDefinitionKeystring流程定义key-
     └─processDefinitionVersionint32流程定义版本-
     └─deploymentIdstring部署id-
     └─startTimestring开始时间-
     └─endTimestring结束时间-
     └─durationInMillisint64持续时间-
     └─endActivityIdstring结束节点id-
     └─startUserIdstring启动用户id-
     └─startActivityIdstring启动节点id-
     └─deleteReasonstring删除原因-
     └─superProcessInstanceIdstring超级流程实例id-
     └─namestring名称-
     └─descriptionstring描述-
     └─variablesmap变量-
          └─any objectobjectany object.-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "processDefinitionId": "",
        "processDefinitionName": "",
        "processDefinitionKey": "",
        "processDefinitionVersion": 0,
        "deploymentId": "",
        "startTime": "yyyy-MM-dd HH:mm:ss",
        "endTime": "yyyy-MM-dd HH:mm:ss",
        "durationInMillis": 0,
        "endActivityId": "",
        "startUserId": "",
        "startActivityId": "",
        "deleteReason": "",
        "superProcessInstanceId": "",
        "name": "",
        "description": "",
        "variables": {
          "mapKey": {}
        }
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据流程定义Key和其他条件搜索回收站件 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/monitor/searchRecycleListByProcessDefinitionKey

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程定义Key和其他条件搜索回收站件

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processDefinitionKeystringtrue流程定义Key-
searchTermstringtrue搜索词-
pageint32true页码-
rowsint32true行数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/monitor/searchRecycleListByProcessDefinitionKey?page=0&rows=0&tenantId=&processDefinitionKey=&searchTerm=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─processDefinitionIdstring流程定义id-
     └─processDefinitionNamestring流程定义名称-
     └─processDefinitionKeystring流程定义key-
     └─processDefinitionVersionint32流程定义版本-
     └─deploymentIdstring部署id-
     └─startTimestring开始时间-
     └─endTimestring结束时间-
     └─durationInMillisint64持续时间-
     └─endActivityIdstring结束节点id-
     └─startUserIdstring启动用户id-
     └─startActivityIdstring启动节点id-
     └─deleteReasonstring删除原因-
     └─superProcessInstanceIdstring超级流程实例id-
     └─namestring名称-
     └─descriptionstring描述-
     └─variablesmap变量-
          └─any objectobjectany object.-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "processDefinitionId": "",
        "processDefinitionName": "",
        "processDefinitionKey": "",
        "processDefinitionVersion": 0,
        "deploymentId": "",
        "startTime": "yyyy-MM-dd HH:mm:ss",
        "endTime": "yyyy-MM-dd HH:mm:ss",
        "durationInMillis": 0,
        "endActivityId": "",
        "startUserId": "",
        "startActivityId": "",
        "deleteReason": "",
        "superProcessInstanceId": "",
        "name": "",
        "description": "",
        "variables": {
          "mapKey": {}
        }
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据系统英文名称和其他条件搜索回收站件 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/monitor/searchRecycleListBySystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据系统英文名称和其他条件搜索回收站件

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
systemNamestringtrue系统英文名称-
searchTermstringtrue搜索词-
pageint32true页码-
rowsint32true行数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/monitor/searchRecycleListBySystemName?page=0&rows=0&tenantId=&systemName=&searchTerm=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─processDefinitionIdstring流程定义id-
     └─processDefinitionNamestring流程定义名称-
     └─processDefinitionKeystring流程定义key-
     └─processDefinitionVersionint32流程定义版本-
     └─deploymentIdstring部署id-
     └─startTimestring开始时间-
     └─endTimestring结束时间-
     └─durationInMillisint64持续时间-
     └─endActivityIdstring结束节点id-
     └─startUserIdstring启动用户id-
     └─startActivityIdstring启动节点id-
     └─deleteReasonstring删除原因-
     └─superProcessInstanceIdstring超级流程实例id-
     └─namestring名称-
     └─descriptionstring描述-
     └─variablesmap变量-
          └─any objectobjectany object.-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "processDefinitionId": "",
        "processDefinitionName": "",
        "processDefinitionKey": "",
        "processDefinitionVersion": 0,
        "deploymentId": "",
        "startTime": "yyyy-MM-dd HH:mm:ss",
        "endTime": "yyyy-MM-dd HH:mm:ss",
        "durationInMillis": 0,
        "endActivityId": "",
        "startUserId": "",
        "startActivityId": "",
        "deleteReason": "",
        "superProcessInstanceId": "",
        "name": "",
        "description": "",
        "variables": {
          "mapKey": {}
        }
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据用户Id，流程定义Key和其他条件搜索回收站件 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/monitor/searchRecycleListByUserIdAndProcessDefinitionKey

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据用户Id，流程定义Key和其他条件搜索回收站件

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
userIdstringtrue用户Id-
processDefinitionKeystringtrue流程定义Key-
searchTermstringtrue搜索词-
pageint32true页码-
rowsint32true行数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/monitor/searchRecycleListByUserIdAndProcessDefinitionKey?page=0&rows=0&tenantId=&userId=&processDefinitionKey=&searchTerm=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─processDefinitionIdstring流程定义id-
     └─processDefinitionNamestring流程定义名称-
     └─processDefinitionKeystring流程定义key-
     └─processDefinitionVersionint32流程定义版本-
     └─deploymentIdstring部署id-
     └─startTimestring开始时间-
     └─endTimestring结束时间-
     └─durationInMillisint64持续时间-
     └─endActivityIdstring结束节点id-
     └─startUserIdstring启动用户id-
     └─startActivityIdstring启动节点id-
     └─deleteReasonstring删除原因-
     └─superProcessInstanceIdstring超级流程实例id-
     └─namestring名称-
     └─descriptionstring描述-
     └─variablesmap变量-
          └─any objectobjectany object.-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "processDefinitionId": "",
        "processDefinitionName": "",
        "processDefinitionKey": "",
        "processDefinitionVersion": 0,
        "deploymentId": "",
        "startTime": "yyyy-MM-dd HH:mm:ss",
        "endTime": "yyyy-MM-dd HH:mm:ss",
        "durationInMillis": 0,
        "endActivityId": "",
        "startUserId": "",
        "startActivityId": "",
        "deleteReason": "",
        "superProcessInstanceId": "",
        "name": "",
        "description": "",
        "variables": {
          "mapKey": {}
        }
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据用户Id，系统英文名称和其他条件搜索回收站件 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/monitor/searchRecycleListByUserIdAndSystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据用户Id，系统英文名称和其他条件搜索回收站件

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
userIdstringtrue用户Id-
systemNamestringtrue系统英文名称-
searchTermstringtrue搜索词-
pageint32true页码-
rowsint32true行数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/monitor/searchRecycleListByUserIdAndSystemName?page=0&rows=0&tenantId=&userId=&systemName=&searchTerm=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─processDefinitionIdstring流程定义id-
     └─processDefinitionNamestring流程定义名称-
     └─processDefinitionKeystring流程定义key-
     └─processDefinitionVersionint32流程定义版本-
     └─deploymentIdstring部署id-
     └─startTimestring开始时间-
     └─endTimestring结束时间-
     └─durationInMillisint64持续时间-
     └─endActivityIdstring结束节点id-
     └─startUserIdstring启动用户id-
     └─startActivityIdstring启动节点id-
     └─deleteReasonstring删除原因-
     └─superProcessInstanceIdstring超级流程实例id-
     └─namestring名称-
     └─descriptionstring描述-
     └─variablesmap变量-
          └─any objectobjectany object.-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "processDefinitionId": "",
        "processDefinitionName": "",
        "processDefinitionKey": "",
        "processDefinitionVersion": 0,
        "deploymentId": "",
        "startTime": "yyyy-MM-dd HH:mm:ss",
        "endTime": "yyyy-MM-dd HH:mm:ss",
        "durationInMillis": 0,
        "endActivityId": "",
        "startUserId": "",
        "startActivityId": "",
        "deleteReason": "",
        "superProcessInstanceId": "",
        "name": "",
        "description": "",
        "variables": {
          "mapKey": {}
        }
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

流程定义数据复制接口 ​

复制拷贝流程定义数据 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processDataCopy/copyModel

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 复制拷贝流程定义数据

Query-parameters:

ParameterTypeRequiredDescriptionSince
sourceTenantIdstringtrue源租户id-
targetTenantIdstringtrue目标租户id-
modelKeystringtrue定义key-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/processDataCopy/copyModel

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

流程定义相关接口 ​

获取有办结权限的UserTask ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/getContainEndEvent4UserTask

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取有办结权限的UserTask

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
processDefinitionIdstringtrue流程定义id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/getContainEndEvent4UserTask?tenantId=&processDefinitionId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─taskDefKeystring节点key-
└─taskDefNamestring任务名称（线上名称存在这里就是线的名字）-
└─multiInstancestring多实例类型-
└─typestring节点类型-
└─conditionExpressionstring条件表达式-
└─realTaskDefNamestring实际任务名称-
└─commonButtonNamesstring节点绑定的普通按钮-
└─sendButtonNamesstring节点绑定的发送按钮-
└─opinionFrameNamesstring节点绑定的意见框名称-
└─bindNamesstring节点绑定的编号信息-
└─roleNamesstring节点绑定的角色信息-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "taskDefKey": "",
      "taskDefName": "",
      "multiInstance": "",
      "type": "",
      "conditionExpression": "",
      "realTaskDefName": "",
      "commonButtonNames": "",
      "sendButtonNames": "",
      "opinionFrameNames": "",
      "bindNames": "",
      "roleNames": ""
    }
  ]
}

获取某一任务所在节点的目标是结束节点的目标节点Key ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/getEndNodeKeyByTaskId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取某一任务所在节点的目标是结束节点的目标节点Key

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
taskIdstringtrue任务id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/getEndNodeKeyByTaskId?tenantId=&taskId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
datastring操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

根据流程定义Id获取节点,路由信息 isContainStartNode为true时，不包含开始节点 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/getFlowElement

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程定义Id获取节点,路由信息 isContainStartNode为true时，不包含开始节点

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
processDefinitionIdstringtrue流程定义id-
isContainStartNodebooleantrue是否包含开始节点-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/getFlowElement?isContainStartNode=true&tenantId=&processDefinitionId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─elementKeystring元素key-
└─elementNamestring元素名称-
└─multiInstancestring元素类型 UserTask SequenceFlow-
└─typestring节点类型-
└─bindbooleanNo comments found.-
└─conditionstringNo comments found.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "elementKey": "",
      "elementName": "",
      "multiInstance": "",
      "type": "",
      "bind": true,
      "condition": ""
    }
  ]
}

根据流程定义Id获取节点信息 isContainStartNode为true时，不包含开始节点 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/getNodes

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程定义Id获取节点信息 isContainStartNode为true时，不包含开始节点

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
processDefinitionIdstringtrue流程定义id-
isContainStartNodebooleantrue是否包含开始节点-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/getNodes?isContainStartNode=true&tenantId=&processDefinitionId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─taskDefKeystring节点key-
└─taskDefNamestring任务名称（线上名称存在这里就是线的名字）-
└─multiInstancestring多实例类型-
└─typestring节点类型-
└─conditionExpressionstring条件表达式-
└─realTaskDefNamestring实际任务名称-
└─commonButtonNamesstring节点绑定的普通按钮-
└─sendButtonNamesstring节点绑定的发送按钮-
└─opinionFrameNamesstring节点绑定的意见框名称-
└─bindNamesstring节点绑定的编号信息-
└─roleNamesstring节点绑定的角色信息-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "taskDefKey": "",
      "taskDefName": "",
      "multiInstance": "",
      "type": "",
      "conditionExpression": "",
      "realTaskDefName": "",
      "commonButtonNames": "",
      "sendButtonNames": "",
      "opinionFrameNames": "",
      "bindNames": "",
      "roleNames": ""
    }
  ]
}

获取具体流程的某个节点类型 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/getNodeType

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取具体流程的某个节点类型

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
processDefinitionIdstringtrue流程定义id-
taskDefKeystringtrue任务key-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/getNodeType?tenantId=&processDefinitionId=&taskDefKey=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
datastring操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

根据taskId获取某个节点除去end节点和默认路由节点的所有的输出线路的个数 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/getOutPutNodeCount

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据taskId获取某个节点除去end节点和默认路由节点的所有的输出线路的个数

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
taskIdstringtrue任务id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/getOutPutNodeCount?tenantId=&taskId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataint32操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

根据流程定义Id和流程节点Key获取目标任务节点集合 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/getParallelGatewayList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程定义Id和流程节点Key获取目标任务节点集合

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
processDefinitionIdstringtrue流程定义id-
taskDefKeystringtrue任务key-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/getParallelGatewayList?tenantId=&processDefinitionId=&taskDefKey=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─taskDefKeystring节点key-
└─taskDefNamestring任务名称（线上名称存在这里就是线的名字）-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "taskDefKey": "",
      "taskDefName": ""
    }
  ]
}

根据流程定义id获取开始节点 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/getStartNodeKeyByProcessDefinitionId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程定义id获取开始节点

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
processDefinitionIdstringtrue流程定义id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/getStartNodeKeyByProcessDefinitionId?tenantId=&processDefinitionId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
datastring操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

根据流程定义key获取最新版本的流程定义的启动节点的taskdefineKey ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/getStartNodeKeyByProcessDefinitionKey

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程定义key获取最新版本的流程定义的启动节点的taskdefineKey

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
processDefinitionKeystringtrue流程定义Key-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/getStartNodeKeyByProcessDefinitionKey?tenantId=&processDefinitionKey=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
datastring操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

根据流程定义Id和流程节点Key获取目标任务节点集合 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/getTargetNodes

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程定义Id和流程节点Key获取目标任务节点集合

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
processDefinitionIdstringtrue流程定义id-
taskDefKeystringtrue任务key-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/getTargetNodes?tenantId=&processDefinitionId=&taskDefKey=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─taskDefKeystring节点key-
└─taskDefNamestring任务名称（线上名称存在这里就是线的名字）-
└─multiInstancestring多实例类型-
└─typestring节点类型-
└─conditionExpressionstring条件表达式-
└─realTaskDefNamestring实际任务名称-
└─commonButtonNamesstring节点绑定的普通按钮-
└─sendButtonNamesstring节点绑定的发送按钮-
└─opinionFrameNamesstring节点绑定的意见框名称-
└─bindNamesstring节点绑定的编号信息-
└─roleNamesstring节点绑定的角色信息-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "taskDefKey": "",
      "taskDefName": "",
      "multiInstance": "",
      "type": "",
      "conditionExpression": "",
      "realTaskDefName": "",
      "commonButtonNames": "",
      "sendButtonNames": "",
      "opinionFrameNames": "",
      "bindNames": "",
      "roleNames": ""
    }
  ]
}

根据流程定义Id和流程节点Key获取目标任务节点集合,去除名称相等的节点，并且加上结束节点 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/getTargetNodes1

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程定义Id和流程节点Key获取目标任务节点集合,去除名称相等的节点，并且加上结束节点

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
processDefinitionIdstringtrue流程定义id-
taskDefKeystringtrue任务key-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/getTargetNodes1?tenantId=&processDefinitionId=&taskDefKey=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─taskDefKeystring节点key-
└─taskDefNamestring任务名称（线上名称存在这里就是线的名字）-
└─multiInstancestring多实例类型-
└─typestring节点类型-
└─conditionExpressionstring条件表达式-
└─realTaskDefNamestring实际任务名称-
└─commonButtonNamesstring节点绑定的普通按钮-
└─sendButtonNamesstring节点绑定的发送按钮-
└─opinionFrameNamesstring节点绑定的意见框名称-
└─bindNamesstring节点绑定的编号信息-
└─roleNamesstring节点绑定的角色信息-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "taskDefKey": "",
      "taskDefName": "",
      "multiInstance": "",
      "type": "",
      "conditionExpression": "",
      "realTaskDefName": "",
      "commonButtonNames": "",
      "sendButtonNames": "",
      "opinionFrameNames": "",
      "bindNames": "",
      "roleNames": ""
    }
  ]
}

根据流程定义Id和流程节点Key获取目标任务节点集合 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/getTargetNodes4ParallelGateway

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程定义Id和流程节点Key获取目标任务节点集合

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
processDefinitionIdstringtrue流程定义id-
taskDefKeystringtrue任务key-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/getTargetNodes4ParallelGateway?tenantId=&processDefinitionId=&taskDefKey=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─taskDefKeystring节点key-
└─taskDefNamestring任务名称（线上名称存在这里就是线的名字）-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "taskDefKey": "",
      "taskDefName": ""
    }
  ]
}

根据流程定义Id和流程节点Key获取目标任务节点集合（可设置是否包含结束节点） ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/getTargetNodes4UserTask

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程定义Id和流程节点Key获取目标任务节点集合（可设置是否包含结束节点）

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
processDefinitionIdstringtrue流程定义id-
taskDefKeystringtrue任务key-
isContainEndNodebooleantrue是否包含结束节点-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/getTargetNodes4UserTask?isContainEndNode=true&tenantId=&processDefinitionId=&taskDefKey=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─taskDefKeystring节点key-
└─taskDefNamestring任务名称（线上名称存在这里就是线的名字）-
└─multiInstancestring多实例类型-
└─typestring节点类型-
└─conditionExpressionstring条件表达式-
└─realTaskDefNamestring实际任务名称-
└─commonButtonNamesstring节点绑定的普通按钮-
└─sendButtonNamesstring节点绑定的发送按钮-
└─opinionFrameNamesstring节点绑定的意见框名称-
└─bindNamesstring节点绑定的编号信息-
└─roleNamesstring节点绑定的角色信息-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "taskDefKey": "",
      "taskDefName": "",
      "multiInstance": "",
      "type": "",
      "conditionExpression": "",
      "realTaskDefName": "",
      "commonButtonNames": "",
      "sendButtonNames": "",
      "opinionFrameNames": "",
      "bindNames": "",
      "roleNames": ""
    }
  ]
}

判断流程定义的节点是否是callActivity节点 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/isCallActivity

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 判断流程定义的节点是否是callActivity节点

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
processDefinitionIdstringtrue流程定义id-
taskDefKeystringtrue任务key-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/isCallActivity?tenantId=&processDefinitionId=&taskDefKey=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
databoolean操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": true
}

查找当前任务节点的输出目标节点中是否包含某一类型的特定节点 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/isContainNodeType

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 查找当前任务节点的输出目标节点中是否包含某一类型的特定节点

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
taskIdstringtrue任务id-
nodeTypestringtrue节点类型-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processDefinition/isContainNodeType?tenantId=&taskId=&nodeType=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
databoolean操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": true
}

在办件列表 ​

根据人员id获取在办件统计 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/doing/getCountByUserId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据人员id获取在办件统计

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
userIdstringtrue人员Id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/doing/getCountByUserId?tenantId=&userId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataint64操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

根据人员Id获取用户的在办任务(分页,包含流程变量) ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/doing/getListByUserId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据人员Id获取用户的在办任务(分页,包含流程变量)

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
userIdstringtrue人员id-
pageint32true页码-
rowsint32true行数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/doing/getListByUserId?page=0&rows=0&tenantId=&userId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─suspendedboolean是否挂起-
     └─endedboolean是否结束-
     └─namestring名称-
     └─descriptionstring描述-
     └─processDefinitionIdstring流程定义id-
     └─processDefinitionNamestring流程定义名称-
     └─processDefinitionKeystring流程定义key-
     └─processDefinitionVersionint32流程定义版本-
     └─deploymentIdstring部署id-
     └─startTimestring开始时间-
     └─endTimestring结束时间-
     └─startUserIdstring开始用户id-
     └─variablesmap流程变量-
          └─any objectobjectany object.-
     └─activityNamestring活动节点-
     └─startUserNamestring启动用户名称-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "suspended": true,
        "ended": true,
        "name": "",
        "description": "",
        "processDefinitionId": "",
        "processDefinitionName": "",
        "processDefinitionKey": "",
        "processDefinitionVersion": 0,
        "deploymentId": "",
        "startTime": "yyyy-MM-dd HH:mm:ss",
        "endTime": "yyyy-MM-dd HH:mm:ss",
        "startUserId": "",
        "variables": {
          "mapKey": {}
        },
        "activityName": "",
        "startUserName": ""
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据人员Id,事项ID获取用户的在办列表(分页,包含流程变量) ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/doing/getListByUserIdAndProcessDefinitionKey

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据人员Id,事项ID获取用户的在办列表(分页,包含流程变量)

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
userIdstringtrue人员id-
processDefinitionKeystringtrue流程定义Key-
pageint32true页码-
rowsint32true行数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/doing/getListByUserIdAndProcessDefinitionKey?page=0&rows=0&tenantId=&userId=&processDefinitionKey=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─suspendedboolean是否挂起-
     └─endedboolean是否结束-
     └─namestring名称-
     └─descriptionstring描述-
     └─processDefinitionIdstring流程定义id-
     └─processDefinitionNamestring流程定义名称-
     └─processDefinitionKeystring流程定义key-
     └─processDefinitionVersionint32流程定义版本-
     └─deploymentIdstring部署id-
     └─startTimestring开始时间-
     └─endTimestring结束时间-
     └─startUserIdstring开始用户id-
     └─variablesmap流程变量-
          └─any objectobjectany object.-
     └─activityNamestring活动节点-
     └─startUserNamestring启动用户名称-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "suspended": true,
        "ended": true,
        "name": "",
        "description": "",
        "processDefinitionId": "",
        "processDefinitionName": "",
        "processDefinitionKey": "",
        "processDefinitionVersion": 0,
        "deploymentId": "",
        "startTime": "yyyy-MM-dd HH:mm:ss",
        "endTime": "yyyy-MM-dd HH:mm:ss",
        "startUserId": "",
        "variables": {
          "mapKey": {}
        },
        "activityName": "",
        "startUserName": ""
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

获取已办件列表，按办理的时间排序 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/doing/getListByUserIdAndProcessDefinitionKeyOrderBySendTime

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取已办件列表，按办理的时间排序

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
userIdstringtrue人员id-
processDefinitionKeystringtrue流程定义key-
pageint32true页码-
rowsint32true行数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/doing/getListByUserIdAndProcessDefinitionKeyOrderBySendTime?page=0&rows=0&tenantId=&userId=&processDefinitionKey=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─suspendedboolean是否挂起-
     └─endedboolean是否结束-
     └─namestring名称-
     └─descriptionstring描述-
     └─processDefinitionIdstring流程定义id-
     └─processDefinitionNamestring流程定义名称-
     └─processDefinitionKeystring流程定义key-
     └─processDefinitionVersionint32流程定义版本-
     └─deploymentIdstring部署id-
     └─startTimestring开始时间-
     └─endTimestring结束时间-
     └─startUserIdstring开始用户id-
     └─variablesmap流程变量-
          └─any objectobjectany object.-
     └─activityNamestring活动节点-
     └─startUserNamestring启动用户名称-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "suspended": true,
        "ended": true,
        "name": "",
        "description": "",
        "processDefinitionId": "",
        "processDefinitionName": "",
        "processDefinitionKey": "",
        "processDefinitionVersion": 0,
        "deploymentId": "",
        "startTime": "yyyy-MM-dd HH:mm:ss",
        "endTime": "yyyy-MM-dd HH:mm:ss",
        "startUserId": "",
        "variables": {
          "mapKey": {}
        },
        "activityName": "",
        "startUserName": ""
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据人员Id,系统标识获取用户的在办列表(分页,包含流程变量) ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/doing/getListByUserIdAndSystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据人员Id,系统标识获取用户的在办列表(分页,包含流程变量)

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
userIdstringtrue人员id-
systemNamestringtrue英文系统名称-
pageint32true页码-
rowsint32true行数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/doing/getListByUserIdAndSystemName?page=0&rows=0&tenantId=&userId=&systemName=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─suspendedboolean是否挂起-
     └─endedboolean是否结束-
     └─namestring名称-
     └─descriptionstring描述-
     └─processDefinitionIdstring流程定义id-
     └─processDefinitionNamestring流程定义名称-
     └─processDefinitionKeystring流程定义key-
     └─processDefinitionVersionint32流程定义版本-
     └─deploymentIdstring部署id-
     └─startTimestring开始时间-
     └─endTimestring结束时间-
     └─startUserIdstring开始用户id-
     └─variablesmap流程变量-
          └─any objectobjectany object.-
     └─activityNamestring活动节点-
     └─startUserNamestring启动用户名称-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "suspended": true,
        "ended": true,
        "name": "",
        "description": "",
        "processDefinitionId": "",
        "processDefinitionName": "",
        "processDefinitionKey": "",
        "processDefinitionVersion": 0,
        "deploymentId": "",
        "startTime": "yyyy-MM-dd HH:mm:ss",
        "endTime": "yyyy-MM-dd HH:mm:ss",
        "startUserId": "",
        "variables": {
          "mapKey": {}
        },
        "activityName": "",
        "startUserName": ""
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

条件搜索在办件 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/doing/searchListByUserId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 条件搜索在办件

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
userIdstringtrue人员id-
searchTermstringtrue搜索词-
pageint32true页码-
rowsint32true行数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/doing/searchListByUserId?page=0&rows=0&tenantId=&userId=&searchTerm=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─suspendedboolean是否挂起-
     └─endedboolean是否结束-
     └─namestring名称-
     └─descriptionstring描述-
     └─processDefinitionIdstring流程定义id-
     └─processDefinitionNamestring流程定义名称-
     └─processDefinitionKeystring流程定义key-
     └─processDefinitionVersionint32流程定义版本-
     └─deploymentIdstring部署id-
     └─startTimestring开始时间-
     └─endTimestring结束时间-
     └─startUserIdstring开始用户id-
     └─variablesmap流程变量-
          └─any objectobjectany object.-
     └─activityNamestring活动节点-
     └─startUserNamestring启动用户名称-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "suspended": true,
        "ended": true,
        "name": "",
        "description": "",
        "processDefinitionId": "",
        "processDefinitionName": "",
        "processDefinitionKey": "",
        "processDefinitionVersion": 0,
        "deploymentId": "",
        "startTime": "yyyy-MM-dd HH:mm:ss",
        "endTime": "yyyy-MM-dd HH:mm:ss",
        "startUserId": "",
        "variables": {
          "mapKey": {}
        },
        "activityName": "",
        "startUserName": ""
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据流程定义key和其他条件搜索在办件 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/doing/searchListByUserIdAndProcessDefinitionKey

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程定义key和其他条件搜索在办件

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
userIdstringtrue人员id-
processDefinitionKeystringtrue流程定义Key-
searchTermstringfalse搜索词-
pageint32true页码-
rowsint32true行数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/doing/searchListByUserIdAndProcessDefinitionKey?page=0&rows=0&tenantId=&userId=&processDefinitionKey=&searchTerm=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─suspendedboolean是否挂起-
     └─endedboolean是否结束-
     └─namestring名称-
     └─descriptionstring描述-
     └─processDefinitionIdstring流程定义id-
     └─processDefinitionNamestring流程定义名称-
     └─processDefinitionKeystring流程定义key-
     └─processDefinitionVersionint32流程定义版本-
     └─deploymentIdstring部署id-
     └─startTimestring开始时间-
     └─endTimestring结束时间-
     └─startUserIdstring开始用户id-
     └─variablesmap流程变量-
          └─any objectobjectany object.-
     └─activityNamestring活动节点-
     └─startUserNamestring启动用户名称-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "suspended": true,
        "ended": true,
        "name": "",
        "description": "",
        "processDefinitionId": "",
        "processDefinitionName": "",
        "processDefinitionKey": "",
        "processDefinitionVersion": 0,
        "deploymentId": "",
        "startTime": "yyyy-MM-dd HH:mm:ss",
        "endTime": "yyyy-MM-dd HH:mm:ss",
        "startUserId": "",
        "variables": {
          "mapKey": {}
        },
        "activityName": "",
        "startUserName": ""
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据系统名称和其他条件搜索在办件 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/doing/searchListByUserIdAndSystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据系统名称和其他条件搜索在办件

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
userIdstringtrue人员id-
systemNamestringtrue英文系统名称-
searchTermstringtrue搜索词-
pageint32true页码-
rowsint32true行数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/doing/searchListByUserIdAndSystemName?page=0&rows=0&tenantId=&userId=&systemName=&searchTerm=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─suspendedboolean是否挂起-
     └─endedboolean是否结束-
     └─namestring名称-
     └─descriptionstring描述-
     └─processDefinitionIdstring流程定义id-
     └─processDefinitionNamestring流程定义名称-
     └─processDefinitionKeystring流程定义key-
     └─processDefinitionVersionint32流程定义版本-
     └─deploymentIdstring部署id-
     └─startTimestring开始时间-
     └─endTimestring结束时间-
     └─startUserIdstring开始用户id-
     └─variablesmap流程变量-
          └─any objectobjectany object.-
     └─activityNamestring活动节点-
     └─startUserNamestring启动用户名称-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "suspended": true,
        "ended": true,
        "name": "",
        "description": "",
        "processDefinitionId": "",
        "processDefinitionName": "",
        "processDefinitionKey": "",
        "processDefinitionVersion": 0,
        "deploymentId": "",
        "startTime": "yyyy-MM-dd HH:mm:ss",
        "endTime": "yyyy-MM-dd HH:mm:ss",
        "startUserId": "",
        "variables": {
          "mapKey": {}
        },
        "activityName": "",
        "startUserName": ""
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

流程设计相关接口 ​

删除模型 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processModel/deleteModel

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除模型

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
modelIdstringtrue模型id-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/processModel/deleteModel

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据modelId部署流程 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processModel/deployModel

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据modelId部署流程

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
modelIdstringtrue模型id-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/processModel/deployModel

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

获取模型列表 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processModel/getModelList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取模型列表

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processModel/getModelList?tenantId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─idstring流程模型唯一标示-
└─keystring流程模型key-
└─namestring流程模型名称-
└─versionint32版本-
└─createTimestring创建时间-
└─lastUpdateTimestring最后修改时间-
└─xmlstring模型xml信息-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "key": "",
      "name": "",
      "version": 0,
      "createTime": "",
      "lastUpdateTime": "",
      "xml": ""
    }
  ]
}

获取模型xml ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processModel/getModelXml

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取模型xml

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
modelIdstringtrue模型id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processModel/getModelXml?tenantId=&modelId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
datastring操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

导入模型文件 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processModel/saveModelXml

Type: POST

Author: qinman,zhangchongjie

Content-Type: multipart/form-data

Description: 导入模型文件

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
userIdstringtrue用户id-
filefilefalse文件-

Request-example:

bash
curl -X POST -k -H 'Content-Type: multipart/form-data' -F 'file=' -i https://demo.youshengyun.com/processAdmin/services/rest/processModel/saveModelXml --data 'tenantId=&userId='

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

待办件列表 ​

根据岗位id获取待办数量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processTodo/countByOrgUnitId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据岗位id获取待办数量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
orgUnitIdstringtrue人员、岗位id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processTodo/countByOrgUnitId?tenantId=&orgUnitId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataint64操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

根据人员、岗位id，流程定义Key获取对应事项的办件统计（包括待办件，在办件，办结件） ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processTodo/getCountByUserIdAndProcessDefinitionKey

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据人员、岗位id，流程定义Key获取对应事项的办件统计（包括待办件，在办件，办结件）

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
userIdstringtrue人员、岗位id-
processDefinitionKeystringtrue流程定义Key-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processTodo/getCountByUserIdAndProcessDefinitionKey?tenantId=&userId=&processDefinitionKey=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─todoCountint64待办数量-
└─doingCountint64在办数量-
└─doneCountint64办结数量-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "todoCount": 0,
    "doingCount": 0,
    "doneCount": 0
  }
}

根据人员、岗位id，系统标识获取对应事项的办件统计（包括待办件，在办件，办结件） ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processTodo/getCountByUserIdAndSystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据人员、岗位id，系统标识获取对应事项的办件统计（包括待办件，在办件，办结件）

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
userIdstringtrue人员、岗位id-
systemNamestringtrue系统名称-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processTodo/getCountByUserIdAndSystemName?tenantId=&userId=&systemName=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─todoCountint64待办数量-
└─doingCountint64在办数量-
└─doneCountint64办结数量-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "todoCount": 0,
    "doingCount": 0,
    "doneCount": 0
  }
}

根据人员、岗位id，流程定义Key获取用户的待办任务(分页) ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processTodo/getListByUserIdAndProcessDefinitionKey

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据人员、岗位id，流程定义Key获取用户的待办任务(分页)

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
userIdstringtrue人员、岗位id-
processDefinitionKeystringtrue流程定义Key-
pageint32true页码-
rowsint32true行数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processTodo/getListByUserIdAndProcessDefinitionKey?page=0&rows=0&tenantId=&userId=&processDefinitionKey=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─namestring名称-
     └─descriptionstring描述-
     └─priorityint32优先级-
     └─ownerstring拥有者-
     └─assigneestring办理人-
     └─processInstanceIdstring流程实例ID-
     └─executionIdstring执行实例ID-
     └─processDefinitionIdstring流程定义ID-
     └─createTimestring创建时间-
     └─taskDefinitionKeystring任务定义key-
     └─formKeystring表单key(用于存放待办件已阅，未阅状态)-
     └─dueDatestring过期时间-
     └─claimTimestring签收时间-
     └─delegationStateenum委派状态
[Enum values:
PENDING()
RESOLVED()
]		-
     └─localVariablesmap任务变量-
          └─any objectobjectany object.-
     └─variablesmap流程变量-
          └─any objectobjectany object.-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "name": "",
        "description": "",
        "priority": 0,
        "owner": "",
        "assignee": "",
        "processInstanceId": "",
        "executionId": "",
        "processDefinitionId": "",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "taskDefinitionKey": "",
        "formKey": "",
        "dueDate": "yyyy-MM-dd HH:mm:ss",
        "claimTime": "yyyy-MM-dd HH:mm:ss",
        "delegationState": "PENDING",
        "localVariables": {
          "mapKey": {}
        },
        "variables": {
          "mapKey": {}
        }
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据人员、岗位id,系统标识获取用户的待办任务(分页) ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processTodo/getListByUserIdAndSystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据人员、岗位id,系统标识获取用户的待办任务(分页)

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
userIdstringtrue人员、岗位id-
systemNamestringtrue系统名称-
pageint32true页码-
rowsint32true行数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processTodo/getListByUserIdAndSystemName?page=0&rows=0&tenantId=&userId=&systemName=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─namestring名称-
     └─descriptionstring描述-
     └─priorityint32优先级-
     └─ownerstring拥有者-
     └─assigneestring办理人-
     └─processInstanceIdstring流程实例ID-
     └─executionIdstring执行实例ID-
     └─processDefinitionIdstring流程定义ID-
     └─createTimestring创建时间-
     └─taskDefinitionKeystring任务定义key-
     └─formKeystring表单key(用于存放待办件已阅，未阅状态)-
     └─dueDatestring过期时间-
     └─claimTimestring签收时间-
     └─delegationStateenum委派状态
[Enum values:
PENDING()
RESOLVED()
]		-
     └─localVariablesmap任务变量-
          └─any objectobjectany object.-
     └─variablesmap流程变量-
          └─any objectobjectany object.-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "name": "",
        "description": "",
        "priority": 0,
        "owner": "",
        "assignee": "",
        "processInstanceId": "",
        "executionId": "",
        "processDefinitionId": "",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "taskDefinitionKey": "",
        "formKey": "",
        "dueDate": "yyyy-MM-dd HH:mm:ss",
        "claimTime": "yyyy-MM-dd HH:mm:ss",
        "delegationState": "PENDING",
        "localVariables": {
          "mapKey": {}
        },
        "variables": {
          "mapKey": {}
        }
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

获取待办件列表 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processTodo/getListByUserIdAndSystemName4xxx

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取待办件列表

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
userIdstringtrue人员、岗位id-
systemNamestringfalse系统名称-
processDefinitionKeystringfalse流程定义key-
targetstringfalse目标-
pageint32true页码-
rowsint32true行数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processTodo/getListByUserIdAndSystemName4xxx?page=0&rows=0&tenantId=&userId=&systemName=&target=&processDefinitionKey=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─namestring名称-
     └─descriptionstring描述-
     └─priorityint32优先级-
     └─ownerstring拥有者-
     └─assigneestring办理人-
     └─processInstanceIdstring流程实例ID-
     └─executionIdstring执行实例ID-
     └─processDefinitionIdstring流程定义ID-
     └─createTimestring创建时间-
     └─taskDefinitionKeystring任务定义key-
     └─formKeystring表单key(用于存放待办件已阅，未阅状态)-
     └─dueDatestring过期时间-
     └─claimTimestring签收时间-
     └─delegationStateenum委派状态
[Enum values:
PENDING()
RESOLVED()
]		-
     └─localVariablesmap任务变量-
          └─any objectobjectany object.-
     └─variablesmap流程变量-
          └─any objectobjectany object.-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "name": "",
        "description": "",
        "priority": 0,
        "owner": "",
        "assignee": "",
        "processInstanceId": "",
        "executionId": "",
        "processDefinitionId": "",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "taskDefinitionKey": "",
        "formKey": "",
        "dueDate": "yyyy-MM-dd HH:mm:ss",
        "claimTime": "yyyy-MM-dd HH:mm:ss",
        "delegationState": "PENDING",
        "localVariables": {
          "mapKey": {}
        },
        "variables": {
          "mapKey": {}
        }
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据人员、岗位id,流程定义key获取对应事项的待办数量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processTodo/getTodoCountByUserIdAndProcessDefinitionKey

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据人员、岗位id,流程定义key获取对应事项的待办数量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
userIdstringtrue人员、岗位id-
processDefinitionKeystringtrue流程定义key-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processTodo/getTodoCountByUserIdAndProcessDefinitionKey?tenantId=&userId=&processDefinitionKey=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataint64操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

根据人员、岗位id，系统标识获取对应事项的待办数量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processTodo/getTodoCountByUserIdAndSystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据人员、岗位id，系统标识获取对应事项的待办数量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
userIdstringtrue人员、岗位id-
systemNamestringtrue系统名称-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processTodo/getTodoCountByUserIdAndSystemName?tenantId=&userId=&systemName=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataint64操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

根据人员、岗位id获取用户的待办任务(分页) ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processTodo/pageByUserId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据人员、岗位id获取用户的待办任务(分页)

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
userIdstringtrue人员、岗位id-
pageint32true页码-
rowsint32true行数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processTodo/pageByUserId?page=0&rows=0&tenantId=&userId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─namestring名称-
     └─descriptionstring描述-
     └─priorityint32优先级-
     └─ownerstring拥有者-
     └─assigneestring办理人-
     └─processInstanceIdstring流程实例ID-
     └─executionIdstring执行实例ID-
     └─processDefinitionIdstring流程定义ID-
     └─createTimestring创建时间-
     └─taskDefinitionKeystring任务定义key-
     └─formKeystring表单key(用于存放待办件已阅，未阅状态)-
     └─dueDatestring过期时间-
     └─claimTimestring签收时间-
     └─delegationStateenum委派状态
[Enum values:
PENDING()
RESOLVED()
]		-
     └─localVariablesmap任务变量-
          └─any objectobjectany object.-
     └─variablesmap流程变量-
          └─any objectobjectany object.-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "name": "",
        "description": "",
        "priority": 0,
        "owner": "",
        "assignee": "",
        "processInstanceId": "",
        "executionId": "",
        "processDefinitionId": "",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "taskDefinitionKey": "",
        "formKey": "",
        "dueDate": "yyyy-MM-dd HH:mm:ss",
        "claimTime": "yyyy-MM-dd HH:mm:ss",
        "delegationState": "PENDING",
        "localVariables": {
          "mapKey": {}
        },
        "variables": {
          "mapKey": {}
        }
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据流程定义Key和其他条件搜索待办件 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processTodo/searchListByUserIdAndProcessDefinitionKey

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程定义Key和其他条件搜索待办件

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
userIdstringtrue人员、岗位id-
processDefinitionKeystringtrue流程定义Key-
searchTermstringfalse搜索词-
pageint32true页码-
rowsint32true行数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processTodo/searchListByUserIdAndProcessDefinitionKey?page=0&rows=0&tenantId=&userId=&processDefinitionKey=&searchTerm=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─namestring名称-
     └─descriptionstring描述-
     └─priorityint32优先级-
     └─ownerstring拥有者-
     └─assigneestring办理人-
     └─processInstanceIdstring流程实例ID-
     └─executionIdstring执行实例ID-
     └─processDefinitionIdstring流程定义ID-
     └─createTimestring创建时间-
     └─taskDefinitionKeystring任务定义key-
     └─formKeystring表单key(用于存放待办件已阅，未阅状态)-
     └─dueDatestring过期时间-
     └─claimTimestring签收时间-
     └─delegationStateenum委派状态
[Enum values:
PENDING()
RESOLVED()
]		-
     └─localVariablesmap任务变量-
          └─any objectobjectany object.-
     └─variablesmap流程变量-
          └─any objectobjectany object.-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "name": "",
        "description": "",
        "priority": 0,
        "owner": "",
        "assignee": "",
        "processInstanceId": "",
        "executionId": "",
        "processDefinitionId": "",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "taskDefinitionKey": "",
        "formKey": "",
        "dueDate": "yyyy-MM-dd HH:mm:ss",
        "claimTime": "yyyy-MM-dd HH:mm:ss",
        "delegationState": "PENDING",
        "localVariables": {
          "mapKey": {}
        },
        "variables": {
          "mapKey": {}
        }
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据系统英文名称和其他条件搜索待办件 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/processTodo/searchListByUserIdAndSystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据系统英文名称和其他条件搜索待办件

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
userIdstringtrue人员、岗位id-
systemNamestringtrue系统英文名称-
searchTermstringfalse搜索词-
pageint32true页码-
rowsint32true行数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/processTodo/searchListByUserIdAndSystemName?page=0&rows=0&tenantId=&userId=&systemName=&searchTerm=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─namestring名称-
     └─descriptionstring描述-
     └─priorityint32优先级-
     └─ownerstring拥有者-
     └─assigneestring办理人-
     └─processInstanceIdstring流程实例ID-
     └─executionIdstring执行实例ID-
     └─processDefinitionIdstring流程定义ID-
     └─createTimestring创建时间-
     └─taskDefinitionKeystring任务定义key-
     └─formKeystring表单key(用于存放待办件已阅，未阅状态)-
     └─dueDatestring过期时间-
     └─claimTimestring签收时间-
     └─delegationStateenum委派状态
[Enum values:
PENDING()
RESOLVED()
]		-
     └─localVariablesmap任务变量-
          └─any objectobjectany object.-
     └─variablesmap流程变量-
          └─any objectobjectany object.-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "name": "",
        "description": "",
        "priority": 0,
        "owner": "",
        "assignee": "",
        "processInstanceId": "",
        "executionId": "",
        "processDefinitionId": "",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "taskDefinitionKey": "",
        "formKey": "",
        "dueDate": "yyyy-MM-dd HH:mm:ss",
        "claimTime": "yyyy-MM-dd HH:mm:ss",
        "delegationState": "PENDING",
        "localVariables": {
          "mapKey": {}
        },
        "variables": {
          "mapKey": {}
        }
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

部署流程相关接口 ​

删除部署的流程 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/repository/delete

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除部署的流程

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
deploymentIdstringtrue部署id-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/repository/delete

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

部署流程 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/repository/deploy

Type: POST

Author: qinman,zhangchongjie

Content-Type: multipart/form-data

Description: 部署流程

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
filefilefalse流程文件-

Request-example:

bash
curl -X POST -k -H 'Content-Type: multipart/form-data' -F 'file=' -i https://demo.youshengyun.com/processAdmin/services/rest/repository/deploy --data 'tenantId='

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据流程定义key获取最新部署的流程定义 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/repository/getLademoProcessDefinitionByKey

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程定义key获取最新部署的流程定义

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processDefinitionKeystringtrue流程定义key-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/repository/getLademoProcessDefinitionByKey?tenantId=&processDefinitionKey=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─idstring主键-
└─categorystring类别-
└─namestring名称-
└─keystringkey-
└─descriptionstring描述-
└─versionint32版本-
└─resourceNamestring资源名称-
└─deploymentIdstring部署id-
└─diagramResourceNamestring图表资源名称-
└─suspendedboolean是否挂起-
└─engineVersionstring引擎版本-
└─deploymentTimestring部署时间-
└─sortTimeint64部署时间（毫秒）用于排序-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "category": "",
    "name": "",
    "key": "",
    "description": "",
    "version": 0,
    "resourceName": "",
    "deploymentId": "",
    "diagramResourceName": "",
    "suspended": true,
    "engineVersion": "",
    "deploymentTime": "",
    "sortTime": 0
  }
}

获取所有流程定义最新版本的集合 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/repository/getLademoProcessDefinitionList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取所有流程定义最新版本的集合

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/repository/getLademoProcessDefinitionList?tenantId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─idstring主键-
└─categorystring类别-
└─namestring名称-
└─keystringkey-
└─descriptionstring描述-
└─versionint32版本-
└─resourceNamestring资源名称-
└─deploymentIdstring部署id-
└─diagramResourceNamestring图表资源名称-
└─suspendedboolean是否挂起-
└─engineVersionstring引擎版本-
└─deploymentTimestring部署时间-
└─sortTimeint64部署时间（毫秒）用于排序-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "category": "",
      "name": "",
      "key": "",
      "description": "",
      "version": 0,
      "resourceName": "",
      "deploymentId": "",
      "diagramResourceName": "",
      "suspended": true,
      "engineVersion": "",
      "deploymentTime": "",
      "sortTime": 0
    }
  ]
}

根据流程定义Id获取上一个版本的流程定义，如果当前版本是1，则返回自己 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/repository/getPreviousProcessDefinitionById

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程定义Id获取上一个版本的流程定义，如果当前版本是1，则返回自己

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processDefinitionIdstringtrue流程定义Id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/repository/getPreviousProcessDefinitionById?tenantId=&processDefinitionId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─idstring主键-
└─categorystring类别-
└─namestring名称-
└─keystringkey-
└─descriptionstring描述-
└─versionint32版本-
└─resourceNamestring资源名称-
└─deploymentIdstring部署id-
└─diagramResourceNamestring图表资源名称-
└─suspendedboolean是否挂起-
└─engineVersionstring引擎版本-
└─deploymentTimestring部署时间-
└─sortTimeint64部署时间（毫秒）用于排序-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "category": "",
    "name": "",
    "key": "",
    "description": "",
    "version": 0,
    "resourceName": "",
    "deploymentId": "",
    "diagramResourceName": "",
    "suspended": true,
    "engineVersion": "",
    "deploymentTime": "",
    "sortTime": 0
  }
}

根据流程定义Id获取流程定义 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/repository/getProcessDefinitionById

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程定义Id获取流程定义

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processDefinitionIdstringtrue流程定义Id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/repository/getProcessDefinitionById?tenantId=&processDefinitionId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─idstring主键-
└─categorystring类别-
└─namestring名称-
└─keystringkey-
└─descriptionstring描述-
└─versionint32版本-
└─resourceNamestring资源名称-
└─deploymentIdstring部署id-
└─diagramResourceNamestring图表资源名称-
└─suspendedboolean是否挂起-
└─engineVersionstring引擎版本-
└─deploymentTimestring部署时间-
└─sortTimeint64部署时间（毫秒）用于排序-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "category": "",
    "name": "",
    "key": "",
    "description": "",
    "version": 0,
    "resourceName": "",
    "deploymentId": "",
    "diagramResourceName": "",
    "suspended": true,
    "engineVersion": "",
    "deploymentTime": "",
    "sortTime": 0
  }
}

根据流程定义key获取最新部署的流程定义 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/repository/getProcessDefinitionListByKey

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程定义key获取最新部署的流程定义

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processDefinitionKeystringtrue流程定义key-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/repository/getProcessDefinitionListByKey?tenantId=&processDefinitionKey=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─idstring主键-
└─categorystring类别-
└─namestring名称-
└─keystringkey-
└─descriptionstring描述-
└─versionint32版本-
└─resourceNamestring资源名称-
└─deploymentIdstring部署id-
└─diagramResourceNamestring图表资源名称-
└─suspendedboolean是否挂起-
└─engineVersionstring引擎版本-
└─deploymentTimestring部署时间-
└─sortTimeint64部署时间（毫秒）用于排序-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "category": "",
      "name": "",
      "key": "",
      "description": "",
      "version": 0,
      "resourceName": "",
      "deploymentId": "",
      "diagramResourceName": "",
      "suspended": true,
      "engineVersion": "",
      "deploymentTime": "",
      "sortTime": 0
    }
  ]
}

获取流程定义xml ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/repository/getXmlByProcessInstance

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取流程定义xml

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
resourceTypestringtruexml-
processInstanceIdstringtrue流程实例id-
processDefinitionIdstringtrue流程定义id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/repository/getXmlByProcessInstance?tenantId=&resourceType=&processInstanceId=&processDefinitionId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
datastring操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

获取已部署流程定义列表 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/repository/list

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取已部署流程定义列表

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/repository/list?tenantId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─idstring主键-
└─categorystring类别-
└─namestring名称-
└─keystringkey-
└─descriptionstring描述-
└─versionint32版本-
└─resourceNamestring资源名称-
└─deploymentIdstring部署id-
└─diagramResourceNamestring图表资源名称-
└─suspendedboolean是否挂起-
└─engineVersionstring引擎版本-
└─deploymentTimestring部署时间-
└─sortTimeint64部署时间（毫秒）用于排序-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "category": "",
      "name": "",
      "key": "",
      "description": "",
      "version": 0,
      "resourceName": "",
      "deploymentId": "",
      "diagramResourceName": "",
      "suspended": true,
      "engineVersion": "",
      "deploymentTime": "",
      "sortTime": 0
    }
  ]
}

激活/挂起流程的状态 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/repository/switchSuspendOrActive

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 激活/挂起流程的状态

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
statestringtrue状态-
processDefinitionIdstringtrue流程定义Id-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/repository/switchSuspendOrActive

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

正在运行流程实例操作接口 ​

加签 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/runtime/addMultiInstanceExecution

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 加签

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
activityIdstringtrue活动节点id-
parentExecutionIdstringtrue父执行实例id-

Body-parameters:

ParameterTypeRequiredDescriptionSince
successbooleanfalse操作是否成功-
codeint32false错误代码-
msgstringfalse操作描述-
dataobjectfalse操作成功返回的数据-
└─mapKeyobjectfalseA map key.-
     └─any objectobjectfalseany object.-

Request-example:

bash
curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/processAdmin/services/rest/runtime/addMultiInstanceExecution?tenantId=&activityId=&parentExecutionId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "mapKey": {
      "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
    }
  }
}'

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

真办结 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/runtime/complete

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 真办结

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
orgUnitIdstringtrue人员、岗位id-
processInstanceIdstringtrue流程实例id-
taskIdstringtrue任务id-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/runtime/complete

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

减签 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/runtime/deleteMultiInstanceExecution

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 减签

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
executionIdstringtrue执行实例id-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/runtime/deleteMultiInstanceExecution

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据执行Id获取当前活跃的节点信息 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/runtime/getActiveActivityIds

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据执行Id获取当前活跃的节点信息

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
executionIdstringtrue执行实例id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/runtime/getActiveActivityIds?tenantId=&executionId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    "",
    ""
  ]
}

根据执行实例Id查找执行实例 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/runtime/getExecutionById

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据执行实例Id查找执行实例

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
executionIdstringtrue执行实例id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/runtime/getExecutionById?tenantId=&executionId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─idstring主键-
└─suspendedboolean是否挂起-
└─endedboolean是否结束-
└─activityIdstring活动id-
└─processInstanceIdstring流程实例id-
└─parentIdstring父活动id-
└─superExecutionIdstring超级执行实例id-
└─rootProcessInstanceIdstring根流程实例id-
└─tenantIdstring租户id-
└─namestring名称-
└─descriptionstring描述-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "suspended": true,
    "ended": true,
    "activityId": "",
    "processInstanceId": "",
    "parentId": "",
    "superExecutionId": "",
    "rootProcessInstanceId": "",
    "tenantId": "",
    "name": "",
    "description": ""
  }
}

根据父流程实例获取子流程实例 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/runtime/getListBySuperProcessInstanceId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据父流程实例获取子流程实例

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
superProcessInstanceIdstringtrue父流程实例id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/runtime/getListBySuperProcessInstanceId?tenantId=&superProcessInstanceId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─idstring主键-
└─suspendedboolean是否挂起-
└─endedboolean是否结束-
└─namestring名称-
└─descriptionstring描述-
└─processDefinitionIdstring流程定义id-
└─processDefinitionNamestring流程定义名称-
└─processDefinitionKeystring流程定义key-
└─processDefinitionVersionint32流程定义版本-
└─deploymentIdstring部署id-
└─startTimestring开始时间-
└─endTimestring结束时间-
└─startUserIdstring开始用户id-
└─variablesmap流程变量-
     └─any objectobjectany object.-
└─activityNamestring活动节点-
└─startUserNamestring启动用户名称-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "suspended": true,
      "ended": true,
      "name": "",
      "description": "",
      "processDefinitionId": "",
      "processDefinitionName": "",
      "processDefinitionKey": "",
      "processDefinitionVersion": 0,
      "deploymentId": "",
      "startTime": "yyyy-MM-dd HH:mm:ss",
      "endTime": "yyyy-MM-dd HH:mm:ss",
      "startUserId": "",
      "variables": {
        "mapKey": {}
      },
      "activityName": "",
      "startUserName": ""
    }
  ]
}

根据流程实例Id获取流程实例信息 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/runtime/getProcessInstance

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例Id获取流程实例信息

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/runtime/getProcessInstance?tenantId=&processInstanceId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─idstring主键-
└─suspendedboolean是否挂起-
└─endedboolean是否结束-
└─namestring名称-
└─descriptionstring描述-
└─processDefinitionIdstring流程定义id-
└─processDefinitionNamestring流程定义名称-
└─processDefinitionKeystring流程定义key-
└─processDefinitionVersionint32流程定义版本-
└─deploymentIdstring部署id-
└─startTimestring开始时间-
└─endTimestring结束时间-
└─startUserIdstring开始用户id-
└─variablesmap流程变量-
     └─any objectobjectany object.-
└─activityNamestring活动节点-
└─startUserNamestring启动用户名称-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "suspended": true,
    "ended": true,
    "name": "",
    "description": "",
    "processDefinitionId": "",
    "processDefinitionName": "",
    "processDefinitionKey": "",
    "processDefinitionVersion": 0,
    "deploymentId": "",
    "startTime": "yyyy-MM-dd HH:mm:ss",
    "endTime": "yyyy-MM-dd HH:mm:ss",
    "startUserId": "",
    "variables": {
      "mapKey": {}
    },
    "activityName": "",
    "startUserName": ""
  }
}

根据流程定义id获取流程实例列表 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/runtime/getProcessInstancesByDefId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程定义id获取流程实例列表

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processDefinitionIdstringtrue流程定义id-
pageint32true页码-
rowsint32true行数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/runtime/getProcessInstancesByDefId?page=0&rows=0&tenantId=&processDefinitionId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─suspendedboolean是否挂起-
     └─endedboolean是否结束-
     └─namestring名称-
     └─descriptionstring描述-
     └─processDefinitionIdstring流程定义id-
     └─processDefinitionNamestring流程定义名称-
     └─processDefinitionKeystring流程定义key-
     └─processDefinitionVersionint32流程定义版本-
     └─deploymentIdstring部署id-
     └─startTimestring开始时间-
     └─endTimestring结束时间-
     └─startUserIdstring开始用户id-
     └─variablesmap流程变量-
          └─any objectobjectany object.-
     └─activityNamestring活动节点-
     └─startUserNamestring启动用户名称-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "suspended": true,
        "ended": true,
        "name": "",
        "description": "",
        "processDefinitionId": "",
        "processDefinitionName": "",
        "processDefinitionKey": "",
        "processDefinitionVersion": 0,
        "deploymentId": "",
        "startTime": "yyyy-MM-dd HH:mm:ss",
        "endTime": "yyyy-MM-dd HH:mm:ss",
        "startUserId": "",
        "variables": {
          "mapKey": {}
        },
        "activityName": "",
        "startUserName": ""
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据流程定义Key获取流程实例列表 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/runtime/getProcessInstancesByKey

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程定义Key获取流程实例列表

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processDefinitionKeystringtrue流程定义key-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/runtime/getProcessInstancesByKey?tenantId=&processDefinitionKey=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─idstring主键-
└─suspendedboolean是否挂起-
└─endedboolean是否结束-
└─namestring名称-
└─descriptionstring描述-
└─processDefinitionIdstring流程定义id-
└─processDefinitionNamestring流程定义名称-
└─processDefinitionKeystring流程定义key-
└─processDefinitionVersionint32流程定义版本-
└─deploymentIdstring部署id-
└─startTimestring开始时间-
└─endTimestring结束时间-
└─startUserIdstring开始用户id-
└─variablesmap流程变量-
     └─any objectobjectany object.-
└─activityNamestring活动节点-
└─startUserNamestring启动用户名称-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "suspended": true,
      "ended": true,
      "name": "",
      "description": "",
      "processDefinitionId": "",
      "processDefinitionName": "",
      "processDefinitionKey": "",
      "processDefinitionVersion": 0,
      "deploymentId": "",
      "startTime": "yyyy-MM-dd HH:mm:ss",
      "endTime": "yyyy-MM-dd HH:mm:ss",
      "startUserId": "",
      "variables": {
        "mapKey": {}
      },
      "activityName": "",
      "startUserName": ""
    }
  ]
}

真办结后恢复流程实例为待办状态 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/runtime/recovery4Completed

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 真办结后恢复流程实例为待办状态

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
orgUnitIdstringtrue人员、岗位id-
processInstanceIdstringtrue流程实例id-
yearstringtrue年份-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/runtime/recovery4Completed

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

恢复流程实例为待办状态，其实是先激活，再设置流程实例的结束时间为null ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/runtime/recovery4SetUpCompleted

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 恢复流程实例为待办状态，其实是先激活，再设置流程实例的结束时间为null

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例id-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/runtime/recovery4SetUpCompleted

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

获取正在运行流程实例列表 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/runtime/runningList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取正在运行流程实例列表

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例id-
pageint32true页吗-
rowsint32true条数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/runtime/runningList?page=0&rows=0&tenantId=&processInstanceId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─suspendedboolean是否挂起-
     └─endedboolean是否结束-
     └─namestring名称-
     └─descriptionstring描述-
     └─processDefinitionIdstring流程定义id-
     └─processDefinitionNamestring流程定义名称-
     └─processDefinitionKeystring流程定义key-
     └─processDefinitionVersionint32流程定义版本-
     └─deploymentIdstring部署id-
     └─startTimestring开始时间-
     └─endTimestring结束时间-
     └─startUserIdstring开始用户id-
     └─variablesmap流程变量-
          └─any objectobjectany object.-
     └─activityNamestring活动节点-
     └─startUserNamestring启动用户名称-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "suspended": true,
        "ended": true,
        "name": "",
        "description": "",
        "processDefinitionId": "",
        "processDefinitionName": "",
        "processDefinitionKey": "",
        "processDefinitionVersion": 0,
        "deploymentId": "",
        "startTime": "yyyy-MM-dd HH:mm:ss",
        "endTime": "yyyy-MM-dd HH:mm:ss",
        "startUserId": "",
        "variables": {
          "mapKey": {}
        },
        "activityName": "",
        "startUserName": ""
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

设置流程实例为办结的状态，其实是先暂停，再设置流程结束时间为当前时间 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/runtime/setUpCompleted

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 设置流程实例为办结的状态，其实是先暂停，再设置流程结束时间为当前时间

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例id-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/runtime/setUpCompleted

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据流程实例id设置流程变量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/runtime/setVariable

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 根据流程实例id设置流程变量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例id-
keystringtrue变量key-

Body-parameters:

ParameterTypeRequiredDescriptionSince
successbooleanfalse操作是否成功-
codeint32false错误代码-
msgstringfalse操作描述-
dataobjectfalse操作成功返回的数据-
└─mapKeyobjectfalseA map key.-
     └─any objectobjectfalseany object.-

Request-example:

bash
curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/processAdmin/services/rest/runtime/setVariable?tenantId=&processInstanceId=&key= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "mapKey": {
      "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
    }
  }
}'

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据执行实例id设置流程变量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/runtime/setVariables

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 根据执行实例id设置流程变量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
executionIdstringtrue执行实例id-

Body-parameters:

ParameterTypeRequiredDescriptionSince
successbooleanfalse操作是否成功-
codeint32false错误代码-
msgstringfalse操作描述-
dataobjectfalse操作成功返回的数据-
└─mapKeyobjectfalseA map key.-
     └─any objectobjectfalseany object.-

Request-example:

bash
curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/processAdmin/services/rest/runtime/setVariables?tenantId=&executionId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "mapKey": {
      "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
    }
  }
}'

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据流程定义Key启动流程实例，设置流程变量,并返回流程实例,流程启动人是人员Id ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/runtime/startProcessInstanceByKey

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 根据流程定义Key启动流程实例，设置流程变量,并返回流程实例,流程启动人是人员Id

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
orgUnitIdstringtrue人员、岗位id-
processDefinitionKeystringtrue流程定义key-
systemNamestringtrue系统名称-

Body-parameters:

ParameterTypeRequiredDescriptionSince
successbooleanfalse操作是否成功-
codeint32false错误代码-
msgstringfalse操作描述-
dataobjectfalse操作成功返回的数据-
└─mapKeyobjectfalseA map key.-
     └─any objectobjectfalseany object.-

Request-example:

bash
curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/processAdmin/services/rest/runtime/startProcessInstanceByKey?tenantId=&orgUnitId=&processDefinitionKey=&systemName= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "mapKey": {
      "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
    }
  }
}'

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─idstring主键-
└─suspendedboolean是否挂起-
└─endedboolean是否结束-
└─namestring名称-
└─descriptionstring描述-
└─processDefinitionIdstring流程定义id-
└─processDefinitionNamestring流程定义名称-
└─processDefinitionKeystring流程定义key-
└─processDefinitionVersionint32流程定义版本-
└─deploymentIdstring部署id-
└─startTimestring开始时间-
└─endTimestring结束时间-
└─startUserIdstring开始用户id-
└─variablesmap流程变量-
     └─any objectobjectany object.-
└─activityNamestring活动节点-
└─startUserNamestring启动用户名称-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "suspended": true,
    "ended": true,
    "name": "",
    "description": "",
    "processDefinitionId": "",
    "processDefinitionName": "",
    "processDefinitionKey": "",
    "processDefinitionVersion": 0,
    "deploymentId": "",
    "startTime": "yyyy-MM-dd HH:mm:ss",
    "endTime": "yyyy-MM-dd HH:mm:ss",
    "startUserId": "",
    "variables": {
      "mapKey": {}
    },
    "activityName": "",
    "startUserName": ""
  }
}

判断是否是挂起实例 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/runtime/suspendedByProcessInstanceId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 判断是否是挂起实例

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/runtime/suspendedByProcessInstanceId?tenantId=&processInstanceId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
databoolean操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": true
}

挂起或者激活流程实例 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/runtime/switchSuspendOrActive

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 挂起或者激活流程实例

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例id-
statestringtrue状态-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/runtime/switchSuspendOrActive

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

退回，收回，重定向，特殊办结接口 ​

重定向 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/specialOperation/reposition

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 重定向

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
orgUnitIdstringtrue人员、岗位id-
taskIdstringtrue任务id-
repositionToTaskIdstringtrue任务key-
userChoicearraytrue岗位id集合,[array of string]-
reasonstringfalse重定向原因-
sponsorGuidstringfalse主办人id-

Request-example:

bash
curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/processAdmin/services/rest/specialOperation/reposition --data 'tenantId=&orgUnitId=&taskId=&repositionToTaskId=&userChoice=&reason=&sponsorGuid='

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

退回 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/specialOperation/rollBack

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 退回

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
orgUnitIdstringtrue人员、岗位id-
taskIdstringtrue任务id-
reasonstringfalse退回的原因-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/specialOperation/rollBack

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

发回给发送人 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/specialOperation/rollbackToSender

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 发回给发送人

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
orgUnitIdstringtrue人员、岗位id-
taskIdstringtrue任务id-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/specialOperation/rollbackToSender

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

返回拟稿人 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/specialOperation/rollbackToStartor

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 返回拟稿人

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
orgUnitIdstringtrue人员、岗位id-
taskIdstringtrue任务id-
reasonstringfalse原因-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/specialOperation/rollbackToStartor

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

特殊办结 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/specialOperation/specialComplete

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 特殊办结

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
orgUnitIdstringtrue人员、岗位id-
taskIdstringtrue任务id-
reasonstringfalse原因-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/specialOperation/specialComplete

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

收回 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/specialOperation/takeBack

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 收回

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
orgUnitIdstringtrue人员、岗位id-
taskIdstringtrue任务id-
reasonstringfalse收回的原因-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/specialOperation/takeBack

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

正在运行任务相关接口 ​

签收任务 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/task/claim

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 签收任务

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
userIdstringtrue人员、岗位id-
taskIdstringtrue任务id-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/task/claim

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

完成任务（不设置流程变量） ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/task/complete

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 完成任务（不设置流程变量）

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
taskIdstringtrue任务id-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/task/complete

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

完成按钮的任务完结 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/task/completeTask

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 完成按钮的任务完结

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
taskIdstringtrue任务id-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/task/completeTask

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

完成按钮的任务完结（相关参与人员的人任务办结） ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/task/completeTaskWithoutAssignee

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 完成按钮的任务完结（相关参与人员的人任务办结）

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
orgUnitIdstringtrue人员、岗位Id-
processInstanceIdstringtrue流程实例id-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/task/completeTaskWithoutAssignee

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

完成任务（设置流程变量） ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/task/completeWithVariables

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 完成任务（设置流程变量）

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
taskIdstringtrue任务id-
orgUnitIdstringtrue人员、岗位Id-

Body-parameters:

ParameterTypeRequiredDescriptionSince
successbooleanfalse操作是否成功-
codeint32false错误代码-
msgstringfalse操作描述-
dataobjectfalse操作成功返回的数据-
└─mapKeyobjectfalseA map key.-
     └─any objectobjectfalseany object.-

Request-example:

bash
curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/processAdmin/services/rest/task/completeWithVariables?tenantId=&taskId=&orgUnitId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "mapKey": {
      "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
    }
  }
}'

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

创建变量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/task/createWithVariables

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 创建变量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
orgUnitIdstringtrue人员、岗位Id-
routeToTaskIdstringtrue任务id-

Body-parameters:

ParameterTypeRequiredDescriptionSince
any objectobjectfalseany object.-
successbooleanfalse操作是否成功-
codeint32false错误代码-
msgstringfalse操作描述-
dataarrayfalse操作成功返回的数据-

Request-example:

bash
curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/processAdmin/services/rest/task/createWithVariables?tenantId=&orgUnitId=&routeToTaskId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    "",
    ""
  ]
}'

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

设置任务代理 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/task/delegateTask

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 设置任务代理

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
taskIdstringtrue任务id-
assigneestringtrue受让人-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/task/delegateTask

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

删除任务的候选人 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/task/deleteCandidateUser

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除任务的候选人

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
taskIdstringtrue任务id-
assigneestringtrue受让人-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/task/deleteCandidateUser

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

查找所有的任务实例 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/task/findAll

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 查找所有的任务实例

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/task/findAll?tenantId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─idstring主键-
└─namestring名称-
└─descriptionstring描述-
└─priorityint32优先级-
└─ownerstring拥有者-
└─assigneestring办理人-
└─processInstanceIdstring流程实例ID-
└─executionIdstring执行实例ID-
└─processDefinitionIdstring流程定义ID-
└─createTimestring创建时间-
└─taskDefinitionKeystring任务定义key-
└─formKeystring表单key(用于存放待办件已阅，未阅状态)-
└─dueDatestring过期时间-
└─claimTimestring签收时间-
└─delegationStateenum委派状态
[Enum values:
PENDING()
RESOLVED()
]		-
└─localVariablesmap任务变量-
     └─any objectobjectany object.-
└─variablesmap流程变量-
     └─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "name": "",
      "description": "",
      "priority": 0,
      "owner": "",
      "assignee": "",
      "processInstanceId": "",
      "executionId": "",
      "processDefinitionId": "",
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "taskDefinitionKey": "",
      "formKey": "",
      "dueDate": "yyyy-MM-dd HH:mm:ss",
      "claimTime": "yyyy-MM-dd HH:mm:ss",
      "delegationState": "PENDING",
      "localVariables": {
        "mapKey": {}
      },
      "variables": {
        "mapKey": {}
      }
    }
  ]
}

根据任务id查找任务 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/task/findById

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据任务id查找任务

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
taskIdstringtrue任务id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/task/findById?tenantId=&taskId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─idstring主键-
└─namestring名称-
└─descriptionstring描述-
└─priorityint32优先级-
└─ownerstring拥有者-
└─assigneestring办理人-
└─processInstanceIdstring流程实例ID-
└─executionIdstring执行实例ID-
└─processDefinitionIdstring流程定义ID-
└─createTimestring创建时间-
└─taskDefinitionKeystring任务定义key-
└─formKeystring表单key(用于存放待办件已阅，未阅状态)-
└─dueDatestring过期时间-
└─claimTimestring签收时间-
└─delegationStateenum委派状态
[Enum values:
PENDING()
RESOLVED()
]		-
└─localVariablesmap任务变量-
     └─any objectobjectany object.-
└─variablesmap流程变量-
     └─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "name": "",
    "description": "",
    "priority": 0,
    "owner": "",
    "assignee": "",
    "processInstanceId": "",
    "executionId": "",
    "processDefinitionId": "",
    "createTime": "yyyy-MM-dd HH:mm:ss",
    "taskDefinitionKey": "",
    "formKey": "",
    "dueDate": "yyyy-MM-dd HH:mm:ss",
    "claimTime": "yyyy-MM-dd HH:mm:ss",
    "delegationState": "PENDING",
    "localVariables": {
      "mapKey": {}
    },
    "variables": {
      "mapKey": {}
    }
  }
}

根据流程实例Id查找任务 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/task/findByProcessInstanceId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例Id查找任务

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/task/findByProcessInstanceId?tenantId=&processInstanceId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─idstring主键-
└─namestring名称-
└─descriptionstring描述-
└─priorityint32优先级-
└─ownerstring拥有者-
└─assigneestring办理人-
└─processInstanceIdstring流程实例ID-
└─executionIdstring执行实例ID-
└─processDefinitionIdstring流程定义ID-
└─createTimestring创建时间-
└─taskDefinitionKeystring任务定义key-
└─formKeystring表单key(用于存放待办件已阅，未阅状态)-
└─dueDatestring过期时间-
└─claimTimestring签收时间-
└─delegationStateenum委派状态
[Enum values:
PENDING()
RESOLVED()
]		-
└─localVariablesmap任务变量-
     └─any objectobjectany object.-
└─variablesmap流程变量-
     └─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "name": "",
      "description": "",
      "priority": 0,
      "owner": "",
      "assignee": "",
      "processInstanceId": "",
      "executionId": "",
      "processDefinitionId": "",
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "taskDefinitionKey": "",
      "formKey": "",
      "dueDate": "yyyy-MM-dd HH:mm:ss",
      "claimTime": "yyyy-MM-dd HH:mm:ss",
      "delegationState": "PENDING",
      "localVariables": {
        "mapKey": {}
      },
      "variables": {
        "mapKey": {}
      }
    }
  ]
}

根据流程实例Id和是否激活状态查找任务 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/task/findByProcessInstanceId1

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例Id和是否激活状态查找任务

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例Id-
activebooleantrue是否存活-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/task/findByProcessInstanceId1?active=true&tenantId=&processInstanceId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─idstring主键-
└─namestring名称-
└─descriptionstring描述-
└─priorityint32优先级-
└─ownerstring拥有者-
└─assigneestring办理人-
└─processInstanceIdstring流程实例ID-
└─executionIdstring执行实例ID-
└─processDefinitionIdstring流程定义ID-
└─createTimestring创建时间-
└─taskDefinitionKeystring任务定义key-
└─formKeystring表单key(用于存放待办件已阅，未阅状态)-
└─dueDatestring过期时间-
└─claimTimestring签收时间-
└─delegationStateenum委派状态
[Enum values:
PENDING()
RESOLVED()
]		-
└─localVariablesmap任务变量-
     └─any objectobjectany object.-
└─variablesmap流程变量-
     └─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "name": "",
      "description": "",
      "priority": 0,
      "owner": "",
      "assignee": "",
      "processInstanceId": "",
      "executionId": "",
      "processDefinitionId": "",
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "taskDefinitionKey": "",
      "formKey": "",
      "dueDate": "yyyy-MM-dd HH:mm:ss",
      "claimTime": "yyyy-MM-dd HH:mm:ss",
      "delegationState": "PENDING",
      "localVariables": {
        "mapKey": {}
      },
      "variables": {
        "mapKey": {}
      }
    }
  ]
}

根据流程实例id获取用户的待办任务(分页) ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/task/findListByProcessInstanceId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例id获取用户的待办任务(分页)

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户Id-
processInstanceIdstringtrue流程实例Id-
pageint32true页码-
rowsint32true行数-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/task/findListByProcessInstanceId?page=0&rows=0&tenantId=&processInstanceId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─idstring主键-
     └─namestring名称-
     └─descriptionstring描述-
     └─priorityint32优先级-
     └─ownerstring拥有者-
     └─assigneestring办理人-
     └─processInstanceIdstring流程实例ID-
     └─executionIdstring执行实例ID-
     └─processDefinitionIdstring流程定义ID-
     └─createTimestring创建时间-
     └─taskDefinitionKeystring任务定义key-
     └─formKeystring表单key(用于存放待办件已阅，未阅状态)-
     └─dueDatestring过期时间-
     └─claimTimestring签收时间-
     └─delegationStateenum委派状态
[Enum values:
PENDING()
RESOLVED()
]		-
     └─localVariablesmap任务变量-
          └─any objectobjectany object.-
     └─variablesmap流程变量-
          └─any objectobjectany object.-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "name": "",
        "description": "",
        "priority": 0,
        "owner": "",
        "assignee": "",
        "processInstanceId": "",
        "executionId": "",
        "processDefinitionId": "",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "taskDefinitionKey": "",
        "formKey": "",
        "dueDate": "yyyy-MM-dd HH:mm:ss",
        "claimTime": "yyyy-MM-dd HH:mm:ss",
        "delegationState": "PENDING",
        "localVariables": {
          "mapKey": {}
        },
        "variables": {
          "mapKey": {}
        }
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

保存任务 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/task/saveTask

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 保存任务

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-

Body-parameters:

ParameterTypeRequiredDescriptionSince
successbooleanfalse操作是否成功-
codeint32false错误代码-
msgstringfalse操作描述-
dataobjectfalse操作成功返回的数据-
└─idstringfalse主键-
└─namestringfalse名称-
└─descriptionstringfalse描述-
└─priorityint32false优先级-
└─ownerstringfalse拥有者-
└─assigneestringfalse办理人-
└─processInstanceIdstringfalse流程实例ID-
└─executionIdstringfalse执行实例ID-
└─processDefinitionIdstringfalse流程定义ID-
└─createTimestringfalse创建时间-
└─taskDefinitionKeystringfalse任务定义key-
└─formKeystringfalse表单key(用于存放待办件已阅，未阅状态)-
└─dueDatestringfalse过期时间-
└─claimTimestringfalse签收时间-
└─delegationStateenumfalse委派状态
[Enum values:
PENDING()
RESOLVED()
]		-
└─localVariablesmapfalse任务变量-
     └─any objectobjectfalseany object.-
└─variablesmapfalse流程变量-
     └─any objectobjectfalseany object.-

Request-example:

bash
curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/processAdmin/services/rest/task/saveTask?tenantId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "name": "",
    "description": "",
    "priority": 0,
    "owner": "",
    "assignee": "",
    "processInstanceId": "",
    "executionId": "",
    "processDefinitionId": "",
    "createTime": "yyyy-MM-dd HH:mm:ss",
    "taskDefinitionKey": "",
    "formKey": "",
    "dueDate": "yyyy-MM-dd HH:mm:ss",
    "claimTime": "yyyy-MM-dd HH:mm:ss",
    "delegationState": "PENDING",
    "localVariables": {
      "mapKey": {}
    },
    "variables": {
      "mapKey": {}
    }
  }
}'

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

设置任务委托人 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/task/setAssignee

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 设置任务委托人

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
taskIdstringtrue任务id-
assigneestringtrue受让人-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/task/setAssignee

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

设置任务的过期时间 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/task/setDueDate

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 设置任务的过期时间

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
taskIdstringtrue任务id-
datestringtrue日期-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/task/setDueDate

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

设置任务的优先级 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/task/setPriority

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 设置任务的优先级

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
taskIdstringtrue任务id-
priorityint32true优先级-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/task/setPriority

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

撤销签收任务 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/task/unClaim

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 撤销签收任务

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
taskIdstringtrue任务id-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/task/unClaim

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

正在运行变量相关接口 ​

删除流程变量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/variable/deleteVariable

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除流程变量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
taskIdstringtrue任务id-
keystringtrue变量key-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/variable/deleteVariable

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

删除任务变量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/variable/deleteVariableLocal

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除任务变量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
taskIdstringtrue任务id-
keystringtrue变量key-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/processAdmin/services/rest/variable/deleteVariableLocal

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据任务id获取流程变量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/variable/getVariable

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据任务id获取流程变量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
taskIdstringtrue任务id-
keystringtrue变量key-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/variable/getVariable?tenantId=&taskId=&key=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
datastring操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

根据流程实例id获取流程变量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/variable/getVariableByProcessInstanceId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例id获取流程变量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程id-
keystringtrue变量key-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/variable/getVariableByProcessInstanceId?tenantId=&processInstanceId=&key=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
datastring操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

获取任务变量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/variable/getVariableLocal

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取任务变量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
taskIdstringtrue任务id-
keystringtrue变量key-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/variable/getVariableLocal?tenantId=&taskId=&key=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
datastring操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

获取多个流程变量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/variable/getVariables

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取多个流程变量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
taskIdstringtrue任务id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/variable/getVariables?tenantId=&taskId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─mapKeyobjectA map key.-
     └─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "mapKey": {
      "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
    }
  }
}

获取指定的流程变量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/variable/getVariablesByProcessInstanceId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 获取指定的流程变量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例id-

Body-parameters:

ParameterTypeRequiredDescriptionSince
successbooleanfalse操作是否成功-
codeint32false错误代码-
msgstringfalse操作描述-
dataarrayfalse操作成功返回的数据-

Request-example:

bash
curl -X GET -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/processAdmin/services/rest/variable/getVariablesByProcessInstanceId?tenantId=&processInstanceId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    "",
    ""
  ]
}'

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─mapKeyobjectA map key.-
     └─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "mapKey": {
      "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
    }
  }
}

获取所有任务变量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/variable/getVariablesLocal

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取所有任务变量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
taskIdstringtrue任务id-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/variable/getVariablesLocal?tenantId=&taskId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─mapKeyobjectA map key.-
     └─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "mapKey": {
      "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
    }
  }
}

根据任务id设置流程变量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/variable/setVariable

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 根据任务id设置流程变量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
taskIdstringtrue任务id-
keystringtrue变量key-

Body-parameters:

ParameterTypeRequiredDescriptionSince
successbooleanfalse操作是否成功-
codeint32false错误代码-
msgstringfalse操作描述-
dataobjectfalse操作成功返回的数据-
└─mapKeyobjectfalseA map key.-
     └─any objectobjectfalseany object.-

Request-example:

bash
curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/processAdmin/services/rest/variable/setVariable?tenantId=&taskId=&key= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "mapKey": {
      "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
    }
  }
}'

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据流程实例id设置流程变量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/variable/setVariableByProcessInstanceId

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 根据流程实例id设置流程变量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processInstanceIdstringtrue流程实例id-
keystringtrue变量key-

Body-parameters:

ParameterTypeRequiredDescriptionSince
successbooleanfalse操作是否成功-
codeint32false错误代码-
msgstringfalse操作描述-
dataobjectfalse操作成功返回的数据-
└─mapKeyobjectfalseA map key.-
     └─any objectobjectfalseany object.-

Request-example:

bash
curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/processAdmin/services/rest/variable/setVariableByProcessInstanceId?tenantId=&processInstanceId=&key= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "mapKey": {
      "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
    }
  }
}'

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

设置任务变量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/variable/setVariableLocal

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 设置任务变量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
taskIdstringtrue任务id-
keystringtrue变量key-

Body-parameters:

ParameterTypeRequiredDescriptionSince
successbooleanfalse操作是否成功-
codeint32false错误代码-
msgstringfalse操作描述-
dataobjectfalse操作成功返回的数据-
└─mapKeyobjectfalseA map key.-
     └─any objectobjectfalseany object.-

Request-example:

bash
curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/processAdmin/services/rest/variable/setVariableLocal?tenantId=&taskId=&key= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "mapKey": {
      "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
    }
  }
}'

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

设置多个流程变量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/variable/setVariables

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 设置多个流程变量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
taskIdstringtrue任务id-

Body-parameters:

ParameterTypeRequiredDescriptionSince
successbooleanfalse操作是否成功-
codeint32false错误代码-
msgstringfalse操作描述-
dataobjectfalse操作成功返回的数据-
└─mapKeyobjectfalseA map key.-
     └─any objectobjectfalseany object.-

Request-example:

bash
curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/processAdmin/services/rest/variable/setVariables?tenantId=&taskId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "mapKey": {
      "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
    }
  }
}'

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

设置多个任务变量 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/variable/setVariablesLocal

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 设置多个任务变量

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
taskIdstringtrue任务id-

Body-parameters:

ParameterTypeRequiredDescriptionSince
successbooleanfalse操作是否成功-
codeint32false错误代码-
msgstringfalse操作描述-
dataobjectfalse操作成功返回的数据-
└─mapKeyobjectfalseA map key.-
     └─any objectobjectfalseany object.-

Request-example:

bash
curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/processAdmin/services/rest/variable/setVariablesLocal?tenantId=&taskId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "mapKey": {
      "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
    }
  }
}'

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

获取当前任务节点的目标节点 ​

获取当前任务节点的目标节点 ​

URL: https://demo.youshengyun.com/processAdmin/services/rest/workflow/getCurrentTaskTargets

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取当前任务节点的目标节点

Query-parameters:

ParameterTypeRequiredDescriptionSince
tenantIdstringtrue租户id-
processDefinitionIdstringtrue流程定义id-
taskDefKeystringtrue任务key-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/processAdmin/services/rest/workflow/getCurrentTaskTargets?tenantId=&processDefinitionId=&taskDefKey=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─taskDefKeystring节点key-
└─taskDefNamestring任务名称（线上名称存在这里就是线的名字）-
└─multiInstancestring多实例类型-
└─typestring节点类型-
└─conditionExpressionstring条件表达式-
└─realTaskDefNamestring实际任务名称-
└─commonButtonNamesstring节点绑定的普通按钮-
└─sendButtonNamesstring节点绑定的发送按钮-
└─opinionFrameNamesstring节点绑定的意见框名称-
└─bindNamesstring节点绑定的编号信息-
└─roleNamesstring节点绑定的角色信息-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "taskDefKey": "",
      "taskDefName": "",
      "multiInstance": "",
      "type": "",
      "conditionExpression": "",
      "realTaskDefName": "",
      "commonButtonNames": "",
      "sendButtonNames": "",
      "opinionFrameNames": "",
      "bindNames": "",
      "roleNames": ""
    }
  ]
}

错误码列表 ​

Error codeDescription
0操作成功
1服务器内部错误，请联系开发人员
2参数校验失败
3对象[{}]不存在
100令牌未传入
101令牌已失效
102校验令牌出问题了
200权限不足拒绝访问
211当前用户不是全局系统管理员
212当前用户不是全局安全保密员
213当前用户不是全局安全审计员
214当前用户不是部门系统管理员
215当前用户不是部门安全保密员
216当前用户不是部门安全审计员
220当前用户没有拥有角色[{}]
221当前岗位没有拥有角色[{}]
222当前用户不是[{}]
230当前用户没有被授权资源[{}]
231当前岗位没有被授权资源[{}]

数据字典 ​

http状态码字典 ​

CodeTypeDescription
200stringok
400stringBad Request
401stringUnauthorized
403stringForbidden
404stringNot Found
415stringUnsupported Media Type
500stringInternal Server Error
502stringBad Gateway
503stringService Unavailable

Released under the GPL-3.0 License.

Copyright © 2024-present 北京有生博大软件股份有限公司