IBM IoT for Automotive : Asset

Preview

IBM IoT for Automotive : Asset

+ Day(s) remaining in the trial

Overview

The IoT for Automotive service API provides automotive domain specialized application development enablers for data acquisition, storage, real-time processing, and business rules support. IoT for Automotive provides APIs to fetch vehicle location, movement, vehicle health, and analytic insights. You can also use the APIs to retrieve and manage large volumes of automotive data, including map context and driver behavior data.
Use the following API documentation to help you to develop your IoT for Automotive service to suit your requirements:

Getting started

Authentication

To authenticate to the IoT for Automotive API, submit the user name and the password for the service instance that you would like to use. The API supports HTTP basic authentication. To see the user credentials of the IoT for Automotive instance that you created on Bluemix, go to the dashboard and click Manage. **NOTE:** The Username and Password credentials for the Driver Behavior service instance are not the same as your Bluemix account user name and password.

Security

Keys

Pick a key to use with this API. Make sure you are logged in with your IBM id for your keys to be populated in the dropdown below. By selecting a key, it will be pre-filled for each endpoint in the Documentation section that can be used with the built-in testing. If you want to change which key to use for a particular endpoint, you can do so at the endpoint in the Documentation section.
You can manage your API keys in the <MyAPIs> section. API keys authenticate you to your subscription, so make sure to keep them secret. Do not share the X-IBM-Client-Secret portion of any API key in publicly accessible places such as GitHub, or client-side code.



Manage your keys
 

Documentation

IBM IoT for Automotive : Asset:

Driver

Add a driver
Create a driver from the information that is defined in the request body. A driver ID is generated by the system and returned in the response.

POST   /driver

			https://automotive.internetofthings.ibmcloud.com/asset/driver
		
Keys
Path and Query parameters

tenant_id

STRING , required

Tenant ID.

Request code
								
HttpResponse<String> response = Unirest.post("https://automotive.internetofthings.ibmcloud.com/asset/driver?tenant_id=SOME_STRING_VALUE") .asString();
Request model

status

object , required

STRING , optional

The status to identify enabling the object into IoT for Automotive

internal_driver_id

INTEGER , optional

The numerical ID of the driver that is automatically generated by the system.

name

STRING , optional

The name of the driver.

driver_id

STRING , required

The ID of the driver that is automatically generated by the system.

contract_id

STRING , optional

Contract ID.

Request example
{
  "status": {
    "": Active,Inactive
  },
  "internal_driver_id": integer,
  "name": string,
  "driver_id": string,
  "contract_id": string
}
Response model

201

Created

Body

id

STRING , required

The generated ID that is created by the POST operation.

400

Tenant ID is invalid.

Body

405

Invalid input

Body

Response example

201

Created

								{
  "id" : string
}
							

400

Tenant ID is invalid.

								
							

405

Invalid input

								
							
Deletes a driver
Delete the driver by specifying the ID.

DELETE   /driver/{driver_id}

			https://automotive.internetofthings.ibmcloud.com/asset/driver/{driver_id}
		
Keys
Path and Query parameters

driver_id

URL , required

ID of the driver to delete.

tenant_id

STRING , required

Tenant ID.

Request code
								
HttpResponse<String> response = Unirest.delete("https://automotive.internetofthings.ibmcloud.com/asset/driver/%7Bdriver_id%7D?tenant_id=SOME_STRING_VALUE") .asString();
Response model

200

Successful operation.

Body

id

STRING , required

The generated ID that is created by the POST operation.

400

Tenant ID is invalid.

Body

404

Driver not found.

Body

Response example

200

Successful operation.

								{
  "id" : string
}
							

400

Tenant ID is invalid.

								
							

404

Driver not found.

								
							
Find a driver by ID
Retrieve a driver by specifying an ID.

GET   /driver/{driver_id}

			https://automotive.internetofthings.ibmcloud.com/asset/driver/{driver_id}
		
Keys
Path and Query parameters

driver_id

URL , required

ID of the driver to return.

tenant_id

STRING , required

Tenant ID.

Request code
								
HttpResponse<String> response = Unirest.get("https://automotive.internetofthings.ibmcloud.com/asset/driver/%7Bdriver_id%7D?tenant_id=SOME_STRING_VALUE") .asString();
Response model

200

Successful operation.

Body

status [Status]

object , required

internal_driver_id

INTEGER , required

The numerical ID of the driver that is automatically generated by the system.

name

STRING , required

