NinjaOne icon

NinjaOne

Consume NinjaOne API

Actions158

Document Templates → Archive Document Template

AI-generated

Overview

This node interacts with the NinjaOne API to manage Document Templates, specifically allowing users to archive a document template by its ID. Archiving a document template typically means marking it as inactive or removing it from active use without deleting it permanently. This operation is useful in scenarios where you want to keep a record of templates but prevent them from being used further.

Practical examples:

  • Automatically archiving outdated document templates as part of a cleanup workflow.
  • Archiving templates that are no longer relevant after a project completion.
  • Managing document lifecycle by programmatically controlling template availability.

Properties

Name Meaning
Document Template Id The unique numeric identifier of the document template to be archived.

Output

The node outputs an array of JSON objects, each representing the response from the NinjaOne API for the archive operation. The exact structure depends on the API response but generally includes confirmation of the archival action or details about the archived template.

No binary data output is involved in this operation.

Dependencies

  • Requires an API authentication token credential configured in n8n to authenticate requests to the NinjaOne API.
  • The node uses the NinjaOne OAuth2 API credential for authorization.
  • Network access to the NinjaOne API endpoint is necessary.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Document Template Id will likely result in an error from the API.
    • Missing or incorrect API credentials will cause authentication failures.
    • Lack of network connectivity or API downtime can cause request failures.
  • Error messages and resolutions:

    • "No binary data exists on item!" — Not applicable here since this operation does not require binary input.
    • API errors related to invalid IDs or permissions should be resolved by verifying the Document Template Id and ensuring the API credentials have sufficient permissions.
    • If the node throws an error about missing parameters, ensure the "Document Template Id" property is set and is a valid number.

Links and References

Discussion