Getting started with Cognos REST APIs

To get started using the IBM Cognos APIs, a designated user account must be created for your organization by IBM Support. After you authenticate to the Cognos APIs, use the IBM Cognos Mashup Service to retrieve the report content in your chosen output format.

About this task

You must be a Reporting Security Administrator to submit a request to turn on Cognos APIs for your organization.

Please note the following.
  • Your REST API user password expires after 90 days. Before 90 days elapse, it is your responsibility to request a password reset by submitting a case on the Watson Health Support Portal. Password resets must be completed by the WCM Operations team.
  • WCM Operations request that password reset requests be submitted to WCM Ops 14 days before the 90 day limit is reached.
  • REST API User IDs will be created by the IBM Web Content Manager Operations team and passwords shared with the designated customer's Reporting Security Administrator.
  • Password reset requests to be submitted through an IBM L2 Support ticket. The ticket must include a valid phone number.
  • The password requester must be a WCM Cognos Security Administrator.
  • WCM Ops will confirm the email address of the requester matches that of an active Cognos Security Administrator.
  • REST user passwords will be reset and new passwords communicated to a Cognos Security Administrator by phone.

Procedure

  1. Request that Cognos APIs be turned on for your organization by submitting a case on the Watson Health Support Portal. Ensure that you provide your contact details in your request.
  2. IBM Support will create a Cognos API user account for you so that you can authenticate to the Cognos APIs.
  3. Authenticate to the Cognos REST APIs.
  4. To make calls to see the supported output formats for a report or to retrieve report data, you must obtain the report ID.
    1. In the Watson™ Care Manager Reporting application, go to a report.
    2. Click Properties > Advanced. In the ID field, you see the report ID.
  5. To retrieve supported output report formats and retrieve report data, see Running reports and retrieving output in IBM Cognos Viewer formats.

    Example call to retrieve report data in a specified format.

    curl -b cookie.txt -c cookie.txt -X GET “https://{reporting domain name} /wcmreportingapi/{tenant id}/{tenant instance id}/disp/rds/outputFormat/report/{report_id}/CSV?v=3&async=” -H “X-XSRF-TOKEN:${xsrf}”

    The outputFormat REST resource returns a HTTP forward 300.x which contains the download URI for the file.

    See Related information for specific Cognos Mashup Service topics that are relevant to this procedure.