All REST Endpoints

Content (IM)/Categories

The Categories (categories) resource lets you view Category objects for the products and categories in the Oracle Knowledge Repository.

Category objects allow the author of the content to categorize the content into specific groups. These objects are used to label the content to make the content more searchable. Category objects are also used to integrate repository data with external system. When integrating with an external system, Category objects can be identified by their externalType and externalId parameters.

Children
Method: get
Path: /km/api/v1/categories/{id}/children
Find all
Method: get
Path: /km/api/v1/categories
Find by ID
Method: get
Path: /km/api/v1/categories/{id}
Find categories by name
Method: get
Path: /km/api/v1/categories/findByName
Content (IM)/Content
The Content (content) resource lets you manage Content objects in the Oracle Knowledge Repository.
Change owner
Method: post
Path: /km/api/v1/content/versions/{versionId}/changeOwner
Check in content
Method: post
Path: /km/api/v1/content/{id}/checkIn
Check out content
Method: post
Path: /km/api/v1/content/{id}/checkOut
Create
Method: post
Path: /km/api/v1/content
Create content from import
Method: post
Path: /km/api/v1/content/import
Delete
Method: delete
Path: /km/api/v1/content/{id}
Delete localized versions
Method: delete
Path: /km/api/v1/content/{id}/deleteLocalizedVersions/{localeCode}
Find all
Method: get
Path: /km/api/v1/content
Find all translations by answer ID
Method: get
Path: /km/api/v1/content/answers/{answerId}/allTranslations
Find all translations by content ID
Method: get
Path: /km/api/v1/content/{id}/allTranslations
Find all translations by doc ID
Method: get
Path: /km/api/v1/content/docId/{docId}/allTranslations
Find all translations by version ID
Method: get
Path: /km/api/v1/content/versions/{versionId}/allTranslations
Find by answer ID
Method: get
Path: /km/api/v1/content/answers/{answerId}
Find by answer ID as user
Method: get
Path: /km/api/v1/content/answers/{answerId}/asUser/{userId}
Find by doc ID
Method: get
Path: /km/api/v1/content/docId/{docId}
Find by ID
Method: get
Path: /km/api/v1/content/{id}
Find by version ID
Method: get
Path: /km/api/v1/content/versions/{versionId}
Get aggregate rating result
Method: get
Path: /km/api/v1/content/{id}/ratingsAggregate
Get all versions by content ID
Method: get
Path: /km/api/v1/content/{id}/allVersions
Get all versions for answer ID
Method: get
Path: /km/api/v1/content/answers/{answerId}/allVersions
Get all versions for document ID
Method: get
Path: /km/api/v1/content/docId/{docId}/allVersions
Get categories
Method: get
Path: /km/api/v1/content/{id}/categories
Get document links by answer ID
Method: get
Path: /km/api/v1/content/answers/{answerId}/documentLinks
Get document links by doc ID
Method: get
Path: /km/api/v1/content/docId/{docId}/documentLinks
Get history by answer ID
Method: get
Path: /km/api/v1/content/answers/{answerId}/history
Get history by document ID
Method: get
Path: /km/api/v1/content/docId/{docId}/history
Get history by ID
Method: get
Path: /km/api/v1/content/{id}/history
Get history by version ID
Method: get
Path: /km/api/v1/content/versions/{versionId}/history
Get incident links
Method: get
Path: /km/api/v1/content/{id}/incidentLinks
Get learned links by answer ID
Method: get
Path: /km/api/v1/content/answers/{answerId}/documentLinks/learned
Get learned links by doc ID
Method: get
Path: /km/api/v1/content/docId/{docId}/documentLinks/learned
Get manual links by answer ID
Method: get
Path: /km/api/v1/content/answers/{answerId}/documentLinks/manual
Get manual links by doc ID
Method: get
Path: /km/api/v1/content/docId/{docId}/documentLinks/manual
Get rating results
Method: get
Path: /km/api/v1/content/{id}/ratings
Get user groups
Method: get
Path: /km/api/v1/content/{id}/userGroups
Get views
Method: get
Path: /km/api/v1/content/{id}/views
Publish all version in all locales
Method: post
Path: /km/api/v1/content/{id}/publishAllVersionInAllLocales
Publish all version in this locale
Method: post
Path: /km/api/v1/content/{id}/publishAllVersionInThisLocale/{localeCode}
Publish this version
Method: post
Path: /km/api/v1/content/versions/{versionId}/publishThisVersion
Rate content
Method: post
Path: /km/api/v1/content/{id}/rate
Translate
Method: post
Path: /km/api/v1/content/{versionId}/translate
Unpublish all version in all locales
Method: post
Path: /km/api/v1/content/{id}/unpublishAllVersionInAllLocales
Unpublish all version in this locale
Method: post
Path: /km/api/v1/content/{id}/unpublishAllVersionInThisLocale/{localeCode}
Unpublish this version
Method: post
Path: /km/api/v1/content/versions/{versionId}/unpublishThisVersion
Update
Method: put
Path: /km/api/v1/content/{id}
Update content from import
Method: put
Path: /km/api/v1/content/{id}/import
Content (IM)/Content Recommendations

