Robot Webservice

Find routes by map

List all routes defined for a map.

post/api/robot/findRobotRoutesByMap

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/robot/findRobotRoutesByMap
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

mapUuidstring RUUID nullable

base 64 (url-safe) uuid string

Example request

{
  "mapUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Response

OK

errorboolean nullable
errorMsgstring nullable
warningMsgstring nullable

Example response

{
  "routeViews": [
    {
      "deployCondition": {
        "action": {
          "activateLocationLockdown": {
            "locationLockdownPlanUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA"
          },
          "audioPlaybackActions": [
            {
              "audioClipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
              "audioGateways": [
                "AAAAAAAAAAAAAAAAAAAAAA"
              ]
            }
          ],
          "cancelLoopingAudioPlaybackAction": {
            "_audioDevices": [
              "AAAAAAAAAAAAAAAAAAAAAA.v0"
            ],
            "audioDevices": [
              "AAAAAAAAAAAAAAAAAAAAAA.v0"
            ]
          },
          "changeComponentCompositeAccessStateActions": [
            {
              "componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA"
            }
          ],
          "connectAudioDeviceToMobileAppAction": {
            "audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "doorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "targetDoorStationUuids": [
              "AAAAAAAAAAAAAAAAAAAAAA"
            ],
            "targetUserUuids": [
              "AAAAAAAAAAAAAAAAAAAAAA"
            ]
          },
          "connectAudioDeviceToPhoneNumberAction": {
            "audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "doorUuid": "AAAAAAAAAAAAAAAAAAAAAA"
          },
          "createAlarmAction": {
            "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "mediaDeviceUuids": [
              "AAAAAAAAAAAAAAAAAAAAAA.v0"
            ],
            "sirenSettings": {
              "audioGateways": [
                "AAAAAAAAAAAAAAAAAAAAAA"
              ],
              "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA"
            },
            "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
          },
          "customLLMActions": [
            {
              "deviceFacetUuids": [
                "AAAAAAAAAAAAAAAAAAAAAA.v0"
              ],
              "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
              "promptUuid": "AAAAAAAAAAAAAAAAAAAAAA"
            }
          ],
          "enableDisableAudioRecordActions": [
            {
              "audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
            }
          ],
          "robotActions": [
            {
              "mapUuid": "AAAAAAAAAAAAAAAAAAAAAA",
              "routeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
              "waypointUuid": "AAAAAAAAAAAAAAAAAAAAAA",
              "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
            }
          ],
          "thirdPartyAudioPlaybackAction": {
            "proxyDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
          },
          "thirdPartyStrobeSirenAction": {
            "proxyDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
          },
          "triggerComponentRelayActions": [
            {
              "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
              "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
            }
          ]
        },
        "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "ownerUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "ruleFilters": {
          "scheduleUuids": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ]
        },
        "triggers": [
          {
            "componentCompositeUuids": [
              "AAAAAAAAAAAAAAAAAAAAAA"
            ],
            "componentUuids": [
              "AAAAAAAAAAAAAAAAAAAAAA"
            ],
            "deviceUuids": [
              "AAAAAAAAAAAAAAAAAAAAAA"
            ],
            "locationUuids": [
              "AAAAAAAAAAAAAAAAAAAAAA"
            ]
          }
        ],
        "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
      },
      "route": {
        "mapUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "triggerRuleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.