(触点)任务发布管理

任务管理2.0API

使用任务模板创建任务API

基本信息

Path： /api/taskhall/v1/taskAPI/addTask

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
taskTypeCode	string	必须		任务类型编码
tenCode	string	必须		租户编码
taskDetails	object	非必须		任务详细信息
├─ taskInfoId	string	非必须		任务信息表编码
├─ taskDetailsCode	string	非必须		任务详情编码
├─ province	string	非必须		省
├─ city	string	非必须		市
├─ area	string	非必须		区
├─ town	string	非必须		镇
├─ linkName	string	非必须		联系人
├─ linkPhone	string	非必须		联系电话
├─ planNum	integer	非必须		计划人数>1
├─ maxReceiveNum	string	非必须		最大领取人数（0表示不限制）
├─ getStartTime	string	非必须		任务开始领取时间
├─ getEndTime	string	非必须		任务结束领取时间
├─ planStartTime	string	非必须		任务计划开始时间
├─ planEndTime	string	非必须		任务计划结束时间
taskRules	object []	非必须		规则信息	item 类型: object
├─ taskRulesTitle	string	非必须		任务执行规则名称
├─ day	object []	非必须		任务执行日规则	item 类型: object
├─ task_rules_id	string	非必须		任务执行规则编码
├─ rules_type	string	非必须		执行日类型（00000:连档，01000:双休日，01001:做五休二，01002:做六休一，01003:做一休一）
├─ rules_string	string	非必须		执行日规则配置（周一到周末，0表示非执行日，1表示执行日011/01/11）
├─ rules_explain	string	非必须		执行日规则说明
├─ time	object []	非必须		任务执行时间规则	item 类型: object
├─ task_rules_id	string	非必须		任务执行规则编码
├─ time_type	string	非必须		时间类型（0:工作，1:休息，2:吃饭）
├─ start_time	string	非必须		开始时间
├─ end_time	string	非必须		结束时间
extra	object []	非必须		任务补全信息	item 类型: object
├─ extraName	string	非必须		扩展字段名称
├─ extraCode	string	非必须		扩展字段code
├─ extraValue	string	非必须		扩展字段值
├─ extraType	string	非必须		扩展字段类型(text文本，number数字，date日期，radio单选, checkbox多选)
├─ memo	string	非必须		备注

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	必须		状态
errCode	string	非必须		错误编码
errMessage	string	非必须		错误信息
traceId	string	必须
data	object	非必须
├─ taskDetailsCode	string	非必须		任务编码

查询任务信息API

基本信息

