开发 地图小程序OPENAPI 开发指南 地图内容 地图任务

地图任务 最后更新时间: 2024年08月30日

产品介绍

地图任务 API 是通过 HTTPS 协议访问远程服务的接口,提供新建/查询地图的能力。

适用场景

  • 父任务创建:创建地图任务
  • 父任务删除
  • 任务查询
    • 父任务列表查询
    • 任务中心列表查询
    • 父任务资源查询
    • 子任务详情查询

使用限制

详细的服务调用量限制可点我查阅

使用说明

接收请求返回的数据(JSON或XML格式),参考返回参数文档解析数据。

如无特殊声明,接口的输入参数和输出数据编码全部统一为 UTF-8 编码方式。

1. 任务创建

请求地址

URL

https://restwia.amap.com/api/v1/wia/task/center/create?parameters

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

parameters代表的参数为“url 请求参数”,包括必填参数和可选参数。所有参数均使用字符"&"进行分隔。下面的列表枚举了这些参数及其使用规则。

url 请求参数

参数名

含义

规则说明

参数类型

是否必须

缺省值

key

高德Key

用户在高德地图官网申请Web服务API类型Key

string

必填

bizToken

工作地图身份token

用户申请的工作地图身份token,一个企业一个token

string

必填

openId

当前操作人

高德用户的开放id

string

必填

sig

数字签名

请参考数字签名获取和使用方法

string

非必填

bizSign

业务签名

