任务执行管理2.0API

(触点)任务执行管理

平台触点任务执行API管理

任务执行管理2.0API

任务包信息查询

基本信息

Path： /api/con2.0/v1/task/packageApi/package/getPackage

Method： POST

接口描述：

该接口功能为：任务包的信息查询，可以用过任务包编码和租户code查询，appcode可以不传，不传的时候查询的是该租户下的所有任务包。传appcode的时候查询的是该租户内对应应用中的任务包。

请求参数

Headers

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

Body

名称	类型	是否必须	备注
packageCode	string	必须	任务包编码
tenCode	string	必须	租户code
appCode	string	必须	应用code

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	必须
errorCode	string	必须
errorMessage	string	必须
data	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
├─ taskSubId	integer	非必须		子任务ID
├─ title	string	非必须		子任务标题
├─ code	string	非必须		子任务编码
├─ sort	integer	非必须		子任务排序
├─ FrontId	integer	非必须		前置子任务ID
├─ price	number	非必须		子任务定价:小数点后两位
├─ must	integer	非必须		是否必做：0：非必做；1：必做
├─ frequency	integer	非必须		子任务执行频次：1：计划执行日，2：指定时间范围，3：每周一次
├─ startTime	string	非必须		子任务开始时间
├─ endTime	string	非必须		子任务结束时间
├─ tips	string	非必须		提示语
├─ needFaceCompare	integer	非必须	0	是否需要刷脸验证：0:不需要 1:需要
├─ compareExpirey	integer	非必须	15	刷脸状态有效期(分钟数)：空值表示不验证有效时长
├─ compareMaxNum	number	非必须	100	刷脸最大验证次数
├─ memo	string	非必须		备注
├─ taskSubTag	object	非必须
├─ tagValueCode	string	非必须		标签编码：如：KSZP:开始照片;JSZP:结束照片;XLSB:销量上报;ZPSB:赠品上报;KCSB:库存上报；CLSB:陈列上报；SDJL:晒单奖励或任务类别：平台任务，品牌任务等
├─ tagValueName	string	非必须		标签名称
├─ tagType	string	非必须		标签类型
├─ memo	string	非必须		备注
├─ collectItems	object []	非必须			item 类型: object
├─ title	string	非必须		采集项标题
├─ code	string	非必须		采集项编码
├─ sort	integer	非必须		采集项排序
├─ sampleText	string	非必须		采集项示例说明
├─ sampleImg	string	非必须		采集项示例图片
├─ itemType	integer	非必须		采集项类型:0：问答；1：单选；2：多选；3：图片上传(单张)；4：图片上传(多张)
├─ itemNo	string	非必须		采集项编号
├─ tips	string	非必须		提示语
├─ isMust	integer	非必须	1	采集项是否必填：0：非必填，1:必填
├─ imgSize	integer	非必须		图片大小要求：单位MB
├─ imgMaxCnt	integer	非必须		图片最多张数：支持范围为：1-9张
├─ charMaxCnt	integer	非必须		字符数量限制
├─ memo	string	非必须		备注
├─ options	object []	非必须			item 类型: object
├─ taskSubItemId	integer	非必须		任务采集项ID
├─ optionNo	string	非必须		选项编号
├─ title	string	非必须		选项标题
├─ code	string	非必须		选项编码
├─ sort	string	非必须		选项排序
├─ tips	string	非必须		提示语
├─ memo	string	非必须		备注
traceId	string	必须

任务包新增

基本信息

Path： /api/con2.0/v1/task/packageApi/package/add

Method： POST

接口描述：

