API description

OpenKM API classes:

OpenKM API classDescription

OKMAuth

Manage security and users. For example add or remove grants on a node, create or modify users or getting profiles.

OKMBookmark

Manage user bookmarks.

OKMDashboard

Manage all data shown on the dashboard.

OKMDocument

Manage documents. For example, create, move or delete a document.

OKMFolder

Manage folders. For example, create, move or delete a folder.

OKMMail

Manage mail. For example, create, move or delete mail.

OKMNote

Manage notes on any node type. For example, create, edit or delete a note on a document, folder, mail or record.

OKMNotification

Manage notifications. For example, add or remove subscriptions on a document or a folder.

OKMProperty

Manage categories and keywords. For example, add or remove keywords on a document, folder, mail or record.

OKMPropertyGroup

Manage metadata. For example, add metadata groups or set metadata fields.

OKMRecord

Manage records. For example, create, move or delete a record. 

OKMRelation

Manage relations between nodes. For example, create a relation (parent-child) between two documents.

OKMReport 

Manage reports.

OKMRepository

Many procedures related to the repository. For example, get the properties of main root node (/okm:root).

OKMSearch

Manage the search feature. For example, manage saved queries or perform a new query to the repository.

OKMStats

General stats of the repository.

OKMTask

Manage tasks. For example, create a new task.

OKMUserConfig

Manage user home configuration.

OKMWorkflow

Manage workflows. For example, execute a new workflow.