2019/11/08

New APIs

Application Portal Service

Added the Application Portal service APIs:

API

Description

Authorize Asset

Authorize the new asset created on EnOS platform to the asset creator

Check Asset Permission

Check if the current user has the access permission of the requested asset

Choose Organization

Select the organization that the user needs to use after login

Create Message

Create common messages and alert message on the Application Portal

Get App Menu and Permission

Get the list of application menu and permission

Get Assets by Application

Get all assets that the current user can access under a specified application

Get Assets by Organization

Get all the assets that a specified user can access under a specified organization

Get Asset Structure

Get the upstream organizational structure of the organizational structure in which the asset is located

Get Colors of the Message Icon

Get the collection of colors that the message icon can be configured

Get Manageable User List

Get a list of all users that can be managed under the current account

Get Message Ringtones

Get the collection of ringtones that the message can be configured

Get Organization List

List the organizations which the current user belongs according to the Access Token

Get Organization User List

Authorize the application to get a list of all users under a specified organization without logging in the Application Portal

Get Token Information

Get information about the currently logged-in user according to the Access Token

Get User Information

Get the information of the current user

Log In

Log in the account

Log Out

Log out the account

Refresh Access Token

Request a new Access Token with the Refresh Token

Revoke Refresh Token

Revoke user’s Refresh Token

Sync Asset

Synchronize assets with specified tags on the EnOS to the Application Portal

Update Message

Update the status of the message

Model Service

API

Description

Search Thing Model

A new parameter dataDefinition is supported in ThingAttribute struct, ThingMeasurepoint struct, and ThingDatapoint struct to define the data type represented by the datatype parameter in the structure.

Alert Service

API

Description

Create Alert Type

A new parameter parentTypeId is supported in generateType struct to indicate the alert type ID of the parent alert.

Update Alert Type

A new parameter parentTypeId is supported in generateType struct to indicate the alert type ID of the parent alert.

Changed APIs

Connection Service

API

Description

Search Device

A new field deviceTags is supported in expression.

Search Product

A new field deviceTags is supported in expression.

Model Service

API

Description

Search Thing Model

The field tags in the expression supports arithmetic operators “exists” and “not exists”.

Alert Service

API

Description

Aggregate Active Alerts

The field tag in the expression supports arithmetic operators “exists” and “not exists”.

Search Active Alert

The field tag in the expression supports arithmetic operators “exists” and “not exists”.

Search History Alert

The field tag in the expression supports arithmetic operators “exists” and “not exists”.

TSDB Data Service

API

Description

Get Asset DI Data

Interpolation is supported in getting the asset status (DI) data.

Deprecations and Removals

Alert Service

API

Description

Create Alert Content

The parameter source is removed from request body.

Create Alert Rule

The parameter source is removed from request body.

Create Alert Severity

The parameter source is removed from request body.

Create Alert Type

The parameter source is removed from request body.

Delete Alert Content

The parameter source is removed from request URI.

Delete Alert Rule

The parameter source is removed from request URI.

Delete Alert Severity

The parameter source is removed from request URI.

Delete Alert Type

The parameter source is removed from request URI.

Search Alert Content

The parameter source is removed from the AlertContent struct.

Search Alert Rule

The parameter source is removed from the AlertRule struct.

Search Alert Severity

The parameter source is removed from the AlertSeverity struct.

Search Alert Type

The parameter source is removed from the AlertType struct.

Update Alert Content

The parameter source is removed from the generateContent struct.

Update Alert Rule

The parameter source is removed from the alertRule struct.

Update Alert Severity

The parameter source is removed from the generateSeverity struct.

Update Alert Type

The parameter source is removed from the generateType struct.