Overview

This node integrates with the Nuvem Solution API to perform various operations related to service order types, among many other resources. Specifically, for the resource "Ordem Serviço Tipo" (Service Order Type), it supports operations such as retrieving a service order type by its ID.

The "Consultar por ID" operation allows users to fetch detailed information about a specific service order type using its unique identifier. This is useful in scenarios where you need to obtain metadata or configuration details about a particular type of service order within your business processes.

Practical example:
If you have a workflow that processes service orders and needs to branch logic based on the type of service order, this node can be used to retrieve the service order type details by ID to make informed decisions or enrich data before further processing.

Properties

Output

• The node outputs a JSON object representing the service order type details retrieved from the Nuvem Solution API.
• The exact structure depends on the API response but typically includes fields describing the service order type's attributes.
• 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 via these credentials to make authorized HTTP requests.
• Proper configuration of the API credentials in n8n is necessary for successful execution.

Troubleshooting

• Common issues:

  • Invalid or expired API credentials will cause authentication failures.
  • Providing an invalid or non-existent service order type ID will result in errors or empty responses.
  • Network connectivity issues may prevent the node from reaching the API endpoint.

• Error messages:

  • "Authentication failed: Invalid response from server" indicates problems with API credentials or network.
  • "The operation "getById" is not supported!" would occur if the operation name is misspelled or unsupported.
  • "The resource "ordemServicoTipo" is not known!" suggests incorrect resource selection.

• Resolutions:

  • Verify and update API credentials in n8n settings.
  • Confirm the service order type ID exists and is correct.
  • Check network access and firewall rules allowing outbound API calls.

Links and References

• Nuvem Solution API Documentation (generic link, replace with actual if available)
• n8n Documentation on Creating Custom Nodes
• REST API concepts for understanding request/response patterns.

Summary of execute() logic for Resource "Ordem Serviço Tipo" and Operation "Consultar por ID"

• The node authenticates with the Nuvem Solution API using stored credentials.
• It reads the input parameter ordemServicoTipoId (service order type ID).
• Constructs a GET request to the endpoint /erp/oficina/ordemServicoTipos/{id}.
• Sends the request with proper authorization headers.
• Returns the JSON response containing the service order type details.
• Handles errors gracefully, optionally continuing on failure if configured.

This summary focuses exclusively on the specified resource and operation, reflecting the static analysis of the provided source code and property definitions.