1. REST API for Oracle IoT Fleet Monitoring Cloud Service
  2. Tasks
  3. Vehicle Type Management

List Vehicle Types

get

/fleetMonitoring/clientapi/v2/vehicleTypes

This operation returns the list of all the vehicle types present in the current instance of the application.

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 : VehicleType_receive_list
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : attributes
Type: array
Attributes associated with this vehicle type. Attributes could be custom or sensor based
Show Source
Nested Schema : icon
Type: object
Binary object representing the vehicle type icon.
Show Source
Nested Schema : years
Type: array
Range of years for the vehicle type.
Show Source
Nested Schema : VehicleAttributes_receive
Type: object
Show Source
Nested Schema : allowedValues
Type: array
Allowed values for the attribute.
Show Source
Nested Schema : items
Type: object

401 Response

Unauthorized. The request requires user authentication.

403 Response

Forbidden. The server understood the request, but is refusing to fulfill it. Authorization will not help and the request SHOULD NOT be repeated.
Back to Top

Examples

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

Example of Response Body

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

{
    "items": [
        {
            "id": "A1BF9272-A87D-4D74-BAC2-3D4EB566D69E",
            "name": "DefaultVehicleType",
            "description": "",
            "years": [],
            "registrationTimeAsString": "2018-04-13T13:04:42.485Z",
            "lastModifiedTimeAsString": "2018-04-13T13:04:42.485Z",
            "attributes": [
                {
                    "name": "Speed",
                    "dataType": "NUMBER",
                    "deviceModel": "urn:com:oracle:iot:device:obd2",
                    "required": false,
                    "unique": false,
                    "messageFormatField": "ora_obd2_vehicle_speed",
                    "type": "SENSOR"
                },
                {
                    "name": "EngineRPM",
                    "dataType": "NUMBER",
                    "deviceModel": "urn:com:oracle:iot:device:obd2",
                    "required": false,
                    "unique": false,
                    "messageFormatField": "ora_obd2_engine_rpm",
                    "type": "SENSOR"
                },
                {
                    "name": "NumberOfDTCS",
                    "dataType": "NUMBER",
                    "deviceModel": "urn:com:oracle:iot:device:obd2",
                    "required": false,
                    "unique": false,
                    "messageFormatField": "ora_obd2_number_of_dtcs",
                    "type": "SENSOR"
                },
                {
                    "name": "EngineCoolantTemp",
                    "dataType": "NUMBER",
                    "deviceModel": "urn:com:oracle:iot:device:obd2",
                    "required": false,
                    "unique": false,
                    "messageFormatField": "ora_obd2_engine_coolant_temperature",
                    "type": "SENSOR"
                },
                {
                    "name": "Odometer",
                    "dataType": "NUMBER",
                    "deviceModel": "urn:com:oracle:iot:device:obd2",
                    "required": false,
                    "unique": false,
                    "messageFormatField": "ora_obd2_true_odometer",
                    "type": "SENSOR"
                }
            ],
            "links": [
                {
                    "href": "https://iotserver/fleetMonitoring/clientapi/v2/vehicleTypes/A1BF9272-A87D-4D74-BAC2-3D4EB566D69E",
                    "rel": "self"
                }
            ]
        }
    ],
    "links": [
        {
            "href": "https://iotserver/fleetMonitoring/clientapi/v2/vehicleTypes?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/vehicleTypes",
            "rel": "canonical"
        },
        {
            "href": "https://iotserver/fleetMonitoring/clientapi/v2/vehicleTypes?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/vehicleTypes?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/vehicleTypes



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