The name of the driver.

driver_id

STRING , required

The ID of the driver that is automatically generated by the system.

contract_id

STRING , required

Contract ID.

STRING , optional

The status to identify enabling the object into IoT for Automotive

400

Invalid ID supplied.

Body

404

Driver not found

Body

Response example

200

Successful operation.

								{
  "status" : {
    "" : Active,Inactive
  },
  "internal_driver_id" : integer,
  "name" : string,
  "driver_id" : string,
  "contract_id" : string
}
							

400

Invalid ID supplied.

								
							

404

Driver not found

								
							
List drivers
You can get a list of drivers that you are interested in by specifying the parameters.

GET   /driver

			https://automotive.internetofthings.ibmcloud.com/asset/driver
		
Keys
Path and Query parameters

num_page

INTEGER , optional

The page number to be returned out of drivers.

num_rec_in_page

INTEGER , optional

The number of drivers to be returned in one page.

tenant_id

STRING , required

Tenant ID.

Request code
								
HttpResponse<String> response = Unirest.get("https://automotive.internetofthings.ibmcloud.com/asset/driver?tenant_id=SOME_STRING_VALUE&num_page=SOME_INTEGER_VALUE&num_rec_in_page=SOME_INTEGER_VALUE") .asString();
Response model

200

Successful operation.

Body

data [Driver]

ARRAY , required

Status

object , optional

internal_driver_id

INTEGER , required

The numerical ID of the driver that is automatically generated by the system.

name

STRING , required

The name of the driver.

driver_id

STRING , required

The ID of the driver that is automatically generated by the system.

contract_id

STRING , required

Contract ID.

STRING , optional

The status to identify enabling the object into IoT for Automotive

400

Tenant ID is invalid.

Body

Response example

200

Successful operation.

								{
  "data" : [{
    "Status" : {
    "" : Active,Inactive
  },
    "internal_driver_id" : integer,
    "name" : string,
    "driver_id" : string,
    "contract_id" : string
  }]
}
							

400

Tenant ID is invalid.

								
							
Refresh driver information on vehicle data hub hosts
Refresh all driver information on vehicle data hub hosts.

POST   /driver/refresh

			https://automotive.internetofthings.ibmcloud.com/asset/driver/refresh
		
Keys
Path and Query parameters

tenant_id

STRING , required

Tenant ID.

Request code
								
HttpResponse<String> response = Unirest.post("https://automotive.internetofthings.ibmcloud.com/asset/driver/refresh?tenant_id=SOME_STRING_VALUE") .asString();
Response model

200

Successful operation.

Body

data [RefreshVDH]

ARRAY , required

message

STRING , required

The message.

vehicle_data_hub_host

STRING , required

The vehicle data hub host.

number_of_records

INTEGER , required

Number of refreshed records.

400

Tenant ID is invalid.

Body

Response example

200

Successful operation.

								{
  "data" : [{
    "message" : string,
    "vehicle_data_hub_host" : string,
    "number_of_records" : integer
  }]
}
							

400

Tenant ID is invalid.

								
							
Update an existing driver
Update the driver that is specified by the ID and the request body.

PUT   /driver/{driver_id}

			https://automotive.internetofthings.ibmcloud.com/asset/driver/{driver_id}
		
Keys
Path and Query parameters

driver_id

URL , required

ID of the driver to update.

tenant_id

STRING , required

Tenant ID.

Request code
								
HttpResponse<String> response = Unirest.put("https://automotive.internetofthings.ibmcloud.com/asset/driver/%7Bdriver_id%7D?tenant_id=SOME_STRING_VALUE") .asString();
Request model

status

object , required

STRING , optional

The status to identify enabling the object into IoT for Automotive

internal_driver_id

INTEGER , optional

The numerical ID of the driver that is automatically generated by the system.

name

STRING , optional

The name of the driver.

driver_id

STRING , required

The ID of the driver that is automatically generated by the system.

contract_id

STRING , optional

Contract ID.

Request example
{
  "status": {
    "": Active,Inactive
  },
  "internal_driver_id": integer,
  "name": string,
  "driver_id": string,
  "contract_id": string
}
Response model

200

Successful operation.

Body

400

Tenant ID is invalid.

Body

404

Driver not found.

Body

405

Validation exception.

Body

Response example

200

Successful operation.

								
							

400

Tenant ID is invalid.

								
							

404

Driver not found.

								
							

405

Validation exception.

								
							

Loading content...