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

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

oa任务详情

接口描述#

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

公共请求参数#

参数类型是否必填最大长度描述示例值
_aidString20开放平台系统编号,固定为S107S107
_akeyString20万店掌开放平台分配给第三方的开发者key认证平台开发者后获取
_mtString100接口名称open.oa.task.getTaskDetail
_smString100签名算法 md5,sha1md5
_requestModeString100请求方式post,getPOST
_versionString100版本号v1
_timestampString100时间戳yyyyMMddHHmmss格式
_sigString32签名token根据签名算法生成,详情见签名算法规则
_formatString10format类型目前默认仅支持json

业务请求参数#

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

公共响应参数#

参数类型最大长度描述示例值
statJSON-网关状态(具体参数描述如下:)查看
stat.cidString100http请求的标识符
stat.codeString100网关返回码
stat.codenameString100网关返回码名称
stat.systimeStringLong接口调用的当前时间
resultString100接口返回提示信息
dataJSON-接口调用返回的业务信息(一般是json格式数据,具体数据格式会在业务返回参数中定义)查看

业务返回参数#

参数名称类型是否一定返回返回最大长度描述示例值
data
JSON×11返回json查看
    
aIModel
boolean×0aIModel
    
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×0object 超期提醒:【集合】id integer ,remindCc boolean 是否提醒抄送人 remind ,Inspector boolean 是否提醒审核人,taskId integer 任务ID
    
forwardRecords
int×0array[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×0requestId

公共返回码#

返回码名称返回码返回码描述解决方案
SUCCESS0调用成功
KEY_NOTNULL1_akey和不能为空接口调用时传入_akey参数
KEY_UNLAWFUL2_akey不合法key是非法的,传入正确的key
KEY_HAS_EXPIRED3_akey已过期请续订服务或联系平台管理人员
SIGN_METHOD_NOTNULL4_sm参数不能为空接口调用时传入_sm参数
SIGN_TYPE_NOTEXIST5_sm类型不存在目前仅支持md5,sha1
SIGN_NOTNULL6_sig参数不能为空接口调用时传入_sig参数
SIGN_WRONG7无效的签名,请检查参数和签名格式_sig值根据签名算法生成
METHOD_NOTNULL8_mt参数不能为空接口调用时传入_mt参数
METHOD_NOTEXIST_CODE9_mt对应的方法名不存在或未注册进服务检查_mt方法名和_version版本号对应的方法是否传入错误
REQUESTMODE_NOTNULL10_requestMode参数不能为空接口调用时传入_requestMode参数
APPLICATIONID_NOTNULL11_aid参数不能为空接口调用时传入_aid参数
APPLICATIONID_NOTSAME12_aid与当前key不匹配_aid与_akey必须一一对应
VERSION_NOTNULL13_version版本号不能为空接口调用时传入_version参数
TIMESTAMP_NOTNULL14_timestamp时间戳不能为空接口调用时传入_timestamp参数
TIMESTAMP_FORMAT_ERROR15_timestamp时间戳格式化错误按照yyyyMMddHHmmss格式
TIMESTAMP_OVERTIME16_timestamp已失效_timestamp每次接口调用时重新生成
FORMAT_TYPE_NOTEXIST17_format类型不存在目前仅支持json(默认),xml
API_CALL_REPEAT-100接口重复调用接口平台调用异常
API_SYSTEM_CALL_ERROR-500api调用失败,系统发生异常接口平台调用异常
UNKNOWN_ERROR-999开放平台系统异常重新发起请求

业务返回码#

返回码名称返回码返回码描述
code
0success