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 Terms of Use and 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
Insights Hub and Industrial IoT

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

Asset Management - Async API Specification¶

This is an API that uses Async API specification. You can download the Asset Management Async API specification.

Asset Management - Asset Model Notification Async API 3.0.0

Asset Model Notification Async API provides messaging operations for receiving notifications when an Asset Model is changed. The notification will be received on the following changes to Asset Model objects:

Aspect Type

  • Create Aspect Type
  • Update Aspect Type
    • Change description
    • Add variable on aspect type
    • Remove variable from aspect type
    • Rename variable on aspect type
    • Change unit on aspect variable
    • Change default value on static aspect variable
  • Delete Aspect Type

Asset Type

  • Create Asset Type
  • Update Asset Type
    • Change description, and image on Asset Type
    • Rename Asset Type
    • Add Asset Type direct variable
    • Rename Asset Type direct variable
    • Change unit on Asset Type direct variable
    • Change default value on Asset Type direct variable
    • Change length on Asset Type direct variable of type STRING
    • Delete Asset Type direct Variable
    • Create Aspect on Asset Type
    • Remove Aspect from Asset Type
    • Rename Aspect on Asset Type
  • Delete Asset Type

Asset

  • Create Asset
  • Update Asset
    • Change asset name, description, and location
    • Change or override the default value of direct asset type variable
    • Change or override the default value of static aspect variable
  • Delete Asset
  • Move Asset

Users will receive notifications about changes to Asset Model after subscribing to given topics. The notification message will contain information like the id of the asset model object, resource (type of asset model object), action (create, update or delete), tenant id, and timestamp. The tenant and topicId will be provided as part of the header for the message. The sample message payload can be found in the examples section below.

For more details, please see the 'Asset Management - Asset Model Notification Async API' section on the MindSphere Developer Documentation page.

Operations

  • SEND mdsp.core.assetmanagement.v1.pubsub.aspecttype.ext.notification

    The topic ID on which Asset Model notification for changes to Aspect Type will be received.

    Subscribe to this topic to receive an Asset Model notification message for Aspect Type create, update or delete action.

    Operation IDsubscribe

    Accepts the following message:

    Aspect Type notification

    Notify about create, update or delete action on Aspect Type.

    Message IDaspectTypeNotificationData
    object

    Examples

  • SEND mdsp.core.assetmanagement.v1.pubsub.assettype.ext.notification

    The topic ID on which Asset Model notification for changes to Asset Type will be received.

    Subscribe to this topic to receive an Asset Model notification message for Asset Type create, update or delete action.

    Operation IDsubscribe

    Accepts the following message:

    Asset Type notification

    Notify about create, update or delete action on Asset Type.

    Message IDassetTypeNotificationData
    object

    Examples

  • SEND mdsp.core.assetmanagement.v1.pubsub.asset.ext.notification

    The topic ID on which Asset Model notification for changes to Asset will be received.

    Subscribe to this topic to receive Asset Model notification message for Asset create, update, delete or move action.

    Operation IDsubscribe

    Accepts the following message:

    Asset notification

    Notify about create, update, delete or move action on Asset.

    Message IDassetNotificationData
    object

    Examples

Messages

  • #1Aspect Type notification

    Notify about create, update or delete action on Aspect Type.

    Message IDaspectTypeNotificationData
    object
  • #2Asset Type notification

    Notify about create, update or delete action on Asset Type.

    Message IDassetTypeNotificationData
    object
  • #3Asset notification

    Notify about create, update, delete or move action on Asset.

    Message IDassetNotificationData
    object

Schemas

  • object
  • object
  • object

Download Async API Specification