REST API for Oracle IoT Fleet Monitoring Cloud Service

Retrieve Vehicle Type by ID

get

/fleetMonitoring/clientapi/v2/vehicleTypes/{type-id}

This operation returns the information about a vehicle type specified by its ID.

Request

Path Parameters

type-id: string

Vehicle Type ID

Query Parameters

expand(optional): string

The list of fields to be expanded in the result. Use 'all' to expand all expandable fields in result.
fields(optional): string

The comma-separated list of fields to be shown in response. By default all response object fields will be present.

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.

Root Schema : VehicleType_receive

Type: object

Show Source

attributes: array attributes

Attributes associated with this vehicle type. Attributes could be custom or sensor based
description: string

Description about the vehicle type.
icon: object icon

Binary object representing the vehicle type icon.
id: string

Unique Identifier of vehicle type.
lastModifiedTimeAsString: string

Modified time as string
make: string

Make of the vehicle type.
model: string

Model of the vehicle type.
name: string

Name of the vehicle type. It must be unique.
registrationTimeAsString: string

Registration time as string.
years: array years

Range of years for the vehicle type.

{
    "type":"object",
    "required":[
        "id",
        "name",
        "description",
        "make",
        "model",
        "years",
        "icon",
        "registrationTimeAsString",
        "lastModifiedTimeAsString",
        "attributes"
    ],
    "properties":{
        "name":{
            "description":"Name of the vehicle type. It must be unique.",
            "type":"string"
        },
        "icon":{
            "description":"Binary object representing the vehicle type icon.",
            "type":"object",
            "properties":{
                "links":{
                    "description":"The set of API navigation links.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "rel":{
                                "description":"Relation type",
                                "type":"string",
                                "example":"canonical"
                            },
                            "href":{
                                "description":"The target resource URI",
                                "type":"string",
                                "example":"https://iotserver/iot/api/vX/some/API/path"
                            }
                        }
                    }
                }
            }
        },
        "lastModifiedTimeAsString":{
            "description":"Modified time as string",
            "type":"string"
        },
        "description":{
            "description":"Description about the vehicle type.",
            "type":"string"
        },
        "model":{
            "description":"Model of the vehicle type.",
            "type":"string"
        },
        "attributes":{
            "description":"Attributes associated with this vehicle type. Attributes could be custom or sensor based",
            "type":"array",
            "items":{
                "$ref":"#/definitions/VehicleAttributes_receive"
            }
        },
        "id":{
            "description":"Unique Identifier of vehicle type.",
            "type":"string"
        },
        "make":{
            "description":"Make of the vehicle type.",
            "type":"string"
        },
        "years":{
            "description":"Range of years for the vehicle type.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "registrationTimeAsString":{
            "description":"Registration time as string.",
            "type":"string"
        }
    }
}

Nested Schema : attributes

Type: array

Attributes associated with this vehicle type. Attributes could be custom or sensor based

Show Source

Array of: object VehicleAttributes_receive

{
    "description":"Attributes associated with this vehicle type. Attributes could be custom or sensor based",
    "type":"array",
    "items":{
        "$ref":"#/definitions/VehicleAttributes_receive"
    }
}

Nested Schema : icon

Type: object

Binary object representing the vehicle type icon.

Show Source

links(optional): array links

The set of API navigation links.

{
    "description":"Binary object representing the vehicle type icon.",
    "type":"object",
    "properties":{
        "links":{
            "description":"The set of API navigation links.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "rel":{
                        "description":"Relation type",
                        "type":"string",
                        "example":"canonical"
                    },
                    "href":{
                        "description":"The target resource URI",
                        "type":"string",
                        "example":"https://iotserver/iot/api/vX/some/API/path"
                    }
                }
            }
        }
    }
}

Nested Schema : years

Type: array

Range of years for the vehicle type.

Show Source

Array of: string

