NinjaOne icon

NinjaOne

Consume NinjaOne API

Actions158

Organization Documents → Archive Client Document

AI-generated

Overview

This node interacts with the NinjaOne API to perform various operations related to organizational data. Specifically, for the "Organization Documents" resource and the "Archive Client Document" operation, it archives a client document identified by its ID. This is useful in scenarios where you want to programmatically manage document lifecycle within an organization, such as archiving outdated or irrelevant client documents to keep the system organized.

Practical examples include:

  • Automatically archiving client documents after a certain date or event.
  • Integrating document management workflows into broader automation processes.
  • Cleaning up document repositories by archiving documents that meet specific criteria.

Properties

Name Meaning
Client Document Id The unique numeric identifier of the client document to be archived. This property is required.

Output

The node outputs JSON data representing the response from the NinjaOne API after attempting to archive the specified client document. The structure typically includes confirmation of the archival action or details about the archived document.

If the node encounters an error during execution (e.g., invalid document ID), the output JSON will contain an error field with the error message.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the NinjaOne API using OAuth2 authentication.
  • The node depends on the NinjaOne API endpoint for archiving client documents.
  • Proper configuration of the NinjaOne OAuth2 API credentials within n8n is necessary.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Client Document Id will result in an error.
    • Missing or incorrect API credentials will cause authentication failures.
    • Network connectivity problems can prevent successful API calls.
  • Error messages:

    • "No binary data exists on item!" or similar errors are not relevant here since this operation does not handle binary data.
    • API errors returned from NinjaOne will appear in the output's error field if "Continue On Fail" is enabled.
  • Resolutions:

    • Verify the Client Document Id is correct and exists in the NinjaOne system.
    • Ensure the NinjaOne OAuth2 credentials are properly set up and valid.
    • Check network connectivity and API availability.

Links and References

Discussion