REST API for Knowledge Management with the Redwood User Experience

All REST Endpoints

Articles

The Articles resource lets you create, update, view, delete, and manage knowledge articles. You can also perform additional operations such as publish, translate, and import knowledge articles as part of the knowledge management life cycle. An article object stores information about knowledge articles.

Create an article: Method: post
Path: /articles
Get all knowledge articles: Method: get
Path: /articles
Get an article: Method: get
Path: /articles/{id}
Publish an article: Method: post
Path: /articles/versions/{versionId}/publishThisVersion
Rate an article: Method: post
Path: /articles/{id}/rate
Update an article: Method: put
Path: /articles/{id}

Content Types

The operations from the Content Types category.

Create a content type: Method: post
Path: /contentTypes
Delete a content type: Method: delete
Path: /contentTypes/{id}
Get a content type: Method: get
Path: /contentTypes/{id}
Get a content type's schema: Method: get
Path: /contentTypes/{contentTypeId}/contentSchema
Get all content type privileges for current user: Method: get
Path: /contentTypes/privileges
Get all content types: Method: get
Path: /contentTypes
Replace a content type: Method: put
Path: /contentTypes/{id}
Update a content type: Method: patch
Path: /contentTypes/{id}

Repositories

The Repositories resource lets you view and update the Content Intelligence locale configuration in your environment.

Get all active locales for a repository: Method: get
Path: /repositories/{id}/availableLocales
Get the default repository: Method: get
Path: /repositories/default
Get the default repository's preferred locale: Method: get
Path: /repositories/default/defaultPreferredLocale
Replace all available locales for a repository: Method: put
Path: /repositories/{id}/availableLocales
Update a repository's default locale: Method: patch
Path: /repositories/{id}/defaultLocale
Update the default repository's preferred locale: Method: patch
Path: /repositories/default/defaultPreferredLocale

The Search resource allows you to search for knowledge and to find knowledge similar to SRs.

Get all knowledge articles: Method: get
Path: /search
Get knowledge articles by service request: Method: post
Path: /search

Tasks

The Tasks resource allows you to interact with knowledge related tasks such as suggestions and workflow tasks.

Create a task: Method: post
Path: /tasks

User Groups

The operations from the User Groups category.

Create a user group: Method: post
Path: /userGroups
Delete a user group: Method: delete
Path: /userGroups/{id}
Get a user group: Method: get
Path: /userGroups/{id}
Get a user group by name: Method: get
Path: /userGroups/findByName
Get all user groups: Method: get
Path: /userGroups
Replace a user group: Method: put
Path: /userGroups/{id}