Table of Contents

• About the REST APIs
• All REST Endpoints

Get Started

• Quick Start
• Send Requests
• Conventions
• Authentication
• Status Codes
• Error Messages
• Collections
• Use cURL
• Using mongoDB Query Syntax

Tasks

• Asset Incidents
  • Add comments to an incident
  • Bulk update of the external activities
  • Delete incident by its ID
  • Get Incidents Count
  • List incident occurrences
  • List incidents
  • Retrieve incident details
  • Retrieve incident details by incident type
  • Retrieve incident occurrence count
  • Update incident by ID
• Asset Rules
  • Create rule
  • Delete rule by ID
  • Get Rules Count
  • List rules
  • Retrieve rule by ID
  • Update rule by ID
• Asset Types
  • Create asset type
  • Create asset type what-if scenario
  • Create new asset type property
  • Delete asset by asset type
  • Delete asset type what-if event by name
  • Delete definition of asset type property
  • Download asset type what-if scenario image
  • Ensure that provided update for asset type is safe
  • Get definition of asset type property
  • List asset type what-if events
  • List asset types
  • Replace asset type by name
  • Replace asset type what-if event
  • Retrieve asset type details by name
  • Retrieve asset type what-if event details by name
  • Retrieve asset type what-if events count
  • Retrieve asset types count
  • Retrieve list of available asset type properties
  • Retrieve list of entities depending on current asset
  • Update asset type by name
  • Update asset type what-if scenario
  • Update definition of asset type property
• Asset Warnings
  • Delete warning by id
  • Get Warnings Count
  • Get warnings details
  • List warnings
• Assets Groups
  • Create asset group
  • Delete asset group by ID
  • List asset groups
  • Refresh list of assets by asset group
  • Retrieve asset group details by ID
  • Retrieve assets of an asset group
  • Retrieve groups count
  • Retrieve user count for an asset group
  • Retrieve users for an asset group
  • Update asset group by ID
  • Update assets of an asset group
  • Update users belonging to an asset group
• Assets Managment
  • Create asset
  • Delete asset by name
  • Force delete asset by ID
  • Get value of asset dynamic property
  • Invoke what-if scenario
  • List all what-if invocation objects
  • Perform actions on assets
  • Replace asset by ID
  • Retrieve a list of assets.
  • Retrieve asset details by name
  • Retrieve asset metrics by name
  • Retrieve asset statistics by name
  • Retrieve asset what-if invocations count
  • Retrieve assets count
  • Retrieve list of available asset properties
  • Retrieve query-based asset groups by asset
  • Retrieve static asset groups by asset
  • Retrieve what-if invocation object
  • Update asset by ID
  • Update status of what-if invocation
• Places Management
  • Create or update floor plan
  • Create place
  • Delete floor plan
  • Delete place by name
  • Replace floor plan
  • Replace place by name
  • Retrieve a list of assets by name
  • Retrieve a list of places
  • Retrieve a list of places by name
  • Retrieve floor plan
  • Retrieve place details
  • Retrieve places count
  • Update place details by place name
  • Update places within a place