Skip to main content
Request

curl --location 'https://openapi.gs-robot.com/openapi/v3/maps/schedule-resources/list' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data '{
  "includePaths": true,
  "includePositions": true,
  "includeRegions": true,
  "mapIdList": [
    "140bbb83-fe48-4282-be25-c48252b9c660"
  ],
  "robotSn": "TEST00-0000-000-B088"
}'

Version requirement: This API is supported only on AIO software version 1.6 and later.

Notes​

  • supportedActions contains only the intersection of resource actions and the robot's available WorkModes; it can be an empty array when no action matches.
  • Except for success code 0, failed responses use six-digit code values according to the unified error-code specification.
Response

{
  "code": 0,
  "data": {
    "maps": [
      {
        "mapId": "140bbb83-fe48-4282-be25-c48252b9c660",
        "paths": [
          {
            "mapResourceAreaId": "",
            "mapResourceId": "21b7db88-8331-46cb-b52b-fa749a209b3a",
            "mapResourceName": "temp_task_1787197793",
            "mapResourceType": "path",
            "supportedActions": [
              "wash"
            ]
          }
        ],
        "positions": [
          {
            "gridX": "341",
            "gridY": "397",
            "mapResourceAreaId": "",
            "mapResourceId": "f0c01d4c-4da8-46f4-9803-7873ae8754ff",
            "mapResourceName": "Navigation 1",
            "mapResourceType": "position",
            "positionId": "0",
            "positionType": "2",
            "supportedActions": [
              "wash"
            ]
          }
        ],
        "regions": [
          {
            "mapResourceAreaId": "1",
            "mapResourceId": "bb713ca7-b622-42a1-9d17-cc57bd69ea06",
            "mapResourceName": "area1",
            "mapResourceType": "region",
            "supportedActions": [
              "wash"
            ]
          }
        ],
        "robotMapUuid": "140bbb83-fe48-4282-be25-c48252b9c660"
      }
    ],
    "robotSn": "TEST00-0000-000-B088",
    "workModes": [
      {
        "configType": "strength",
        "defaultStrength": "middle",
        "hasStrength": true,
        "id": "wm-1",
        "mode": "wash",
        "recommended": true,
        "strengthOptions": [
          "middle"
        ],
        "subTaskEnabled": false,
        "subType": "wash",
        "type": 0
      }
    ]
  },
  "msg": "success"
}