• Documentation
  • EnOS Common Data Service API FAQs

EnOS Common Data Service API FAQs

How to get access key (accessKey)


accessKey is the service account that EnOS assigns to the application for authentication purpose. To get the information, perform the following steps:

  1. Click Application Registration in the left navigation bar of the EnOS Management Console.

  2. Select the application that needs to invoke the API and you can get the Access Key in the basic information.

How to get organization ID (orgId)


In the left navigation bar of the EnOS Management Console, click IAM > Organization Profile. The Organization ID is the orgId.

How to get object type ID (mdmTypes)


Select Common Data Service from EnOS Application Portal and click Meta Data > MdmTypes in the left navigation bar. The Object Type Identifier is the mdmTypes.

How to get record type ID (recordTypes)


Select Common Data Service from EnOS Application Portal and click Meta Data > Record Types in the left navigation bar. The Record Type ID is the recordTypes.

How to get topology rule ID (topologyRuleId)


Use the Asset Topology Rule API provided by Common Data Service to get topologyRuleId. For the detailed steps to query a topology rule, see Query Asset Topology Rule.

How to get measurement point ID (pointId)


Common Data Service API can be used to query all measurement points of the models in the registered device types, as well as the self-defined virtual measurement points.

  • Virtual Points: Select Common Data Service from EnOS Application Portal and click Meta Data > Virtual Points in the left navigation bar. The Point is the pointId.

  • Model Points:

    1. In the left navigation bar of the EnOS Management Console, click Asset Tree, select the target asset tree, and search for the device name you want to query.

    2. Click on the device and the identifier in the Measurement Points is the pointId.

How to get attribute ID (attributes)


Common Data Service API can be used to query all attributes of the models in the registered device types, as well as the self-defined virtual attributes.

  • Virtual Attributes: Select Common Data Service from EnOS Application Portal and click Meta Data > Virtual Attributes in the left navigation bar. The Attribute is the attributes.

  • Model Attributes:

    1. In the left navigation bar of the EnOS Management Console, click Asset Tree, select the target asset tree, and search for the device name you want to query.

    2. Click on the device and select Attributes tab from the right panel. The Identifier of the corresponding Attribute Name is the attributes.

How to get metric ID (metrics)


Select Common Data Service from EnOS Application Portal and click Meta Data > Unified Metrics in the left navigation bar. The Metric Key is the metrics.

How to get dimension ID (dimensions)


Select Common Data Service from EnOS Application Portal and click Meta Data > Dimension Types in the left navigation bar. The Dimension Identifier is the dimensions.

Note

Use one of the following methods to check if a metric can be aggregated by a specific dimension：

  • Go to Meta Data > Unified Metrics and locate the target metric in the list. Check if the target dimension’s ID exists in the Aggregation Dimension column. If not, the metric cannot be aggregated by this dimension.

  • Go to Meta Data > Unified Metrics and select the target dimension in the drop-down filter list of the Aggregation Dimension Name column. Check if the target metric exists in the filtered metric list. If not, the metric cannot be aggregated by this dimension.