The Content Recommendations (contentRecommendations) resource allows users, with or without authoring rights, to recommend changes to the content in the Oracle Knowledge Repository. The user can recommend the creation of a new content, or modification of existing content, by providing supporting materials. The author of the content can create or modify the content according to the recommendations from the end users.

The Content Recommendations resource allows authors to manage ContentRecommendation objects in the Oracle Knowledge Repository.

Create
Method: post
Path: /km/api/v1/contentRecommendations
Delete
Method: delete
Path: /km/api/v1/contentRecommendations/{id}
Find all
Method: get
Path: /km/api/v1/contentRecommendations
Find by ID
Method: get
Path: /km/api/v1/contentRecommendations/{id}
Get categories
Method: get
Path: /km/api/v1/contentRecommendations/{id}/categories
Get views
Method: get
Path: /km/api/v1/contentRecommendations/{id}/views
Replace all categories
Method: patch
Path: /km/api/v1/contentRecommendations/{id}/categories
Replace all views
Method: patch
Path: /km/api/v1/contentRecommendations/{id}/views
Update
Method: put
Path: /km/api/v1/contentRecommendations/{id}
Content (IM)/Content Types

The Content Types (contentTypes) resource lets you view Content Types in the Oracle Knowledge Repository. You cannot create or update the content type, because Oracle Knowledge Management Console manages the resource.

Find all
Method: get
Path: /km/api/v1/contentTypes
Find by ID
Method: get
Path: /km/api/v1/contentTypes/{id}
Find content schema attributes
Method: get
Path: /km/api/v1/contentTypes/{contentTypeId}/contentSchema
Find meta schema attributes
Method: get
Path: /km/api/v1/contentTypes/{contentTypeId}/metaSchema
Get categories
Method: get
Path: /km/api/v1/contentTypes/{contentTypeId}/categories
Get content type privileges for active user
Method: get
Path: /km/api/v1/contentTypes/privileges
Get custom metrics
Method: get
Path: /km/api/v1/contentTypes/{id}/customMetrics
Get optional categories
Method: get
Path: /km/api/v1/contentTypes/{contentTypeId}/optionalCategories
Get public document count
Method: get
Path: /km/api/v1/contentTypes/{contentTypeId}/publicDocumentCount
Get required categories
Method: get
Path: /km/api/v1/contentTypes/{contentTypeId}/requiredCategories
Get translation request locales
Method: get
Path: /km/api/v1/contentTypes/{id}/translationRequestLocales
Get user groups
Method: get
Path: /km/api/v1/contentTypes/{id}/userGroups
Content (IM)/Content User Visits

The Content User Visits (contentUserVisits) resource lets you view the ContentUserVisit objects in the Oracle Knowledge Repository.

ContentUserVisit objects track the number of visits that end users pay to the content. This is used to find highly viewed content and to find the authors who created the content. It is also used to identify the content that may need retirement due to lack of views.

Find all
Method: get
Path: /km/api/v1/contentUserVisits
Find by ID
Method: get
Path: /km/api/v1/contentUserVisits/{id}
Content (IM)/Data Forms
Services for managing Data Forms objects.
Find all
Method: get
Path: /km/api/v1/dataForms
Find by ID
Method: get
Path: /km/api/v1/dataForms/{id}
Get questions
Method: get
Path: /km/api/v1/dataForms/{id}/questions
Get views
Method: get
Path: /km/api/v1/dataForms/{id}/views
Rate content
Method: post
Path: /km/api/v1/dataForms/{contentId}/rateContent
Content (IM)/Data Lists
Services for managing Data Lists objects.
Find all
Method: get
Path: /km/api/v1/dataLists
Find by ID
Method: get
Path: /km/api/v1/dataLists/{id}
Get data list filters
Method: get
Path: /km/api/v1/dataLists/{id}/dataListFilters
Get data list items
Method: get
Path: /km/api/v1/dataLists/{id}/dataListItems
Content (IM)/Incident Links

