Retrieve Vehicle Type pre-seeded fields
get
/fleetMonitoring/clientapi/v2/vehicleTypes/fields
This operation returns the pre-seeded fields of the vehicle type.
Request
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=singular
200 Response
Successfully processed.
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.
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.
Examples
curl -X GET
-u <username>:<password>
-H 'Accept: application/json'
https://iotserver/fleetMonitoring/clientapi/v2/vehicleTypes/fields
Example of Response Body
The following example shows the content of the response body in JSON format:
[
{
"name": "Speed",
"type": "NUMBER",
"defaultValue": 0,
"expectedField": "ora_obd2_vehicle_speed"
},
{
"name": "EngineRPM",
"type": "NUMBER",
"defaultValue": 0,
"expectedField": "ora_obd2_engine_rpm"
},
{
"name": "NumberOfDTCS",
"type": "NUMBER",
"defaultValue": 0,
"expectedField": "ora_obd2_number_of_dtcs"
},
{
"name": "EngineCoolantTemp",
"type": "NUMBER",
"defaultValue": 0,
"expectedField": "ora_obd2_engine_coolant_temperature"
},
{
"name": "Odometer",
"type": "NUMBER",
"defaultValue": 0,
"expectedField": "ora_obd2_true_odometer"
}
]
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/fields
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.