Conformance

The TM1 REST API meets the intermediate conformance level of the OData Version 4 protocol.

The OData Version 4 protocol describes three levels of conformance for OData services: minimal, intermediate, and advanced. The minimal conformance level specifies the minimum set of requirements for a service to be considered an OData-compliant service.

Non-updateable service compliance

The TM1 REST API meets all requirements of the Intermediate Conformance Level, as described in section 13.1.2 of the OData Protocol specification, for a non-updatable OData Service.

In addition to the intermediate level supported, the TM1 REST API also satisfies the following requirements from the Advanced Conformance Level:

  • Items 1-8.
  • The following items from 9:
    • i, ii, iii, v, and vi.

Updatable service compliance

The TM1 REST API is an Updatable service but does not meet all of the requirements to be considered an Updatable OData service, as described in section 13.1.1 OData Minimal Conformance Level. It does satisfy requirements 14, 15, 16, 19, 20, and 23.

Supported formats

The TM1 REST API supports the [OData-JSON] format.

Supported preferences

The TM1 REST API supports some of the Header Prefer values that are specified in the OData Version 4 protocol.

Supported preferences include the following values:

Entity tag (ETag) support

The TM1 REST API provides weak ETags for Cube, Dimension, Hierarchy, ElementCollection, Element, Subset, Process, View, and Chore entities.

For more information about the ETag header field, see the following ODATA references: