AvantGuard - WebhookSite icon

AvantGuard - WebhookSite

AvantGuard - WebhookSite

Actions100

Overview

The "Get Procedures" operation retrieves a list of procedures from an external service. This node is useful when you want to fetch procedure data filtered by various criteria such as name, company association, pagination, or template type. Typical use cases include integrating procedure data into workflows for reporting, synchronization with other systems, or conditional processing based on procedure attributes.

For example, you might use this node to:

  • Retrieve all global template procedures for display in a dashboard.
  • Fetch procedures associated with a specific company to automate company-specific workflows.
  • Paginate through large sets of procedures to process them in batches.

Properties

Name Meaning
Additional Query Parameters Optional filters and pagination controls to refine the list of procedures returned. Includes:
- Name Filter procedures by their exact name (string).
- Company Id Filter procedures by the associated company ID (number).
- Page Specify the current page number of results to retrieve (number).
- Page Size Number of results to return per page (number).
- Slug Filter procedures by their URL slug (string).
- Global Template Filter for global templates; choose 'true' to get global templates or 'false' for company-specific ones.
- Company Template Filter for company-specific templates by providing the company ID (number).
- Parent Procedure Id Filter for child procedures belonging to a specific parent procedure (number).

These parameters are sent as query parameters to the API endpoint to control which procedures are retrieved.

Output

The node outputs JSON data representing the list of procedures matching the specified filters. The structure typically includes an array of procedure objects, each containing details such as procedure name, ID, associated company, template type, and other metadata.

If the API supports pagination, the output may also include pagination metadata like total count, current page, and page size.

This node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating requests to the external service.
  • The base URL for the API must be configured in the node credentials.
  • Depends on the external service's API being available and responsive.

Troubleshooting

  • Empty Results: If no procedures are returned, verify that your filter parameters are correct and that procedures exist matching those filters.
  • Authentication Errors: Ensure that the API key credential is correctly set up and has sufficient permissions.
  • Pagination Issues: If you expect more results than returned, check the page and page_size parameters to paginate through all available data.
  • Invalid Parameter Values: Passing incorrect types (e.g., string instead of number) for numeric filters may cause errors or unexpected behavior.

Links and References

  • Refer to the external service's API documentation for detailed information on the procedures endpoint and supported query parameters.
  • n8n documentation on how to configure API credentials and use HTTP request nodes for custom integrations.

Discussion