Picture Picture Dev

Docs & guidelines > 

What´s new

Through these portal news, we like to inform you about changes regarding APIs and about additional changes of these portal pages. The API content updates and API deployment activities are communicated via MS Teams channels. Changes of this portal pages are communicated via these What´s new pages in the following.

See also

Established MS Teams channels (article)

News on updates of the portal pages

The following release notes provides a chronicle overview about additional content and functional updates in this portal.

Further news and topics are communicated through our established MS Teams channels.

See also

teamplay Fleet Connect APIs

Release 2024-08-12

  • Docs & Guidelines - Services - teamplay Fleet Connect APIs

    • Added the new "Cybersecurity API" feature to the overview of Fleet Connect features

    • Added the flow for "Cybersecurity Vulnerability Management" as a new sample scenario

  • CUT US - end of service
    Removed all mentions of the deleted CUT US environment

See also

About the API details
Parent API products
Managing your subscriptions
teamplay Services on Edge

Release 2023-05-26

  • Docs & Guidelines - Getting Started - About the Developer Portal - About the API details
    Enhanced descriptions of the API details page.

  • Docs & Guidelines - Getting Started - About the Developer Portal - About the API details - Parent API products
    Added an article on how to discover parent API products from the API details page.

  • Docs & Guidelines - Getting Started - Getting started as a developer - Managing your subscriptions
    Added references to learn more on how to identify parent API products for an API version displayed on the API details page and on how to view all my submitted subscription requests with their status in a single list.

  • Docs & guidelines - Services on Edge - teamplay Services on Edge
    Updated references to the internal teamplay partner partner knowledge base (tp-kb-i).

See also

Sign-in (page)
Sign-up (page)
About the portal environments (revised article)
About the API details (revised articles)
teamplay Images on Edge (removed article)
teamplay Services on Edge (added article)

Release 2023-04-21

  • Sign-in & Sign up page

    • Style and layout improvements.

  • Environments page

    • Updated links on environment page to reflect the current teamplay environments.

  • Docs & guidelines - Getting Started - About the Developer Portal - About the API details page

    • Extended article with screenshots to illustrate existing descriptions.

  • Docs & guidelines - Services - teamplay Images - teamplay Images on Edge page

    • Removed article. For teamplay Edge, refer to the new dedicated article for teamplay Services on Edge.

  • Docs & guidelines - Services on Edge - teamplay Services on Edge

    • Added new article about services on edge. Currently, teamplay Edge is available for Healthineers-internal employees only.

See also

Sign-in page
Sign-up page
Domain name change news
API product page
API product details page
API gallery page

Release 2023-03-17

  • Sign-in and Sign-up pages

    • Redesigned sign-in and sign-up page and updated partner information including references and contact data.

  • Docs & guidelines - What´s new - Domain name change news

    • Updated article regarding end of grace period for China and RoW. Removed information on legacy URLs for this Developer Portal as the URL has been already changed using the new domain names.

  • API products page - search form

    • Fixed issue with search input form. The search text you type is no longer overlaid by the search icon.

  • API product details page - subscription note

    • Fixt issue with weird behavior of the subscription hints card. When hovering over, the card is not jumping anymore.

    • For new subscriptions, the new naming convention must be applied. The new naming convention also requires the application ID (appID).

    • Added two notes below the naming convention statement:

      • Extension 1: "For requesting an application ID (appID), use the teamplay Partner Information Form."

      • Extension 2: "For subscriptions in status Submitted, request activation via teamplay Partner Tech Support."

  • API gallery page - search form

    • Fixed issue with search input form. The search text you type is no longer overlaid by the search icon.

See also

Links to the portal environments (article)

Release 2022-11-29

  • Developer Portal links

    • Added and updated some links on the "About the portal environments" page.

See also

Links to the portal environments (article)

Release 2022-10-20

  • Developer Portal links

    • Added and updated links on the "About the portal environments" page regarding Dev environments.

See also

Links to the portal environments (article)

