1. REST API for Oracle IoT Fleet Monitoring Cloud Service
  2. Tasks
  3. Driver Information

List drivers

get

/fleetMonitoring/clientapi/v2/drivers

This operation returns the list of all the drivers registered with the current application instance.

Request

Query Parameters
Header Parameters
  • To allow targeting requests to different organizations. The header value should contain the organization identifier(orgId). This header is optional, if not provided orgId will be ORA_DEFAULT_ORG
Back to Top

Response

Supported Media Types

200 Response

Successfully processed.
Body ()
Root Schema : Driver_receive_list
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : MetricSnapshot_receive
Type: object
Show Source
Nested Schema : metricValues
Type: array
The metric values of an entity
Show Source
Nested Schema : MetricValue_receive
Type: object
Show Source
Nested Schema : esAdditionalData
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
Property description was not set
Show Source
Nested Schema : EsJoinFieldValue_receive
Type: object
Show Source
Nested Schema : GeoPosition_receive
Type: object
Show Source
Nested Schema : metadata
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
Property description was not set
Show Source
Nested Schema : params
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
Property description was not set
Show Source
Nested Schema : additionalElements
Type: array
Property description was not set
Show Source

401 Response

Unauthorized. The request requires user authentication.

406 Response

Request Not Acceptable. The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.
Back to Top

Examples

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/fleetMonitoring/clientapi/v2/drivers

Example of Response Body

The following example shows the content of the response body in JSON format:

{
    "items": [
        {
            "id": "5432EFA4-96E4-4332-80AF-82BBB995EA52",
            "name": "Driver4",
            "loginId": "Driver4",
            "dutyStatus": "DRIVING",
            "tripId": "DE75FFB0-4193-44D3-B8A5-C726DCD791EC",
            "vehicleId": "D2B7B78A-653C-4F6C-9CB5-1D901BADA5FF",
            "registrationTime": 1519032343175,
            "registrationTimeAsString": "2018-02-19T09:25:43.175Z",
            "registeredBy": "system",
            "lastModifiedTime": 1519032343175,
            "lastModifiedTimeAsString": "2018-02-19T09:25:43.175Z",
            "lastModifiedBy": "system",
            "links": [
                {
                    "href": "https://iotserver/fleetMonitoring/clientapi/v2/vehicles/D2B7B78A-653C-4F6C-9CB5-1D901BADA5FF",
                    "rel": "vehicle"
                },
                {
                    "href": "https://iotserver/fleetMonitoring/clientapi/v2/trips/DE75FFB0-4193-44D3-B8A5-C726DCD791EC",
                    "rel": "trip"
                },
                {
                    "href": "https://iotserver/fleetMonitoring/clientapi/v2/drivers/5432EFA4-96E4-4332-80AF-82BBB995EA52/metrics",
                    "rel": "metrics"
                }
            ]
        }
    ],
    "links": [
        {
            "href": "https://iotserver/fleetMonitoring/clientapi/v2/drivers?offset=0&limit=10&q=%7B%20%22$and%22%20:%20[%7B%20%22$or%22%20:%20[%7B%22registeredBy%22:%20%7B%20%22$exists%22:false%20%7D%20%7D,%7B%22registeredBy%22:%20%7B%20%22$ne%22:%22OIOTFMSYS%22%20%7D%20%7D]%20%7D,%7B%22loginId%22:%20%7B%20%22$eq%22:%22Driver4%22%20%7D%20%7D]%20%7D",
            "rel": "self"
        },
        {
            "href": "https://iotserver/fleetMonitoring/clientapi/v2/drivers",
            "rel": "canonical"
        },
        {
            "href": "https://iotserver/fleetMonitoring/clientapi/v2/drivers?q=%7B%20%22$and%22%20:%20[%7B%20%22$or%22%20:%20[%7B%22registeredBy%22:%20%7B%20%22$exists%22:false%20%7D%20%7D,%7B%22registeredBy%22:%20%7B%20%22$ne%22:%22OIOTFMSYS%22%20%7D%20%7D]%20%7D,%7B%22loginId%22:%20%7B%20%22$eq%22:%22Driver4%22%20%7D%20%7D]%20%7D&offset=0&limit=10",
            "rel": "first"
        },
        {
            "href": "https://iotserver/fleetMonitoring/clientapi/v2/drivers?q=%7B%20%22$and%22%20:%20[%7B%20%22$or%22%20:%20[%7B%22registeredBy%22:%20%7B%20%22$exists%22:false%20%7D%20%7D,%7B%22registeredBy%22:%20%7B%20%22$ne%22:%22OIOTFMSYS%22%20%7D%20%7D]%20%7D,%7B%22loginId%22:%20%7B%20%22$eq%22:%22Driver4%22%20%7D%20%7D]%20%7D&offset=0&limit=10",
            "rel": "last"
        }
    ],
    "offset": 0,
    "limit": 10,
    "count": 1,
    "hasMore": false
}



Complete cURL Example

The following example shows a complete cURL command that you can use to perform the described operation:

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/fleetMonitoring/clientapi/v2/drivers



Note that in the request, https://iotserver will be replaced by the name and port of your assigned IoT Cloud Service instance. The format of the Cloud Service instance is https://myinstance-myidentitydomain.iot.us.oraclecloud.com and the default port is 443.
Back to Top