Nuvem Solution icon

Nuvem Solution

Interact with Nuvem Solution API

Actions120

Ordem de Serviço → Listar Ordens de Serviço Geral

AI-generated

Overview

This node interacts with the Nuvem Solution API to manage and retrieve data related to "Ordem de Serviço" (Service Orders). Specifically, for the operation Listar Ordens de Serviço Geral (List General Service Orders), it fetches a paginated list of service orders filtered by optional start and end dates.

This functionality is useful in scenarios where users need to monitor or report on all service orders within a certain period, such as generating operational reports, tracking workload, or auditing service activities across an organization.

For example, a workshop manager could use this node to list all service orders created between two dates to analyze service volume trends or identify peak periods.

Properties

Name Meaning
Data de Início Start date filter to limit results to service orders created on or after this date.
Data de Fim End date filter to limit results to service orders created on or before this date.
Página Page number for pagination, indicating which page of results to retrieve (default: 1).
Tamanho da Página Number of items per page to return in the response (default: 10).

These properties allow users to control the time range and pagination of the service order listing.

Output

The output is a JSON array containing the list of service orders matching the specified filters. Each item in the array represents a service order object returned by the Nuvem Solution API endpoint /erp/oficina/ordensServico/listarOrdensServicoGeral.

The structure of each service order object depends on the API but typically includes fields such as order ID, customer details, status, dates, and other relevant metadata.

No binary data output is produced by 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.
  • Network access to the Nuvem Solution API endpoints is necessary.
  • No additional external dependencies are required beyond the configured API credentials.

Troubleshooting

  • Authentication failures: If the node throws errors about authentication, verify that the API key credential is correctly configured with valid software key, secret, user ID, and user key.
  • Invalid date formats: Ensure that the "Data de Início" and "Data de Fim" inputs are valid ISO 8601 date-time strings; otherwise, the API may reject the request.
  • Pagination issues: Requesting pages beyond the available range will result in empty responses. Adjust the "Página" and "Tamanho da Página" accordingly.
  • API errors: Any unexpected API errors will be surfaced as error messages. Check the API documentation or contact support if persistent errors occur.

Links and References

Discussion