签名参数:openId、bizToken (参考签名规则

string

必填

workMapId

高德工作地图id

string

必填

workTaskCenterName

任务名称

string

必填

workTaskCenterDesc

任务描述

string

非必填

workTaskCenterExecutorId

执行人

string

必填

workTaskCenterBeginTime

开始时间

时间戳

long

 必填

workTaskCenterEndTime

结束时间

时间戳

long

必填

workTaskCenterType

任务类型

1- 普通任务 2-周期任务 

int

必填

workTaskCenterPeriod

任务周期提醒

{"periodType":1,"periodFreq":1,"periodInterval":1,"periodNum":1,"skipHoliday":1,"skipWeekend":1,"endType":1,"endCount":3,"endTime":"2024-09-12 13:15:20"}

详细说明见 : 附件

string

非必填

workTaskCenterNotify

任务提醒类型

[{"workTaskNotifyType":3}]

详细说明见 : 附件

string

非必填

resourceIdList

资源Id集合

规则“ 使用半角逗号分隔的字符串格式”

string

必填

workTaskCenterRuleList

任务达成条件集合

[{"workTaskRuleType":1,"workTaskRuleRemark":"需要完成打卡哦"},{"workTaskRuleType":2,"workTaskRuleRemark":"需要进行任务反馈哦"}]

详细说明见 : 附件

string

非必填

workTaskCenterSceneType

任务场景类型

1-普通 2-智能调度 3-排程

int

必填

routePlanningFlag

路线规划标识

1-不规划 2-规划

int

非必填

1

imageUrls

图片url 信息

规则“ 使用半角逗号分隔的字符串格式”

string

非必填

workTaskCenterBeginType

开始类型

1 自动开始   2 手动开始

int

必填

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {

Strin requestUrl = "https://restwia.amap.com/api/v1/wia/task/center/create";
        //封装入参
        Map<String, Object> params = new HashMap<>();
        //params.put("key", key);//高德应用key,线上环境需要传
        params.put("bizToken","在高德开放平台申请的bizToken");
        params.put("openId", "当前操作人的openId");//当前操作人
        params.put("workMapId","工作地图id");//地图id
        params.put("workTaskCenterName","任务名称");//任务名字
        params.put("workTaskCenterExecutorId", "执行者openId");//任务执行者id
        params.put("workTaskCenterBeginTime","开始时间戳");//工作开始时间
        params.put("workTaskCenterEndTime","结束时间戳" );//工作结束时间
        params.put("workTaskCenterType",1);//1- 普通任务 2-周期任务
        //params.put("workTaskCenterPeriod", );//任务周期提醒
        //params.put("workTaskCenterNotify", );//任务提醒类型
        params.put("resourceIdList","2003003712445027");//资源点入参 需要String类型,多个之间,隔开, 例如 "123,456"
        params.put("workTaskCenterSceneType",1);//任务场景类型
        //计算bizSign
        String[] signArgs = new String[]{"操作人openId","在高德开放平台申请的bizToken"};//获取业务参数,用于签名计算
        params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret", signArgs));//业务签名
        String response = MyHttpUtils.postFormUrlencoded(requestUrl, params);
}

返回参数

响应结果的格式为 JSON 形式。

以下是返回参数说明:

名称

含义

参数说明

规则说明

code

返回结果状态值

number

返回值为1 表示请求成功,其他情况表示失败。

message

返回状态说明

string

当 status 为 0 时,message 会返回具体错误原因,否则返回“Successful”。详情可以参阅info状态表

timestamp

服务时间戳

number

data

返回结果数据

string

任务id(workTaskCenterId

2、任务创建(新增电子围栏)

请求地址:

URL

https://restwia.amap.com/api/v1/wia/task/center/doCreate?parameters

请求方式

POST

ContenType

application/x-www-form-urlencoded

url 请求参数

参数名

参数类型

含义

规则

示例值

是否必填

key

String

高德Key

用户在高德地图官网申请Web服务API类型Key

必填

bizToken

String

工作地图身份token

用户申请的工作地图身份token,一个企业一个token

必填

openId

String

当前操作人

高德用户的开放id

必填

sig

String

数字签名

请参考数字签名获取和使用方法

选填

bizSign

String

业务签名

签名参数openId,bizToken参考签名规则

必填

body请求参数

参数名

参数类型

含义

规则

示例值

是否必填

workMapId

string

工作地图Id

P3AOnftSzq7bdMTxw057S

必填

workTaskCenterName

string

任务名称

测试任务

必填

workTaskCenterDesc

string

任务描述

测试任务

非必填

workTaskCenterExecutorId

string

执行人

执行人的openId

-

必填

workTaskCenterBeginTime

number

开始时间

当workTaskCenterBeginType = 1 时 ,必填

时间戳

非必填

workTaskCenterEndTime

number

截止时间

时间戳

非必填

workTaskCenterType

number

任务类型

1- 普通任务 

2- 周期任务

1

必填

workTaskCenterPeriod

string

任务周期提醒

详细说明见 : 附件

{"periodType":1,"periodFreq":1,"periodInterval":1,"periodNum":1,"skipHoliday":1,"skipWeekend":1,"endType":1,"endCount":3,"endTime":"2024-09-12 13:15:20"}

必填

workTaskCenterNotify

string

任务提醒类型

详细说明见 : 附件

[{"workTaskNotifyType":3}]

非必填

resourceListStr

string

资源Id集合

资源点不能超过50,

详细说明见 : 附件

[{"resourceId":"2003003712445027","beginTime":1702899563823,"endTime":1702985963000}]

必填

workTaskCenterRuleList

string

任务达成条件集合

详细说明见 : 附件

[{"workTaskRuleType":1,"workTaskRuleRemark":"需要完成签到打卡哦"},{"workTaskRuleType":2,"workTaskRuleRemark":"需要进行任务反馈哦","subRuleList":[{"workTaskSubRuleId":"12000044568007"}]},{"workTaskRuleType":2,"workTaskRuleRemark":"需要进行任务反馈哦(无表单)"]},{"workTaskRuleType":3,"workTaskRuleRemark":"需要进行签退打卡哦"},{"workTaskRuleType":4,"workTaskRuleRemark":"需要进行编辑地点哦","subRuleList":[{"workTaskSubRuleId":"1"},{"workTaskSubRuleId":"2"}]}]

非必填

workTaskCenterSceneType

number

任务场景类型

1-普通 

2-智能调度

3-排程

必填

fenceSwitch

number

电子围栏开关 

1 关闭

2 打开

-

必填

fenceScope

number

电子围栏范围

fenceSwitch 为2 的时候必填

-

非必填

imageUrls

Array

图片url 信息

-

非必填

workTaskCenterBeginType

Number

开始类型

1 自动开始 

2 手动开始

必填

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {
        Strin requestUrl = "https://restwia.amap.com/api/v1/wia/task/center/doCreate";

        //url request param
        HashMap<String, Object> param1 = Maps.newHashMap();
        param1.put("key","在高德开放平台申请的key");
        param1.put("bizToken","在高德开放平台申请的bizToken");
        param1.put("openId","当前操作用户的openId");
        param1.put("bizSign",SignatureHelper.calcSign(env.getBizSecret(),new String[]{"openId","bizToken"}));

        //body param
        long beginTime = System.currentTimeMillis(); //开始时间
        long endTime = System.currentTimeMillis()+24*60*60*1000;//结束时间

        HashMap<String, Object> param2 = Maps.newHashMap();
        param2.put("workMapId",env.getWorkMapId());
        param2.put("workTaskCenterName","测试任务051303");
        param2.put("workTaskCenterDesc","test data");
        param2.put("workTaskCenterExecutorId",env.getOpenId());//执行人openId

        param2.put("workTaskCenterBeginType",1);//1-自动开始,2-手动开始
        param2.put("workTaskCenterBeginTime",beginTime);//当任务开始类型为"自动开始时",需要填写开始时间
        param2.put("workTaskCenterEndTime",endTime);//结束时间,当workTaskCenterNotify = 6 时必填
        param2.put("workTaskCenterType",1);//1-普通任务,2-周期任务
        //任务周期重复
        HashMap<String, Object> periodMap = Maps.newHashMap();
        periodMap.put("periodType",5);//
        periodMap.put("periodFreq",2);//
        periodMap.put("periodInterval",1);
        periodMap.put("periodNum",1);
        periodMap.put("skipHoliday",2);
        periodMap.put("skipWeekend",2);
        periodMap.put("endType",1);
//        periodMap.put("endCount",2);//结束次数
//        periodMap.put("endTime");//结束时间
        param2.put("workTaskCenterPeriod",JSONObject.toJSONString(periodMap));
        //任务提醒
        ArrayList<Map<String,Object>> notifyList = Lists.newArrayList();
        HashMap<String, Object> notifyMap = Maps.newHashMap();
        notifyMap.put("workTaskNotifyType",3);
        notifyList.add(notifyMap);
        param2.put("workTaskCenterNotify",JSONObject.toJSONString(notifyList));
        //资源列表
        ArrayList<Map<String,Object>> resourceList = Lists.newArrayList();
        HashMap<String, Object> resourceMap01 = Maps.newHashMap();
        resourceMap01.put("resourceId", "资源点1id");
        resourceMap01.put("beginTime",beginTime);
        resourceMap01.put("endTime",endTime);
        HashMap<String, Object> resourceMap02 = Maps.newHashMap();
        resourceMap02.put("resourceId", "资源点2id");
        resourceMap02.put("beginTime",beginTime);
        resourceMap02.put("endTime",endTime);

        resourceList.add(resourceMap01);
        resourceList.add(resourceMap02);
        param2.put("resourceListStr",JSONObject.toJSONString(resourceList));

        //规则列表
        ArrayList<Map<String,Object>> ruleList = Lists.newArrayList();
        HashMap<String, Object> ruleMap01 = Maps.newHashMap();
        ruleMap01.put("workTaskRuleType", 1);
        ruleMap01.put("workTaskRuleRemark","签到打卡");
        ArrayList<Map<String,Object>> subRuleList = Lists.newArrayList();
        HashMap<String, Object> subRuleMap01 = Maps.newHashMap();
        subRuleMap01.put("workTaskSubRuleId",1);
        subRuleList.add(subRuleMap01);
        ruleMap01.put("subRuleList",subRuleList);
        ruleList.add(ruleMap01);
        param2.put("workTaskCenterRuleList",JSONObject.toJSONString(ruleList));

        param2.put("workTaskCenterSceneType",1);
        param2.put("fenceSwitch",2);//1-关闭 2-打开
        param2.put("fenceScope",100);
//        param2.put("imageUrls",);
        requestUrl = MyHttpUtils.attachParamsToUrl(requestUrl,param1);
        String s = MyHttpUtils.postFormUrlencoded(requestUrl, param2);
        System.out.println("s = " + s);
}

返回参数

响应结果的格式为 JSON 形式,以下是参数说明

参数名

含义

参数类型

规则说明

data

返回结果数据

Object

workTaskCenterId

String

code

返回结果状态值

Number

message

返回状态说明

String

成功时返回Successful,否则返回错误原因

result

结果

Boolean

true或false

version

版本信息

String

timestamp

时间戳

Number

requestId

请求id

String

返回示例

{
    "data": {
      "workTaskCenterId":"500820330871010",
    },
    "code": 1,
    "message": "Successful",
    "result": true,
    "version": "1.0",
    "timestamp": 1701142286019,
    "requestId": "1eb5d12017011422856761177d14ca"
}

3. 父任务删除

请求地址

URL

https://restwia.amap.com/api/v1/wia/task/center/delete

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

请求参数

参数名

含义

规则说明

参数类型

是否必填

缺省值

key

请求服务权限标识 

用户在高德地图官网申请Web服务API类型KEY 

string

openId

高德开放用户id

操作人在高德的身份id

string

workMapId

地图id

-

string

workTaskCenterIds

要删除的父任务id

半角逗号分隔的字符串格式

string

bizToken

工作地图身份token

用户申请的工作地图身份token,一个组织一个token

string

bizSign

业务签名

签名参数:workMapId, openId(参考签名规则

string

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {
        String requestUrl  = "https://restwia.amap.com/api/v1/wia/task/center/delete";
        HashMap<String, Object> param1 = Maps.newHashMap();
        param1.put("key","在高德开放平台申请的key");
        param1.put("bizToken","在高德开放平台申请的bizToken");
        param1.put("openId","当前操作用户的openId");
        param1.put("bizSign",SignatureHelper.calcSign("在高德开放平台申请的bizSecret",new String[]{"工作id","操作人openId"}));
        param1.put("workMapId","工作地图id");
        param1.put("workTaskCenterIds","5003003711035062,5003003711034899");//任务之间用逗号分隔
        String s1 = MyHttpUtils.postFormUrlencoded(requestUrl, param1);
        System.out.println("s1 = " + s1);
}

返回参数

返回字段

含义

规则说明

code

返回结果编码

1 表示成功

message

返回状态说明

成功时返回Successful,否则返回错误原因

version

版本号

字符串类型

timestamp

时间戳

Unix 时间戳,参考文档:《Unix 时间戳》

requestId

requestId是RPC链路的全局唯一标识,排查问题时需要提供

字符串格式,长度30

附表

0、异常

1、成功

2、失败

3、参数错误

1001、权限不足:『不是地图成员』,或『不是任务创建人且不是管理员』

4. 父任务详情

请求地址

URL

https://restwia.amap.com/api/v1/wia/task/center/detail?parameters

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

parameters代表的参数为“url 请求参数”,包括必填参数和可选参数。所有参数均使用字符"&"进行分隔。下面的列表枚举了这些参数及其使用规则。

url 请求参数

参数名

含义

规则说明

参数类型

是否必须

缺省值

key

高德Key

用户在高德地图官网申请Web服务API类型Key

string

必填

bizToken

工作地图身份token

用户申请的工作地图身份token,一个企业一个token

string

必填

openId

当前操作人

高德用户的开放id

string

必填

sig

数字签名

请参考数字签名获取和使用方法

string

必填

bizSign

业务签名

签名参数:openId、bizToken (参考签名规则

string

必填

workMapId

工作地图id

string

必填

workTaskCenterId

任务id

string

必填

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {
       Strin requestUrl = "https://restwia.amap.com/api/v1/wia/task/center/detail";
        //封装请求参数
        Map<String, Object> params = new HashMap<>();
        params.put("bizToken","在高德开放平台申请的bizToken");
        params.put("openId", "当前操作人openId");//当前操作人
        params.put("workMapId","工作地图id");//地图id
        params.put("workTaskCenterId","任务id");
        params.put("key","在高德开放平台申请的key");
        //计算业务签名
        String[] signArgs = new String[]{openId,bizToken};
        params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret",signArgs ));//业务签名
        String response = MyHttpUtils.postFormUrlencoded(requestUrl, params);
}

返回参数

响应结果的格式为 JSON 形式。

以下是返回参数说明:

名称

含义

参数说明

规则说明

code

返回结果状态值

number

返回值为1 表示请求成功,其他情况表示失败。

message

返回状态说明

string

当 status 为 0 时,message 会返回具体错误原因,否则返回“Successful”。详情可以参阅info状态表

timestamp

服务时间戳

number

data

返回结果数据

object

结果对象,包括下述字段:

routePlanningFlag

是否可以顺路规划

int

workMapId

工作地图id

string

workTaskCenterBeginTime

任务开始时间

long

workTaskCenterCreateUserAvatar

用户头像

string

workTaskCenterCreateUserId

创建人openId

string

workTaskCenterCreateUserName

创建人

string

workTaskCenterDesc

任务描述

string

workTaskCenterEndTime

任务结束时间

long

workTaskCenterExecutionStatus

执行状态

int

0 - "执行中"

1 - "完成"

2 - "待开始"

3 - "已逾期"

workTaskCenterExecutorAvatar

执行人头像

string

workTaskCenterExecutorId

执行人openId

string

workTaskCenterExecutorName

执行人名称

string

workTaskCenterId

任务ID

string

workTaskCenterName

任务名称

string

workTaskCenterNotifyList

通知列表

List<workTaskCenterNotifyList>

workTaskCenterNotifyList

workTaskNotifyId

通知id

workTaskNotifyType

int

1 - 不提醒   2-任务开始时提醒  3-任务开始前5分钟   4-任务开始前15分钟   5-任务开始前30分钟 6-任务截止前一天

workTaskCenterPeriod

提醒规则

WorkTaskCenterPeriod

WorkTaskCenterPeriod

periodType

int

选择类型:

1-不重复 2-每天重复 3-每周重复 4-每月重复 5-自定义重复

periodFreq

int

重复周期类型:

1- 按天  2-按周  3-按月 4-按年

periodInterval

int

重复频次:从1开始

例子 : 每()天,每()周

这里代表括号里的数字

periodNum

int

重复时间

例子:选择按周 这里代表的是:

1:周一,2:周二

以此类推

endType

int

重复截止类型:

1-一直重复 2-按时间结束重复  3-按次数结束重复

endCount

int

重复截止次数:

例子:选择按次数结束

这里的意思:执行了3次结束

endTime

String

重复截止时间

"2024-09-12 13:15:20"

skipHoliday

int

是否跳过法定节假日  1-否 2-是

skipWeekend

int

是否跳过双休日 1-否 2-是

workTaskCenterRuleList

规则列表

List<WorkTaskCenterRule> 

WorkTaskCenterRule

workTaskRuleId

string

规则id

workTaskRuleRemark

string

规则说明

workTaskRuleType

int

规则类型 1-打卡 2-评论

workTaskCenterSceneType

任务场景类型

int

1-普通 2-智能调度 3-排程

workTaskCount

任务数量

int

workTaskFinishCount

完成任务数量

int

5. 任务中心列表

请求地址

URL

https://restwia.amap.com/api/v1/wia/task/center/list?parameters

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

parameters代表的参数为“url 请求参数”,包括必填参数和可选参数。所有参数均使用字符"&"进行分隔。下面的列表枚举了这些参数及其使用规则。

url 请求参数

参数名

含义

规则说明

参数类型

是否必须

缺省值

key

高德Key

用户在高德地图官网申请Web服务API类型Key

string

必填

bizToken

工作地图身份token

用户申请的工作地图身份token,一个企业一个token

string

必填

openId

当前操作人

高德用户的开放id

string

必填

sig

数字签名

请参考数字签名获取和使用方法

string

必填

bizSign

业务签名

签名参数:openId、bizToken (参考签名规则

string

必填

workMapId

工作地图id

string

必填

queryType

查询任务类型

查询任务类型 1: 我执行的 2: 我创建的 默认全部

int

非必填

taskStatusList

任务状态

0 - "执行中"

1 - "完成"

2 - "完成"

List<string>

非必填

memberIds

执行人

List<string>

非必填

dataTimeType

时间类型

1. 创建时间、2. 开始时间、3. 截止时间、4. 完成时间

int

非必填

startTime

开始时间

时间戳

long

非必填

endTime

结束时间

时间戳

long

非必填

sortType

排序方式

1. 按截止时间最近 2. 按开始时间最早 3. 按开始时间最晚

int

必填

token

游标id

string

非必填

size

每页大小

int

必填

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {
        String requestUrl  = "https://restwia.amap.com/api/v1/wia/task/center/list";

        //url 参数
        HashMap<String, Object> param1 = Maps.newHashMap();
        param1.put("key","在高德开放平台申请的key");
        param1.put("bizToken","在高德开放平台申请的bizToken");
        param1.put("openId","操作人openId");
        param1.put("bizSign",SignatureHelper.calcSign("在高德开放平台申请的bizSecret",new String[]{"操作人openId","在高德开放平台申请的bizToken"}));
        param1.put("workMapId","工作地图id");
        param1.put("queryType",1);//1-我执行的
        param1.put("taskStatusList","0,1");//0-执行中,1-完成,状态之间用逗号隔开
        param1.put("memberIds","openId1");//成员ids
//        param1.put("dataTimeType",1);
//        param1.put("startTime","时间戳");
//        param1.put("endTime","时间戳");
        param1.put("sortType",1);
        param1.put("size",10);

        String s1 = MyHttpUtils.postFormUrlencoded(requestUrl, param1);
        System.out.println("s1 = " + s1);
}

返回参数

响应结果的格式为 JSON 形式。

以下是返回参数说明:

名称

含义

参数说明

规则说明

code

返回结果状态值

number

返回值为1 表示请求成功,其他情况表示失败。

message

返回状态说明

string

当 status 为 0 时,message 会返回具体错误原因,否则返回“Successful”。详情可以参阅info状态表

timestamp

服务时间戳

number

data

返回结果数据

object

结果对象,包括下述字段:

token

游标id

string

count

查询数量

int

resultDTOList

返回数据

List<ListWorkTaskCenterResultDTO>

ListWorkTaskCenterResultDTO

workTaskCenterCreateUserId 

string

 创建人openId

workTaskCenterCreateUserName

string

创建人名称

workTaskCenterBeginTime number 

long

任务开始时间

workTaskCenterEndTime

long

任务截止时间

workTaskCenterExecutionStatus

int

0 - "执行中"

1 - "完成"

2 - "待开始"

3 - "已逾期"

workTaskCenterExecutorId  

string

 任务执行人id

workTaskCenterExecutorName  

string

任务执行人名称

workTaskCenterExecutorAvatar

string

执行人头像

workTaskCenterDesc  

string

任务描述

workTaskCenterId   

string

任务id

workTaskCenterName  

string

任务名称

workTaskCount number 

int

 子任务总数量

workTaskFinishCount

int

子任务完成的数量

workTaskCenterExecutorMobile  

string

任务执行人手机号

6. 父任务资源列表

请求地址

URL

https://restwia.amap.com/api/v1/wia/task/center/resource/list?parameters

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

parameters代表的参数为“url 请求参数”,包括必填参数和可选参数。所有参数均使用字符"&"进行分隔。下面的列表枚举了这些参数及其使用规则。

url 请求参数

参数名

含义

规则说明

参数类型

是否必须

缺省值

key

高德Key

用户在高德地图官网申请Web服务API类型Key

string

必填

bizToken

工作地图身份token

用户申请的工作地图身份token,一个企业一个token

string

必填

openId

当前操作人

高德用户的开放id

string

必填

sig

数字签名

请参考数字签名获取和使用方法

string

必填

bizSign

业务签名

签名参数:openId、bizToken (参考签名规则

string

必填

workMapId

工作地图id

string

必填

workTaskCenterId

任务id

string

必填

pageSize

每页数量

50

int

必填

pageNumber

页码

int

必填

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {
        String url = "https://restwia.amap.com/api/v1/wia/task/center/resource/list";
        Map<String,Object> postParams = new HashMap<>();
        String[] signArgs = new String[]{openId, bizToken};
        postParams.put("bizSign",SignatureHelper.calcSign("在高德开放平台申请的bizSecret",signArgs));
        postParams.put("bizToken","在高德开放平台申请的bizToken");
        postParams.put("openId","当前操作人openId");
        postParams.put("workMapId","工作地图id");
        postParams.put("workTaskCenterId","任务id");
        postParams.put("pageNumber",1);
        postParams.put("pageSize",50);
        postParams.put("key","在高德开放平台申请的key");

        String response = MyHttpUtils.postFormUrlencoded(url, postParams);
}

返回参数

响应结果的格式为 JSON 形式。

以下是返回参数说明:

名称

含义

参数说明

规则说明

code

返回结果状态值

number

返回值为1 表示请求成功,其他情况表示失败。

message

返回状态说明

string

当 status 为 0 时,message 会返回具体错误原因,否则返回“Successful”。详情可以参阅info状态表

timestamp

服务时间戳

number

data

返回结果数据

object

结果对象,包括下述字段:

hasMore

是否还有数据

int

0-没有 1-有

currentPage

当前页码

int

resourceList

资源集合

List<OpenTaskCenterResourceListDTO>

OpenTaskCenterResourceListDTO

resourceId

string

资源Id

subResourceId

string

子资源Id

resourceType

int

资源类型:

4-点

6-面

resourceName

string

资源名称

resourceColor

string

资源颜色

approvalStatus

int

资源的违规状态:

0-未审核

1-通过

2-违规

modifiedTime

string

修改时间

iconOutline

string

点自定义扎标边框

iconFiller

string

点自定义扎标填充物

iconFillerInfo

WiaIconFillerDTO

见附件:WiaIconFillerDTO

showImageSwitch

string

0-不展示

1-展示

imageList

List<String>

image列表

categoryId

string

图层id

poiSecretType

int

涉密类型:

-1-不涉密,无限制

1-禁止扎点

2-可扎点,不可编辑

3-非法名称

sortNum

int

资源排序

workTaskId

string

子任务id

workTaskFinishStatus

int

0 - "执行中"

1 - "完成"

2 - "待开始"

3 - "已逾期"

resourceStatus

int

0-已删除

1-已上线

workMissionId

string

资源关系id(资源id 暂时无用)

haveAuth

bool

是否有权限

7. 子任务内容详情

请求地址

URL

https://restwia.amap.com/api/v1/wia/task/content/detail?parameters

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

parameters代表的参数为“url 请求参数”,包括必填参数和可选参数。所有参数均使用字符"&"进行分隔。下面的列表枚举了这些参数及其使用规则。

url 请求参数

参数名

含义

规则说明

参数类型

是否必须

缺省值

key

高德Key

用户在高德地图官网申请Web服务API类型Key

string

必填

bizToken

工作地图身份token

用户申请的工作地图身份token,一个企业一个token

string

必填

openId

当前操作人

高德用户的开放id

string

必填

sig

数字签名

请参考数字签名获取和使用方法

string

必填

bizSign

业务签名

签名参数:openId、bizToken (参考签名规则

string

必填

workMapId

工作地图id

string

必填

workTaskId

子任务id

string

必填

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {
        String url = "https://restwia.amap.com/api/v1/wia/task/content/detail";
        Map<String,Object> postParams = new HashMap<>();
        String[] signArgs = new String[]{openId, bizToken};
        postParams.put("bizSign",SignatureHelper.calcSign("在高德开放平台申请的bizSecret",signArgs));
        postParams.put("bizToken","在高德开放平台申请的bizToken");
        postParams.put("openId","当前操作人openId");
        postParams.put("workMapId","工作地图id");
        postParams.put("workTaskId","子任务id");
        postParams.put("key","在高德开放平台申请的key");

        String response = MyHttpUtils.postFormUrlencoded(url, postParams);
}

返回参数

响应结果的格式为 JSON 形式。

以下是返回参数说明:

名称

含义

参数说明

规则说明

code

返回结果状态值

number

返回值为1 表示请求成功,其他情况表示失败。

message

返回状态说明

string

当 status 为 0 时,message 会返回具体错误原因,否则返回“Successful”。详情可以参阅info状态表

timestamp

服务时间戳

number

data

返回结果数据

object

结果对象,包括下述字段:

mapTaskVO

任务信息详情

OpenWorkTaskDTO

OpenWorkTaskDTO

workTaskId

string

子任务id

workTaskEndTime

long

子任务截止时间

executeStatus

int

子任务执行状态:

0 - "执行中"

1 - "完成"

2 - "待开始"

3 - "已逾期"

workTaskName

string

子任务名称

workTaskDesc

string

子任务描述

workMissionId

string

资源关系id(资源id 暂时无用)

taskApprovalStatus

int

0-未审核

1-通过

2-违规

workTaskCenterId

string

父任务id

resourceVO

资源详情

OpenTaskResourceDTO

OpenTaskResourceDTO

resourceId

string

资源Id

resourceName

string

资源名称

resourceColor

string

资源颜色

iconOutline

string

点自定义扎标边框

iconFiller

string

点自定义扎标填充物

iconFillerInfo

WiaIconFillerDTO

填充物详情

见附件:WiaIconFillerDTO

poiSecretType

int

涉密类型:

-1-不涉密,无限制

1-禁止扎点

2-可扎点,不可编辑

3-非法名称

resourceType

int

资源类型:

4-点

6-面

approvalStatus

int

资源的违规状态:

0-审核中

1-通过

2-违规

workTaskRuleInfoList

任务规则信息列表

List<OpenTaskRuleInfoDTO> 

OpenTaskRuleInfoDTO

workTaskRuleId

string

规则id

workTaskRuleType

int

规则类型 :1打卡 2评论

workTaskRuleRemark

string

规则备注

workTaskEntityId

string

任务id

workTaskRuleRecordId

string

规则记录id。 完成规则的时候需要用到

operateStatus

int

规则完成状态:1未完成 2完成

operateTime

date

完成规则操作时间

feedbackInfo

MapTaskFeedbackInfoDTO

任务反馈

见附件:MapTaskFeedbackInfoDTO

punchingCardInfo

MapTaskPunchingCardInfoDTO

打卡信息

见附件:MapTaskPunchingCardInfoDTO

8、查询任务资源快照信息

请求地址:

URL

https://restwia.amap.com/api/v1/wia/task/center/query/resource/snapshot?parameter

请求方式

POST

ContenType

application/json

url 请求参数

参数名

参数类型

含义

规则

示例值

是否必填

key

String

高德Key

用户在高德地图官网申请Web服务API类型Key

必填

bizToken

String

工作地图身份token

用户申请的工作地图身份token,一个企业一个token

必填

openId

String

当前操作人

高德用户的开放id

必填

sig

String

数字签名

请参考数字签名获取和使用方法

选填

bizSign

String

业务签名

签名参数openId,bizToken参考签名规则

必填

body请求参数

参数名

参数类型

含义

规则

示例值

是否必填

workMapId

String

工作地图Id

P3AOnftSzq7bdMTxw057S

必填

workTaskCenterId

String

父任务id

-

必填

pageNum

Number

页码

2

必填

pageSize

Number

单页显示条数

最大支持100

50

必填

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {
        String requestUrl = "https://restwia.amap.com/api/v1/wia/task/center/query/resource/snapshot";

        //url 参数
        HashMap<String, Object> param1 = Maps.newHashMap();
        param1.put("key","在高德开放平台申请的key");
        param1.put("bizToken","在高德开放平台申请的bizToken");
        param1.put("openId","当前操作人openId");
        param1.put("bizSign",SignatureHelper.calcSign("在高德开放平台申请的bizSecret",new String[]{"操作人openId","bizToken"});

        HashMap<String, Object> param2 = Maps.newHashMap();
        param2.put("workMapId","工作地图id");
        param2.put("workTaskCenterId","任务id");
        param2.put("pageNum",1);
        param2.put("pageSize",50);


        String s = MyHttpUtils.attachParamsToUrl(requestUrl, param1);
        String s1 = MyHttpUtils.postApplicationJson(s, JSONObject.toJSONString(param2));
        System.out.println("s1 = " + s1);
}

返回参数

响应结果的格式为 JSON 形式,以下是参数说明

参数名

含义

参数类型

规则说明

data

返回结果数据

Object

currentPage

当前页码

Number

hasMore

是否有更多

Number

1 有  0没有

resourceCommentList

资源评论列表

Array

workTaskCenterId

父任务id

String

workTaskId

子任务id

String

resourceId

资源id

String

commentId

评论id

String

content

评论内容

String

imageUrlList

评论图片列表

Array

commentUserId

评论者id

String

commentUserNickName

评论者昵称

String

commentUserAvatar

评论者图像挂件

String

commentTime

评论时间

Number

commentTypeDesc

评论类型描述

String

commentType

评论类型

Number

code

返回结果状态值

Number

message

返回状态说明

String

成功时返回Successful,否则返回错误原因

result

结果

Boolean

true或false

version

版本信息

String

timestamp

时间戳

Number

requestId

请求id

String

返回示例

{
    "data": {
        "resourceCommentList": [
            {
                "workTaskCenterId": "500300371824006",
                "workTaskId": "4003003711050007",
                "resourceId": null,
                "commentId": "7f209bd7cd70300371",
                "content": "编辑了位置「测试资源点231215」",
                "imageUrlList": null,
                "commentUserId": "70300371",
                "commentUserNickName": "陆小果",
                "commentUserAvatar": "http://img-cdn-test.amap.com/pp/avatar/b2f/3a/e3/70300371.jpeg?ver=1698826935&imgoss=1",
                "commentTime": 1702620006022,
                "commentTypeDesc": "编辑位置",
                "commentType": 6
            }
        ],
        "currentPage": 1,
        "hasMore": 0
    },
    "code": 1,
    "message": "Successful",
    "result": true,
    "version": "1.0",
    "timestamp": 1702620049500,
    "requestId": "0b7b2fe417026200491857203d2269"
}

9、查询任务评论信息

请求地址:

URL

https://restwia.amap.com/api/v1/wia/task/center/query/resource/comments?parameter

请求方式

POST

ContenType

application/json

url 请求参数

参数名

参数类型

含义

规则

示例值

是否必填

key

String

高德Key

用户在高德地图官网申请Web服务API类型Key

必填

bizToken

String

工作地图身份token

用户申请的工作地图身份token,一个企业一个token

必填

openId

String

当前操作人

高德用户的开放id

必填

sig

String

数字签名

请参考数字签名获取和使用方法

选填

bizSign

String

业务签名

签名参数openId,bizToken参考签名规则

必填

body请求参数

参数名

参数类型

含义

规则

示例值

是否必填

workMapId

String

工作地图Id

P3AOnftSzq7bdMTxw057S

必填

workTaskCenterId

String

父任务id

-

必填

pageNum

Number

页码

2

必填

pageSize

Number

单页显示条数

最大支持100

50

必填

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {
        String requestUrl = "https://restwia.amap.com/api/v1/wia/task/center/query/resource/comments";

        //url 参数
        HashMap<String, Object> param1 = Maps.newHashMap();
        param1.put("key","在高德开放平台申请的key");
        param1.put("bizToken","在高德开放平台申请的bizToken");
        param1.put("openId","当前操作人openId");
        param1.put("bizSign",SignatureHelper.calcSign("在高德开放平台申请的bizSecret",new String[]{"操作人openId","bizToken"});

        HashMap<String, Object> param2 = Maps.newHashMap();
        param2.put("workMapId","工作地图id");
        param2.put("workTaskCenterId","任务id");
        param2.put("pageNum",1);
        param2.put("pageSize",50);


        String s = MyHttpUtils.attachParamsToUrl(requestUrl, param1);
        String s1 = MyHttpUtils.postApplicationJson(s, JSONObject.toJSONString(param2));
        System.out.println("s1 = " + s1);
}

返回参数

响应结果的格式为 JSON 形式,以下是参数说明

参数名

含义

参数类型

规则说明

data

返回结果数据

Object

currentPage

当前页码

Number

hasMore

是否有更多

Number

1 有  0没有

resourceSnapshotList

资源快照列表

Array

workTaskCenterId

父任务id

String

workTaskId

子任务id

String

resourceId

资源id

String

gmtCreate

快照创建时间

String

resourceGmtCreate

资源创建时间

String

resourceCreateOpenId

资源创建人id

String

resourceCreateNickName

资源创建人昵称

String

resourceGmtModified

资源修改时间

String

resourceModifiedOpenId

资源修改人id

String

resourceModifiedNickName

资源修改人昵称

String

lon

经度

String

lat

纬度

String

address

资源地址

String

code

返回结果状态值

Number

message

返回状态说明

String

成功时返回Successful,否则返回错误原因

result

结果

Boolean

true或false

version

版本信息

String

timestamp

时间戳

Number

requestId

请求id

String

返回示例

{
    "data": {
        "resourceSnapshotList": [
            {
                "workTaskCenterId": "500300371824006",
                "workTaskId": "4003003711050007",
                "resourceId": "2003003712445027",
                "gmtCreate": 1702610897000,
                "resourceGmtCreate": 1699251449067,
                "resourceCreateUid": "70300371",
                "resourceCreateNickName": "陆小果",
                "resourceGmtModified": 1699251449067,
                "resourceModifiedUid": "70300371",
                "resourceModifiedNickName": "陆小果",
                "lon": "116.43144384026526",
                "lat": "40.022614531933975",
                "address": "北京市朝阳区来广营西路99号"
            }
        ],
        "currentPage": 1,
        "hasMore": 0
    },
    "code": 1,
    "message": "Successful",
    "result": true,
    "version": "1.0",
    "timestamp": 1702611474016,
    "requestId": "1eb5d10417026114736441004d18c9"
}

10、任务反馈表单查询

请求地址

请求URL

https://restwia.amap.com/api/v1/wia/task/feedback/template/list?parameter

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

url请求参数

名称

类型

描述

规则

是否必填

key

string

高德key

用户在高德地图官网申请Web服务API类型Key

openId

string

当前操作人

高德用户的开放id

bizToken

string

工作地图身份token

用户申请的工作地图身份token,一个企业一个token

bizSign

string

业务签名

签名参数 workMapId openId  (参考签名规则

sig

string

数字签名

请参考数字签名获取和使用方法

workMapId

String

工作地图id

请求参数

名称

类型

描述

规则

是否必填

pageNum

Number

页码

默认1

pageSize

Number

每页条数

默认20

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {
            String requestUrl = "https://restwia.amap.com/api/v1/wia/task/feedback/template/list";
            HashMap<String, Object> param1 = Maps.newHashMap();
            param1.put("key","在高德开放平台申请的key");
            param1.put("bizToken","在高德开放平台申请的bizToken");
            param1.put("openId","当前操作人openId");
            param1.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret",new String[]{"workMapId","openId"}));
            param1.put("workMapId","工作地图id");

            HashMap<String, Object> param2 = Maps.newHashMap();
            param2.put("pageNum","1");
            param2.put("pageSize","20");
            String s = MyHttpUtils.attachParamsToUrl(requestUrl, param1);
            String s1 = MyHttpUtils.postApplicationJson(s, JSONObject.toJSONString(param2));
            System.out.println("s1 = " + s1);
}

返回参数

名称

类型

描述

规则说明

code

Number

返回结果状态

data

Object

返回结果数据

total

Number

数据总量

hasMore

Number

1表示还有下一页0没有下一页

templates

Array

反馈表单集合

templateName

String

模版名称

templateId

String

模版id

effectiveType

Number

类型

message

String

返回状态说明

成功时返回Successful,否则返回错误原因

result

Boolean

返回结果状态

true或false

version

String

版本

timestamp

Long

时间戳

requestId

String

请求id

附件

WiaIconFillerDTO

名称

含义

参数说明

规则说明

iconFillerId

填充物id

string

模版类型id=value,文本/图片类型id为服务在扎标配置接口生成

iconFillerShowType

填充物展示类

int

1-文本

2,-图片 3-模版

iconFillerValue

填充内容

string

MapTaskFeedbackInfoDTO

名称

含义

参数说明

规则说明

imageUrls

image列表

List<String>

comment

评论

string

approvalStatus

审核状态

string

0-审核中

1-通过

2-违规

MapTaskPunchingCardInfoDTO

名称

含义

参数说明

规则说明

id

打卡业务id

long

punchingCardTime

打卡时间

long

时间戳

punchingCardName

打开名称

string

geographyName

地点名称

string

comment

评论

string

imageUrls

图片链接

List<String>

approvalStatus

审核状态

0-审核中

1-通过

2-违规

workTaskCenterPeriod 参数详细说明

参数名

类型

含义

规则

是否必填

periodType

number

提醒重复类型

1-不重复

2-每天重复

3-每周重复

4-每月重复

5-自定义重复

必填

periodFreq

number

提醒频率

1-每天

2-每周

3-每月

当periodType为5时必填

periodInterval

number

提醒时间间隔

例如:填提醒频率为1,此参数为3,

任务提醒为每3天提醒一次

当periodType为5时必填

periodNum

number

提醒的日期

当periodFreq=2时

1-星期一

2-星期二

以此类推

当periodFreq=3时

1-每月1号

2-每月2号

以此类推

例如:填提醒频率为2,时间间隔为2,此参数为1,任务提醒为每2周的周一进行任务提醒

当periodFreq=3/2的时候必填

skipHoliday

number

提醒是否跳过节假日

1-否

2-是

非必填

skipWeekend

number

提醒是否跳过周末

1-否

2-是

非必填

endType

number

提醒结束类型

1-一直重复

2-按日期结束重复

3-按次数结束重复

当periodType为5时必填

endCount

number

提醒结束次数

当endType为2时必填

endTime

number

提醒结束时间

传日时间戳

当endType为3时必填

workTaskCenterNotify 参数详细说明

参数名

类型

含义

规则

是否必填

workTaskNotifyType

number

任务提醒类型

1-不提醒

2-任务开始时提醒

3-任务开始前5分钟提醒

4-任务开始前15分钟提醒

5-任务开始前30分钟提醒

6-任务截止前一天

注:当设置为6时,需要填写任务结束时间

必填

resourceListStr 详细说明

参数名

类型

含义

规则

是否必填

resourceId

String

资源id

必填

beginTime

String

开始时间

时间戳

非必填

endTime

String

结束时间

时间戳

非必填

workTaskCenterRuleList 参数详细说明

参数名

类型

含义

规则

是否必填

workTaskRuleType

number

任务规则类型

1-签到打卡

2-填写表单

3-签退打卡

4-编辑地点信息

必填

workTaskRuleRemark

String

任务规则描述

非必填

subRuleList

array

子任务规则信息集合

当workTaskRuleType = 2/4时必填

workTaskSubRuleId

String

规则id

当workTaskRuleType=2时,填写表单id

当workTaskRuleType=4时

-1 - 不限制

1-名称

2-地址

3-图标颜色

4-图标样式

5-文件夹

6-照片

7-描述

8-自定义字段

9-负责人

返回顶部 示例中心 常见问题 智能客服 公众号
二维码