Robot Webservice

Find waypoint runs by route

Find waypoint runs for a route, filtered by time range.

post/api/robot/findWaypointRunsByRoute

Request

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

endMsinteger nullable

End of the time range in epoch milliseconds, defaults to Long.MAX_VALUE

routeUuidstring RUUID nullable required

base 64 (url-safe) uuid string

startMsinteger nullable required

Start of the time range in epoch milliseconds

Example request

{
  "routeUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Response

OK

errorboolean nullable
errorMsgstring nullable
warningMsgstring nullable

Example response

{
  "waypointRuns": [
    {
      "arrivedAtEventUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "completedAtEventUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "parentRouteRunUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "parentRouteUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "routeWaypointUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "ruleReferences": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "startedAtEventUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "waypointUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Changes

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