How to add data dictionaries
Summary
Data dictionaries make it possible to improve the documentation of APIs and add extended capabilities on them.
Configure data dictionaries
To set up the data dictionary for a method, you must access the method and click on the button Data dictionary.
A window with columns would allow you to define the name, description and type for each of the columns in the data view.
The name should relate to the name of the attribute you were referring at the data dictionary and the type of data provided.
You do not need to complete all the columns, you can add a dictionary only on some of them.
Extended capacities
When you add a data dictionary, in the Test method of the developer portal would visualize extended options for applying filters, aggregations and calculations. These options are available to the developer user for use, without affecting API configuration.
Related Articles
What is a data view
Summary The platform does not require an off-line ETL process to extract data from the origins, but associated with the view, find a set of rules that the data engine interprets for check the source on demand or periodically, extract the data updated ...
Select data and headers
Summary Data views allow you to select the data and define the headers or titles that would be available in APIs methods. It is possible to make selections from the entire table, columns, column intersections and rows. In addition, it is possible to ...
Data sources from REST/json web services
Summary The REST/JSON web services connector offers all the capabilities needed to connect to such sources. This option allows you to collect data from REST/JSON web services or configure writing actions, and then create data views and exhibit them ...
Add aliases in data view columns
Summary APIs method templates allow you to obtain the values of the data view columns by position or alias name. Here we explain how to configure the aliases of the data view columns. Add alias To add aliases to the data view columns you must select ...
Add filters and parameters in data view
Summary Data views allow you to add fixed or dynamic filters, these are parameters. Fixed filters To add a filter you must click on the option Filter data. A form would be displayed where you should select the column on which the filter, the type of ...