Release 2022-09-09

  • Developer Portal links

    • Added and updated links on the "About the portal environments" page regarding Dev environments.

See also

Domain name change news (article - NEW!)
Links to the portal environments (article)

Release 2022-07-12

  • Domain name change news

    • Added the article "Domain name change news" to this What's new section for news on the upcoming domain name change in teamplay-related URLs.
      There is an upcoming breaking change for all API consumers! For details, refer to the article Domain name change news.

  • Developer Portal links

    • Added and updated some links on the "About the portal environments" page.

See also

Links to the supported portal environments (article)

Release 2022-04-22

  • Supported Environments 

    • Removed the link to the production environment for Brazil as this environment isn´t supported anymore.

  • Domain name change news:

    • Initially informed on a high level on the upcoming domain name change through this What´s new page. The content has been moved in the meantime to a dedicated article "Domain name change news" in this What´s new section.

Release 2022-04-20

  • Docs & guidelines/general improvements

    • Fixed few content issues.

See also

Links to the supported portal environments (article)
teamplay Fleet Connect APIs (article)
Sign-in (log-in page)
Sign-up (partner management contact)
API gallery (list of APIs)

  • Docs & guidelines/Services/teamplay/Fleet Connect

    • Updated several graphics and added three example scenario sections to the end of the article.

  • General changes

    • Several font and style-related issues have been resolved.

    • Continued fixing responsiveness issues for smaller screen resolutions.

    • Corrected a broken link for the China East environment in the article "Links to the supported teamplay environments".

    • Optimized the loading performance and incorporated several minor improvements on the home page.

    • Added the portal environment name to the name of the browser tab card for keeping the overview in case of viewing several browser tab cards with different portal environments in one browser.

  • Sign-in page

    • Pinned the footer of the Sign-in page to the bottom of the browser window.

    • Updated references for requesting access and for getting support as a business partner.

  • Sign-up page/FAQs

    • Rearranged and added contents on support references.

  • API gallery

    • Added a column to the list of APIs showing the type of the listed API.

  • API details page

    • Added an additional selection box on the upper right to facilitate navigating to a parent API product from the top without the need of scrolling to the end of the page. Thus, removed the obsolete outdated content from the end of the page.

Release 2021-08-20

About the Developer Portal (article)
About the portal environments (new article)
About the Developer Portal (updated article)
Managing your subscriptions (updated article)
Managing your application tokens (updated article)

  • Docs & guidelines / Getting started

    • About the Developer Portal
      Restructured the section and added a slide deck that gives you a first taste of how to access the main areas of the Developer Portal.

      • About the portal environments
        Created a dedicated article about the portal environments and added the new sub chapter "Environment-specific API endpoints". Added a slide deck to explain how to access the main areas of this portal.

    • Getting started as a developer

      • Managing your subscriptions
        Updated the article. Added a slide deck to demonstrate how to subscribe to API products in this portal.

      • Managing your application tokens
        Updated the article and added slide decks in order to demonstrate how to register a cloud application for token generation and how to generate application tokens through this portal.

Types of supported tokens (revised article)

  • Docs & guidelines / Cross-service docs / Supported types of tokens
    Revised article.

teamplay Images on Edge (revised article)
Glossary (revised entries)

  • Docs & guidelines / services/ teamplay / teamplay Images / teamplay Images on Edge
    Revised the article regarding the following new statement: APIs for teamplay Images on Edge are not yet available in the API gallery and will be published on demand.

  • Docs & guidelines / Glossary
    Added and revised several glossary entries.

See also

Test your application in the Sandbox environment (updated article)
teamplay Images on Edge (new article)
Links to the supported portal environments (revised article)
About the portal environments (extended article)
FAQs (added an entry)
Communication through MS Teams (updated article)
Glossary (revised entry)

Release 2021-04-06

