万店掌 开放平台 oa任务详情

open.oa.task.getTaskDetail (oa任务详情 )

oa任务详情

接口描述 #

环境 接口方法 提交方式 是否需要签名 HTTP请求路由
正式环境 open.oa.task.getTaskDetail POST true http://cloudapi.ovopark.com/cloud.api

公共请求参数 #

参数 类型 是否必填 最大长度 描述 示例值
_aid String 20 开放平台系统编号,固定为S107 S107
_akey String 20 万店掌开放平台分配给第三方的开发者key 认证平台开发者后获取
_mt String 100 接口名称 open.oa.task.getTaskDetail
_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

业务请求参数 #

参数 类型 是否必填 最大长度 描述 示例值
endTime
string × 11 任务结束时间
startTime
string × 0 任务开始时间
taskId
int × 0 任务ID

公共响应参数 #

参数 类型 最大长度 描述 示例值
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 查看
    
aIModel
boolean × 0 aIModel
    
attachLimit
int × 0 附件、图片最小数量限制 必需 无明细任务生效,有明细任务参考明细数组里的attachLimit
    
attachMaxLimit
int × 0 附件、图片最大数量限制 必需 无明细任务生效,有明细任务参考明细数组里的attachMaxLimit
    
attachments
string × 0 附件:集合类型 [][object {2}] attachNames string 附件名称 必需 attachmentUrls string 附件URL 必需
    
cannotOverdueExecution
int × 0 不可逾期执行
    
ccSelectType
int × 0 抄送人选择人员方式
    
ccpersonList
string × 0 抄送人员 数[] endTime integer 任务结束时间,enterpriseId integer 企业ID,id integer 可选,isClosed integer 是否停用 可选,isDelete integer 是否删除 可选,isExpired integer 是否超期 可选,isRead integer 是否已读 可选,shortName string 名称简写 可选,startTime integer 任务开始时间 可选,state integer 人员状态 可选 默认1正常,0删除,2冻结,taskId integer 任务ID 可选,taskRoleType integer 人员角色 可选 1执行人;2检查人;3抄送人,userId integer 抄送人用户ID 可选,userName string 抄送人用户名 可选
    
createTime
string × 0 任务创建时间
    
creatorId
int × 0 创建人用户ID
    
creatorName
int × 0 创建人用户名
    
departmentDetail
string × 0 门店明细列表 集合[] depId integer 门店ID, depName string 门店名称,executorNum integer, hasRegress boolean ,openStatus integer ,state integer ,submitQuestionnaireStatus integer,taskDepStatus integer 门店任务状态
    
enableDetailComment
boolean × 0 开启明细评论 必需 明细任务生效,默认0关闭,1打开。如果开启明细评论,则不允许统一评论,默认统一评论
    
enableInapplicable
int × 0 是否启用不适用 默认0关闭,1开启
    
enableRealtimeShooting
int × 0 是否开启实时拍摄
    
enableReject
int × 0 是否执行人拒绝功能
    
endTime
int × 0 结束时间
    
enterpriseId
int × 0 企业ID
    
executionDetails
string × 0 明细 array [object {9}] 【集合】 attachLimit integer ,attachMaxLimit integer, enterpriseId integer ,id integer ,notifyType integer ,remark string ,sort integer ,taskId integer ,urls string
    
executorSelectType
string × 0 执行人选择人员方式 默认1指定成员、3角色、4指定门店、6组织架构门店
    
expireNotify
string × 0 object 超期提醒:【集合】 id integer ,remindCc boolean 是否提醒抄送人 remind ,Inspector boolean 是否提醒审核人,taskId integer 任务ID
    
forwardRecords
int × 0 array[string] 转执行记录
    
id
int × 0 任务ID
    
importance
int × 0 优先级 0最低级 5最高级
    
inspectorList
string × 0 检查人列表【集合】 endTime integer 任务结束时间,enterpriseId integer 企业ID,id integer 可选,isClosed integer 是否停用 可选,isDelete integer 是否删除 可选,isExpired integer 是否超期 可选,isRead integer 是否已读 可选,shortName string 名称简写 可选,startTime integer 任务开始时间 可选,state integer 人员状态 可选 默认1正常,0删除,2冻结,taskId integer 任务ID 可选,taskRoleType integer 人员角色 可选 1执行人;2检查人;3抄送人,userId integer 抄送人用户ID 可选,userName string 抄送人用户名 可选
    
inspectorSelectType
int × 0 检查人选择人员方式 0无检查人自动审核,默认1指定成员
    
isClosed
int × 0 是否停用
    
isConfigure
int × 0 是否要上传照片/视频
    
isDelete
int × 0 是否删除
    
isDone
int × 0 是否有人做过
    
isExecutionDetail
int × 0 是否明细任务
    
isExpired
int × 0 是否超期
    
isPeriod
int × 0 是否周期任务
    
isRemind
int × 0 是否需要提醒
    
isStoreMode
int × 0 任务执行模式
    
lableId
string × 0 标签ID
    
overdueExecutionTime
int × 0 驳回后逾期执行时间,单位h, 单位h,默认0不设置
    
overdueTaskDefaultClose
int × 0 超期任务默认关闭
    
remark
int × 0 任务描述
    
startTime
int × 0 任务开始时间
    
taskAttach
JSON × 0 任务附件 查看
    
taskCommentList
JSON × 0 任务评论列表 查看
    
taskName
string × 0 任务名
    
taskStatus
int × 0 任务状态
    
taskType
int × 0 任务类型
    
templateId
int × 0 模板ID
    
templateNo
int × 0 模板编号
    
requestId
int × 0 requestId

公共返回码 #

返回码名称 返回码 返回码描述 解决方案
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