REST API for Oracle IoT Fleet Monitoring Cloud Service

All REST Endpoints

Driver Information

The Driver Information API provides methods to retrieve information about the drivers in Fleet Monitoring. All methods of this group support a request header named 'X-Oracle-IoT-Org' with a value of an organization ID, which helps you to target requests to different organizations.

List drivers: Method: get
Path: /fleetMonitoring/clientapi/v2/drivers
Retrieve driver by ID: Method: get
Path: /fleetMonitoring/clientapi/v2/drivers/{id}
Retrieve driver metrics by ID: Method: get
Path: /fleetMonitoring/clientapi/v2/drivers/{id}/metrics
Retrieve drivers count: Method: get
Path: /fleetMonitoring/clientapi/v2/drivers/count

Fleet Incidents

The Fleet Incidents API enables you to configure incidents and manage their lifecycle in Fleet Monitoring.All methods of this group support a request header named 'X-Oracle-IoT-Org' with a value of an organization ID, which helps you to target requests to different organizations.

Add comments to an incident: Method: post
Path: /fleetMonitoring/clientapi/v2/incidents/{incident-id}/comments
Delete incident by its ID: Method: delete
Path: /fleetMonitoring/clientapi/v2/incidents/{incident-id}
List incident occurrences: Method: get
Path: /fleetMonitoring/clientapi/v2/incidents/{incident-id}/occurrences
List incidents: Method: get
Path: /fleetMonitoring/clientapi/v2/incidents/
Retrieve incident details: Method: get
Path: /fleetMonitoring/clientapi/v2/incidents/{incident-id}
Retrieve incident occurrence count: Method: get
Path: /fleetMonitoring/clientapi/v2/incidents/{incident-id}/occurrences/count
Update incident by ID: Method: post
Path: /fleetMonitoring/clientapi/v2/incidents/{incident-id}

Fleet Rules

The Fleet Rules API help you to configure rules and manage their lifecycle in Fleet Monitoring. All methods of this group support a request header named 'X-Oracle-IoT-Org' with a value of an organization ID, which helps you to target requests to different organizations.

Create rule: Method: post
Path: /fleetMonitoring/clientapi/v2/rules/
Delete rule by ID: Method: delete
Path: /fleetMonitoring/clientapi/v2/rules/{rule-id}
List rules: Method: get
Path: /fleetMonitoring/clientapi/v2/rules/
Retrieve attribute names and types supported by threshold predicate: Method: get
Path: /fleetMonitoring/clientapi/v2/rules/predicate/attributes
Retrieve rule details: Method: get
Path: /fleetMonitoring/clientapi/v2/rules/{rule-id}
Update rule by ID: Method: post
Path: /fleetMonitoring/clientapi/v2/rules/{rule-id}

Shipment Management (To be Deprecated, see Description)

Shipment Management provide methods to manage the shipments in Fleet Monitoring. These APIs will be deprecated in a future release. You could preferably use Trip Management APIs for real-time monitoring of in-transit movements. All methods of this group support a request header named 'X-Oracle-IoT-Org' with a value of an organization ID, which helps you to target requests to different organizations.

Complete a shipment: Method: post
Path: /fleetMonitoring/clientapi/v2/shipments/completed
Create shipment: Method: post
Path: /fleetMonitoring/clientapi/v2/shipments
Delete a planned shipment by ID: Method: delete
Path: /fleetMonitoring/clientapi/v2/shipments/{id}
List shipment field definitions: Method: get
Path: /fleetMonitoring/clientapi/v2/shipments/fields
List shipments: Method: get
Path: /fleetMonitoring/clientapi/v2/shipments
Retrieve shipment by ID: Method: get
Path: /fleetMonitoring/clientapi/v2/shipments/{id}
Retrieve shipment count: Method: get
Path: /fleetMonitoring/clientapi/v2/shipments/count
Retrieve shipment metrics: Method: get
Path: /fleetMonitoring/clientapi/v2/shipments/{id}/metrics
Start a shipment: Method: post
Path: /fleetMonitoring/clientapi/v2/shipments/start
Update shipment by ID: Method: post
Path: /fleetMonitoring/clientapi/v2/shipments/{shipmentId}

Trip Management

The Trip Management API provides methods to add new trips, update, and retrieve the trip details from Fleet Monitoring. All methods of this group support a request header named 'X-Oracle-IoT-Org' with a value of an organization ID, which helps you to target requests to different organizations.

