Method define response formats for methods

Method define response formats for methods

Summary

Output formats allow you to define one or more response formats in your API methods.

Output formats can be multiple in JSON format, although it can also expose the data in CSV and XML.



Configure formats


When creating a method you should define one or more response formats. The response formats make it possible to define the output of the request, i.e. the response that the method would deliver to a request.

Once the data view is selected, you should define the output formats and their templates.

Output or output templates allow you to define the output response for the selected format.

To define a new output select the desired format andNew template. You could also select an existing template and copy it to reuse it in its new method.

Output templates are defined by jinja templates.


In the same window, when creating or editing template, you could access references that would allow you to invoke the results of your data view.


To learn more about templates read the articleHow to work with templates to define the output of methods



    • Related Articles

    • Apply data formats in data view

      Summary Data formats make it possible to modify the values of data view columns and configure when the content is JSON type. To apply a format you must select the option Configure data type and column format and you could select: The column on which ...
    • Try a method

      Summary The developer portal allows you to test reading methods (GETs) on the same portal. Test method Enter an API in the APIs Catalog on the portal's homepage. Then select a method and click on the buttonTest method. Select the implementation which ...
    • 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 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 ...
    • 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 ...