The Incident Links (incidentLinks) resource lets you view the link between an Incident object and a Content object in the Oracle Knowledge Repository. Incident Links can be managed through the Incidents (incidents) resource.

Find all
Method: get
Path: /km/api/v1/incidentLinks
Find by ID
Method: get
Path: /km/api/v1/incidentLinks/{id}
Content (IM)/Incidents

The Incidents (incidents) resource lets you manage links between Incident object and Content objects in the Oracle Knowledge Repository.

The end user links a Content object with an Incident object when the content is related to the incident or when the Content object solves a problem related to the Incident object.

Delete
Method: delete
Path: /km/api/v1/incidents/{id}
Find all
Method: get
Path: /km/api/v1/incidents
Find by ID
Method: get
Path: /km/api/v1/incidents/{id}
Incident links
Method: get
Path: /km/api/v1/incidents/{id}/incidentLinks
Link
Method: post
Path: /km/api/v1/incidents/link
Unlink
Method: post
Path: /km/api/v1/incidents/unlink
Update
Method: put
Path: /km/api/v1/incidents/{id}
Content (IM)/Knowledge Interaction

The knowledge interaction resource is used to create a unique session identifier for every unique user session. The session identifier is called knowledge interaction ID, which is used for session management, analytics, and billing purposes for Content (IM) and Search endpoints.

Start interaction
Method: get
Path: /km/api/v1/knowledgeInteraction/startInteraction
Content (IM)/Languages

The Languages (languages) resource lets you view the languages available in the Oracle Knowledge Repository. A Language object is identified by the language it represents.

Find all
Method: get
Path: /km/api/v1/languages
Find by ID
Method: get
Path: /km/api/v1/languages/{id}
Get locales
Method: get
Path: /km/api/v1/languages/{id}/locales
Content (IM)/Locales

The Locales (locales) resource lets you view the locale objects available in the Oracle Knowledge system. Locale objects are identified by the language and the country it represents.

The Locale objects differs form the Language objects as the Language objects are identified only by specific language and not by the country. For example, the Language object that represents English has two Locale objects in the system, they are English United States and English Great Britain. For each Language, only one Locale is set as the group default. For example, English United States is the default locale for the group of Locale objects representing the English Language.

The system assigns Locale objects to users for displaying information in the user interface and for authoring purposes. Content can be authored and translated to many Locale objects to provide global access to content.

Find all
Method: get
Path: /km/api/v1/locales
Find by ID
Method: get
Path: /km/api/v1/locales/{id}
Content (IM)/Media

The Media (/media) resource lets you manage media items in the Oracle Knowledge repository.

Create media
Method: post
Path: /km/api/v1/media
Delete media
Method: post
Path: /km/api/v1/media/deleteMedia
Get media
Method: get
Path: /km/api/v1/media
Update media
Method: put
Path: /km/api/v1/media
Content (IM)/Replacement Tokens

The Replacement Tokens (replacementTokens) resource lets you manage the ReplacementToken objects in the Oracle Knowledge Repository. Replacement Tokens are used by authors to create a short, manageable term (the tokenName), that can represent standardized, translatable, and sometimes complex content, such as integrated text, images, lists, and tables (the replacementText). Authors reuse the replacementTokens (referenced by tokenName) objects in multiple Content objects and in multiple translations of those Content. When the Content objects are displayed to end-users for a specific translation, any text containing a tokenName is replaced with the token's replacementText for the specified Locale.

Create
Method: post
Path: /km/api/v1/replacementTokens
Delete
Method: delete
Path: /km/api/v1/replacementTokens/{id}
Find all
Method: get
Path: /km/api/v1/replacementTokens
Find by ID
Method: get
Path: /km/api/v1/replacementTokens/{id}
Update
Method: put
Path: /km/api/v1/replacementTokens/{id}
Content (IM)/Repositories

The Repositories (repositories) resource lets you view and manage the Locale objects and Category objects associated with a specific, or the default repository in the Oracle Knowledge system.

The default Repository is the one in which the API user is currently logged in.

