OData endpoint

OData is a best-practice approach to exposing and consuming data over the web, and enables you to interact with data sources, such as Anaplan Financial Consolidation, using a consistent set of conventions and operations.

Open Data Protocol (OData) is an OASIS standard that defines best practices for building and consuming RESTful APIs. OData-compliant endpoints promote interoperability between different systems and platforms by defining uniform operations and query options.

In the Anaplan Financial Consolidation API, the OData endpoint can retrieve, insert, update, and delete data from a client schema staging table using HTTP methods. Supported methods are:

• GET, retrieves information from a single schema table.
• POST, inserts data into a client schema table.
• PUT, updates one or more rows in a client schema table.
• DELETE, removes one or more rows from a client schema table, or clears the table contents while preserving the overall schema.

Any request to the OData endpoint must include the tenant and a valid API token. The server must authenticate this token to process the rest of the request. The request must also specify an intersection of parameters or address the table as a whole. This is done in the header and body of the request and is described for each individual request.

Parameters in OData endpoints can be of different data types. Anaplan Financial Consolidation supports these standard data types: