What are the types of method requests

Summary

APIs methods require the definition of a type of application.

We suggest that you respect REST/json standards when creating their methods, based on the following definitions.

---

Types of request or application

The methods most used in APIs applications are as follows:

Type of application	Description
GET	The GET method is used to consult or obtain source data.
POST	The POST method is normally used to send a resource or entity to the origin, i.e. to create a new record. Despite this, there may be methods that do not make changes in origin but are used to obtain data.
PUT	The PUT method is used to change the entirety of an entity at origin.
PATCH	The PATCH method is used to apply partial modifications to an entity at source.
DELETE	The DELETE method is used to delete or delete an entity or resource at source.

That is the definition of the standard, your API may not meet these specifications depending on your requirements.

It recalls that the selection of the type of application in the API method is independent of the request to be sent to the source. The request sent to the source is defined by creating the Data Source.

That is, you can set up a POST request at your source to obtain data, while you can expose that data in a GET method. This allows you to standardize application types based on the standard without making changes to your data source.

GET requests can be previewed and tested on the developer portal. The rest of the application types are not previewed on the portal to avoid unwanted executions.

• Related Articles

• 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 ...

• Audit API

  Summary The Audit API allows you to consult audit records in detail of applications received and responses submitted from APIs methods. Through this API you can learn the details of each of the requests made to your APIs and the responses submitted. ...

• Data sources from SOAP/xml web services

  Summary The SOAP/XML web services connector offers all the necessary capabilities to connect to these types of sources. This option allows collecting data from SOAP/XML web services or configuring writing actions, for then creating data views and ...

• 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 ...