List of changes:

  • Docs & guidelines / Getting started 

    • Initial onboarding steps / Test your application in the Sandbox environment
      Added some information on how to test your application against the Sandbox environment as a business partner.

    • Further information / About the portal environments
      Added some information on the differences between the supported portal environments.

  • Docs & guidelines / Services / teamplay / Images APIs
    Added a new new article about teamplay Images on Edge as part of the teamplay Images APIs sub chapters in the Docs & guidelines section.

  • Links to the supported portal environments
    Added links to articles with rules and prerequisites to test your application against the Sandbox environments.

  • FAQs
    Added the FAQ entry Where to execute functional and non-functional tests?.

  • Glossary
    Revised the definition for glossary entry Computerized Maintenance Management System (CMMS).

  • What´s new / Communication through MS Teams
    Added a list of topics that are typically communicated through the established MS Teams channels. 

See also

Initial onboarding steps (extended article)
Types of access tokens (updated article)
teamplay Fleet Connect APIs (new article)
Computerized Maintenance Management System (glossary entry)

Release 2021-03-09

List of changes:

  • General
    Based on the last Microsoft Azure release, applicable response headers are now also displayed on the API details page.

  • Docs & guidelines 

    • Getting started /initial onboarding steps
      Added the step "Validating tokens with your application" and added a reference to the associated new article.

    • Services / teamplay / General concepts / Types of access tokens (updated article)
      Added a sub chapter for the new teamplay Fleet Connect token with the reference to the new teamplay Fleet Connect APIs article.

    • Services /teamplay / Fleet Connect APIs (new article)
      A new high-level article is available about teamplay Fleet Connect APIs. 

    • Glossary (new entry)
      Added a glossary entry for the term Computerized Maintenance Management System (CMMS) that is related to the new teamplay Fleet Connect APIs article.

See also

Query and retrieve of DICOM images (updated article)

Release 2021-03-03

List of changes:

  • API details (new function and known issue)
    When selecting an API from the API gallery, scroll to the bottom of the API details pages for information on parent API products. The current positioning of the list of parent API products at the end of the API detail page is only a temporary solution. In the long term, a list with the names of the parent API products should be available at the top of the API details page.

  • Docs & Guidelines

    • teamplay Images / Query and retrieve of DICOM images (updated article)
      Fixed several issues in the text and fixed issues with truncated image for smaller window resolutions.

    • teamplay Fleet Connect APIs (updated titles)
      Updated teamplay service name from teamplay Fleet to teamplay Fleet Connect. Prepared new substructure for initial overview article coming soon.

See also

Environments (updated article)
Initial onboarding steps (updated article)
Options to invoke your cloud application (updated article)
Tools, samples & download center (new section)
Types of access tokens (updated article)
teamplay Images APIs (updated article)
teamplay User Notification APIs (updated article)
Query and retrieve of DICOM images (new article)
Glossary (updated article)
Types of processed data (updated article)

Release 2021-02-23

List of changes:

  • General

    • Issues with the responsiveness of the main menu and the environment button in the DevPortal header of the API gallery and the API details pages have been resolved.

    • Fixed issues with inconsistent colors of the environment button in the navigation header.

    • Fixed some broken link issues.

    • The Developer Portal is now also deployed for dedicated environments in China. The Environment page with the list of links to the supported environments has been extended accordingly.

  • API products / details

    • Added UX improvements.

  • API gallery / API details

    • Fixed issues with truncated text in the list of API operations. Now, longer operation names are wrapped in additional lines.

    • An additional toggle button has been added to the list of operation widget. Now, you can switch between the list of operation names and list of operation path information.

  • Docs & guidelines

    • Getting started / Getting started as a developer

      • Extended the article Initial onboarding steps. For example, added a new step for integrating Siemens Healthineers user authentication depending on the use cases of your application.

    • Services / teamplay

      • teamplay concepts

        • Extended the article Options to invoke your cloud application. Provided more details on the options to integrate your application into the teamplay digital health platform.

        • Reworked and extended the article Types of access tokens.

        • Extended the article Types of processed data with a sub topic about processing personal data.

      • teamplay Images APIs

        • Updated the overview article.

        • Added the new sub article Query and retrieve of DICOM images.

      • teamplay User Notifications APIs
        Updated the article to add information on an additional communication channel. Now, for applications that have integrated into the teamplay portal, user notifications can be also sent to the teamplay Notification Center in the teamplay portal.

    • Tools, samples & download center
      Added the Tools, samples & download center sub section to the main menu of the Docs & guidelines section. Includes sample applications based on the Angular and the ASP.NET Core frameworks. The sample applications demonstrate how to authenticate users for your cloud application in the user context.

  • Glossary
    Added and updated several glossary entries and linked them to associated articles in the Docs & guidelines section.

