An action is an operation the connector can perform on the API: list customers, create an order, delete an appointment.
Kinds of actions
The kind tells the component what the action is for: a list uses GET to display, CREATE when you click Add, and so on. Actions are assigned to the component in the Source tab (see Multi-source).
Adding an action
Actions step › Add action:
Import from OpenAPI: actions generated from a specification (see
OpenAPI import);
Custom action: you describe it yourself.
A custom action
The parts of the endpoint in braces ({id}) become required path parameters.
Configuring an action
Select an action in the Actions list to set:
the Request Entity and Request DTO: what is sent;
the
Response Entity and
Response DTO: what comes back (see
Mapping);
the Tags, to sort the actions;
the Parameters and their default value (* = required).
Right-click an action: Rename or Delete.
Testing
The Preview step really calls the API:
Choose an action in the Actions list.
Fill in the Parameters and, for a write, the Request body. It is a form generated from the entity, and empty fields are not sent.
Click Execute.
Read the Results table.
Does it work?
If the Results table shows your data in columns, the action is ready: save the connector and plug it into a component.
Good to know
The body is sent only for POST, PUT and PATCH, never for DELETE.
A connector without a Host cannot call anything.
A path parameter left empty causes an error.
Runtime errors