Sharing the API document for a questionnaire

When you share a questionnaire, Watson Care Manager generates an API document in JSON format. You can download the document to share with the relevant integrator for your organization.

About this task

The API document contains the REST API calls and structure that Watson Care Manager requires for external systems to share completed client questionnaires with Watson Care Manager and for Watson Care Manager to share completed client questionnaires with 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 download an API document for a questionnaire version is available only when a questionnaire 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 questionnaire that is shared with external systems, you may need to redistribute its API document to your organization's integrator. Otherwise, existing integrations might fail.

Procedure

  1. Sign in with your administrator credentials.
    Your home page opens.
  2. Click Questionnaires.
    The list of questionnaires is displayed.
  3. From the Actions menu for an Active questionnaire that is shared, click Share Document to download its API document.
  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.