Migrate to v5
Breaking changes ahead for: Digital Twin Registry API, Aspect Model Catalog API.
The APIs will be updated to Bosch Semantic Stack v5 on November 04, 2025. The update will be carried out from 16:30 to approximately 18:30 CET / UTC+1. |
What will change
New URL for Digital Twin Registry and Aspect Model Catalog
New URL for both Digital Twin Registry and Aspect Model Catalog:
https://workspace.bosch-semantic-stack.com/overview?tenant=<your-tenant-id>
|
In the URL, replace <your-tenant-id>
by your tenant ID.
Before the update
Get ready for the new URL
With the arrival of v5, both Digital Twin Registry and Aspect Model Catalog will be reached via the same, new URL:
https://workspace.bosch-semantic-stack.com/overview?tenant=<your-tenant-id>
Consider to:
-
Update your bookmarks or saved links to reflect the new URLs
-
Inform your team: To ensure a smooth transition, share this information with your team members who may be using these applications.
Comparing old and new URLs
The table below lists the old and new URLs for comparison.
Web application | Old URL (v4) | New URL (v5) |
---|---|---|
Digital Twin Registry |
|
|
Aspect Model Catalog |
|
|
After the update
Old URLs are deactivated. Consequently, the old target client IDs for access to the REST APIs are invalid. |
Update your API requests with the new target client ID
The target client ID is set as a part of API requests. This is how you already access the REST APIs with authentication at the Access Management portal (aka MACMA). For more details, refer to: Authentication
With v5, the target client ID changes.
The new target client ID to define the scope for the required token (JWT) is:
i2zkcq1li0ps1pjh62gjj1892
|
For comparison, the old target client IDs were:
-
Digital Twin Registry:
bqfin42m7vho1k7r2srjrge28
-
Aspect Model Catalog:
q8f6z22otkd7137qlsykwckuc
The full new scope value—including the new target client ID—is:
aud:i2zkcq1li0ps1pjh62gjj1892 openid
|
Ensure that the new target client ID is used for your API requests:
-
Review current implementations
Identify all applications and services that utilize the current target client ID in their JWTs. -
Update your code
Modify your code to accommodate the new target client ID. Ensure that any references to the old target ClientID are updated accordingly. -
Documentation
Update any internal documentation to reflect the change in the target client ID and the date of the update. -
Monitor for issues
After the change is implemented, monitor your applications for any unexpected behavior or issues.
Support
If you have any questions or require assistance during this transition, please do not hesitate to reach out:
support.semantic-stack@bosch.com
We are here to help you ensure a smooth update process. Thank you for your attention to this important matter.
API docs URLs remain the same
Note that the URLs for API references won’t change.
For your convenience, here is a list of the available API references for Digital Twin Registry and Aspect Model Catalog:
-
Digital Twin Registry API
https://registry.bosch-semantic-stack.com/docs/rest/api-doc-registry.html -
Digital Twin Registry Bulk API
https://registry.bosch-semantic-stack.com/docs/rest/api-doc-registry-bulk.html -
Digital Twin Registry Statistic API
https://registry.bosch-semantic-stack.com/docs/rest/api-doc-registry-statistics.html -
Asset Administration Shell Registry API
https://registry.bosch-semantic-stack.com/docs/rest/api-doc-aas-registry.html -
Asset Administration Shell Discovery API
https://registry.bosch-semantic-stack.com/docs/rest/api-doc-aas-discovery.html -
Digital Twin Registry Async API
https://registry.bosch-semantic-stack.com/docs/async/api-doc-async.html -
Digital Twin Registry Async Credentials API
https://registry.bosch-semantic-stack.com/docs/async/api-doc-async-credentials.html -
Aspect Model Catalog API
https://catalog.bosch-semantic-stack.com/static/api-doc-catalog.html