API Documentation

These API commands can be run against workspaces and assets.

NOTE: The logged in user must have their certificate generated from their profile to run API commands.

Hover the mouse next to the lock to copy the command to the clipboard. The PUT, POST, and DELETE commands return standard HTTP codes such as 200, 201, 207, 400, 401, and 404.

Here is a command example.

GET /assets/{workspace}/{asset_reference}

API Command List

Command	Parameters	Description
GET	/assets/{workspace} /{asset_reference}	Get an asset from the database.
DELETE	/assets/{workspace} /{asset_reference}	Delete an asset from the database.
PUT	/assets/{workspace} /{asset_reference}	Modify an asset in the database. Only fields that are present in the request will be updated. The rest of the fields remain unchanged. To delete a field, send a null value. Object fields like asset_custom_properties, aggregations, or geometry, will be replaced by the given value. To modify a part of those object attributes, read the asset first, get the original object value, modify what you need to modify, and send the modified object in the PUT command.
GET	/assets/{workspace}	List references of all assets contained in the given workspace in a paginated response.
POST	/assets/{workspace}	Create a new asset, or a batch of new assets in the database. It is recommended to limit batch calls to 100 assets at a time.
DELETE	/assets/{workspace}	Delete a batch of assets.
PUT	/assets/{workspace}	Update a batch of assets. Only fields that are present in the request will be updated. The other ones remain unchanged. To delete a field, send null value. Object fields like asset_custom_properties, aggregations, or geometry, will be replaced by the given value. To modify a part of those object attributes, read the asset first, get the original object value, modify what you need to modify, and send the modified object in the PUT command.
POST	/filtered_assets/{workspace}	List asset references that match the given filters.
GET	/assets/{workspace}/upload	Create a S3 URL pre-signed PUT object and the ID generated for the file.
POST	/assets/{workspace}/upload	Read a specific format file with asset data and upload it to a database.
DELETE	/assets/{workspace}/upload	Read a specific format file with assets data and delete them to a database.
PUT	/assets/{workspace}/upload	Read a specific format file with assets data and update them to a database.
GET	/assets/{workspace}/upload/{file_id}	Get information about a specific upload job by specifying a filename ID.
GET	/assettimeseries/{workspace}/{asset_reference}/{timeseries_name}	Get information on a given time series.
POST	/assettimeseries/{workspace}/{asset_reference}/{timeseries_name}	Upload a series of time series records that are created if they do not exist.
DELETE	/assettimeseries/{workspace}/{asset_reference}/{timeseries_name}	Delete time series records between two timeframes.
GET	/assettype/{workspace}/{asset_type_name}	Get an asset type.
DELETE	/assettype/{workspace}/{asset_type_name}	Delete an asset type.
PUT	/assettype/{workspace}/{asset_type_name}	Modify an asset type.
GET	/assettype/{workspace}	List the names of all asset types in a given workspace.
POST	/assettype/{workspace}	Create a new asset type, or a batch of new asset types.
DELETE	/assettype/{workspace}	Delete a batch of asset types.
GET	/scenario/{workspace}	List the scenarios for a given workspace.
GET	/scenario/{workspace}/{scenario_id}	Get program information for a specific scenario.
GET	/scenario/{workspace}/treated_assets/{program_id}	Get treated assets from a given program.
GET	/maintenance_recommendation/{workspace}	List maintenance recommendations for the given workspace.