Path： /api/taskhall/v1/taskAPI/getTaskInfo

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
taskDetailsCode	是		任务详情编码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	必须		状态
errCode	string	非必须		错误码
errMessage	string	非必须		错误信息
traceId	string	必须
data	object	非必须		任务信息
├─ taskDetails	object	非必须		任务详情
├─ taskInfoId	string	非必须		任务信息表编码
├─ taskDetailsCode	string	非必须		任务详情编码
├─ province	string	非必须		省
├─ city	string	非必须		市
├─ area	string	非必须		区
├─ town	string	非必须		镇
├─ linkName	string	非必须		联系人
├─ linkPhone	string	非必须		联系电话
├─ planNum	integer	非必须		计划人数>1
├─ maxReceiveNum	string	非必须		最大领取人数（0表示不限制）
├─ getStartTime	string	非必须		任务开始领取时间
├─ getEndTime	string	非必须		任务结束领取时间
├─ planStartTime	string	非必须		任务计划开始时间
├─ planEndTime	string	非必须		任务计划结束时间
├─ taskInfo	object	非必须		任务信息
├─ taskInfoCode	string	非必须		任务编码
├─ taskInfoTitle	string	非必须		任务标题
├─ typeCode	string	非必须		任务类型编码
├─ typeName	string	非必须		任务类型名称
├─ taskDescription	string	非必须		任务说明
├─ taskRequire	string	非必须		任务要求
├─ taskTVersion	string	非必须		任务模板版本
├─ extra	object []	非必须		扩展字段	item 类型: object
├─ extraName	string	非必须		扩展字段名称
├─ extraCode	string	非必须		扩展字段编码
├─ extraValue	string	非必须		扩展字段值
├─ extraType	string	非必须		扩展字段类型(text文本，number数字，date日期，radio单选, checkbox多选)
├─ memo	string	非必须		备注
├─ taskPackage	object	非必须		任务包
├─ packageCode	string	非必须		任务包编码
├─ packageType	integer	非必须		任务包类型:关联的任务类型,0：执行模板；1：执行任务，2：非执行任务，3：任务库
├─ memo	string	非必须		描述
├─ publishPort	string	非必须		任务发布端口：MIKA:米咖(default),SMV:SMV,DDAPP:督导APP,DZXCX:店主小程序,udefined:自定义
├─ performPort	string	非必须		执行端口：MIKA:米咖(default),UDEFINED:自定义
├─ performUrl	string	非必须		执行地址
├─ performUrlParam	string	非必须		执行地址参数配置json格式:[{"k":"123","v":"123"}]//k表示变量名v表示变量值，isp表示是否做传递参数
├─ callbackUrl	string	非必须		回调地址
├─ callbackUrlParam	string	非必须		回调地址参数说明：json格式:[{"k":"123","v":"123"}]//k表示变量名v表示变量值，isp表示是否做接收参数
├─ c1	string	非必须		扩展字段1
├─ c2	string	非必须		扩展字段2
├─ c3	string	非必须		扩展字段3
├─ c4	string	非必须		扩展字段4
├─ c5	string	非必须		扩展字段5
├─ taskSub	object []	非必须		子任务	item 类型: object
├─ title	string	非必须		任务标题
├─ code	string	非必须		任务编码
├─ sort	string	非必须		任务排序
├─ frontId	string	非必须		前置任务编码
├─ must	string	非必须		是否必做
├─ frequency	string	非必须		任务执行频次
├─ tips	string	非必须		提示语
├─ collectItems	object []	非必须		采集项	item 类型: object
├─ title	string	非必须		采集项标题
├─ code	string	非必须		采集项编码
├─ sort	string	非必须		采集项排序
├─ sampleText	string	非必须		采集项示例说明
├─ sampleImg	string	非必须		采集项示例图片
├─ itemType	string	非必须		采集项类型0：问答；1：单选；2：多选；3：图片上传(单张)；4：图片上传(多张)
├─ itemNo	string	非必须		采集项编号
├─ tips	string	非必须		提示语
├─ isMust	string	非必须		采集项是否必填（0：非必填，1:必填）
├─ imgSize	string	非必须		图片大小要求
├─ imgMaxCnt	string	非必须		图片最多张数
├─ memo	string	非必须		备注
├─ options	object []	非必须		选项（采集项类型值为1或2时存在）	item 类型: object
├─ taskSubItemId	string	非必须		任务采集项编码
├─ optionNo	string	非必须		选项编号
├─ title	string	非必须		选项标题
├─ code	string	非必须		选项编码
├─ sort	string	非必须		选项排序
├─ tips	string	非必须		提示语
├─ memo	string	非必须		备注

查询任务模板API

基本信息

