OData

Last modified: May 23, 2019 @ 08:49

Overview

OData (Open Data protocol) is a protocol for the creation and consumption of RESTful APIs.

Access to data from applications (mobile apps, web, integration software, etc.) is routed through client or OData APIs, where every request is secured and processed, based on user access control. User identity verification is handled through federated identity standards and integrates with all credential solutions that support SAML/OAUTH.

OData Authentication

To access the OData service, you need to generate an API key in DDM.

See Accessing the API for instructions on how to generate an API key in DDM.

See OData Endpoint Request for instructions on how to use the key.

OData Endpoint Request

This section provides instructions on how to prepare a request against a DDM OData endpoint.

  1. Include an authentication token in the request header. See Accessing the API for instructions on how to obtain a valid authentication token.
  2. See the following header example:
HEADER:

Authorization: Bearer INSERT-TOKEN
  1. See the following base endpoint for the OData endpoints:
https://ODATA-SERVICE/odatav2/DEVICE-NETWORK-ID

Note: The base endpoint requires a device network, which will be the target device network. If unsure about where to find your device network, call this endpoint:

GET https://API-ROUTE/api/v3/user/devicenetworks

This request will be answered with a list of device networks that you, or the generated token, have permission to access. Select the appropriate device network ID from the list.

  1. Insert the device network ID at the end of the OData base endpoint.
  2. Call the base endpoint with an HTTPS GET request. A list with all available dimensions is fetched.
  3. Configure DDM as appropriate. For more information, see the Appendix charts.

Appendix charts