Retrieve vehicle on board diagnostics 2 (OBD2) parameters
get
/fleetMonitoring/clientapi/v2/vehicles/{vehicleId}/parameters/devices
This operation returns On Board Diagnostics 2 (OBD2) parameters of a vehicle specified by its ID.
Request
Path Parameters
-
vehicleId: string
vehicle ID
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.
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/{vehicleId}/parameters/devices
Example of Response Body
The following example shows the content of the response body in JSON format:
{
"ora_longitude": -81.45078440911566,
"ora_latitude": 39.201236028757826,
"ora_obd2_engine_rpm": 400,
"ora_obd2_vehicle_speed": 120,
"ora_obd2_runtime_since_engine_start": 7200,
"ora_obd2_number_of_dtcs": 22,
"ora_obd2_engine_coolant_temperature": 45
}
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/{vehicleId}/parameters/devices
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.