1. 创建地名地址索引

创建地名地址索引。

请求方式:POST

请求地址:/bosFoundationService/{appKey}/addresses/index

1.1. 请求参数:

Headers:

参数名 类型 示例 是否必填 参数含义
Authorization string c4570cb9ca324bc8ba7dd9d1967710ea access_token

PathParas:

参数名 类型 示例 是否必填 参数含义
appKey string xb05cd3a35614caa85c0f8f86c58fcc1 应用Key

SearchParas:

参数名 类型 示例 是否必填 参数含义
NULL NULL NULL NULL NULL

Body(application/json):

{
    "bosclass":"documents", // 指定bos类
    "placeField":"name", //地名字段名称
    "addressField":"address" //地址字段名称
}

1.2. 参数说明:

参数名 类型 示例 是否必填 参数含义
NULL NULL NULL NULL NULL

1.3. 正确返回:

Http Status Code:200
{
    "code": "SUCCESS",
    "message": "请求处理成功",
    "data": null
}

1.4. 错误返回:

状态码 code message data 原因
200 object.requiredField.empty boscalss属性必填 NULL bosclass为空
200 ENTITY_BOSCLASS_NOTFOUND 实体类{key}不存在 NULL 实体类{key}不存在
200 ENTITY_READPERMISSION_REQUIRED 缺少实体对象{bosclass/key}的读权限 NULL 用户满足不了以下条件之一: 应用管理员,拥有该类的读权限,该类是公开类

1.5. 注意事项:

  1. 请求bos数据库根据appKey和bosclass类建立地名地址索引
  2. placeField为地名字段名称,如未指定,则默认为enterpriseName
  3. addressField为地址字段名称,如未指定,则默认为enterpriseAddress
版权所有@盈嘉互联(北京)科技有限公司 京ICP备15051988号-9 Copyright © 2022 all right reserved,powered by Gitbook该文件修订时间: 2022-05-16 19:01:04

results matching ""

    No results matching ""