Get available locales
Method: get
Path: /km/api/v1/repositories/{id}/availableLocales
Get categories assigned to view
Method: get
Path: /km/api/v1/repositories/{id}/categoriesAssignedToView
Get default available locales
Method: get
Path: /km/api/v1/repositories/default/availableLocales
Get default categories assigned to view
Method: get
Path: /km/api/v1/repositories/default/categoriesAssignedToView
Replace all available locales
Method: patch
Path: /km/api/v1/repositories/{id}/availableLocales
Replace all categories assigned to view
Method: patch
Path: /km/api/v1/repositories/{id}/categoriesAssignedToView
Content (IM)/Suggested Search
The Suggested Search (suggestedSearch) resource lets you query the lucene index stored in the Oracle Knowledge repository and then retrieve the article titles which partially or completely contain the specified search-keyword.
Get suggested articles
Method: get
Path: /km/api/v1/suggestedSearch
Content (IM)/Tasks

The Tasks (tasks) resource lets you manage all types of tasks in the Oracle knowledge Repository. You can assign, unassign, and close tasks using this resource. You cannot create or update tasks, because a task is created in association with the process flow of associated resource. For example, a content expiration task is created when a content in the Oracle Knowledge Repository is about to expire.

Assign task
Method: post
Path: /km/api/v1/tasks/assignTask
Close task
Method: post
Path: /km/api/v1/tasks/closeTask
Find all
Method: get
Path: /km/api/v1/tasks
Find by ID
Method: get
Path: /km/api/v1/tasks/{id}
Un assign task
Method: post
Path: /km/api/v1/tasks/unassignTask
Content (IM)/Tasks/Content Change Tasks
Services to view ContentChangeTask objects. Both CREATE and UPDATE is disallowed since task will be generated as a result of completion of a Content Change (publish/unpublish) process flow.
Find all
Method: get
Path: /km/api/v1/tasks/contentChangeTasks
Find by ID
Method: get
Path: /km/api/v1/tasks/contentChangeTasks/{id}
Content (IM)/Tasks/Content Expiration Tasks

The Content Expiration Tasks (contentExpirationTasks) resource lets you manage the tasks associated with the contents that are close to expiry in the Oracle Knowledge Repository. A task is created for each content that are close to expiry. You cannot create or update these tasks, because they are generated as a part of the content process flow.

Find all
Method: get
Path: /km/api/v1/tasks/contentExpirationTasks
Find by ID
Method: get
Path: /km/api/v1/tasks/contentExpirationTasks/{id}
Content (IM)/Tasks/Content Recommendation Tasks

The Content Recommendation Tasks (contentRecommendationTasks) resource lets you view tasks which are created as a result of the content recommendations. Both create and update are not allowed because the task is handled along with contentRecommendations resource and does not have an independent existence.

Delete
Method: delete
Path: /km/api/v1/tasks/contentRecommendationTasks/{id}
Find all
Method: get
Path: /km/api/v1/tasks/contentRecommendationTasks
Find by ID
Method: get
Path: /km/api/v1/tasks/contentRecommendationTasks/{id}
Content (IM)/Tasks/Review Date Tasks

The Review Date Tasks (reviewDateTasks) resource lets you view ReviewDateTask objects in the Oracle Knowledge repository. Both create and update are not allowed because the task is generated as a result of completion of a content review date process flow.

Find all
Method: get
Path: /km/api/v1/tasks/reviewDateTasks
Find by ID
Method: get
Path: /km/api/v1/tasks/reviewDateTasks/{id}
Content (IM)/Tasks/Translation Tasks

The Translation Tasks (translationTasks) resource lets you view TranslationTask objects in the Oracle Knowledge repository. Both create and update are not allowed because the task is generated as a result of the completion of a content translation process flow.

Find all
Method: get
Path: /km/api/v1/tasks/translationTasks
Find by ID
Method: get
Path: /km/api/v1/tasks/translationTasks/{id}
Content (IM)/Tasks/Workflow Changed Tasks

The Workflow Changed Tasks (workflowChangedTasks) resource lets you view WorkflowChangedTask objects in the Oracle Knowledge repository. Both create and update are not allowed as the task is generated after the completion of workflow approvals, workflow rejects or workflow step process flow.

Find all
Method: get
Path: /km/api/v1/tasks/workflowChangedTasks
Find by ID
Method: get
Path: /km/api/v1/tasks/workflowChangedTasks/{id}
Content (IM)/Tasks/Workflow Expiration Tasks

The Workflow Expiration Task (workflowExpirationTask) resource lets you view WorkflowExpirationTask objects in the Oracle Knowledge repository. Both create and update are not allowed because the task is generated as a result of expiration of Workflow process flow.

