Retrieve list of entities depending on current asset
get
/assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/dependingEntities
This operation returns a list of entities depending on given asset type.
Request
Path Parameters
-
asset-type-name: string
Name of asset type to retrieve dependent entities for from Oracle IoT Asset Monitoring Cloud Service
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.
Response
Supported Media Types
- application/json
- application/vnd.oracle.resource+json;type=singular
200 Response
Successfully processed.
Root Schema : CorrelationGraphEntityImpl_receive
Type:
Show Source
object
-
associationTime:
integer
Property description was not set
-
associationType:
string
One of [LINKING, HIERARCHY, INTEGRITY].
-
createdTime:
integer
Property description was not set
-
dependentEntities:
array dependentEntities
Property description was not set
-
destinationEntityId:
string
Property description was not set
-
destinationEntityTypeName:
string
Property description was not set
-
id:
string
Property description was not set
-
metadata:
object metadata
Additional Properties Allowed: additionalPropertiesProperty description was not set
-
optional:
boolean
Property description was not set
-
sourceEntityId:
string
Property description was not set
-
sourceEntityTypeName:
string
Property description was not set
Nested Schema : metadata
Type:
object
Additional Properties Allowed
Show Source
-
string
A map of the following type: Map<String, String>
Property description was not set
Show Source
401 Response
Unauthorized. The request requires user authentication.
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.
406 Response
Request 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/assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/dependingEntities
Example of Response Body
The following example shows the content of the response body in JSON format:
{
"associationTime":1469184297746,
"associationType":"One of [LINKING, HIERARCHY, INTEGRITY].",
"createdTime":1469184297746,
"dependentEntities":[
{
"associationTime":1469184297746,
"associationType":"One of [LINKING, HIERARCHY, INTEGRITY].",
"createdTime":1469184297746,
"destinationEntityId":"2fac63555665-29e3",
"destinationEntityTypeName":"Property description was not set",
"id":"67e415ac4b8f-6ab7",
"metadata":{
"metadata_key1":"metadata_value1",
"metadata_key2":"metadata_value2",
"metadata_key3":"metadata_value3"
},
"optional":false,
"sourceEntityId":"4c5332781380-14ac",
"sourceEntityTypeName":"Property description was not set"
}
],
"destinationEntityId":"432654da74d-3dca",
"destinationEntityTypeName":"Property description was not set",
"id":"5e1b223a2d87-6449",
"metadata":{
"metadata_key1":"metadata_value1",
"metadata_key2":"metadata_value2",
"metadata_key3":"metadata_value3"
},
"optional":false,
"sourceEntityId":"79e49023d39-46ef",
"sourceEntityTypeName":"Property description was not set"
}
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/assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/dependingEntities
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.