Asset Management - Async API Specification¶
This is an API that uses Async API specification. You can download the Asset Management Async API specification.
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 IDsubscribeAccepts the following message:
Aspect Type notificationNotify about create, update or delete action on Aspect Type.
Message IDaspectTypeNotificationDataobjectExamples
{ "header": { "topic": "mdsp.core.assetmanagement.v1.pubsub.aspecttype.ext.notification", "tenantContext": [ "siemens" ] }, "aspectType": { "id": "siemens.aspectType", "resource": "ASPECT_TYPE", "action": "CREATE", "tenant": "siemens", "timestamp": "2022-02-08T06:24:35.629Z" } }
This example has been generated automatically.
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 IDsubscribeAccepts the following message:
Asset Type notificationNotify about create, update or delete action on Asset Type.
Message IDassetTypeNotificationDataobjectExamples
{ "header": { "topic": "mdsp.core.assetmanagement.v1.pubsub.assettype.ext.notification", "tenantContext": [ "siemens" ] }, "assetType": { "id": "siemens.assetType", "resource": "ASSET_TYPE", "action": "CREATE", "tenant": "siemens", "timestamp": "2022-02-08T06:24:35.629Z" } }
This example has been generated automatically.
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 IDsubscribeAccepts the following message:
Asset notificationNotify about create, update, delete or move action on Asset.
Message IDassetNotificationDataobjectExamples
{ "header": { "topic": "mdsp.core.assetmanagement.v1.pubsub.asset.ext.notification", "tenantContext": [ "siemens" ] }, "asset": { "id": "4ed7e69d1f6747dcb96dafec7a844488", "resource": "ASSET", "action": "CREATE", "tenant": "siemens", "timestamp": "2022-02-08T06:24:35.629Z" } }
This example has been generated automatically.
Messages
- #1Aspect Type notification
Notify about create, update or delete action on Aspect Type.
Message IDaspectTypeNotificationDataobject - #2Asset Type notification
Notify about create, update or delete action on Asset Type.
Message IDassetTypeNotificationDataobject - #3Asset notification
Notify about create, update, delete or move action on Asset.
Message IDassetNotificationDataobject
Schemas
- object
- object
- object