See also

Authorizing requests with tokens (new article)
Privacy levels for DICOM images (new article)

Release 2020-12-10

List of changes:

  • General UX improvements
    Resolved further issues with main menu section when reducing the size of the browser window.

  • Sign-in page
    Shortened and optimized the texts on the Sign-in page to improve the user experience.

  • Docs & guidelines - Services - teamplay

    • General Information
      Added article Authorizing requests with tokens.

    • Images APIs
      Added article Privacy levels for DICOM images.

Release 2020-11-13

List of changes:

  • API gallery - API details page
    As of now, the table view is activated by default. To switch from table view to raw data view, click the raw data icon "{ }" on top of the table.

  • API products - API product details page
    Improved the usability and design of the API product details page, especially in regard to facilitate subscriptions.

See also

teamplay general information
Options to integrate and run your applications (new article)
Processing different types of data classes (new article)

Release 2020-10-22

List of changes:

  • Cross-cutting style issues
    Changed the font size and font color of the first three title levels to better adjust the look & feel with the preconfigured widget fonts.

  • Getting started pages
    Revised content and added placeholder pages for planned articles.

  • API product details page
    Improved usability and layout.

  • Services / teamplay / General information
    Added new articles:

    • "Options to integrate and run your applications".

    • "Processing different types of data classes".

  • Services / teamplay / teamplay Fleet
    Added a placeholder page for a planned article: "teamplay Fleet APIs".

See also

Getting started (reworked section)
Managing your applications (new article)
About the API details page (revised article)

Release 2020-10-16

List of changes:

  • Cross-cutting issues

    • Fixed issues when hovering over hint elements
      When hovering over a hint element (hints are framed with a dotted line) on any of these portal page with the mouse pointer, the hint frame and the text inside had been earlier shaken. Now, the hint element doesn´t change its appearance anymore when hovering over it with the mouse pointer.

    • Main menu
      Several issues with main navigation in the right portal header has been solved by a Microsoft Azure update and through a corresponding adaption of the templates for the portal pages. As of now, the main navigation doesn´t jump anymore when hovering over it with your mouse pointer and the main menu is always accessible without the need of scrolling even when reducing the size of your browser window.

  • API gallery

    • UX improvements on the API details page

      • Fixed an issue when invoking the API details page. The details of the first operation in the list are now shown by default. You do not need to explicitly select the first operation item anymore after opening the API details page.

      • Fixed issues with truncated text in the descriptions of the request header parameters.

      • Improved the color scheme of the example elements and of the request text at the end of the Try it panel. The fonts in these two areas are now more legible.

      • Improved scrolling through API details pages with very long example texts by limiting the height of example box to 600 pixels. For longer example texts an additional scrollbar will be added to the example box that allows to scroll through the example contents without losing the focus on the current API details page and without the need to scroll too much to get to the end of the API details page in case of several very long example texts.

    • Fixed changelogs link on the API details page
      The changelogs link on the API details pages has been fixed. The changelogs can be invoked again.

    • Improved look & feel of the changelogs pages
      The look & feel of the changelogs page has been reworked. Now, you can easily identify for which API version the changelogs have been selected and you can easily switch to the changelogs of another API version.

  • Docs & guidelines - Getting started

    • Sub navigation
      Reworked the sub navigation and the structure for the whole Getting started section to improve portal and developer onboarding.

    • Getting started as a developer - Managing your applications
      New article:  An initial article about managing your applications for the teamplay digital health platform has been added! The first version of this article especially highlights the Application Token Management and the associated API that will be publicly available in November. 

