Importance of Providing Valid Fields

It is important to understand that every endpoint has its own unique set of fields based upon the model that its data is associated with, and the model’s related entities.

Making a request with a field name that does not exist with the endpoint’s set of available fields can cause an internal service error (ISE) within the TUNE Management API service. It is important to make sure that the field names used within method parameter type fields, filter, sort, and group are appropriate to the endpoint it is calling.

Every data-consuming endpoint is associated with a single data model (hosted upon either row-oriented or column-oriented DBMS) and with zero or more related data models. Below shows mapping record fields by Endpoint defining availability to its Actions.

matapi-endpoint-fields

 

When requesting a report for export from these endpoints, it is important to refer to only fields that are available to the endpoints’ associated data models. Providing field names that are not associated with an endpoint’s data models and included within actions’ parameters will lead to:

  1. Parameter fields: Report exported will be missing column.
  2. Parameters sort, group, filter: TUNE Management API’s service creates an invalid query and thus will fail returning an “Internal Service Error” (ISE).
Have a Question? Please contact support@tune.com for technical support.