AvantGuard - WebhookSite icon

AvantGuard - WebhookSite

AvantGuard - WebhookSite

Actions100

Overview

The "Update Procedure" operation allows users to modify an existing procedure by specifying its unique identifier and updating various optional fields such as name, description, template status, company association, and archival state. This node is useful in scenarios where procedures need to be maintained or adjusted dynamically, for example, updating procedural documentation, changing ownership between companies, or archiving outdated procedures.

Practical examples include:

  • Renaming a procedure after a process change.
  • Adding or updating the description to clarify steps.
  • Transferring a procedure to a different company or making it global.
  • Archiving procedures that are no longer active without deleting them.

Properties

Name Meaning
Id The ID of the procedure to update (required).
Additional Body Fields Optional fields to update on the procedure:
- Name The new name for the procedure.
- Description The new description for the procedure.
- Company Template Boolean flag; when true, sets both template and remove completion ability to true, otherwise false.
- Company Id The ID of the company to transfer the procedure to; set to null to make it a global template.
- Archived Boolean flag; when true, archives the procedure by setting a discard timestamp; when false, unarchives it.

Output

The node outputs JSON data representing the updated procedure object returned from the API after the update operation. This typically includes the procedure's current state with all updated fields reflected. There is no indication of binary data output.

Dependencies

  • Requires an API key credential for authentication to the AvantGuard service.
  • The base URL for the API must be configured in the node credentials.
  • Depends on the @avantguardllc/n8n-openapi-node package and the associated OpenAPI specification (openapi.json) for request building and execution.

Troubleshooting

  • Invalid Procedure ID: If the provided procedure ID does not exist, the API will likely return an error indicating the resource was not found. Verify the ID before running the node.
  • Permission Issues: Updating procedures may require specific permissions. Ensure the API key used has rights to modify procedures.
  • Invalid Field Values: Providing invalid types or values (e.g., non-boolean for archived) can cause validation errors. Double-check input types.
  • Network or Authentication Errors: Check API base URL configuration and API key validity if requests fail to authenticate or connect.

Links and References

Discussion