Path： /api/taskhall/v1/taskAPI/getMode

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
typeCode	是		任务类型编码
tenCode	是		租户编码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	必须		状态
errCode	string	非必须		错误码
errMessage	string	非必须		错误信息
traceId	string	必须
data	object	非必须		模板信息
├─ platformTemplate	object	非必须		平台任务模板
├─ taskTCode	string	非必须		任务模板编码
├─ templateType	string	非必须		0：平台模板，1：租户模板
├─ taskTitle	string	非必须		任务标题
├─ typeCode	string	非必须		任务类型编码
├─ typeName	string	非必须		任务类型名称
├─ taskDescription	string	非必须		任务说明
├─ taskRequire	string	非必须		任务要求
├─ taskPackage	object	非必须		任务包
├─ packageCode	string	非必须		任务包编码
├─ packageType	integer	非必须		任务包类型:关联的任务类型,0：执行模板；1：执行任务，2：非执行任务，3：任务库
├─ memo	string	非必须		描述
├─ publishPort	string	非必须		任务发布端口：MIKA:米咖(default),SMV:SMV,DDAPP:督导APP,DZXCX:店主小程序,udefined:自定义
├─ performPort	string	非必须		执行端口：MIKA:米咖(default),UDEFINED:自定义
├─ performUrl	string	非必须		执行地址
├─ performUrlParam	string	非必须		执行地址参数配置json格式:[{"k":"123","v":"123"}]//k表示变量名v表示变量值，isp表示是否做传递参数
├─ callbackUrl	string	非必须		回调地址
├─ callbackUrlParam	string	非必须		回调地址参数说明：json格式:[{"k":"123","v":"123"}]//k表示变量名v表示变量值，isp表示是否做接收参数
├─ c1	string	非必须		扩展字段1
├─ c2	string	非必须		扩展字段2
├─ c3	string	非必须		扩展字段3
├─ c4	string	非必须		扩展字段4
├─ c5	string	非必须		扩展字段5
├─ taskSub	object []	非必须		子任务	item 类型: object
├─ title	string	非必须		任务标题
├─ code	string	非必须		任务编码
├─ sort	string	非必须		任务排序
├─ frontId	string	非必须		前置任务编码
├─ must	string	非必须		是否必做
├─ frequency	string	非必须		任务执行频次
├─ tips	string	非必须		提示语
├─ collectItems	object []	非必须		采集项	item 类型: object
├─ title	string	非必须		采集项标题
├─ code	string	非必须		采集项编码
├─ sort	string	非必须		采集项排序
├─ sampleText	string	非必须		采集项示例说明
├─ sampleImg	string	非必须		采集项示例图片
├─ itemType	string	非必须		采集项类型0：问答；1：单选；2：多选；3：图片上传(单张)；4：图片上传(多张)
├─ itemNo	string	非必须		采集项编号
├─ tips	string	非必须		提示语
├─ isMust	string	非必须		采集项是否必填（0：非必填，1:必填）
├─ imgSize	string	非必须		图片大小要求
├─ imgMaxCnt	string	非必须		图片最多张数
├─ memo	string	非必须		备注
├─ options	object []	非必须		选项（采集项类型值为1或2时存在）	item 类型: object
├─ taskSubItemId	string	非必须		任务采集项编码
├─ optionNo	string	非必须		选项编号
├─ title	string	非必须		选项标题
├─ code	string	非必须		选项编码
├─ sort	string	非必须		选项排序
├─ tips	string	非必须		提示语
├─ memo	string	非必须		备注
├─ tenantTemplate	object	非必须		租户任务模板
├─ taskTCode	string	非必须		任务模板编码
├─ templateType	string	非必须		0：平台模板，1：租户模板
├─ taskTitle	string	非必须		任务标题
├─ typeCode	string	非必须		任务类型编码
├─ typeName	string	非必须		任务类型名称
├─ taskDescription	string	非必须		任务说明
├─ taskRequire	string	非必须		任务要求
├─ taskPackage	object	非必须		任务包
├─ packageCode	string	非必须		任务包编码
├─ packageType	integer	非必须		任务包类型:关联的任务类型,0：执行模板；1：执行任务，2：非执行任务，3：任务库
├─ memo	string	非必须		描述
├─ publishPort	string	非必须		任务发布端口：MIKA:米咖(default),SMV:SMV,DDAPP:督导APP,DZXCX:店主小程序,udefined:自定义
├─ performPort	string	非必须		执行端口：MIKA:米咖(default),UDEFINED:自定义
├─ performUrl	string	非必须		执行地址
├─ performUrlParam	string	非必须		执行地址参数配置json格式:[{"k":"123","v":"123"}]//k表示变量名v表示变量值，isp表示是否做传递参数
├─ callbackUrl	string	非必须		回调地址
├─ callbackUrlParam	string	非必须		回调地址参数说明：json格式:[{"k":"123","v":"123"}]//k表示变量名v表示变量值，isp表示是否做接收参数
├─ c1	string	非必须		扩展字段1
├─ c2	string	非必须		扩展字段2
├─ c3	string	非必须		扩展字段3
├─ c4	string	非必须		扩展字段4
├─ c5	string	非必须		扩展字段5
├─ taskSub	object []	非必须		子任务	item 类型: object
├─ title	string	非必须		任务标题
├─ code	string	非必须		任务编码
├─ sort	string	非必须		任务排序
├─ frontId	string	非必须		前置任务编码
├─ must	string	非必须		是否必做
├─ frequency	string	非必须		任务执行频次
├─ tips	string	非必须		提示语
├─ collectItems	object []	非必须		采集项	item 类型: object
├─ title	string	非必须		采集项标题
├─ code	string	非必须		采集项编码
├─ sort	string	非必须		采集项排序
├─ sampleText	string	非必须		采集项示例说明
├─ sampleImg	string	非必须		采集项示例图片
├─ itemType	string	非必须		采集项类型0：问答；1：单选；2：多选；3：图片上传(单张)；4：图片上传(多张)
├─ itemNo	string	非必须		采集项编号
├─ tips	string	非必须		提示语
├─ isMust	string	非必须		采集项是否必填（0：非必填，1:必填）
├─ imgSize	string	非必须		图片大小要求
├─ imgMaxCnt	string	非必须		图片最多张数
├─ memo	string	非必须		备注
├─ options	object []	非必须		选项（采集项类型值为1或2时存在）	item 类型: object
├─ taskSubItemId	string	非必须		任务采集项编码
├─ optionNo	string	非必须		选项编号
├─ title	string	非必须		选项标题
├─ code	string	非必须		选项编码
├─ sort	string	非必须		选项排序
├─ tips	string	非必须		提示语
├─ memo	string	非必须		备注