REST API for Oracle IoT Asset Monitoring Cloud Service

Asset Types REST Endpoints

Asset Types

The Asset Types API lets you manage and maintain the asset types in your Oracle IoT Asset Monitoring Cloud Service instance. Besides specific parameters in each method, all methods in this group support a request header named 'X-Oracle-IoT-Org' and value of an Org ID, which allows targeting requests to different organizations.

Create asset type: Method: post
Path: /assetMonitoring/clientapi/v2/assetTypes
Create asset type what-if scenario: Method: post
Path: /assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/whatIfs
Create new asset type property: Method: post
Path: /assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/properties
Delete asset by asset type: Method: delete
Path: /assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}
Delete asset type what-if event by name: Method: delete
Path: /assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/whatIfs/{event-name}
Delete definition of asset type property: Method: delete
Path: /assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/properties/{property-name}
Download asset type what-if scenario image: Method: get
Path: /assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/whatIfs/{event-name}/attachments/{id}
Ensure that provided update for asset type is safe: Method: post
Path: /assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/updateCheck
Get definition of asset type property: Method: get
Path: /assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/properties/{property-name}
List asset type what-if events: Method: get
Path: /assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/whatIfs
List asset types: Method: get
Path: /assetMonitoring/clientapi/v2/assetTypes
Replace asset type by name: Method: put
Path: /assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}
Replace asset type what-if event: Method: put
Path: /assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/whatIfs/{event-name}
Retrieve asset type details by name: Method: get
Path: /assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}
Retrieve asset type what-if event details by name: Method: get
Path: /assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/whatIfs/{event-name}
Retrieve asset type what-if events count: Method: get
Path: /assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/whatIfs/count
Retrieve asset types count: Method: get
Path: /assetMonitoring/clientapi/v2/assetTypes/count
Retrieve list of available asset type properties: Method: get
Path: /assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/properties
Retrieve list of entities depending on current asset: Method: get
Path: /assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/dependingEntities
Update asset type by name: Method: post
Path: /assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}
Update asset type what-if scenario: Method: post
Path: /assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/whatIfs/{event-name}
Update definition of asset type property: Method: post
Path: /assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/properties/{property-name}