You can use the IBM® Cognos® TM1® REST API to perform create, read, update, and delete operations on TM1 data by using standards that are defined by OData Version 4 (

This document describes the semantics of the TM1 REST API and demonstrates how to use the TM1 REST API by using samples and use cases.

Finding information

To find documentation on the web, including all translated documentation, access IBM Knowledge Center (


To use the IBM Cognos TM1 REST API effectively, you must be familiar with the following areas:

  • TM1 and the TM1 architecture
  • Dimensional data and modeling terminology and concepts
  • OData Version 4
  • REST
  • HTTP programming (methods, headers, result codes)
  • Web authentication
  • JSON

For detailed information about how to interact with the TM1 REST API, see Representing TM1 data.

Samples disclaimer

The Sample Outdoors Company, Great Outdoors Company, GO Sales, any variation of the Sample Outdoors or Great Outdoors names, and Planning Sample depict fictitious business operations with sample data used to develop sample applications for IBM and IBM customers. These fictitious records include sample data for sales transactions, product distribution, finance, and human resources. Any resemblance to actual names, addresses, contact numbers, or transaction values is coincidental. Other sample files may contain fictional data manually or machine generated, factual data compiled from academic or public sources, or data used with permission of the copyright holder, for use as sample data to develop sample applications. Product names referenced may be the trademarks of their respective owners. Unauthorized duplication is prohibited.

Accessibility features

Accessibility features help users who have a physical disability, such as restricted mobility or limited vision, to use information technology products.

This product does not currently support accessibility features that help users with a physical disability, such as restricted mobility or limited vision, to use this product.

Forward-looking statements

This documentation describes the current functionality of the product. References to items that are not currently available may be included. No implication of any future availability should be inferred. Any such references are not a commitment, promise, or legal obligation to deliver any material, code, or functionality. The development, release, and timing of features or functionality remain at the sole discretion of IBM.