该接口功能：从任务包到采集项的新建，不存在更新功能，只能新建任务包，任务包下的子任务，子任务下的采集项。必须要从任务包开始新建

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
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	integer	非必须		子任务排序:数字越小越靠前，默认为1
├─ frontId	integer	非必须		前置子任务ID
├─ price	number	非必须		子任务定价：小数点后两位	mock: @float
├─ must	integer	必须		是否必做:0：非必做；1：必做
├─ frequency	number	必须		子任务执行频次	枚举: 1,2,3 枚举备注: 1：计划执行日，2：指定时间范围，3：每周一次
├─ startTime	string	非必须		子任务开始时间
├─ endTime	string	非必须		子任务结束时间
├─ tips	string	非必须		提示语
├─ needFaceCompare	integer	非必须	0	是否需要刷脸验证	枚举: 0,1 枚举备注: 0:不需要 1:需要
├─ compareExpirey	integer	非必须	15	刷脸状态有效期(分钟数),空值表示不验证有效时长
├─ compareMaxNum	integer	非必须	100	刷脸最大验证次数
├─ memo	string	非必须		备注
├─ taskSubTag	object	非必须
├─ tagValueCode	string	非必须		标签编码:如：KSZP:开始照片;JSZP:结束照片;XLSB:销量上报;ZPSB:赠品上报;KCSB:库存上报；CLSB:陈列上报；SDJL:晒单奖励或任务类别：平台任务，品牌任务等
├─ tagValueName	string	非必须		标签名称
├─ tagType	string	非必须		标签类型
├─ memo	string	非必须		备注
├─ collectItems	object []	非必须			item 类型: object
├─ title	string	非必须		采集项标题
├─ code	string	非必须		采集项编码
├─ sort	integer	非必须		采集项排序:越小越靠前
├─ sampleText	string	非必须		采集项示例说明
├─ sampleImg	string	非必须		采集项示例图片
├─ itemType	string	非必须		采集项类型：0：问答；1：单选；2：多选；3：图片上传(单张)；4：图片上传(多张)
├─ itemNo	string	非必须		采集项编号
├─ tips	string	非必须		提示语
├─ isMust	integer	非必须		采集项是否必填:0：非必填，1:必填
├─ imgSize	integer	非必须		图片大小要求.单位MB
├─ imgMaxCnt	integer	非必须		图片最多张数,支持范围为：1-9张
├─ charMaxCnt	integer	非必须		字符数量限制,不能超过2000
├─ memo	string	非必须		备注
├─ options	object []	非必须		采集项类型为1或者2时才会有此项	item 类型: object
├─ optionNo	string	非必须		选项编号
├─ title	string	非必须		选项标题
├─ code	string	非必须		选项编码
├─ sort	integer	非必须		选项排序
├─ tips	string	非必须		提示语
├─ memo	string	非必须		备注

返回数据

名称	类型	是否必须
success	boolean	必须
errorCode	string	必须
errorMessage	string	必须
data	object	必须
├─ packageCode	string	必须
traceId	string	必须

任务提报信息查询

基本信息

Path： /api/con2.0/v1/task/packageApi/report/getReport

Method： POST

接口描述：

该接口功能为任务信息提报结果查询，可以通过任务包编码+子任务编码+用户编码来查询，如果进行提报日期的筛选，格式需要是“YYYY-MM-DD",如“2022-02-20”这种。

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
packageCode	string	必须	任务包编码
taskSubCode	string	必须	子任务编码
userCode	string	必须	用户编码
reportDate	string	必须	提报开始日期:yyyy-MM-dd	mock: @datetime

返回数据

名称	类型	是否必须	备注	其他信息
success	string	非必须
errorCode	string	非必须
errorMessage	string	非必须
data	object	非必须
├─ taskSubCode	string	必须	子任务编码
├─ taskSubName	string	必须	子任务名称
├─ userCode	string	必须	用户编码
├─ userName	string	必须	用户名称
├─ terminalCode	string	必须	终端编码
├─ terminalName	string	必须	终端名称
├─ terminalProvince	string	必须	终端省
├─ terminalCity	string	必须	终端市
├─ terminalArea	string	必须	终端区
├─ terminalTown	string	必须	终端镇
├─ terminalLongitude	string	必须	终端经度
├─ terminalLatitude	string	必须	终端纬度
├─ taskPackageCode	string	必须	任务包编码
├─ reportDate	string	必须	提报日期:yyyy-MM-dd
├─ reportTime	string	必须	提报时间
├─ reportPrice	number	必须	任务定价
├─ reportLongitude	string	必须	提报经度
├─ reportLatitude	string	必须	提报纬度
├─ reportDistance	string	必须	提报距位置距离
├─ submitStatus	string	必须	提交状态:0未提交，1已提交，审核只能审核已提交的数据
├─ userFaceLogId	integer	非必须	用户任务刷脸记录id
├─ taskDetail	object []	非必须		item 类型: object
├─ taskSubItemCode	string	非必须	子任务采集编码
├─ taskSubItemName	string	非必须	子任务采集名称
├─ itemType	integer	非必须	采集项类型：0：问答；1：单选；2：多选；3：图片上传(单张)；4：图片上传(多张)
├─ itemAnswer	string	非必须	采集项问答题答案
├─ itemOptionCode	string	非必须	采集项选项编码：多选题选项用"#"分割，控制在10个选项内
├─ itemImg	string	非必须	采集项图片单张
├─ itemImgs	string	非必须	采集项图片多张:目前最多支持9张，用";"分割
traceId	string	非必须

