Knowledge Base 2.0 in REST 3.0: Section Overview

Knowledge Base 2.0 helps collect internal company materials: regulations, instructions, training texts, and other documents. You can maintain multiple knowledge bases, build a page hierarchy, restrict access, and collaborate on content.

The section methods work with several groups of objects:

• Knowledge Bases — create a knowledge base, retrieve data and field schemas, rename, archive, and move to the shopping cart
• Documents — create documents, retrieve the page tree and content, search for documents, retrieve field schemas for documents, the tree, and search, and archive or delete page subtrees
• Files — upload a file to a document, retrieve data and field schemas, and return a Markdown block for inserting an attachment

Quick navigation: all methods

User documentation: Knowledge Base 2.0

Getting StartedGetting Started

1. Create a knowledge base using the note.collection.add method if you do not already have a container for documents
2. Retrieve a list of available knowledge bases using the note.collection.list method if you need to work with an existing structure
3. Retrieve data for a single knowledge base using the note.collection.get method if you need to open a selected knowledge base by its ID
4. Retrieve knowledge base fields using the note.collection.field.list and note.collection.field.get methods if you are building a form or a table on your side
5. Create a root document using the note.document.add method
6. Retrieve the document tree using the note.document.tree.list method if you need to display the page structure
7. Read an individual document using the note.document.get method or search for documents using the note.document.search.list method
8. Retrieve fields for documents, the tree, and search using methods note.document.field.*, note.document.tree.field.*, note.document.search.field.*
9. Update a document heading and content using the note.document.update method
10. Upload images, videos, and standard files using the note.file.add method
11. Use the assetMarkdown from the note.file.add response or retrieve it using the note.file.get method, then add the attachment to a document via note.document.update
12. Retrieve file fields using the note.file.field.list and note.file.field.get methods if you are building your own form or table
13. Archive or delete a knowledge base and documents using the corresponding methods when you need to finish working with the materials

Limitations and RecommendationsLimitations and Recommendations

• Document archiving and deletion methods operate on the entire subtree rather than a single page. If a document has child pages, they will also be archived or moved to the shopping cart.
• Access to view and edit Knowledge bases, documents, and files depends on the current user's permissions. The same scenario may be available to some employees and unavailable to others.

Connection with Other ObjectsConnection with Other Objects

Documents. The Knowledge base is populated with documents. You can first create a root page and then add child pages to it to build a tree of materials organized by topic. To do this, specify the Knowledge base where the document should appear when creating a document, and for nested pages, additionally provide the parent document.

Files. Files are added to a specific document rather than the entire Knowledge base. First, upload a file using the note.file.add method, then retrieve the assetMarkdown from the method response or obtain it using the note.file.get method. After that, update the document content using the note.document.update method so that the attachment appears in the page text.

Overview of MethodsOverview of Methods

Scope: note

Who can execute the methods: depends on the method

Knowledge BasesKnowledge Bases

Method	Description
note.collection.add	Creates a knowledge base
note.collection.update	Renames a knowledge base
note.collection.get	Returns a single knowledge base by ID
note.collection.list	Returns a list of knowledge bases available to the user
note.collection.delete	Moves a knowledge base to the trash
note.collection.archive	Archives a knowledge base
note.collection.field.get	Returns the description of a knowledge base field
note.collection.field.list	Returns a list of knowledge base fields

DocumentsDocuments

Method	Description
note.document.add	Creates a document
note.document.update	Updates the title and content of a document
note.document.get	Returns a document with content in Markdown
note.document.delete	Moves a document and its child pages to the trash
note.document.archive	Archives a document and its child pages
note.document.tree.list	Returns the document tree of a single knowledge base
note.document.search.list	Searches for documents by title and content
note.document.field.get	Returns the description of a document field
note.document.field.list	Returns a list of document fields
note.document.tree.field.get	Returns the description of a document tree field
note.document.tree.field.list	Returns a list of document tree fields
note.document.search.field.get	Returns the description of a document search result field
note.document.search.field.list	Returns a list of document search result fields

FilesFiles

Method	Description
note.file.add	Uploads a file to a document
note.file.get	Returns the document file data and a Markdown block for insertion into the document
note.file.field.get	Returns the description of a document file field
note.file.field.list	Returns a list of document file fields

Continue LearningContinue Learning

• Knowledge Base 2.0: Methods Overview
• Documents in Knowledge Base 2.0: Methods Overview
• Files in Knowledge Base 2.0: Methods Overview
• Overview of REST API 3.0