List tripTemplates
get
/fleetMonitoring/clientapi/v2/tripTemplates
This operation returns a list of all the trip templates known to the current Oracle IoT Fleet Monitoring Application instance.
Request
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.
-
limit(optional): integer
The maximum number of entries to return to the end user.
-
offset(optional): integer
The number that the first record of results is starting from.
-
orderBy(optional): string
Ordering criteria for the returned tripTemplates' list.
-
q(optional): string
Query to filter tripTemplates on the app. (For more information on mongoDB query parameters refer to Using mongoDB Query Syntax.)
-
since(optional): integer
The starting point of the desired time interval, in milliseconds. The default is 0.
-
totalResults(optional): boolean
The total number of results suiting the request.
-
until(optional): integer
The finishing point of the desired time interval, in milliseconds. The default is 0.
Response
Supported Media Types
- application/json
- application/vnd.oracle.resource+json;type=collection
200 Response
Successfully processed.
Root Schema : TripTemplate_receive_list
Type:
Show Source
object
-
count:
integer(int32)
-
hasMore:
boolean
-
items:
array items
-
limit:
integer(int32)
-
links:
array links
The set of API navigation links.
-
offset:
integer(int32)
Nested Schema : items
Type:
Show Source
object
-
destination:
object TripStop_receive
-
expectedDuration:
integer
Expected duration of TripTemplate (second)
-
id:
string
TripTemplate ID
-
name:
string
TripTemplate name
-
source:
object TripStop_receive
-
stops:
array stops
List of stops that are part of TripTemplate
-
stopsClassification:
string
One of [SINGLE_STOP, DUAL_STOP, TRIPLE_STOP, MULTI_STOP, NON_STOP].
-
totalStops:
integer
Total stops in TripTemplate
-
tripLength:
number
Trip Distance
-
tripLengthClassification:
string
One of [SHORT, MEDIUM, LONG].
Nested Schema : TripStop_receive
Type:
Show Source
object
-
address:
string
Unified full address, e.g. 500 Oracle Parkway::Redwood City::CA::US::94065 . Must be provided if geoLocation is not specified.
-
city:
string
Name of City
-
country:
string
Name of country
-
distanceToNextStop:
number
Estimated distance to next stop
-
estimatedTimeToNextStop:
integer
Estimated time it will take to reach next stop (second)
-
expectedDurationFromStart:
integer
Expected duration to reach from Start to this Stop (second)
-
geoLocation:
object GeoPosition_receive
-
postalCode:
string
Postal/Zip code
-
state:
string
Name of State
-
stopSequence:
integer
Property description was not set
-
street:
string
Name of Street
Nested Schema : GeoPosition_receive
Type:
Show Source
object
-
additionalElements:
array additionalElements
Property description was not set
-
altitude:
number
Property description was not set
-
latitude:
number
Property description was not set
-
longitude:
number
Property description was not set
-
valid:
boolean
Property description was not set
Nested Schema : items
Type:
Show Source
object
-
href:
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel:
string
Relation typeExample:
canonical
401 Response
Unauthorized. The request requires user authentication.
406 Response
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/tripTemplates
Example of Response Body
The following example shows the content of the response body in JSON format:
{
"offset":0,
"count":2,
"limit":10,
"hasMore":false,
"links":[
{
"rel":"self",
"href":"https://iotserver/fleetMonitoring/clientapi/version/resource/path"
},
{
"rel":"canonical",
"href":"https://iotserver/fleetMonitoring/clientapi/version/resource/path"
}
],
"items":[
{
"tripLength":0.0,
"totalStops":12345,
"name":"TripTemplate name",
"destination":{
"estimatedTimeToNextStop":1469184297746,
"distanceToNextStop":0.0,
"country":"Name of country",
"stopSequence":12345,
"address":"Unified full address, e.g. 500 Oracle Parkway::Redwood City::CA::US::94065 . Must be provided if geoLocation is not specified.",
"geoLocation":[longitude,latitude],
"city":"Name of City",
"street":"Name of Street",
"postalCode":"Postal/Zip code",
"expectedDurationFromStart":12345,
"state":"Name of State"
},
"stopsClassification":"One of [SINGLE_STOP, DUAL_STOP, TRIPLE_STOP, MULTI_STOP, NON_STOP].",
"tripLengthClassification":"One of [SHORT, MEDIUM, LONG].",
"id":"25603d8e36fb-49c",
"source":{
"estimatedTimeToNextStop":1469184297746,
"distanceToNextStop":0.0,
"country":"Name of country",
"stopSequence":12345,
"address":"Unified full address, e.g. 500 Oracle Parkway::Redwood City::CA::US::94065 . Must be provided if geoLocation is not specified.",
"geoLocation":[longitude,latitude],
"city":"Name of City",
"street":"Name of Street",
"postalCode":"Postal/Zip code",
"expectedDurationFromStart":12345,
"state":"Name of State"
},
"stops":[
{
"estimatedTimeToNextStop":1469184297746,
"distanceToNextStop":0.0,
"country":"Name of country",
"stopSequence":12345,
"address":"Unified full address, e.g. 500 Oracle Parkway::Redwood City::CA::US::94065 . Must be provided if geoLocation is not specified.",
"geoLocation":[longitude,latitude],
"city":"Name of City",
"street":"Name of Street",
"postalCode":"Postal/Zip code",
"expectedDurationFromStart":12345,
"state":"Name of State"
}
],
"expectedDuration":12345
},
{
"tripLength":0.0,
"totalStops":12345,
"name":"TripTemplate name",
"destination":{
"estimatedTimeToNextStop":1469184297746,
"distanceToNextStop":0.0,
"country":"Name of country",
"stopSequence":12345,
"address":"Unified full address, e.g. 500 Oracle Parkway::Redwood City::CA::US::94065 . Must be provided if geoLocation is not specified.",
"geoLocation":[longitude,latitude],
"city":"Name of City",
"street":"Name of Street",
"postalCode":"Postal/Zip code",
"expectedDurationFromStart":12345,
"state":"Name of State"
},
"stopsClassification":"One of [SINGLE_STOP, DUAL_STOP, TRIPLE_STOP, MULTI_STOP, NON_STOP].",
"tripLengthClassification":"One of [SHORT, MEDIUM, LONG].",
"id":"46f26ca275b0-331b",
"source":{
"estimatedTimeToNextStop":1469184297746,
"distanceToNextStop":0.0,
"country":"Name of country",
"stopSequence":12345,
"address":"Unified full address, e.g. 500 Oracle Parkway::Redwood City::CA::US::94065 . Must be provided if geoLocation is not specified.",
"geoLocation":[longitude,latitude],
"city":"Name of City",
"street":"Name of Street",
"postalCode":"Postal/Zip code",
"expectedDurationFromStart":12345,
"state":"Name of State"
},
"stops":[
{
"estimatedTimeToNextStop":1469184297746,
"distanceToNextStop":0.0,
"country":"Name of country",
"stopSequence":12345,
"address":"Unified full address, e.g. 500 Oracle Parkway::Redwood City::CA::US::94065 . Must be provided if geoLocation is not specified.",
"geoLocation":[longitude,latitude],
"city":"Name of City",
"street":"Name of Street",
"postalCode":"Postal/Zip code",
"expectedDurationFromStart":12345,
"state":"Name of State"
}
],
"expectedDuration":12345
}
]
}
Complete cURL Example
The following example shows the complete cURL command that can be used to perform the described operation:
curl -X GET
-u <username>:<password>
-H 'Accept: application/json'
https://iotserver/fleetMonitoring/clientapi/v2/tripTemplates
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
.