See also

API details page (fixed issues)
About the API details (updated article)
teamplay Images APIs (new article)

Release 2020-09-17

List of changes:

  • Main menu
    Known issue: Since one of the last Microsoft Azure hot fixes, clicking on items in the right header menu of these portal pages lets the menu items jumping up and moving."

  • API gallery - API details page

    • Minor UX improvements have been implemented by slightly adapting the layout of the API details page.

    • Known issues: 

      • When invoking the API details page, the details for the first operation in the list that is selected are not always shown at a glance. As a workaround, you need to click again the list item to see the operation details in case they are not displayed.

      • Several issues with truncated texts have been reported to Microsoft Azure. Waiting for associated fixes and releases. As a workaround, you can download the API JSON specification from the associated API details page and search for the readable text in the description. In the API specification, you can find the complete texts for the descriptions.

  • Docs & guidelines - Services - teamplay - Images APIs
    New article:  An initial high-level article about teamplay Images APIs has been added!

Release 2020-09-10

List of changes:

  • Fixed footer issue on the Sign-in page
    Fixed issues with overlapping fonts due to a Microsoft issue regarding responsiveness. Footer is not fixed anymore, but is placed always at the end of the content area. Now, irrespective of the window resolution there is no overlapping text in the footer of the Sign-in page anymore.

  • Improved the usability of the API and product detail pages
    To facilitate the usage of the API details page regarding responsiveness and readability, several improvements have been applied such as:

    • To allow focusing on the API details, additional titles such as "API details" and "Operation details" have been removed from the content area. Instead, we configured the pull-down box with the list of available APIs that the current API name is displayed by default.

    • With reduced screen resolution it was not possible anymore to read the list of APIs in the pull-down menu of the upper right corner. When opening the API details page from the API gallery for a dedicated API, the size of the API pull-down list has been increased. 

    • To avoid too much scrolling in tables and code samples on the API details page for higher screen resolutions, we increased the column size for the operation details.

    • Added a breadcrumb at the top left corner to indicate that the details page has been selected to compensate the removal of the header information.

  • Docs & guidelines updates

    • Updated references on the teamplay digital health platform page
      Updated references in the right column with links to Siemens Healthineers Internet pages. Links to articles such "teamplay digital health platform-as-a-service (PaaS)" are placed there now.

    • Reworked the Getting started pages

      • Extended the About the API details page
        Provided more details on how to benefit from the options of the API details pages.

      • Extended the Further portal information page
        Added reference to associated portal pages and added a new entry on how to access the Environments page.

    • Improved the What´s new pages
      Shifted the article "News on API changes and deployments" on a separate page that is now accessible through the What´s new sub menu on the upper left of the page.
      By doing this, more details of the most current release note for this portal page can be viewed by default when opening this page with less scrolling.

See also

Environments (new article)
Getting started (reworked section)

Release 2020-09-07

List of changes:

  • Portal available in CUT and productive environments now
    Rolled-out the new Siemens Healthineers Developer Portal pages with the new look & feel to CUT and productive environments as of this version.

  • Timeout issue solved
    With Microsoft Azure update 2.4.2, timeout issues of the Microsoft Azure developer portals have been resolved. The timeout of each user session has been extended from previously 5 to about 30 minutes.

  • Sign-in page
    Revised user assistance on sign-in page basing on user feedback.

  • New "Environment" indicator and references
    As of now, the environment of the portal you are currently signed in is indicated by a button in the header of this portal. To open the Environment page with a list of the available environments for our internal and external business partners, click the environment button in the header.
    Remark: Clicking on the environment button from the Sign-in page doesn´t open the environment list due to some limitations with this Microsoft framework that is used to manage the portal.

  • API gallery
    Grouping the list of API operations/functions by tags is now possible again due to a current Microsoft Azure update (2.4.2).

  • API details page
    Fixed the issue with showing operation details when entering the API details page. When opening the API details page now, the first API operation is highlighted and the details of the highlighted operation are shown in the content area as expected.

  • Docs & guidelines - Getting started
    Reworked the getting started section. Clicking the Getting started entry from the Docs & guidelines section, opens a sub navigation now. The content has been revised and extracted to several sub pages now.

  • Your profile page
    Added a safety advice in the right column to keep the subscription keys secret and regenerate them regularly - at least once a year or earlier as needed.

