Outline icon

Outline

Interact with Outline knowledge base
Join our community

Actions53

Overview

This node interacts with the Outline knowledge base service, providing various operations on different resources such as documents, collections, users, groups, comments, and more. Specifically, for the Document resource with the Move operation, it allows moving a document to a different collection or changing its parent document within the Outline system.

This is useful in scenarios where you want to reorganize your knowledge base content programmatically, such as:

  • Moving a document from one collection to another to reflect changes in categorization.
  • Changing the hierarchical structure by assigning a new parent document.
  • Adjusting the order of documents within a collection or under a parent document.

For example, if you have a document that was initially created in a general collection but later needs to be moved to a more specific collection, this operation automates that process without manual intervention.

Properties

Name Meaning
Document ID The unique identifier of the document to move (required).
Target Collection ID The ID of the collection to which the document should be moved (optional).
Parent Document ID The ID of the new parent document under which this document will be placed (optional).

Output

The output is a JSON object representing the response from the Outline API after attempting to move the document. This typically includes details about the updated document, such as its new collection ID, parent document ID, and possibly other metadata reflecting the change.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Outline knowledge base API.
  • The node makes HTTP POST requests to the Outline API endpoints.
  • Proper configuration of the API authentication credential in n8n is necessary.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Document ID will result in an error from the API.
    • Specifying a Target Collection ID or Parent Document ID that does not exist or is inaccessible may cause the move operation to fail.
    • Insufficient permissions for the API key to modify documents or collections can lead to authorization errors.

  • Error messages:

    • Errors returned from the Outline API are passed through; typical messages might include "Document not found", "Collection not found", or "Permission denied".
    • To resolve these, verify that all IDs are correct and that the API key has sufficient rights.

Links and References

Discussion