Sharing the API document for a client data type

When you share a configurable client data type version, Watson Care Manager generates an API definition document in JSON format. You can download the API document to distribute to the relevant systems integrator for your organization.

About this task

The document contains the REST API calls and structure that Watson Care Manager requires to receive client information captured in respect of the client data type from external systems. Your integrator uses the API document to understand what data is expected from the receiving system and the format of the data.

Note: The option to share the API document for a configurable client data type version is available only when the client data type version is Active and shared. The API document is compatible only with Version 2.0 of the Swagger Editor.
Important: Whenever you modify or create a new version of a client data type that is shared with external systems, you may need to redistribute its API definition document to your organization's integrator. Otherwise, existing integrations might fail. For more information, see Updates to client data types and external systems.

Procedure

  1. Sign in with your administrator credentials.
    Your home page opens.
  2. Click Client Data.
    The tabs in the Client Data library contain a list of configurable and non-configurable client data types. Configurable data types are displayed by default.
  3. From the Actions menu for a configurable client data type that is Active and shared, click Share Document. The Share Document page opens.
  4. Click Download.
  5. Browse to where you want to store the file on your computer.
  6. Distribute the document to the systems integrator for your organization.