Cloud Services API ReferenceAdvanced Device ServicesExtension APIsRobot Vacuum Open APIsLaser Robot VacuumGet Map File List

Get Map File List

Last Updated on : 2023-06-20 14:54:04

Get a list of map files on pages based on the file type. The minimum value of the page number is 1. No more than 1,000 items can be returned on each page. In case of exceeding 1,000 items, only the first 1,000 items are displayed.

API address

GET: /v1.0/users/sweepers/file/{device_id}/list

Request parameter

Parameter name	Type	IN	Required	Description
device_id	String	uri	true	The device ID.
file_type	String	query	true	The file type. Valid values: `pic`: a single map. `collect_recode`: multiple maps.
start_time	Integer	query	false	The start timestamp.
end_time	Integer	query	false	The end timestamp.
page_no	Integer	query	true	The page number. Minimum value: `1`.
page_size	Integer	query	true	The number of items returned on each page. Maximum value: `1,000`.

Return parameter

Parameter name	Type	Description
result	SweeperCleaningResultVO	The object of file information.

Description of result

Parameter name	Type	Description
datas	List	The object list of cleaning record files.
total_count	Long	The total number of results.
has_more	Boolean	Specifies whether to return the next page.

Description of datas

Parameter name	Type	Description
id	Long	The record ID of a specified file.
extend	String	The extension information about a file.
time	Integer	The timestamp when a file is generated.
file_name	String	The file name.

Request example

GET: /v1.0/users/sweepers/file/6c6561cfb316df6e7a****/list?fileType=pic&pageNo=1&pageSize=10

Return example

{
    "result": {
        "datas": [
            {
                "extend": "yxzne56c96fb00522aa7_1639211017_1640779297_1640779735_6_****.txt",
                "id": 14428924,
                "time": 1640779772
            },
            {
                "extend": "yxzne56c96fb00522aa7_1639211017_1640414644_1640416159_17_****.txt",
                "id": 14272580,
                "time": 1640416221
            }
        ],
        "total_count": 2,
        "has_more": false
    },
    "t": 1641882023112,
    "success": true
}

Error code

For more information, see error code.

Prev DocDelete Cleaning Map

Next DocGet Download Link of Map