All REST Endpoints

Sort by

Task Path Method

Group by API

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: post

Path: /assetMonitoring/clientapi/v2/incidents/{incident-id}/comments

Bulk update of the external activities

Method: post

Path: /assetMonitoring/clientapi/v2/incidents/externalActivities

Delete incident by its ID

Method: delete

Path: /assetMonitoring/clientapi/v2/incidents/{incident-id}

Get Incidents Count

Method: get

Path: /assetMonitoring/clientapi/v2/incidents/count

List incident occurrences

Method: get

Path: /assetMonitoring/clientapi/v2/incidents/{incident-id}/occurrences

List incidents

Method: get

Path: /assetMonitoring/clientapi/v2/incidents

Retrieve incident details

Method: get

Path: /assetMonitoring/clientapi/v2/incidents/{incident-id}

Retrieve incident details by incident type

Method: get

Path: /assetMonitoring/clientapi/v2/incidents/incidentDetails

Retrieve incident occurrence count

Method: get

Path: /assetMonitoring/clientapi/v2/incidents/{incident-id}/occurrences/count

Update incident by ID

Method: post

Path: /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: post

Path: /assetMonitoring/clientapi/v2/rules

Delete rule by ID

Method: delete

Path: /assetMonitoring/clientapi/v2/rules/{rule-id}

Get Rules Count

Method: get

Path: /assetMonitoring/clientapi/v2/rules/count

List rules

Method: get

Path: /assetMonitoring/clientapi/v2/rules

Retrieve rule by ID

Method: get

Path: /assetMonitoring/clientapi/v2/rules/{rule-id}

Update rule by ID

Method: post

Path: /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: 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}

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: delete

Path: /assetMonitoring/clientapi/v2/warnings/{warning-id}

Get Warnings Count

Method: get

Path: /assetMonitoring/clientapi/v2/warnings/count

Get warnings details

Method: get

Path: /assetMonitoring/clientapi/v2/warnings/{warning-id}

List warnings

Method: get

Path: /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: post

Path: /assetMonitoring/clientapi/v2/groups

Delete asset group by ID

Method: delete

Path: /assetMonitoring/clientapi/v2/groups/{asset-group-id}

List asset groups

Method: get

Path: /assetMonitoring/clientapi/v2/groups

Refresh list of assets by asset group

Method: post

Path: /assetMonitoring/clientapi/v2/groups/{asset-group-id}/assets/refresh

Retrieve asset group details by ID

Method: get

Path: /assetMonitoring/clientapi/v2/groups/{asset-group-id}

Retrieve assets of an asset group

Method: get

Path: /assetMonitoring/clientapi/v2/groups/{asset-group-id}/assets

Retrieve groups count

Method: get

Path: /assetMonitoring/clientapi/v2/groups/count

Retrieve user count for an asset group

Method: get

Path: /assetMonitoring/clientapi/v2/groups/{asset-group-id}/users/count

Retrieve users for an asset group

Method: get

Path: /assetMonitoring/clientapi/v2/groups/{asset-group-id}/users

Update asset group by ID

Method: post

Path: /assetMonitoring/clientapi/v2/groups/{asset-group-id}

Update assets of an asset group

Method: post

Path: /assetMonitoring/clientapi/v2/groups/{asset-group-id}/assets

Update users belonging to an asset group

Method: post

Path: /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: post

Path: /assetMonitoring/clientapi/v2/assets

Delete asset by name

Method: delete

Path: /assetMonitoring/clientapi/v2/assets/{asset-id}

Force delete asset by ID

Method: delete

Path: /assetMonitoring/clientapi/v2/assets/{asset-id}/force

Get value of asset dynamic property

Method: get

Path: /assetMonitoring/clientapi/v2/assets/{asset-name}/properties/{property-name}

Invoke what-if scenario

Method: post

Path: /assetMonitoring/clientapi/v2/assets/{asset-id}/whatIfInvocations

List all what-if invocation objects

Method: get

Path: /assetMonitoring/clientapi/v2/assets/{asset-id}/whatIfInvocations

Perform actions on assets

Method: post

Path: /assetMonitoring/clientapi/v2/assets/checkedOut

Replace asset by ID

Method: put

Path: /assetMonitoring/clientapi/v2/assets/{asset-id}

Retrieve a list of assets.

Method: get

Path: /assetMonitoring/clientapi/v2/assets

Retrieve asset details by name

Method: get

Path: /assetMonitoring/clientapi/v2/assets/{asset-id}

Retrieve asset metrics by name

Method: get

Path: /assetMonitoring/clientapi/v2/assets/{asset-name}/metrics

Retrieve asset statistics by name

Method: get

Path: /assetMonitoring/clientapi/v2/assets/{asset-name}/history/statistics

Retrieve asset what-if invocations count

Method: get

Path: /assetMonitoring/clientapi/v2/assets/{asset-id}/whatIfInvocations/count

Retrieve assets count

Method: get

Path: /assetMonitoring/clientapi/v2/assets/count

Retrieve list of available asset properties

Method: get

Path: /assetMonitoring/clientapi/v2/assets/{asset-name}/properties

Retrieve query-based asset groups by asset

Method: get

Path: /assetMonitoring/clientapi/v2/assets/{asset-name}/queryGroups

Retrieve static asset groups by asset

Method: get

Path: /assetMonitoring/clientapi/v2/assets/{asset-name}/groups

Retrieve what-if invocation object

Method: get

Path: /assetMonitoring/clientapi/v2/assets/{asset-id}/whatIfInvocations/{invocation-id}

Update asset by ID

Method: post

Path: /assetMonitoring/clientapi/v2/assets/{asset-id}

Update status of what-if invocation

Method: post

Path: /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: post

Path: /assetMonitoring/clientapi/v2/places/{place-name}/floorplan

Create place

Method: post

Path: /assetMonitoring/clientapi/v2/places

Delete floor plan

Method: delete

Path: /assetMonitoring/clientapi/v2/places/{place-name}/floorplan

Delete place by name

Method: delete

Path: /assetMonitoring/clientapi/v2/places/{place-name}

Replace floor plan

Method: put

Path: /assetMonitoring/clientapi/v2/places/{place-name}/floorplan

Replace place by name

Method: put

Path: /assetMonitoring/clientapi/v2/places/{place-name}

Retrieve a list of assets by name

Method: get

Path: /assetMonitoring/clientapi/v2/places/{place-name}/assets

Retrieve a list of places

Method: get

Path: /assetMonitoring/clientapi/v2/places

Retrieve a list of places by name

Method: get

Path: /assetMonitoring/clientapi/v2/places/{place-name}/places

Retrieve floor plan

Method: get

Path: /assetMonitoring/clientapi/v2/places/{place-name}/floorplan

Retrieve place details

Method: get

Path: /assetMonitoring/clientapi/v2/places/{place-name}

Retrieve places count

Method: get

Path: /assetMonitoring/clientapi/v2/places/count

Update place details by place name

Method: post

Path: /assetMonitoring/clientapi/v2/places/{place-name}

Update places within a place

Method: post

Path: /assetMonitoring/clientapi/v2/places/{place-name}/places