{
    "description":"Range of years for the vehicle type.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : VehicleAttributes_receive

Type: object

Show Source

allowedValues: array allowedValues

Allowed values for the attribute.
dataType: string

Data type of the attribute. One of [STRING, NUMBER, BOOLEAN, DATE, BINARY].
deviceModel: string

Device model URN for the message format field this attribute is mapped to. It is mandatory for the attribute of the type sensor.
instructions: string

Instructions on how to fill the vehicle type attributes.
messageFormat: string

Message format URN which the field is mapped. For attributes of SENSOR type this attribute is mandatory.
messageFormatField: string

Message format field to which this attributes is mapped. For attributes of SENSOR type this is mandatory.
name: string

Name of the attribute.
required: boolean

Boolean value for whether the attribute if required or optional.
type: string

Attribute Type. One of [CUSTOM, SENSOR].
unique: boolean

Boolean value for whether the attribute is unique or not.

{
    "type":"object",
    "required":[
        "instructions",
        "required",
        "deviceModel",
        "type",
        "messageFormat",
        "messageFormatField",
        "unique",
        "allowedValues",
        "dataType",
        "name"
    ],
    "properties":{
        "allowedValues":{
            "description":"Allowed values for the attribute. ",
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "instructions":{
            "description":"Instructions on how to fill the vehicle type attributes.",
            "type":"string"
        },
        "messageFormat":{
            "description":"Message format URN which the field is mapped. For attributes of SENSOR type this attribute is mandatory.",
            "type":"string"
        },
        "unique":{
            "description":"Boolean value for whether the attribute is unique or not.",
            "type":"boolean"
        },
        "dataType":{
            "description":"Data type of the attribute. One of [STRING, NUMBER, BOOLEAN, DATE, BINARY].",
            "type":"string"
        },
        "name":{
            "description":"Name of the attribute.",
            "type":"string"
        },
        "messageFormatField":{
            "description":"Message format field to which this attributes is mapped. For attributes of SENSOR type this is mandatory.",
            "type":"string"
        },
        "deviceModel":{
            "description":"Device model URN for the message format field this attribute is mapped to. It is mandatory for the attribute of the type sensor.",
            "type":"string"
        },
        "type":{
            "description":"Attribute Type. One of [CUSTOM, SENSOR].",
            "type":"string"
        },
        "required":{
            "description":"Boolean value for whether the attribute if required or optional.",
            "type":"boolean"
        }
    }
}

Nested Schema : allowedValues

Type: array

Allowed values for the attribute.

Show Source

Array of: object items

{
    "description":"Allowed values for the attribute. ",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : links

Type: array

The set of API navigation links.

Show Source

Array of: object items

{
    "description":"The set of API navigation links.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "rel":{
                "description":"Relation type",
                "type":"string",
                "example":"canonical"
            },
            "href":{
                "description":"The target resource URI",
                "type":"string",
                "example":"https://iotserver/iot/api/vX/some/API/path"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

href(optional): string

The target resource URI

Example: https://iotserver/iot/api/vX/some/API/path
rel(optional): string

Relation type

Example: canonical

{
    "type":"object",
    "properties":{
        "rel":{
            "description":"Relation type",
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "description":"The target resource URI",
            "type":"string",
            "example":"https://iotserver/iot/api/vX/some/API/path"
        }
    }
}

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/{type-id}

Example of Response Body

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

{
    "id": "2F29B565-D2A4-4922-AE40-ED6A3E1F5E8B",
    "name": "Test_Vehicle_Type",
    "description": "Vehicle Type Description",
    "make": "Vehicle_Type_Make",
    "model": "Vehicle_Type_Model",
    "years": [
        2015,
        2016,
        2017
    ],
    "registrationTimeAsString": "2018-04-16T07:58:16.186Z",
    "lastModifiedTimeAsString": "2018-04-16T07:58:16.186Z",
    "attributes": [
        {
            "name": "TestAttribute_Custom",
            "dataType": "STRING",
            "allowedValues": [
                "Value_1",
                "Value_2"
            ],
            "defaultValue": "Value_1",
            "required": true,
            "unique": false,
            "type": "CUSTOM"
        },
        {
            "name": "TestAttribute_Sensor",
            "dataType": "NUMBER",
            "deviceModel": "urn:com:oracle:iot:device:obd2",
            "required": false,
            "unique": false,
            "messageFormatField": "ora_obd2_vehicle_speed",
            "type": "SENSOR"
        }
    ],
    "links": [
        {
            "href": "https://iotserver/fleetMonitoring/clientapi/v2/vehicleTypes/2F29B565-D2A4-4922-AE40-ED6A3E1F5E8B",
            "rel": "self"
        },
        {
            "href": "https://iotserver/fleetMonitoring/clientapi/v2/vehicleTypes/2F29B565-D2A4-4922-AE40-ED6A3E1F5E8B",
            "rel": "canonical"
        }
    ],
    "icon": {
        "links": [
            {
                "href": "https://iotserver/fleetMonitoring/clientapi/v2/binary/6A10144B-37FC-45B5-BD6F-070142944B50.image.jpeg",
                "rel": "self"
            }
        ]
    }
}

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/6c523b3c73f8-6425

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.