List vehicles
get
                    /fleetMonitoring/clientapi/v2/vehicles
This operation returns the list of all vehicles.
                Request
Query Parameters
                - 
                        expand(optional): string
                        
                        The list of fields to be expanded in the result. Use 'all' to expand all expandable fields in result.
- 
                        fields(optional): string
                        
                        The comma-separated list of fields to be shown in response. By default all response object fields will be present.
- 
                        limit(optional): integer
                        
                        The maximum number of entries to return to the end user.
- 
                        offset(optional): integer
                        
                        The number that the first record of results is starting from.
- 
                        orderBy(optional): string
                        
                        Ordering criteria for the returned vehicles.
- 
                        q(optional): string
                        
                        Query to filter vehicles on the server. (For more information on mongoDB query parameters refer to Using mongoDB Query Syntax.)
- 
                        since(optional): integer
                        
                        The starting point of the desired time interval, in milliseconds. The default is 0.
- 
                        totalResults(optional): boolean
                        
                        The total number of results suiting the request.
- 
                        until(optional): integer
                        
                        The finishing point of the desired time interval, in milliseconds. The default is 0.
Header Parameters
                - 
                        X-ORACLE-IOT-ORG(optional): string
                        
                        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
Response
Supported Media Types
                - application/json
- application/vnd.oracle.resource+json;type=collection
200 Response
Successfully processed.
                
                
                    Root Schema : Vehicle_receive_list
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            count: 
            integer(int32)
            
- 
            hasMore: 
            boolean
            
- 
            items: 
            array  items
            
            
- 
            limit: 
            integer(int32)
            
- 
            links: 
            array  links
            
            The set of API navigation links.
- 
            offset: 
            integer(int32)
            
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            attributes: 
            array  attributes
            
            Vehicle attributes
- 
            description: 
            string
            Vehicle Description
- 
            driverId: 
            string
            Driver ID
- 
            id: 
            string
            Vehicle ID
- 
            lastModifiedBy: 
            string
            Vehicle modified by
- 
            lastModifiedTime: 
            integer
            Vehicle last modified time (epoch time in milliseconds)
- 
            lastReportedTime: 
            integer
            Vehicle last reported time (epoch time in milliseconds)
- 
            make: 
            string
            Vehicle make
- 
            metricSnapshot: 
            object  MetricSnapshot_receive
            
            
- 
            model: 
            string
            Vehicle model
- 
            name: 
            string
            Vehicle Name
- 
            registeredBy: 
            string
            Vehicle registered by
- 
            registrationNumber: 
            string
            Vehicle registration number
- 
            registrationTime: 
            integer
            Time at which vehicle was registered (epoch time in milliseconds)
- 
            registrationTimeAsString: 
            string
            Vehicle registration time
- 
            status: 
            string
            Vehicle mobility status, One of [IN_MOTION, STOPPED, UNKNOWN, IDLING].
- 
            tripId: 
            string
            Trip Id
- 
            type: 
            string
            Vehicle Type ID
- 
            vin: 
            string
            Vehicle identification number
- 
            year: 
            integer
            Vehicle year
Nested Schema : MetricSnapshot_receive
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            metricValues: 
            array  metricValues
            
            The metric values of an entity
Nested Schema : MetricValue_receive
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            booleanValue(optional): 
            boolean
            Property description was not set
- 
            computedTime: 
            integer
            Property description was not set
- 
            confidenceLevel(optional): 
            integer
            Property description was not set
- 
            entityId: 
            string
            Property description was not set
- 
            entityType: 
            string
            Property description was not set
- 
            esAdditionalData: 
            object  esAdditionalData
            
            Additional Properties Allowed: additionalPropertiesProperty description was not set
- 
            esRelationType: 
            object  EsJoinFieldValue_receive
            
            
- 
            eventTime: 
            integer
            Property description was not set
- 
            eventTimeAsString: 
            string
            Property description was not set
- 
            geoLocationValue(optional): 
            object  GeoPosition_receive
            
            
- 
            id: 
            string
            Property description was not set
- 
            interval: 
            string
            One of [DYNAMIC, CURRENT, EVERY2MINUTE, HOURLY, DAILY, NEXT24HOURS, WEEKLY, BIWEEKLY, NEXT7DAYS, NEXT30DAYS, MONTHLY, DAYS90, STATIC].
- 
            lastKnown: 
            boolean
            Property description was not set
- 
            metadata: 
            object  metadata
            
            Additional Properties Allowed: additionalPropertiesProperty description was not set
- 
            name: 
            string
            Property description was not set
- 
            numericValue(optional): 
            integer
            Property description was not set
- 
            params: 
            object  params
            
            Additional Properties Allowed: additionalPropertiesProperty description was not set
- 
            stringValue(optional): 
            string
            Property description was not set
