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

Traceability Service - API Overview

Idea

The purpose of the Traceability application is to navigate MES production data to help customers understand the complex relationships between incoming and outgoing materials, operations performed on materials, and the equipment, operators and tools involved in the material processing. This application also explores the genealogy of each material and traces its origin even when the manufacturing process has been executed in different plants.

Note

This is only applicable for region Europe 1.

Access

To access the Traceability service, you need to have the role indicated in Traceability Service API roles and scopes.

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

Features

Traceability APIs support the application’s containment and release functionalities. They enable integration with external systems by providing access to headers and items that are either contained or released. Additionally, two dedicated APIs handle the acknowledgment action, which confirms the reading of containment or release requests.

In the “Settings” section of the application, you can set the maximum number of items within a containment request that can be downloaded via the APIs in a single round trip. This value represents the maximum number of items contained in the JSON file when programmatically accessing the APIs used to download an active containment request. Considering typical cloud architecture limitations (connections active for a limited time, typically 30 seconds) and the size of the returned package (usually less than 10 MB), you can define a custom value for the number of elements in a single request. Traceability APIs support pagination when the dataset exceeds the defined limit, allowing sequential calls until the entire dataset is retrieved.

Limitations

The following are the limitations of Traceability APIs:

  • 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 10,000 records. You can adjust the limits. Refer to Opcenter Intelligence configuration for the maximum limit, and to the Traceability "Settings" section for the minimum limit.
  • The APIs are accessible from UI and server to server.
  • Data can be accessed by custom applications and standard tools via REST/OData API 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 Traceability app documentation.

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