Retrieve attribute names and types supported by threshold predicate
get
/fleetMonitoring/clientapi/v2/rules/predicate/attributes
This operation returns attribute names and types that are supported by threshold predicate.
Request
Query Parameters
-
attributeSource(optional): string
Attribute source going to be used in predicate config
-
ruleSource(optional): array
The set of unique rule sources
-
ruleSourceType(optional): string
The type of rule sources passed in ruleSourceType parameter
Response
Supported Media Types
- application/json
200 Response
Successfully processed.
Root Schema : RuleMetadata_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
-
attributeSources:
object attributeSources
Additional Properties Allowed: additionalPropertiesattributeSources
-
links:
array links
The set of API navigation links.
-
metadata:
object metadata
Additional Properties Allowed: additionalPropertiesmetadata
Nested Schema : attributeSources
Type:
object
Additional Properties Allowed
Show Source
-
string
Map of the following type: Map<String, String>
attributeSources
Show Source
Nested Schema : metadata
Type:
object
Additional Properties Allowed
Show Source
-
string
Map of the following type: Map<String, String>
metadata
Show Source
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
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/rules/predicate/attributes
Example of Response Body
The following example shows the content of the response body in JSON format:
{
"attributeSources" : { },
"threshold" : {
"businessObject" : [ {
"attributeName" : "sensor/distanceSinceDtcsCleared",
"attributeType" : "NUMBER"
}, {
"attributeName" : "metric/sys_openIncidents",
"attributeType" : "NUMBER"
}, {
"attributeName" : "metric/sys_openOutageIncidents",
"attributeType" : "NUMBER"
}, {
"attributeName" : "sensor/averageFuelEconomy",
"attributeType" : "NUMBER"
}, {
"attributeName" : "sensor/numberOfDtcs",
"attributeType" : "NUMBER"
}, {
"attributeName" : "metric/sys_consumedFuelCost",
"attributeType" : "NUMBER"
}, {
"attributeName" : "sensor/runtimeSinceEngineStart",
"attributeType" : "NUMBER"
}, {
"attributeName" : "metric/sys_fuelConsumed",
"attributeType" : "NUMBER"
}, {
"attributeName" : "metric/sys_availabilityStatus",
"attributeType" : "BOOLEAN"
}, {
"attributeName" : "sensor/engineRpm",
"attributeType" : "NUMBER"
}, {
"attributeName" : "metric/sys_averageFuelEconomy",
"attributeType" : "NUMBER"
}, {
"attributeName" : "sensor/vehicleSpeed",
"attributeType" : "NUMBER"
}, {
"attributeName" : "metric/sys_incidents",
"attributeType" : "NUMBER"
}, {
"attributeName" : "sensor/trueOdometer",
"attributeType" : "NUMBER"
}, {
"attributeName" : "sensor/engineCoolantTemperature",
"attributeType" : "NUMBER"
}, {
"attributeName" : "metric/sys_alerts",
"attributeType" : "NUMBER"
}, {
"attributeName" : "sensor/throttlePosition",
"attributeType" : "NUMBER"
}, {
"attributeName" : "sensor/totalFuelUsed",
"attributeType" : "NUMBER"
}, {
"attributeName" : "metric/sys_idlingDuration",
"attributeType" : "NUMBER"
}, {
"attributeName" : "metric/sys_geoLocation",
"attributeType" : "STRING"
}, {
"attributeName" : "status",
"attributeType" : "STRING",
"attributeParameters" : [ {
"allowedValues" : [ "IN_MOTION", "STOPPED", "UNKNOWN" ]
} ]
}, {
"attributeName" : "metric/sys_utilizationStatus",
"attributeType" : "BOOLEAN"
}, {
"attributeName" : "sensor/massAirFlow",
"attributeType" : "NUMBER"
} ],
"message" : [ ]
},
"metadata" : {
"attributeTypes" : [ {
"type" : "BOOLEAN",
"operators" : [ "EQ", "NE" ],
"values" : [ "true", "false" ]
}, {
"type" : "STRING",
"operators" : [ "EQ", "CONTAINS", "NE" ]
}, {
"type" : "NUMBER",
"operators" : [ "LT", "LE", "EQ", "GT", "GE", "NE" ]
} ]
},
"links" : [ {
"href" : "https://iotserver:443/fleetMonitoring/clientapi/v2/rules/predicate/attributes/?ruleSourceType=vehicle&ruleSource=ALL",
"rel" : "self"
}, {
"href" : "https://iotserver:443/fleetMonitoring/clientapi/v2/rules/predicate/attributes/?ruleSourceType=vehicle&ruleSource=ALL",
"rel" : "canonical"
} ]
}
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/rules/predicate/attributes
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.