- 
            type: 
            string
            One of [KPI, PREDICTION, ANOMALY, TREND_NELSON, TREND, SENSOR, CORRELATION, CLUSTERING].
Nested Schema : esAdditionalData
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
       objectAdditional Properties Allowed
       Show Source
       - 
           
               string
           
           A map of the following type: Map<String, String>
Property description was not set
    
    
    
    
        Show Source
        Nested Schema : EsJoinFieldValue_receive
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            name: 
            string
            Property description was not set
- 
            parent: 
            string
            Property description was not set
Nested Schema : GeoPosition_receive
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            additionalElements: 
            array  additionalElements
            
            Property description was not set
- 
            altitude: 
            number
            Property description was not set
- 
            latitude: 
            number
            Property description was not set
- 
            longitude: 
            number
            Property description was not set
- 
            valid: 
            boolean
            Property description was not set
Nested Schema : metadata
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
       objectAdditional Properties Allowed
       Show Source
       - 
           
               string
           
           A map of the following type: Map<String, String>
Property description was not set
    
    
    
    
        Show Source
        Nested Schema : params
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
       objectAdditional Properties Allowed
       Show Source
       - 
           
               string
           
           A map of the following type: Map<String, String>
Property description was not set
    
    
    
    
        Show Source
        Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            href(optional): 
            string
            The target resource URIExample:https://iotserver/iot/api/vX/some/API/path
- 
            rel(optional): 
            string
            Relation typeExample:canonical
401 Response
Unauthorized. The request requires user authentication.
                
                
                404 Response
Not Found. The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.
                
                
                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.
                
                
                Examples
