Nuvem SolutionInstall

Overview

This node interacts with the "Nuvem Solution" API, specifically focusing on operations related to "Ordem de Serviço" (Service Order). The selected operation "Listar Agendamentos" allows users to list scheduled service order appointments within a specified date range and supports pagination.

Typical use cases include:

• Retrieving all scheduled service orders between two dates for reporting or monitoring.
• Paginating through large sets of service order schedules to process or display them incrementally.
• Filtering schedules by start and end dates to focus on specific time periods.

For example, a workshop manager could use this node to fetch all service appointments scheduled for the upcoming week to prepare resources accordingly.

Properties

These properties allow filtering and controlling the volume of schedule data returned by the API.

Output

The node outputs a JSON array containing the list of service order schedules ("agendamentos") retrieved from the API. Each item in the array represents a scheduled appointment with details as provided by the Nuvem Solution API.

The exact structure of each schedule object depends on the API response but typically includes fields such as appointment date/time, service order ID, customer information, and status.

No binary data output is involved in this operation.

Dependencies

• Requires an API key credential for authenticating with the Nuvem Solution API.
• The node uses the base URL and authentication tokens obtained from these credentials.
• Proper configuration of the API credentials in n8n is necessary before using this node.

Troubleshooting

• Authentication errors: If the node fails due to authentication issues, verify that the API key credential is correctly configured and valid.
• Invalid date filters: Ensure that the "Data de Início" and "Data de Fim" are valid ISO date-time strings; invalid formats may cause request failures.
• Pagination parameters: Using very high page numbers or page sizes might result in empty responses if no data exists for those pages.
• API endpoint errors: If the API returns errors, check network connectivity and confirm that the Nuvem Solution API service is operational.

Common error messages:

• "Authentication failed: Invalid response from server" indicates credential or connectivity problems.
• "The operation "listarAgendamentos" is not supported!" would indicate a misconfiguration or unsupported operation selection.

Links and References

• Nuvem Solution API Documentation (general reference, actual docs should be consulted for detailed API specs)
• n8n documentation on Creating Custom Nodes
• For date-time formatting, refer to ISO 8601 Date Format

Summary of execute() logic for Resource "Ordem de Serviço" and Operation "Listar Agendamentos"

• Authenticates with the Nuvem Solution API using stored credentials.
• Constructs a GET request to the endpoint /erp/oficina/ordensServico/agendamentos/listar.
• Applies query parameters based on input properties: startAt, endAt, page, and pageSize.
• Sends the request with proper authorization headers.
• Returns the JSON response containing the list of scheduled service orders.