AvantGuard - HuduInstall

Overview

The "Update Procedure" operation for the "Procedures" resource allows you to update an existing procedure in your system. This node is useful when you need to modify details of a procedure, such as its name, description, associated company, or archival status. Common scenarios include automating updates to procedures based on workflow changes, synchronizing procedure data with other systems, or managing templates and archiving within your organization.

Practical examples:

• Automatically renaming and updating descriptions of procedures after a review process.
• Transferring a procedure to another company or making it a global template.
• Archiving or unarchiving procedures based on business rules.

Properties

Name	Type	Meaning
Id	Number	The ID of the procedure to update. Required to identify which procedure will be modified.
Additional Body Fields	Collection	Optional fields to further specify what should be updated. Contains:
— Name	String	The new name for the procedure.
— Description	String	The new description for the procedure.
— Company Template	Boolean	When true, sets both template and remove_completion_ability to true; when false, sets both to false.
— Company Id	Number	The ID of the company this procedure should be transferred to. Set to null to make this a global template.
— Archived	Boolean	When true, archives the procedure by setting discarded_at. When false, unarchives the procedure by clearing discarded_at.

Output

The node outputs the updated procedure's data in the json field. The structure typically mirrors the API response for a procedure object, including all relevant fields such as id, name, description, company information, template status, and archival status.

Example output (structure):

{
  "id": 123,
  "name": "Updated Procedure Name",
  "description": "New description",
  "company_id": 456,
  "template": true,
  "remove_completion_ability": true,
  "archived": false,
  // ...other fields as returned by the API
}

Note: The actual fields may vary depending on the API's response.

Dependencies

• External Service: Requires access to the Hudu API via AvantGuard integration.
• API Key/Credentials: Needs valid credentials (avantguardHuduApi) configured in n8n, including the base URL and authentication token.
• n8n Configuration: Ensure the credentials are set up in n8n under the appropriate credential type.

Troubleshooting

Common Issues:

• Invalid or missing procedure ID: If the provided Id does not correspond to an existing procedure, the API will likely return a "Not Found" error.
• Missing required credentials: If credentials are not set or invalid, the node will fail with an authentication error.
• Insufficient permissions: The user associated with the API key must have permission to update procedures.
• Incorrect data types: Providing values in the wrong format (e.g., string instead of number) can cause validation errors.

Common Error Messages:

• "Procedure not found": Check that the Id is correct and the procedure exists.
• "Unauthorized" or "Invalid API Key": Verify that the credentials are correctly configured in n8n.
• "Validation failed": Ensure all input fields are provided in the correct format and meet any constraints required by the API.

Links and References

• Hudu API Documentation (for reference on procedure endpoints)
• n8n Credentials Documentation
• AvantGuard n8n Integration