任务提报新建更新

基本信息

Path： /api/con2.0/v1/task/packageApi/report/add

Method： POST

接口描述：

该接口实现任务提报信息的新建和更新功能，如果存在任务提报编码code，则是更新，否则是新增。

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
taskSubCode	string	必须	子任务编码
code	string	必须	任务提报编码
taskSubName	string	必须	子任务名称
userCode	string	必须	用户编码
userName	string	必须	用户名称
terminalCode	string	必须	终端编码
terminalName	string	必须	终端名称
terminalProvince	string	必须	终端省
terminalCity	string	必须	终端市
terminalArea	string	必须	终端区
terminalTown	string	必须	终端镇
terminalLongitude	string	必须	终端经度
terminalLatitude	string	必须	终端纬度
taskPackageCode	string	必须	任务包编码
reportDate	string	必须	提报日期:yyyy-MM-dd
reportTime	string	必须	提报时间
reportPrice	number	必须	任务定价：两位小数
reportLongitude	string	必须	提报经度
reportLatitude	string	必须	提报纬度
reportDistance	string	必须	提报距位置距离
submitStatus	integer	必须	提交状态：0未提交，1已提交，审核只能审核已提交的数据
userFaceLogId	integer	非必须	用户任务刷脸记录id
collectItems	object []	必须		item 类型: object
├─ taskSubItemName	string	必须	子任务采集名称
├─ itemType	integer	必须	采集项类型:0：问答；1：单选；2：多选；3：图片上传(单张)；4：图片上传(多张)
├─ itemAnswer	string	非必须	采集项问答题答案
├─ itemOptionCode	string	非必须	采集项选项编码
├─ itemImg	string	非必须	采集项图片单张
├─ itemImgs	string	非必须	采集项图片多张:目前最多支持9张，用";"分割

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
errorCode	string	非必须
errorMessage	string	非必须
data	object	非必须
├─ taskReportCode	string	必须	任务提报编码
traceId	string	非必须

采集项编辑保存

基本信息

Path： /api/con2.0/v1/task/packageApi/package/Items/save

Method： POST

接口描述：

该接口实现针对采集项的新增，编辑，删除操作
如果没有code，且status=1，则认为是新增
如果有code，且status=0，则认为是删除，同时关联的选项也会被删除
如果有code，且status=1，则认为是编辑，此时，如果传入的选项code为空，则会新增选项，相反，则会新增

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
subCode	string	必须	子任务Code
collevtItems	object []	非必须		item 类型: object
├─ title	string	必须	采集项标题
├─ code	string	必须	为空时新增采集项
├─ sort	number	必须	采集项排序
├─ sampleText	string	非必须	采集项示例说明
├─ sampleImg	string	非必须	采集项示例图片
├─ itemType	string	必须	为1或2时必有options
├─ itemNo	string	非必须	采集项编号
├─ tips	string	非必须	提示语
├─ isMust	integer	非必须	采集项是否必填
├─ imgSize	integer	非必须	图片大小要求
├─ imgMaxCnt	integer	非必须	图片最多张数
├─ charMaxCnt	integer	非必须	字符数量限制
├─ itemMemo	string	非必须	备注
├─ options	object []	非必须		item 类型: object
├─ taskSubItemId	string	非必须	任务采集项ID
├─ optionNo	string	非必须	选项编号
├─ title	string	非必须	选项标题
├─ code	string	非必须	选项编码
├─ sort	number	非必须	选项排序
├─ tips	string	非必须	提示语
├─ memo	string	非必须	备注
├─ status	string	必须	针对采集项：1 启用 0 禁用

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
errorCode	string	非必须
errorMessage	string	非必须
data	object	非必须
├─ subCode	string	非必须	采集项编码
traceId	string	非必须

YAPI 接口文档

(触点)任务执行管理

任务执行管理2.0API

任务包信息查询

基本信息

请求参数

返回数据

任务包新增

基本信息

请求参数

返回数据

任务提报信息查询

基本信息

请求参数

返回数据

任务提报新建更新

基本信息

请求参数

返回数据

采集项编辑保存

基本信息

请求参数

返回数据