All REST Endpoints
Asset Incidents
The Asset Incidents API lets you add, update, view, and delete details about the incidents associated with the assets of your Oracle IoT Asset Monitoring Cloud Service instance. All non-org aware REST API will be deprecated in future releases.
- Add comments to an incident
- Method: postPath:
/assetMonitoring/clientapi/v2/incidents/{incident-id}/comments
- Bulk update of the external activities
- Method: postPath:
/assetMonitoring/clientapi/v2/incidents/externalActivities
- Delete incident by its ID
- Method: deletePath:
/assetMonitoring/clientapi/v2/incidents/{incident-id}
- Get Incidents Count
- Method: getPath:
/assetMonitoring/clientapi/v2/incidents/count
- List incident occurrences
- Method: getPath:
/assetMonitoring/clientapi/v2/incidents/{incident-id}/occurrences
- List incidents
- Method: getPath:
/assetMonitoring/clientapi/v2/incidents
- Retrieve incident details
- Method: getPath:
/assetMonitoring/clientapi/v2/incidents/{incident-id}
- Retrieve incident details by incident type
- Method: getPath:
/assetMonitoring/clientapi/v2/incidents/incidentDetails
- Retrieve incident occurrence count
- Method: getPath:
/assetMonitoring/clientapi/v2/incidents/{incident-id}/occurrences/count
- Update incident by ID
- Method: postPath:
/assetMonitoring/clientapi/v2/incidents/{incident-id}
Asset Rules
The Asset Rules API allows you to manage and maintain rules in your Oracle IoT Asset Monitoring Cloud Service instance. All non-org aware REST API will be deprecated in future releases.
- Create rule
- Method: postPath:
/assetMonitoring/clientapi/v2/rules
- Delete rule by ID
- Method: deletePath:
/assetMonitoring/clientapi/v2/rules/{rule-id}
- Get Rules Count
- Method: getPath:
/assetMonitoring/clientapi/v2/rules/count
- List rules
- Method: getPath:
/assetMonitoring/clientapi/v2/rules
- Retrieve rule by ID
- Method: getPath:
/assetMonitoring/clientapi/v2/rules/{rule-id}
- Update rule by ID
- Method: postPath:
/assetMonitoring/clientapi/v2/rules/{rule-id}
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: postPath:
/assetMonitoring/clientapi/v2/assetTypes
- Create asset type what-if scenario
- Method: postPath:
/assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/whatIfs
- Create new asset type property
- Method: postPath:
/assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/properties
- Delete asset by asset type
- Method: deletePath:
/assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}
- Delete asset type what-if event by name
- Method: deletePath:
/assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/whatIfs/{event-name}
- Delete definition of asset type property
- Method: deletePath:
/assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/properties/{property-name}
- Download asset type what-if scenario image
- Method: getPath:
/assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/whatIfs/{event-name}/attachments/{id}
- Ensure that provided update for asset type is safe
- Method: postPath:
/assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/updateCheck
- Get definition of asset type property
- Method: getPath:
/assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/properties/{property-name}
- List asset type what-if events
- Method: getPath:
/assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/whatIfs
- List asset types
- Method: getPath:
/assetMonitoring/clientapi/v2/assetTypes
- Replace asset type by name
- Method: putPath:
/assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}
- Replace asset type what-if event
- Method: putPath:
/assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/whatIfs/{event-name}
- Retrieve asset type details by name
- Method: getPath:
/assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}
- Retrieve asset type what-if event details by name
- Method: getPath:
/assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/whatIfs/{event-name}
- Retrieve asset type what-if events count
- Method: getPath:
/assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/whatIfs/count
- Retrieve asset types count
- Method: getPath:
/assetMonitoring/clientapi/v2/assetTypes/count
- Retrieve list of available asset type properties
- Method: getPath:
/assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/properties
- Retrieve list of entities depending on current asset
- Method: getPath:
/assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/dependingEntities
- Update asset type by name
- Method: postPath:
/assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}
- Update asset type what-if scenario
- Method: postPath:
/assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/whatIfs/{event-name}
- Update definition of asset type property
- Method: postPath:
/assetMonitoring/clientapi/v2/assetTypes/{asset-type-name}/properties/{property-name}
Asset Warnings
The Asset Warnings API provides a set of operations and methods to manage various aspects of warning life-cycle and configurations. All non-org aware REST API will be deprecated in future releases.
- Delete warning by id
- Method: deletePath:
/assetMonitoring/clientapi/v2/warnings/{warning-id}
- Get Warnings Count
- Method: getPath:
/assetMonitoring/clientapi/v2/warnings/count
- Get warnings details
- Method: getPath:
/assetMonitoring/clientapi/v2/warnings/{warning-id}
- List warnings
- Method: getPath:
/assetMonitoring/clientapi/v2/warnings
Assets Groups
The Asset Groups API lets you add, update, view, and delete details about the asset groups in your Oracle IoT Asset Monitoring Cloud Service instance. All non-org aware REST API will be deprecated in future releases.
- Create asset group
- Method: postPath:
/assetMonitoring/clientapi/v2/groups
- Delete asset group by ID
- Method: deletePath:
/assetMonitoring/clientapi/v2/groups/{asset-group-id}
- List asset groups
- Method: getPath:
/assetMonitoring/clientapi/v2/groups
- Refresh list of assets by asset group
- Method: postPath:
/assetMonitoring/clientapi/v2/groups/{asset-group-id}/assets/refresh
- Retrieve asset group details by ID
- Method: getPath:
/assetMonitoring/clientapi/v2/groups/{asset-group-id}
- Retrieve assets of an asset group
- Method: getPath:
/assetMonitoring/clientapi/v2/groups/{asset-group-id}/assets
- Retrieve groups count
- Method: getPath:
/assetMonitoring/clientapi/v2/groups/count
- Retrieve user count for an asset group
- Method: getPath:
/assetMonitoring/clientapi/v2/groups/{asset-group-id}/users/count
- Retrieve users for an asset group
- Method: getPath:
/assetMonitoring/clientapi/v2/groups/{asset-group-id}/users
- Update asset group by ID
- Method: postPath:
/assetMonitoring/clientapi/v2/groups/{asset-group-id}
- Update assets of an asset group
- Method: postPath:
/assetMonitoring/clientapi/v2/groups/{asset-group-id}/assets
- Update users belonging to an asset group
- Method: postPath:
/assetMonitoring/clientapi/v2/groups/{asset-group-id}/users
Assets Managment
The Assets Management API lets you manage and maintain the assets in your Oracle IoT Asset Monitoring Cloud Service instance. Besides specific parameters for each method, all methods in this group, support a request header named 'X-Oracle-IoT-Org' and value of an organization ID, which allows targeting requests to different organizations.
- Create asset
- Method: postPath:
/assetMonitoring/clientapi/v2/assets
- Delete asset by name
- Method: deletePath:
/assetMonitoring/clientapi/v2/assets/{asset-id}
- Force delete asset by ID
- Method: deletePath:
/assetMonitoring/clientapi/v2/assets/{asset-id}/force
- Get value of asset dynamic property
- Method: getPath:
/assetMonitoring/clientapi/v2/assets/{asset-name}/properties/{property-name}
- Invoke what-if scenario
- Method: postPath:
/assetMonitoring/clientapi/v2/assets/{asset-id}/whatIfInvocations
- List all what-if invocation objects
- Method: getPath:
/assetMonitoring/clientapi/v2/assets/{asset-id}/whatIfInvocations
- Perform actions on assets
- Method: postPath:
/assetMonitoring/clientapi/v2/assets/checkedOut
- Replace asset by ID
- Method: putPath:
/assetMonitoring/clientapi/v2/assets/{asset-id}
- Retrieve a list of assets.
- Method: getPath:
/assetMonitoring/clientapi/v2/assets
- Retrieve asset details by name
- Method: getPath:
/assetMonitoring/clientapi/v2/assets/{asset-id}
- Retrieve asset metrics by name
- Method: getPath:
/assetMonitoring/clientapi/v2/assets/{asset-name}/metrics
- Retrieve asset statistics by name
- Method: getPath:
/assetMonitoring/clientapi/v2/assets/{asset-name}/history/statistics
- Retrieve asset what-if invocations count
- Method: getPath:
/assetMonitoring/clientapi/v2/assets/{asset-id}/whatIfInvocations/count
- Retrieve assets count
- Method: getPath:
/assetMonitoring/clientapi/v2/assets/count
- Retrieve list of available asset properties
- Method: getPath:
/assetMonitoring/clientapi/v2/assets/{asset-name}/properties
- Retrieve query-based asset groups by asset
- Method: getPath:
/assetMonitoring/clientapi/v2/assets/{asset-name}/queryGroups
- Retrieve static asset groups by asset
- Method: getPath:
/assetMonitoring/clientapi/v2/assets/{asset-name}/groups
- Retrieve what-if invocation object
- Method: getPath:
/assetMonitoring/clientapi/v2/assets/{asset-id}/whatIfInvocations/{invocation-id}
- Update asset by ID
- Method: postPath:
/assetMonitoring/clientapi/v2/assets/{asset-id}
- Update status of what-if invocation
- Method: postPath:
/assetMonitoring/clientapi/v2/assets/{asset-id}/whatIfInvocations/{invocation-id}
Places Management
The Places Management API lets you manage and maintain the places in your Oracle IoT Asset Monitoring Cloud Service instance. A place is a permitted location for the assets that you monitor in the application. All non-org aware REST API will be deprecated in future releases.
- Create or update floor plan
- Method: postPath:
/assetMonitoring/clientapi/v2/places/{place-name}/floorplan
- Create place
- Method: postPath:
/assetMonitoring/clientapi/v2/places
- Delete floor plan
- Method: deletePath:
/assetMonitoring/clientapi/v2/places/{place-name}/floorplan
- Delete place by name
- Method: deletePath:
/assetMonitoring/clientapi/v2/places/{place-name}
- Replace floor plan
- Method: putPath:
/assetMonitoring/clientapi/v2/places/{place-name}/floorplan
- Replace place by name
- Method: putPath:
/assetMonitoring/clientapi/v2/places/{place-name}
- Retrieve a list of assets by name
- Method: getPath:
/assetMonitoring/clientapi/v2/places/{place-name}/assets
- Retrieve a list of places
- Method: getPath:
/assetMonitoring/clientapi/v2/places
- Retrieve a list of places by name
- Method: getPath:
/assetMonitoring/clientapi/v2/places/{place-name}/places
- Retrieve floor plan
- Method: getPath:
/assetMonitoring/clientapi/v2/places/{place-name}/floorplan
- Retrieve place details
- Method: getPath:
/assetMonitoring/clientapi/v2/places/{place-name}
- Retrieve places count
- Method: getPath:
/assetMonitoring/clientapi/v2/places/count
- Update place details by place name
- Method: postPath:
/assetMonitoring/clientapi/v2/places/{place-name}
- Update places within a place
- Method: postPath:
/assetMonitoring/clientapi/v2/places/{place-name}/places