Nuvem Solution icon

Nuvem Solution

Interact with Nuvem Solution API

Actions120

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

AI-generated

Overview

This node integrates with the Nuvem Solution API to list service orders ("Ordens de Serviço") from a workshop or service management system. Specifically, the "Listar Ordens de Serviço" operation allows users to retrieve paginated lists of service orders filtered by date ranges and optionally by client ID.

Typical use cases include:

  • Fetching all service orders scheduled or created within a specific time frame.
  • Filtering service orders for a particular client to monitor their service history.
  • Paginating through large sets of service orders for reporting or synchronization purposes.

For example, a user might want to list all service orders created between January 1st and January 31st, showing 20 orders per page, to generate monthly reports or feed data into another system.

Properties

Name Meaning
Data de Início (startAt) Start date/time to filter service orders from (inclusive). Format: ISO 8601 datetime string. Optional.
Data de Fim (endAt) End date/time to filter service orders until (inclusive). Format: ISO 8601 datetime string. Optional.
Página (page) Page number for pagination. Defaults to 1.
Tamanho da Página (pageSize) Number of items per page in the paginated response. Defaults to 10.
ID do Cliente (clienteId) Client ID to filter service orders by a specific customer. Optional; if 0 or omitted, no client filtering is applied.

These properties allow flexible querying of service orders based on date intervals, pagination controls, and client-specific filtering.

Output

The node outputs a JSON array where each element represents a service order record retrieved from the Nuvem Solution API.

The structure of each service order object depends on the API's response but typically includes fields such as:

  • Service order identifiers
  • Dates and times related to scheduling or creation
  • Client information
  • Status and details of the service order

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 bearer token authentication obtained via the provided software key, secret, user ID, and user key credentials.
  • Network access to the Nuvem Solution API endpoint is necessary.
  • No additional external dependencies are required beyond standard HTTP requests.

Troubleshooting

  • Authentication failures: If the node returns errors about authentication, verify that the API credentials (software key, secret, user ID, user key) are correct and have not expired.
  • Invalid date formats: Ensure that the "Data de Início" and "Data de Fim" inputs are valid ISO 8601 datetime strings. Incorrect formats may cause the API to reject the request.
  • Pagination issues: If no results appear, check that the page number and page size are set appropriately and that the date filters cover the expected range.
  • Client ID filtering: Using an invalid or non-existent client ID will result in empty responses. Confirm the client ID is valid.
  • API errors: The node throws errors if unsupported operations or resources are requested. Make sure to select the correct resource ("ordemServico") and operation ("listar").

Links and References

Discussion