open.oa.task.createTask （创建OA任务）
创建OA任务
接口描述#
| 环境 | 接口方法 | 提交方式 | 是否需要签名 | HTTP请求路由 |
|---|---|---|---|---|
| 正式环境 | open.oa.task.createTask | POST | true | http://cloudapi.ovopark.com/cloud.api |
公共请求参数#
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| _aid | String | 是 | 20 | 开放平台系统编号，固定为S107 | S107 |
| _akey | String | 是 | 20 | 万店掌开放平台分配给第三方的开发者key | 认证平台开发者后获取 |
| _mt | String | 是 | 100 | 接口名称 | open.oa.task.createTask |
| _sm | String | 是 | 100 | 签名算法 md5,sha1 | md5 |
| _requestMode | String | 是 | 100 | 请求方式post,get | POST |
| _version | String | 是 | 100 | 版本号 | v1 |
| _timestamp | String | 是 | 100 | 时间戳 | yyyyMMddHHmmss格式 |
| _sig | String | 是 | 32 | 签名token | 根据签名算法生成，详情见签名算法规则 |
| _format | String | 否 | 10 | format类型 | 目前默认仅支持json |
业务请求参数#
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| taskVoJson | string | √ | 99 | application/x-www-form-urlencoded | { "enterpriseId": 1084, "executors": [ ], "taskDeps": [ 87846, 87847 ], "taskName": "任务参数", "taskType": 0, "isPeriod": 0, "inspectorIds": [ 512174639 ], "ccpersonIds": [ 512535874 ], "ccSelectType": 1, "executorSelectType": 4, "importance": 0, "isStoreMode": 1, "remark": "任务描述", "richRemark": "", "startTime": "2024-11-28 00:00:00", "endTime": "2024-11-29 23:59:59", "attachments": [ { } ], "executionDetails": [ { "remark": "明细1", "urlList": [ ], "attachLimit": 1, "attachMaxLimit": 50, "notifyType": 0, "appointNotifyTimes": "", "pointInTimes": "", "sort": 1 }, { "remark": "明细2", "urlList": [ ], "attachLimit": 2, "attachMaxLimit": 50, "notifyType": 0, "sort": 2 } ], "isExecutionDetail": 1, "enableAI": false, "AIModel": "", "subTaskDetail": [ ], "taskUrls": [ ], "thirdPartyType": 0, "thirdPartyId": null, "lableId": "17261", "attachLimit": 1, "attachMaxLimit": 50, "enableDetailComment": false, "enableRealtimeShooting": true, "notifies": [ { "notifyType": 1, "duration": 30 } ], "startOfNotifies": [ { "notifyType": -1, "duration": 30, "notifyObjects": "1,2,3,0" } ], "expireNotify": { "remindInspector": false, "remindCc": true, "appointUsers": [] }, "isConfigure": 1, "cannotOverdueExecution": 1, "overdueTaskDefaultClose": 1, "strongReminderType": 0, "enableInapplicable": 0, "cannotSubmitAfterRejection": 1, "enableReject": 1, "overdueExecutionTime": 1, "executorsFilters": [ { "objectId": 2, "objectName": "店长[系统自带]", "objectType": 1 }, { "objectId": 3, "objectName": "督导[系统自带]", "objectType": 1 } ], "inspectorSelectType": 1, "inspectorFilters": [ { "objectId": 2, "objectName": "店长[系统自带]", "objectType": 1 }, { "objectId": 3, "objectName": "督导[系统自带]", "objectType": 1 } ], "taskAttach": [ { "isPicture": 1, "isVideo": 0 } ] } |
| × | |||||
| JSON | √ | 0 | 执行人员ID数组（人员模式传值），人员模式必填 | 查看 | |
| JSON | √ | 0 | 执行门店ID数组（门店模式传值），门店模式必填 | 查看 | |
| int | √ | 0 | 任务描述，必填 | 最大50字 | |
| int | √ | 0 | 任务类型 0 执行任务 1阅读任务 必填 | ||
| int | √ | 0 | 默认0即可，是否老循环任务（老循环任务已移除）必填 | ||
| JSON | √ | 0 | // 检查人员ID数组 ， inspectorSelectType= 0自动审核可以不填，其他必填 | 查看 | |
| JSON | √ | 0 | // 抄送人员ID数组 ，非必填 | 查看 | |
| int | × | 0 | 抄送人选择类型 1指定人员 , 默认1即可 | ||
| int | √ | 0 | 执行人员选择类型 1指定人员 4指定门店 ，必填 | ||
| int | × | 0 | 优先级， 0最低级 5最高级 ，非必填 | ||
| int | × | 0 | 是否门店模式 1门店模式，0 人员模式， 必填 | ||
| string | × | 0 | 任务描述, &richRemark只能二选一生效， 非必填 | 最大5000字 | |
| string | × | 0 | 富文本描述 ，非必填 | ||
| string | √ | 0 | 任务开始时间，必填 | 时间格式yyyy-MM-dd HH:mm:ss | |
| string | √ | 0 | 任务结束时间，必填 | 时间格式yyyy-MM-dd HH:mm:ss | |
| JSON | × | 0 | 任务附件 ，非必填 | 查看 | |
| string | × | 0 | 附件名称 | ||
| string | × | 0 | 附件地址URL | ||
| JSON | √ | 0 | 执行明细 isExecutionDetail=0必填 | 查看 | |
| int | √ | 0 | 明细描述 | ||
| int | × | 0 | 明细图片地址URL | ||
| int | × | 0 | 上传最小数量 | ||
| int | × | 0 | 最大上传数量 | ||
| int | × | 0 | 通知类型，0 不提醒，1每天按照时间点提醒 取pointInTimes 2 指定时间提醒 取appointNotifyTimes | ||
| int | × | 0 | 指定时间，String 格式(yyyy-MM-dd HH:mm:ss)，多个英文逗号分隔（目前支持一个即可） | ||
| int | × | 0 | 指定时间点，String 格式(HH:mm:ss)，多个英文逗号分隔（目前支持一个即可） | ||
| int | √ | 0 | 明细排序 | ||
| int | √ | 0 | 是否明细任务，1是，0非明细任务，明细任务executionDetails必传。必填 | ||
| int | × | 0 | 第三方任务类型，0关闭1店报任务 2 问卷 ，非必填 | ||
| int | × | 0 | 第三方业务ID，非必填 | ||
| string | × | 0 | 标签ID，多个英文逗号分隔，非必填 | ||
| int | × | 0 | 非明细任务最小上传数量，非必填，默认1 | ||
| int | × | 0 | 非明细任务最大上传数量，非必填默认50，最大限制50 | ||
| boolean | × | 0 | 是否开启开启明细评论，isExecutionDetail = 1生效，如果开启明细评论，则不允许统一评论，默认统一评论。，非必填 | ||
| boolean | × | 0 | 是否开启实时拍摄，默认空，空或false不限制，非必填 | ||
| JSON | × | 0 | 到期前提醒 ，非必填 | 查看 | |
| int | × | 0 | 通知类型，1：分钟前，2：小时前，3 天 | ||
| int | × | 0 | 具体时长，分钟或者小时、天 | ||
| JSON | × | 0 | 开始前提醒，非必填 | 查看 | |
| int | × | 0 | 开始前通知类型，-1：分钟前，-2：小时前，-3 天 | ||
| int | × | 0 | 具体时长，分钟或者小时、天 | ||
| int | × | 0 | 通知对象 0 创建人，1执行人 2 审核人 3 抄送人 ，多个英文逗号分隔 | ||
| int | × | 0 | 到期后未执行情况提醒。 overdueTaskDefaultClose=0 可配置生效，非必填 | ||
| boolean | × | 0 | 提醒审核人 | ||
| JSON | × | 0 | "[{"userId":512504938,"userName":"geyang"},{"userId":512520033,"userName":"geyangcs"}]" // 提醒指定人，需要用户ID，用户名。限制任务20人 | 查看 | |
| int | √ | 0 | 是否要上传照片/视频，必填 | 1是0否 | |
| int | × | 0 | 不可逾期执行 1是，0否，必填，不可修改 | ||
| int | × | 0 | 超期任务默认关闭 1是 0否，必填，不可修改 | ||
| int | × | 0 | 是否允许执行人选择『不适用』选项 1是 0否（明细任务生效），必填，不可修改 | ||
| int | × | 0 | 驳回后不可再次提交，默认关闭，非必填，不可修改 | 驳回后不可再次提交，1是，0否默认0关闭，非必填，不可修改 | |
| int | × | 0 | 是否执行人拒绝功能，默认0关闭，1开启.非必填 | ||
| int | √ | 0 | 不可逾期执行开启后，但在驳回的在多少小时时间范围内可以执行,默认0，必填，不可修改 | 1是，0否,默认0，必填，不可修改 | |
| JSON | × | 0 | { "objectId": 2, // 角色ID "objectName": "店长[系统自带]",// 角色名称 "objectType": 1 // 1 角色 } | 查看 | |
| int | √ | 0 | 检查人选择人员方式，0无检查人自动审核，默认1指定成员，必填 | ||
| JSON | × | 0 | { "objectId": 2,// 角色ID "objectName": "店长[系统自带]",// 角色名称 "objectType": 1 // 1 角色 } | 查看 | |
| JSON | × | 0 | 任务图片/视频，非必填 { "url": "https://ovopark-oss-dev.oss-cn-hangzhou.aliyuncs.com/oa-task/1084/web/2024/11/27/SC7XjAQkJVEe2qs.jpg", // 图片地址URL "isPicture": 1, //图片1 "isVideo": 0 // 视频1 } | 查看 |
公共响应参数#
| 参数 | 类型 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|
| stat | JSON | - | 网关状态(具体参数描述如下：) | 查看 |
| stat.cid | String | 100 | http请求的标识符 | |
| stat.code | String | 100 | 网关返回码 | |
| stat.codename | String | 100 | 网关返回码名称 | |
| stat.systime | String | Long | 接口调用的当前时间 | |
| result | String | 100 | 接口返回提示信息 | |
| data | JSON | - | 接口调用返回的业务信息(一般是json格式数据，具体数据格式会在业务返回参数中定义) | 查看 |
业务返回参数#
| 参数名称 | 类型 | 是否一定返回 | 返回最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| data | JSON | × | 11 | 返回json格式 | 查看 |
公共返回码#
| 返回码名称 | 返回码 | 返回码描述 | 解决方案 |
|---|---|---|---|
| SUCCESS | 0 | 调用成功 | |
| KEY_NOTNULL | 1 | _akey和不能为空 | 接口调用时传入_akey参数 |
| KEY_UNLAWFUL | 2 | _akey不合法 | key是非法的,传入正确的key |
| KEY_HAS_EXPIRED | 3 | _akey已过期 | 请续订服务或联系平台管理人员 |
| SIGN_METHOD_NOTNULL | 4 | _sm参数不能为空 | 接口调用时传入_sm参数 |
| SIGN_TYPE_NOTEXIST | 5 | _sm类型不存在 | 目前仅支持md5,sha1 |
| SIGN_NOTNULL | 6 | _sig参数不能为空 | 接口调用时传入_sig参数 |
| SIGN_WRONG | 7 | 无效的签名，请检查参数和签名格式 | _sig值根据签名算法生成 |
| METHOD_NOTNULL | 8 | _mt参数不能为空 | 接口调用时传入_mt参数 |
| METHOD_NOTEXIST_CODE | 9 | _mt对应的方法名不存在或未注册进服务 | 检查_mt方法名和_version版本号对应的方法是否传入错误 |
| REQUESTMODE_NOTNULL | 10 | _requestMode参数不能为空 | 接口调用时传入_requestMode参数 |
| APPLICATIONID_NOTNULL | 11 | _aid参数不能为空 | 接口调用时传入_aid参数 |
| APPLICATIONID_NOTSAME | 12 | _aid与当前key不匹配 | _aid与_akey必须一一对应 |
| VERSION_NOTNULL | 13 | _version版本号不能为空 | 接口调用时传入_version参数 |
| TIMESTAMP_NOTNULL | 14 | _timestamp时间戳不能为空 | 接口调用时传入_timestamp参数 |
| TIMESTAMP_FORMAT_ERROR | 15 | _timestamp时间戳格式化错误 | 按照yyyyMMddHHmmss格式 |
| TIMESTAMP_OVERTIME | 16 | _timestamp已失效 | _timestamp每次接口调用时重新生成 |
| FORMAT_TYPE_NOTEXIST | 17 | _format类型不存在 | 目前仅支持json(默认),xml |
| API_CALL_REPEAT | -100 | 接口重复调用 | 接口平台调用异常 |
| API_SYSTEM_CALL_ERROR | -500 | api调用失败，系统发生异常 | 接口平台调用异常 |
| UNKNOWN_ERROR | -999 | 开放平台系统异常 | 重新发起请求 |
业务返回码#
| 返回码名称 | 返回码 | 返回码描述 |
|---|---|---|
| code | 0 | success |