Create trip: Method: post
Path: /fleetMonitoring/clientapi/v2/trips
Delete trip: Method: delete
Path: /fleetMonitoring/clientapi/v2/trips/{tripId}
List trips: Method: get
Path: /fleetMonitoring/clientapi/v2/trips
Retrieve trip count: Method: get
Path: /fleetMonitoring/clientapi/v2/trips/count
Retrieve trip details: Method: get
Path: /fleetMonitoring/clientapi/v2/trips/{tripId}
Retrieve trip metrics by ID: Method: get
Path: /fleetMonitoring/clientapi/v2/trips/{id}/metrics
Update trip by ID: Method: post
Path: /fleetMonitoring/clientapi/v2/trips/{tripId}

Trip Template Management

The Trip Template Management API lets you manage the trip templates in Fleet Monitoring. All methods of this group support a request header named 'X-Oracle-IoT-Org' with a value of an organization ID, which helps you to target requests to different organizations.

Create new tripTemplate: Method: post
Path: /fleetMonitoring/clientapi/v2/tripTemplates
List tripTemplates: Method: get
Path: /fleetMonitoring/clientapi/v2/tripTemplates
Retrieve tripTemplate count: Method: get
Path: /fleetMonitoring/clientapi/v2/tripTemplates/count
Retrieve tripTemplate details: Method: get
Path: /fleetMonitoring/clientapi/v2/tripTemplates/{tripTemplateId}

Vehicle Management

The Vehicle Management API provides methods to manage the vehicles in Fleet Monitoring. All methods of this group support a request header named 'X-Oracle-IoT-Org' with a value of an organization ID, which helps you to target requests to different organizations.

Create a single vehicle: Method: post
Path: /fleetMonitoring/clientapi/v2/vehicles/
Create vehicle details in bulk: Method: post
Path: /fleetMonitoring/clientapi/v2/vehicles
Delete Vehicle by ID: Method: delete
Path: /fleetMonitoring/clientapi/v2/vehicles/{id}
List vehicles: Method: get
Path: /fleetMonitoring/clientapi/v2/vehicles
Retrieve vehicle by ID: Method: get
Path: /fleetMonitoring/clientapi/v2/vehicles/{id}
Retrieve vehicle count: Method: get
Path: /fleetMonitoring/clientapi/v2/vehicles/count
Retrieve vehicle metrics by ID: Method: get
Path: /fleetMonitoring/clientapi/v2/vehicles/{id}/metrics
Retrieve vehicle on board diagnostics 2 (OBD2) parameters: Method: get
Path: /fleetMonitoring/clientapi/v2/vehicles/{vehicleId}/parameters/devices
Update vehicle by ID: Method: post
Path: /fleetMonitoring/clientapi/v2/vehicles/{vehicle-id}

Vehicle Provisioning

The Vehicle Provisioning API enables you to retrieve provisioning information for the vehicles in Oracle IoT Fleet Monitoring Cloud Service. The provisioning information contains attributes such as, serverURI, sharedSecret, endpointId, trustAnchor certificate etc, and is required for provisioning the sensors in Oracle IoT Fleet Monitoring Cloud Service.

Retrieve provisioning files for vehicle sensors by activation IDs: Method: post
Path: /fleetMonitoring/clientapi/v2/provisioner
Retrieve provisioning files for vehicle sensors by vehicle identifiers: Method: post
Path: /fleetMonitoring/clientapi/v2/provisioner/vehicles

Vehicle Type Management

The Vehicle Type Management API provides methods to manage the vehicle types in Fleet Monitoring. All methods of this group support a request header named 'X-Oracle-IoT-Org' with a value of an organization ID, which helps you to target requests to different organizations.

Create Vehicle Type: Method: post
Path: /fleetMonitoring/clientapi/v2/vehicleTypes
Delete Vehicle Type by ID: Method: delete
Path: /fleetMonitoring/clientapi/v2/vehicleTypes/{type-id}
List Vehicle Types: Method: get
Path: /fleetMonitoring/clientapi/v2/vehicleTypes
Retrieve Vehicle Type by ID: Method: get
Path: /fleetMonitoring/clientapi/v2/vehicleTypes/{type-id}
Retrieve vehicle type count: Method: get
Path: /fleetMonitoring/clientapi/v2/vehicleTypes/count
Retrieve Vehicle Type pre-seeded fields: Method: get
Path: /fleetMonitoring/clientapi/v2/vehicleTypes/fields
Update Vehicle Type by ID: Method: post
Path: /fleetMonitoring/clientapi/v2/vehicleTypes/{type-id}