• 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 EnOS Management Console.

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

How to get organization ID (orgId)


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

How to get object type ID (mdmTypes)


Select Common Data Service in EnOS Application Portal and click Business Object Types in the left navigation bar. Object Type Identifier is mdmTypes.

How to get record type ID (recordTypes)


Select Common Data Service in EnOS Application Portal and click Business Object Elements > Record Types in the left navigation bar. Record Type ID is recordTypes.

How to get topology rule ID (topologyRuleId)


Use the Query 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 in EnOS Application Portal and click Business Object Elements > Virtual Points in the left navigation bar. Point is pointId.

  • Model Points:

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

    2. Click the device and the identifier in Measurement Points is 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 in EnOS Application Portal and click Business Object Elements > Virtual Attributes in the left navigation bar. Attribute is attributes.

  • Model Attributes:

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

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

How to get metric ID (metrics)


Select Common Data Service in EnOS Application Portal and click Business Object Elements > Biz Metrics in the left navigation bar. You can use Metric Key or Standard Key as metrics to query the metric data.

How to get dimension ID (dimensions)


Select Common Data Service in EnOS Application Portal and click Business Object Elements > Dimension Types in the left navigation bar. Dimension Identifier is dimensions.

Note

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

  • Go to Business Object Elements > Biz 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 Business Object Elements > Biz 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.