The chat responses are generated using Generative AI technology for intuitive search and may not be entirely accurate. They are not intended as professional advice. For full details, including our use rights, privacy practices and potential export control restrictions, please refer to our Generative AI Service Privacy Information. As this is a test version, please let us know if something irritating comes up. Like you get recommended a chocolate fudge ice cream instead of an energy managing application. If that occurs, please use the feedback button in our contact form!
Skip to content
Go to Marketplace
Insights Hub and Industrial IoT Share llms optimized content

Insights Hub drives smart manufacturing through the industrial Internet of Things. Gain actionable insights with asset and operational data and improve your processes.

Explore subscription options

Opcenter Intelligence Service - API Overview

Idea

Opcenter Intelligence allows you to access and analyze production-relevant contextualized data from multiple sources. The integration with Insights Hub enables data-driven decision-making based on MES and IoT data.

Opcenter Intelligence API Service can be used to access Opcenter Intelligence data to perform analysis and KPI calculation within the supported Insights Hub services.

Specifically, these APIs provide:

  • The list of KPIs defined in Opcenter Intelligence including their configuration data.
  • KPI calculation results of:
    • A single KPI, with an applied filter.
    • A single KPI, with an applied filter and a grouping criterion.
    • A single KPI, with an applied filter and a target matrix.
    • Multiple KPIs, with an applied filter.

Note

This is only applicable for region Europe 1.

Access

For accessing Opcenter Intelligence Service, you need to have the role indicated in Opcenter Intelligence Service API roles and scopes.

A user can only interact with objects within their tenant and subtenants.

Prerequisites

The following prerequisites are required and common to all APIs:

  • The Opcenter Intelligence app is enabled for the tenant.
  • The Opcenter Intelligence app is configured, the Opcenter Intelligence environment is deployed and data ingested.
  • In Opcenter Intelligence, a smart view is created, deployed, and configured with the necessary measures and attributes.
  • Multiple KPIs are created.

Features

Opcenter Intelligence APIs provide access to data stored in the Opcenter Intelligence Manufacturing Data Warehouse. For a detailed list of available entities, refer to the Opcenter Intelligence reference manual on the support center.

These APIs also support key operations, including:

  • Retrieving KPI configurations.
  • Calculating a single KPI with an applied filter.
  • Calculating a single KPI with an applied filter and a grouping criterion.
  • Calculating a single KPI with an applied filter and a target matrix.
  • Calculating multiple KPIs with an applied filter.

Info

  • For more details on APIs, refer to Opcenter Intelligence reference manual available on the support center.
  • For more details on how to create KPIs in Opcenter Intelligence, refer to Opcenter Intelligence user manual available on the support center.

Limitations

The following are the limitations of Opcenter Intelligence API:

  • When executing a query, note that the API supports data filtering and provides a mechanism for paginated access. By default, a query returns a maximum of 1000 records.
  • The API is accessible from UI and server to server.
  • Data can be accessed by custom applications and standard tools via REST/OData APIs that are compatible with IAM/Cognito authentication.
  • Query results are cached for 2 minutes.
  • Key and Value in the query string must be URL-encoded.

For more information, refer to the following:

Contact us
© Siemens
Corporate InformationPrivacy noticeCookie noticeTerms of useDigital IDTrust centerWhistleblowing