| Data Dimension Authorization | Enterprise-level Authorization | This API requires enterprise-level authorization. Both enterprise-level and agent-level authorization accounts can call this API. Please refer to Authorization Methods. |
| Interface Dimension Authorization | Default Authorization | This API is granted by default, so you don't need to apply for interface dimension authorization separately for your authorization account. Please refer to Authorization Methods. |
| HTTP URL Path | /v1/corp/map_list |
| HTTP Method | GET |
| Parameter | Type | Required | Description |
| ov_corpid | string | Yes | Enterprise ID |
| map_name | string | No | Map name, exact match. If not provided, no restriction is applied. |
| page | int | No | Pagination parameter. Current page number, starting from 1, default is 1. |
| page_rows | int | No | Pagination parameter. Number of records per page, default is 1. |
# Please replace the entry point with yours according to your region
curl --location 'https://global-openapi.orionstar.com/v1/corp/map_list?ov_corpid=test_ov_corpid' \
--header 'Authorization: Bearer YOUR-ACCESS-TOKEN'
Common Response Body
| Parameter | Type | Description |
| code | int | Error code. 0 means success, non-zero means failure, Please refer to Error Codes. |
| msg | string | Error description. When there is a failure, a specific error description will be provided. |
| req_id | string | Log tracking ID. When encountering problems that require assistance from OrionStar, please provide this tracking ID value. |
| data | object | Business data object, see below for details Response Body Data Object. |
Response Body Data Object
| Parameter | Type | Description |
| total_count | string | Pagination parameter. Total number of records. |
| map_list | array | Array of map information objects, each element in this array is a map information object. |
| map_list[].map | object | Map information object, please refer to map - Robot Map Information Object. |
| Parameter | Type | Description |
| map_id | string | Map ID |
| map_name | string | Map Name |
| create_time | string | Creation time, integer timestamp in seconds. |
| update_time | string | Last modification time, integer timestamp in seconds. |
Response Body Example
{
"code": 0,
"msg": "",
"data": {
"total_count": "1",
"map_list" : [
{
"map" : {
"map_id": "test_id",
"map_name": "testmap-0107152028",
"create_time": "1547021774",
"update_time": "1562222558"
},
},
// ... other map information
]
}
}