文件夹 最后更新时间: 2024年08月30日
产品介绍
在地图中，文件夹用于对标记资源进行分类管理。文件夹 API 是通过 HTTPS 协议访问远程服务的接口，提供新建/修改/批量删除文件夹、在文件夹间转移标记资源的能力。
适用场景
- 新建文件夹：创建一个空的文件夹；创建文件夹时如果携带资源id，可以创建文件夹的同时，将资源放入
- 修改文件夹：修改文件夹名称
- 批量删除文件夹：删除文件夹，同时删除文件夹下所有资源
- 资源转移：将资源从文件夹A移出；将资源移入文件夹B；将资源从文件夹A移动到文件夹B
使用限制
详细的服务调用量限制可点我查阅。
使用说明
接收请求返回的数据（JSON或XML格式），参考返回参数文档解析数据。
如无特殊声明，接口的输入参数和输出数据编码全部统一为 UTF-8 编码方式。
1. 新建文件夹
请求地址
parameters代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。
请求参数
示例代码（以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/category/create";
Map<String, Object> params = new HashMap<>();
String workMapId = "工作地图id";
params.put("key", "在高德开放平台申请的key");
params.put("openId", "当前操作用户的openId");
params.put("bizToken", "在高德开放平台申请的bizToken");
params.put("workMapId", workMapId);
String[] signArgs = new String[]{workMapId};
params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret", signArgs));
params.put("title", "文件夹名称");
// 创建根目录下的文件夹不用传 parentCategoryId
params.put("parentCategoryId", "父文件夹 id");
String response = MyHttpUtils.postFormUrlencoded(url, params);
System.out.println(response);
}
返回参数
响应结果的格式为 JSON 形式。
以下是返回参数说明：
2. 修改文件夹
请求地址
parameters代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。
请求参数
示例代码（以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/category/update";
Map<String, Object> params = new HashMap<>();
String workMapId = "工作地图id";
String categoryId = "待修改文件夹id";
params.put("key", "在高德开放平台申请的key");
params.put("openId", "当前操作用户的openId");
params.put("bizToken", "在高德开放平台申请的bizToken");
params.put("workMapId", workMapId);
params.put("categoryId", categoryId);
String[] signArgs = new String[]{workMapId, categoryId};
params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret", signArgs));
params.put("title", "修改后的文件夹名称");
String response = MyHttpUtils.postFormUrlencoded(url, params);
System.out.println(response);
}
返回参数
响应结果的格式为 JSON 形式。
以下是返回参数说明：
3. 批量删除文件夹
请求地址
parameters代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。
请求参数
示例代码（以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/category/delete/batch";
Map<String, Object> params = new HashMap<>();
String workMapId = "工作地图id";
// 文件夹列表是用逗号拼接的字符串 示例："4008007244022880,4008007244027722"
String categoryIds = "要删除的文件夹列表";
params.put("key", "在高德开放平台申请的key");
params.put("openId", "当前操作用户的openId");
params.put("bizToken", "在高德开放平台申请的bizToken");
params.put("workMapId", workMapId);
String[] signArgs = new String[]{workMapId, categoryIds};
params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret", signArgs));
params.put("categoryIds", categoryIds);
String response = MyHttpUtils.postFormUrlencoded(url, params);
System.out.println(response);
}
返回参数
响应结果的格式为 JSON 形式。
以下是返回参数说明：
4. 资源转移
请求地址
parameters代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。
请求参数
示例代码（以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/category/transfer";
Map<String, Object> params = new HashMap<>();
String workMapId = "工作地图id";
// 资源列表是用逗号拼接的字符串 示例："200800724647844303,200800724647844304"
String resourceIds = "要转移的资源列表";
params.put("key", "在高德开放平台申请的key");
params.put("openId", "当前操作用户的openId");
params.put("bizToken", "在高德开放平台申请的bizToken");
params.put("workMapId", workMapId);
String[] signArgs = new String[]{workMapId, resourceIds};
params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret", signArgs));
params.put("resourceIds", resourceIds);
params.put("targetCategoryId", "目标文件夹id");
String response = MyHttpUtils.postFormUrlencoded(url, params);
System.out.println(response);
}
返回参数
响应结果的格式为 JSON 形式。
以下是返回参数说明：
5. 查询地图内的文件夹列表
请求地址
parameters代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。
请求参数
代码实例（以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/category/list";
Map<String, Object> params = new HashMap<>();
String openId = "当前操作用户的openId";
String workMapId = "工作地图id";
params.put("key","在高德开放平台申请的key");
params.put("openId",openId);
params.put("bizToken","在高德开放平台申请的bizToken");
params.put("workMapId", workMapId);
params.put("pageSize", 20);
params.put("pageNumber",1);
String[] signArgs = new String[]{workMapId};
params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret",signArgs));
url = MyHttpUtils.attachParamsToUrl(url, params);
String response = MyHttpUtils.get(url);
System.out.println(response);
}返回参数
响应结果的格式为 JSON 形式。
以下是返回参数说明：
6. 批量查询文件夹信息
请求地址
parameters代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。
请求参数
请求body
代码实例（以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/category/batchQuery";
Map<String, Object> params = new HashMap<>();
String openId = "当前操作用户的openId";
String workMapId = "工作地图id";
params.put("key","在高德开放平台申请的key");
params.put("openId",openId);
params.put("bizToken","在高德开放平台申请的bizToken");
params.put("workMapId", workMapId);
String[] signArgs = new String[]{workMapId};
params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret",signArgs));
url = MyHttpUtils.attachParamsToUrl(url, params);
String json = "{\"categoryIds\": [\"40042875302\",\"400888713001\",\"400428750400\"]}";
String response = MyHttpUtils.postApplicationJson(url,json);
System.out.println(response);
}返回参数
响应结果的格式为 JSON 形式。
以下是返回参数说明：
