AvantGuard - NinjaOne icon

AvantGuard - NinjaOne

AvantGuard - NinjaOne

Actions159

Overview

This node updates an existing organization document within the "Organization Documents" resource. It is useful when you need to modify metadata or content details of a document already stored in an organization's system, such as changing the document name, description, or custom fields.

Practical examples include:

  • Renaming a policy document after revision.
  • Adding or updating descriptive information for compliance documents.
  • Modifying structured JSON fields associated with the document for integration purposes.

Properties

Name Meaning
Organization Id Numeric identifier of the organization owning the document.
Client Document Id Numeric identifier of the specific organization document to update.
Additional Body Fields Optional collection of additional fields to update on the document:
- Document Name: New name/title for the document.
- Document Description: Textual description or notes about the document.
- Fields: JSON object containing custom structured data related to the document.

Output

The node outputs JSON data representing the updated organization document. This typically includes the updated properties such as the document's ID, name, description, and any custom fields that were modified. The output can be used downstream for further processing or confirmation of the update operation.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authentication to the external service managing organization documents.
  • The base URL for the API must be configured in the node credentials.
  • The node uses HTTP requests with JSON payloads to communicate with the external API.

Troubleshooting

  • Common issues:

    • Invalid or missing organization or document IDs will cause the update to fail.
    • Incorrect JSON format in the "Fields" property may result in parsing errors.
    • Authentication failures if the API key or base URL is misconfigured.

  • Error messages and resolutions:

    • "Document not found": Verify that the provided organization and document IDs are correct.
    • "Invalid JSON format": Ensure the JSON entered in the "Fields" property is valid and properly formatted.
    • "Authentication failed": Check that the API key credential is correctly set up and has necessary permissions.

Links and References

  • Refer to the external API documentation for organization document management for detailed field descriptions and update constraints.
  • JSON validation tools can help ensure the correctness of the "Fields" input.

Discussion