Robot Webservice

Get full robot state

Get detailed information about state of specified robot

post/api/robot/getFullState

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/robot/getFullState
  • 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

deviceUuidstring DeviceFacetUuid nullable

RUUID with optional appended facet information

forceboolean nullable

Example request

{
  "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0"
}

Response

OK

Example response

{
  "fullState": {
    "activityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "lastEventUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "mapId": "AAAAAAAAAAAAAAAAAAAAAA",
    "mediaStorageDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
    "phaseUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "robotPlatformCapability": {
      "supportedFacets": [
        "v0, a0"
      ]
    },
    "routeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
    "supportedFacets": [
      "v0, a0"
    ],
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "waypointUuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}

Changes

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