About the API gallery

With the help of our restful APIs and services along our Siemens Healthineers offerings, you can quickly get your application up and running. Calling our APIs essentially means calling an operation in a published API version.

In the API gallery, you find the list of APIs that are associated to all available API products. The API gallery allows you browsing and filtering for individual API version. The API gallery contains all versions of an API that are currently active.

A higher version of an API indicates a major breaking change to a previous version as you have to pass the version number in every API call. Therefore, new API versions are in general provided in case of major architectural changes.
For existing API versions, further updates can be frequently provided in form of a new API revision. New revisions are provided in cases such as resolving bugs, extending an existing operation, adding a new operation, or declaring an existing operation as "deprecated".
The changelogs page of a selected API lists log entries that have been explicitly added by the API provider. The log entries might not be always added for each new revision.
For API versions or API operations that are not supported anymore or that have been substituted by another API operation, the term "deprecated" indicates that an API or a dedicated operation is obsolete and should not be used anymore. In such cases, there might be further information about the end of service.
Deprecated APIs can be permanently removed from this portal after a retention period of approx. 12 months. The retention time can be reduced to a minimum in case of dependencies to other services from our technical partners and suppliers or due to short-term changes in regional laws and regulations.

Clicking on an API name from the API gallery opens the associated API detail page. On the API detail page, you can find a list of all associated operations and their details.