curl -X GET
-u <username>:<password>
-H 'Accept: application/json'
https://iotserver/fleetMonitoring/clientapi/v2/vehicles
Example of Response Body
The following example shows the content of the response body in JSON format:
{
    "items": [
        {
            "id": "73DC1618-F2C0-4253-A9B9-5734384FC780",
            "name": "Vehicle_Name",
            "status": "IDLING",
            "vin": "vin1",
            "type": "52085970-62D7-4DE9-8E16-79039310EFD3",
            "registrationNumber": "reg1",
            "attributes": [
                {
                    "name": "Speed",
                    "value": {
                        "deviceId": "8FE83699-C174-436A-B728-9FB5036BA373",
                        "deviceModel": "urn:com:oracle:iot:device:obd2",
                        "messageFormatField": "ora_obd2_vehicle_speed"
                    }
                },
                {
                    "name": "EngineRPM",
                    "value": {
                        "deviceId": "8FE83699-C174-436A-B728-9FB5036BA373",
                        "deviceModel": "urn:com:oracle:iot:device:obd2",
                        "messageFormatField": "ora_obd2_engine_rpm"
                    }
                },
                {
                    "name": "NumberOfDTCS",
                    "value": {
                        "deviceId": "8FE83699-C174-436A-B728-9FB5036BA373",
                        "deviceModel": "urn:com:oracle:iot:device:obd2",
                        "messageFormatField": "ora_obd2_number_of_dtcs"
                    }
                },
                {
                    "name": "EngineCoolantTemp",
                    "value": {
                        "deviceId": "8FE83699-C174-436A-B728-9FB5036BA373",
                        "deviceModel": "urn:com:oracle:iot:device:obd2",
                        "messageFormatField": "ora_obd2_engine_coolant_temperature"
                    }
                },
                {
                    "name": "Odometer",
                    "value": {
                        "deviceId": "8FE83699-C174-436A-B728-9FB5036BA373",
                        "deviceModel": "urn:com:oracle:iot:device:obd2",
                        "messageFormatField": "ora_obd2_true_odometer"
                    }
                }
            ],
            "registrationTime": 1523863206608,
            "registrationTimeAsString": "2018-04-16T07:20:06.608Z",
            "lastModifiedTime": 1524036006608,
            "lastModifiedTimeAsString": "2018-04-18T07:20:06.608Z",
            "lastModifiedBy": "system",
            "description": "",
            "metricValues": [
                {
                    "id": "171bd431-7566-3414-ad41-315c46507fbf",
                    "name": "sys_utilizationStatus",
                    "entityType": "vehicles",
                    "eventTime": 1523884461945,
                    "computedTime": 1523884461945,
                    "eventTimeAsString": "2018-04-16T13:14:21Z",
                    "interval": "CURRENT",
                    "entityId": "73DC1618-F2C0-4253-A9B9-5734384FC780",
                    "type": "KPI",
                    "lastKnown": false,
                    "booleanValue": false
                },
                {
                    "id": "e2668020-3b1f-3b61-8e9b-23d43fa65234",
                    "name": "sys_averageFuelEconomy",
                    "entityType": "vehicles",
                    "eventTime": 1524036006392,
                    "computedTime": 1524036006392,
                    "eventTimeAsString": "2018-04-18T07:20:06Z",
                    "interval": "CURRENT",
                    "entityId": "73DC1618-F2C0-4253-A9B9-5734384FC780",
                    "type": "KPI",
                    "lastKnown": false,
                    "numericValue": 127.5
                },
                {
                    "id": "42ca2644-b5d8-3974-ab8e-46b1e2376778",
                    "name": "sys_idlingDuration",
                    "entityType": "vehicles",
                    "eventTime": 1524036006392,
                    "computedTime": 1524036006392,
                    "eventTimeAsString": "2018-04-18T07:20:06Z",
                    "interval": "CURRENT",
                    "entityId": "73DC1618-F2C0-4253-A9B9-5734384FC780",
                    "type": "KPI",
                    "lastKnown": false,
                    "numericValue": 144354
                },
                {
                    "id": "1c4196cb-a8f9-39f8-95b9-2e2af265f7d2",
                    "name": "sys_openOutageIncidents",
                    "entityType": "vehicles",
                    "eventTime": 1523884461945,
                    "computedTime": 1523884461945,
                    "eventTimeAsString": "2018-04-16T13:14:21Z",
                    "interval": "CURRENT",
                    "entityId": "73DC1618-F2C0-4253-A9B9-5734384FC780",
                    "type": "KPI",
                    "lastKnown": false,
                    "numericValue": 0
                },
                {
                    "id": "eb8916d6-b2d5-31a8-9fc0-e83fff45799c",
                    "name": "sys_fuelConsumed",
                    "entityType": "vehicles",
                    "eventTime": 1523884461945,
                    "computedTime": 1523884461945,
                    "eventTimeAsString": "2018-04-16T13:14:21Z",
                    "interval": "CURRENT",
                    "entityId": "73DC1618-F2C0-4253-A9B9-5734384FC780",
                    "type": "KPI",
                    "lastKnown": false,
                    "numericValue": 0
                },
                {
                    "id": "a6d176fe-a283-3c74-aae2-7c759dfeb44a",
                    "name": "sys_consumedFuelCost",
                    "entityType": "vehicles",
                    "eventTime": 1523884461945,
                    "computedTime": 1523884461945,
                    "eventTimeAsString": "2018-04-16T13:14:21Z",
                    "interval": "CURRENT",
                    "entityId": "73DC1618-F2C0-4253-A9B9-5734384FC780",
                    "type": "KPI",
                    "lastKnown": false,
                    "numericValue": 0
                },
                {
                    "id": "2176b6b7-e8b6-397c-8cbb-6218a24e738d",
                    "name": "sys_availabilityStatus",
                    "entityType": "vehicles",
                    "eventTime": 1523884461944,
                    "computedTime": 1523884461944,
                    "eventTimeAsString": "2018-04-16T13:14:21Z",
                    "interval": "CURRENT",
                    "entityId": "73DC1618-F2C0-4253-A9B9-5734384FC780",
                    "type": "KPI",
                    "lastKnown": false,
                    "booleanValue": true
                },
                {
                    "id": "2b381dff-66b2-314b-9c43-5ec1d559d1db",
                    "name": "sys_openIncidents",
                    "entityType": "vehicles",
                    "eventTime": 1523884461945,
                    "computedTime": 1523884461945,
                    "eventTimeAsString": "2018-04-16T13:14:21Z",
                    "interval": "CURRENT",
                    "entityId": "73DC1618-F2C0-4253-A9B9-5734384FC780",
                    "type": "KPI",
                    "lastKnown": false,
                    "numericValue": 0
                },
                {
                    "id": "b8a4acfe-af6a-3821-8301-9432328fd8d0",
                    "name": "sys_alerts",
                    "entityType": "vehicles",
                    "eventTime": 1523884461945,
                    "computedTime": 1523884461945,
                    "eventTimeAsString": "2018-04-16T13:14:21Z",
                    "interval": "CURRENT",
                    "entityId": "73DC1618-F2C0-4253-A9B9-5734384FC780",
                    "type": "KPI",
                    "lastKnown": false,
                    "numericValue": 0
                }
            ]
        }
    ],
    "links": [
        {
            "href": "https://iotserver/fleetMonitoring/clientapi/v2/vehicles?offset=0&limit=10&q=%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",
            "rel": "self"
        },
        {
            "href": "https://iotserver/fleetMonitoring/clientapi/v2/vehicles",
            "rel": "canonical"
        },
        {
            "href": "https://iotserver/fleetMonitoring/clientapi/v2/vehicles?q=%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&offset=0&limit=10",
            "rel": "first"
        },
        {
            "href": "https://iotserver/fleetMonitoring/clientapi/v2/vehicles?q=%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&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/vehicles
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.