# 创建待办

调用本接口,会创建一条待办任务,显示在应办人的待办列表中。

# 权限

要调用此API,需要申请poa能力,获取poa token,接口请求头中添加 Authorization 值为token

详细参考-获取access token

# 请求方法

报文样例

POST /apis/ttc/v1/transaction/poa/todo/addTask
Host: poa地址
Authorization:String
Content-Type:application/json

[
  {
    "appId": "xxx",
    "taskId": "TASK-01",
    "transactionId": "",
    "transactionName": "自定义事务名称",
    "taskName": "待办名称0001",
    "transTypeCode": "xxxx",
    "handlers": "xxxx",
    "handlingGroup": "",
    "initiator": "xxx",
    "initiatorName": "xxx",
    "viewUrl": "xxx",
    "handleUrl": "xxx",
    "mhandleUrl": "xxx",
    "mviewUrl": "xxx"
  }, 
  {
    "appId": "xxx",
    "taskId": "TASK-02",
    "transactionId": "",
    "transactionName": "自定义事务名称",
    "taskName": "待办名称0002",
    "transTypeCode": "xxxx",
    "handlers": "xxxx",
    "handlingGroup": "",
    "initiator": "xxx",
    "initiatorName": "xxx",
    "viewUrl": "xxx",
    "handleUrl": "xxx",
    "mhandleUrl": "xxx",
    "mviewUrl": "xxx"
  }
]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

# Header参数

名称 类型 是否必填 描述
Authorization String 调用该接口的访问凭证

# Body参数

名称 类型 是否必填 描述
appId String 业务系统应用appId(在事务中心注册的应用id值)
autoGenTaskId Boolean 表示是否自动生成taskId,为空或者false时,taskId字段必填,如果为true且taskId为空时, 则自动生成taskId ;前提条件是数组<=1 (ttc-api版本>=1.3.9)
taskId String 条件必填 任务ID(唯一值,任务唯一标识,任务办理时依赖此参数)
taskName String 任务名称
transTypeCode String 事务类型码值 (在事务中心注册的应用下创建)
handlers String 条件必填 办理人学工号,多个学工号通过","分离
handlingGroup String 条件必填 办理用户组,多个用户组通过","分离 与handlers字段选择一个必填
transactionId String 事务ID,唯一,通过此参数可以将多条待办关联显示在一条事务中
transactionName String 事务名称,自定义发起标题:不传发起标题则为事务类型名称 (1.3.8-release.3版本)
initiator String 发起人学工号,为空取应用名称
initiatorName String 发起人姓名
viewUrl String 待办PC查看地址
handleUrl String 待办PC办理地址
mhandleUrl String 待办APP办理地址
mviewUrl String 待办APP查看地址

入参中transactionId(事务ID)是指待办任务关联的实例ID。

  • 为空时,一条待办任务对应一条事务,事务ID自动生成;
  • 不为空时,按照入参提供的事务ID创建事务,并自动将事务ID相同待办任务关联到该事务。事务办结时,需要调用修改事务状态接口,对事务状态进行修改 详细参考-修改事务状态

# 接口调用成功返回

接口返回code值0为成功返回

{
  "took": 6089,
  "timestamp": 1688956011462,
  "code": 0,
  "message": "创建成功",
  "data": {
    "successIds": ["cfbff0d193755685968c48ce8b15ae17"],
    "errorIds": [],
  }
}
1
2
3
4
5
6
7
8
9
10

# 接口调用失败返回

  • 接口支持批量,批量操作中的每条数据独立运行,批量中有失败的数据接口整体响应code为0 (成功),data中返回出现错误的数据
  • 外层响应code不为0时为未知的错误,请自行设计重试机制
{
  "took": 80,
  "timestamp": 1688701475919,
  "code": 0,
  "message": "创建中有异常数据",
  "data": {
    "errorIds": [
      {
        "code": 400,
        "taskId": "TTTT-PL-002",
        "message": "transTypeCode is null"
      },
      {
        "code": 400,
        "taskId": "TTTT-PL-004",
        "message": "handlers and handlingGroup are all null"
      }
    ]
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

data.errorIds.code说明:

code message 说明
400 xxx is null 参数校验不合法
400 this app/transTypeCode does not exist 业务校验异常:应用或者类型不存在
500 the app/transactionType is not enabled 业务校验异常:应用或者类型未启用
500 * 业务逻辑异常
2003 the task already exists 当前任务已存在