Release 2020-07-10

List of changes:

  • API product page

    • API product details page
      Moved descriptions about the subscription steps to the Getting started section.

  • Docs & guidelines section

    • Issues with page menus. With help of additional menus on each page in the top of the right column, you can easily navigate within the page contents. For updated pages, these menus don´t work anymore. The issues are caused by the latest DevPortal update from Microsoft Azure. Therefore, Some of the page navigation bars had been temporarily removed. Even for the active page menus, when navigating to the page target, the title is hidden from the main menu bar in the top of each page. As soon as this issue has been resolved, we will add the missing page navigation bars again.

    • Incorporated feedback for the following chapters:

      • Getting started with this portal

      • Getting started as a developer

      • Services

Release 2020-07-02

List of changes:

  • Sign-in page
    The following improvements have been done:

    • Removed the Sign-in menu item in the header to avoid confusion of new users without access rights.

    • Rearranged the area below the AAD button. Added some hints to troubleshoot if the sign-in to the portal fails.

  • Home page
    Added a direct link to this "What´s new" article to allow a quicker access of the what´s new contents after sign-in.

  • API products page
    Removed web widget for the already subscribed API products in the left column as this widget only correctly works on the API details page.

    • API product details page

      • Changed page title from "Product details" to "API product details".

      • Rephrased header of the web widget with the overview of already subscribed API products.

  • API gallery - API details page

    • Enabled the link to the "changelogs" for each API.

    • Changed schema of the web widget for the operation details to "raw" schema. Now, the code snippet boxes are visible by default without further user interaction. The code snippet boxes can still be hidden by each user with the collapsing icon if required.

    • Improved the layout of the pages and the title phrases.

  • Docs & guideline pages
    Revised contents, some page/navigation titles, and links to API details for the following pages:

    • teamplay digital health platform

    • Getting started with this portal

    • Getting started as a developer

    • Services (renamed previous title: "Applications and services")

  • Profile page
    Removed web widget with duplicate subscription information.

Release 2020-06-10

Minor update with the following changes, extensions, and improvements:

  • Added user reports
    Added a link on the Your profile page to the user reports and updated the Getting started with this portal page accordingly. Now, the user who is logged in can view his/her API usage statistics for the corresponding portal instance as indicated in the portal URL.

  • Changed browser tab card names
    Improved the page-related names on the browser tab card and the corresponding tool tip for these portal pages.

  • Improved layout issues
    Improved several layout-out issues on a lot of pages that had been caused by the last Microsoft Azure update.

  • Adapted navigation bar
    The Sign-up page is now only accessible via the main menu on the Sign-in page of this portal. After you already logged in to this portal, you can still access the Sign-in and Sign-up page by logging out. After logging out, the Sign-in page shows up again. In some articles in this portal, you can also find a reference in the quick link bar on the right next to the page contents.

Release 2020-06-08

Initial roll-out of the new Siemens Healthineers Developer Portal including the following updates in comparison to the old portal offerings:

  • As Azure supports a new developer portal infrastructure with new functions and features, Siemens Healthineers decided to switch to the new infrastructure.

  • With the new portal infrastructure, a new design has been assigned and the navigation bar has been reworked.

  • There´s a new Docs & guidelines section that provides information about how to start as a developer, high-level overviews, architectural decisions, details about supported applications and services, etc. 

  • Remark: some of the teamplay articles are still under construction and highlighted accordingly

Go to top

--------------- go to the top of this article --------------->>