Find all
Method: get
Path: /km/api/v1/tasks/workflowExpirationTasks
Find by ID
Method: get
Path: /km/api/v1/tasks/workflowExpirationTasks/{id}
Content (IM)/Tasks/Workflow Tasks

The Workflow Task (workflowTask) resource lets you view WorkflowTask objects in the Oracle Knowledge repository. Both create and update are not allowed because the task is generated as a result of completion of a content type Workflow process-flow.

Find all
Method: get
Path: /km/api/v1/tasks/workflowTasks
Find by ID
Method: get
Path: /km/api/v1/tasks/workflowTasks/{id}
Content (IM)/User Groups

The User Groups (userGroups) resource lets you access the UserGroup objects in the Oracle Knowledge Repository.

Find all
Method: get
Path: /km/api/v1/userGroups
Find by external ID
Method: get
Path: /km/api/v1/userGroups/accessLevel/{externalId}
Find by ID
Method: get
Path: /km/api/v1/userGroups/{id}
Find by reference key
Method: get
Path: /km/api/v1/userGroups/referenceKey/{referenceKey}
Content (IM)/User Key Values

The User Key Values (userKeyValues) resource lets you manage User Key Value objects in the Oracle Knowledge repository.

Create
Method: post
Path: /km/api/v1/users/{userId}/userKeyValues
Delete
Method: delete
Path: /km/api/v1/userKeyValues/{id}
Find all
Method: get
Path: /km/api/v1/users/{userId}/userKeyValues
Find by ID
Method: get
Path: /km/api/v1/users/{userId}/userKeyValues/{id}
Update
Method: put
Path: /km/api/v1/users/{userId}/userKeyValues/{id}
Content (IM)/Users

The Users (users) resource let you access the Users objects in the Oracle Knowledge repository. The User object is used to modify the subscription information associated with a specified user within the Oracle Knowledge repository.

Activate subscription
Method: post
Path: /km/api/v1/users/{id}/subscriptions/{subscriptionId}/activate
Add subscription
Method: post
Path: /km/api/v1/users/{id}/subscriptions
Deactivate subscription
Method: post
Path: /km/api/v1/users/{id}/subscriptions/{subscriptionId}/deactivate
Delete all subscriptions
Method: delete
Path: /km/api/v1/users/{id}/subscriptions
Delete subscription
Method: delete
Path: /km/api/v1/users/{id}/subscriptions/{subscriptionId}
Find by ID
Method: get
Path: /km/api/v1/users/{id}
Find subscription by ID
Method: get
Path: /km/api/v1/users/{id}/subscriptions/{subscriptionId}
Get content locales
Method: get
Path: /km/api/v1/users/{id}/contentLocales
Get custom key values
Method: get
Path: /km/api/v1/users/{id}/customKeyValues
Get data form notifications
Method: get
Path: /km/api/v1/users/{id}/dataFormNotifications
Get subscriptions
Method: get
Path: /km/api/v1/users/{id}/subscriptions
Replace all content locales
Method: patch
Path: /km/api/v1/users/{id}/contentLocales
Replace all custom key values
Method: patch
Path: /km/api/v1/users/{id}/customKeyValues
Replace all data form notifications
Method: patch
Path: /km/api/v1/users/{id}/dataFormNotifications
Replace all subscriptions
Method: patch
Path: /km/api/v1/users/{id}/subscriptions
Content (IM)/Views
Services for managing View objects.
Find all
Method: get
Path: /km/api/v1/views
Find by ID
Method: get
Path: /km/api/v1/views/{id}
Get categories
Method: get
Path: /km/api/v1/views/{id}/categories
Get interface mapping
Method: get
Path: /km/api/v1/views/getInterfaceMapping
Get user groups
Method: get
Path: /km/api/v1/views/{id}/userGroups
Search/Contact Deflection
Service for contact deflection
Ask question
Method: post
Path: /srt/api/v1/contactDeflection/question
Initial screen
Method: post
Path: /srt/api/v1/contactDeflection/initial
Respond contact
Method: post
Path: /srt/api/v1/contactDeflection/response
Search/Search

This method returns an HTTP response containing the Allow and Link header.

Answer
Method: post
Path: /srt/api/v1/search/answer
Ask question
Method: post
Path: /srt/api/v1/search/question
Initial screen
Method: post
Path: /srt/api/v1/search/initialScreen
Navigate
Method: post
Path: /srt/api/v1/search/navigation
Page results
Method: post
Path: /srt/api/v1/search/pagination
Record feedback
Method: post
Path: /srt/api/v1/search/feedback