すべてのRESTエンドポイント
コンテンツ(IM)/Articleステータス
記事ステータス・リソースを使用すると、ナレッジ管理者はナレッジ項目の記事ステータスを作成、変更または削除できます。 記事ステータスは、ナレッジ管理ライフ・サイクルの記事のステータスを示します。 作成者の場合は、必要に応じて、ナレッジ記事に記事ステータスを割り当てることができます。
- 記事ステータスの作成
- メソッド: postパス:
/km/api/v1/articleStatus - 記事ステータスの削除
- メソッド: deleteパス:
/km/api/v1/articleStatus/{id} - すべての記事のステータスを取得
- メソッド: getパス:
/km/api/v1/articleStatus - 記事ステータスの取得
- メソッド: getパス:
/km/api/v1/articleStatus/{id} - 記事ステータスの設定
- メソッド: postパス:
/km/api/v1/articleStatus/control/{action} - 記事ステータスの更新
- メソッド: 着るパス:
/km/api/v1/articleStatus/{id}
コンテンツ(IM)/Categories
カテゴリ・リソースを使用すると、特性またはビジネス要件別にナレッジ項目をグループ化できます。 カテゴリは、簡単に識別できるようにナレッジ記事をグループ化する手段です。 たとえば、ナレッジ記事は、インストールやオーダー・ステータスなど、記事のサブジェクト領域に基づいて分類できます。
- カテゴリの取得
- メソッド: getパス:
/km/api/v1/categories/{id} - すべてのカテゴリの取得
- メソッド: getパス:
/km/api/v1/categories - 子カテゴリの取得
- メソッド: getパス:
/km/api/v1/categories/{id}/children
コンテンツ(IM)/Content
コンテンツ・リソースを使用すると、ナレッジ記事を作成、更新、表示、削除および管理できます。 ナレッジ管理のライフサイクルの一環として、ナレッジ記事の公開、翻訳、インポートなどの追加操作を実行することもできます。 コンテンツ・オブジェクトには、ナレッジ記事に関する情報が格納されます。
- コンテンツのチェックイン
- メソッド: postパス:
/km/api/v1/content/{id}/checkIn - コンテンツのチェックアウト
- メソッド: postパス:
/km/api/v1/content/{id}/checkOut - コンテンツ・チェックアウトのクリア
- メソッド: postパス:
/km/api/v1/content/versions/{versionId}/clearCheckOut - コンテンツの作成
- メソッド: postパス:
/km/api/v1/content - インポートからのコンテンツの作成
- メソッド: postパス:
/km/api/v1/content/import - ロケール内のコンテンツのすべてのバージョンを削除
- メソッド: deleteパス:
/km/api/v1/content/{id}/deleteLocalizedVersions/{localeCode} - コンテンツの削除
- メソッド: deleteパス:
/km/api/v1/content/{id} - アンサーIDで記事を検索
- メソッド: getパス:
/km/api/v1/content/articles/{answerId} - 総合評価結果の取得
- メソッド: getパス:
/km/api/v1/content/{id}/ratingsAggregate - コンテンツに割り当てられたすべてのカテゴリの取得
- メソッド: getパス:
/km/api/v1/content/{id}/categories - すべてのコンテンツを取得
- メソッド: getパス:
/km/api/v1/content - すべての翻訳済コンテンツの取得
- メソッド: getパス:
/km/api/v1/content/{id}/allTranslations - アンサーIDによるすべての翻訳済コンテンツの取得
- メソッド: getパス:
/km/api/v1/content/answers/{answerId}/allTranslations - ドキュメントIDによるすべての翻訳済コンテンツの取得
- メソッド: getパス:
/km/api/v1/content/docId/{docId}/allTranslations - バージョンIDによるすべての翻訳済コンテンツの取得
- メソッド: getパス:
/km/api/v1/content/versions/{versionId}/allTranslations - コンテンツに割り当てられたすべてのユーザー・グループを取得
- メソッド: getパス:
/km/api/v1/content/{id}/userGroups - コンテンツのすべてのバージョンを取得
- メソッド: getパス:
/km/api/v1/content/{id}/allVersions - ドキュメントIDによるコンテンツのすべてのバージョンの取得
- メソッド: getパス:
/km/api/v1/content/docId/{docId}/allVersions - コンテンツに割り当てられたすべてのビューの取得
- メソッド: getパス:
/km/api/v1/content/{id}/views - 回答IDで記事を取得
- メソッド: getパス:
/km/api/v1/content/answers/{answerId} - コンテンツの取得
- メソッド: getパス:
/km/api/v1/content/{id} - ドキュメントIDによるコンテンツの取得
- メソッド: getパス:
/km/api/v1/content/docId/{docId} - バージョンIDによるコンテンツの取得
- メソッド: getパス:
/km/api/v1/content/versions/{versionId} - コンテンツの履歴を取得
- メソッド: getパス:
/km/api/v1/content/{id}/history - ドキュメントIDによるコンテンツの履歴の取得
- メソッド: getパス:
/km/api/v1/content/docId/{docId}/history - コンテンツの評価結果を取得
- メソッド: getパス:
/km/api/v1/content/{id}/ratings - ロケール内のすべてのバージョンのコンテンツを公開
- メソッド: postパス:
/km/api/v1/content/{id}/publishAllVersionInThisLocale/{localeCode} - すべてのロケールでコンテンツのすべてのバージョンを公開
- メソッド: postパス:
/km/api/v1/content/{id}/publishAllVersionInAllLocales - コンテンツの公開
- メソッド: postパス:
/km/api/v1/content/versions/{versionId}/publishThisVersion - コンテンツの評価
- メソッド: postパス:
/km/api/v1/content/{id}/rate - 翻訳記事の内容
- メソッド: postパス:
/km/api/v1/content/{versionId}/translate - ロケール内のすべてのバージョンのコンテンツを非公開にします
- メソッド: postパス:
/km/api/v1/content/{id}/unpublishAllVersionInThisLocale/{localeCode} - すべてのロケールのすべてのバージョンのコンテンツを非公開にします
- メソッド: postパス:
/km/api/v1/content/{id}/unpublishAllVersionInAllLocales - コンテンツの非公開
- メソッド: postパス:
/km/api/v1/content/versions/{versionId}/unpublishThisVersion - コンテンツの更新
- メソッド: 着るパス:
/km/api/v1/content/{id} - バージョンIDによるコンテンツの更新
- メソッド: patchパス:
/km/api/v1/content/{versionId} - インポートからのコンテンツの更新
- メソッド: 着るパス:
/km/api/v1/content/{id}/import - コンテンツ所有者の更新
- メソッド: postパス:
/km/api/v1/content/versions/{versionId}/changeOwner
コンテンツ(IM)/Contentタイプ
コンテンツ・タイプ・リソースでは、ナレッジ管理機能領域で使用可能なコンテンツ・タイプのみを取得できます。 コンテンツ・タイプは、解決策やFAQなど、ナレッジ・ベース内の様々なタイプの記事を定義します。
- コンテンツ・タイプの取得
- メソッド: getパス:
/km/api/v1/contentTypes/{id} - すべてのコンテンツ・タイプの取得
- メソッド: getパス:
/km/api/v1/contentTypes - コンテンツ・タイプに割り当てられたすべてのユーザー・グループを取得
- メソッド: getパス:
/km/api/v1/contentTypes/{id}/userGroups - カテゴリの取得
- メソッド: getパス:
/km/api/v1/contentTypes/{contentTypeId}/categories - パブリック・ドキュメント数の取得
- メソッド: getパス:
/km/api/v1/contentTypes/{contentTypeId}/publicDocumentCount
コンテンツ(IM)/Dataフォーム
データ・フォーム・リソースを使用すると、ナレッジ管理機能領域で使用可能な評点スキームの詳細を表示できます。 データ・フォームは、エージェントおよびエンドユーザーがナレッジ記事の有用性を評価できる評価スキームを記述するために使用されます。
- データ・フォームの取得
- メソッド: getパス:
/km/api/v1/dataForms/{id}
コンテンツ(IM)/Languages
言語リソースを使用すると、ナレッジ管理機能領域で使用可能な言語を表示できます。
- 言語を取得
- メソッド: getパス:
/km/api/v1/languages/{id} - すべての言語の取得
- メソッド: getパス:
/km/api/v1/languages - 言語に割り当てられたすべてのロケールを取得
- メソッド: getパス:
/km/api/v1/languages/{id}/locales
コンテンツ(IM)/Locales
ロケール・リソースを使用すると、ナレッジ管理機能領域で使用可能なロケールを表示できます。 ロケールは、言語とロケールが表すリージョンによって識別されます。 たとえば、en_USは米国での英語を表します。
- ロケールの取得
- メソッド: getパス:
/km/api/v1/locales/{id} - すべてのロケールを取得
- メソッド: getパス:
/km/api/v1/locales
コンテンツ(IM)/Repositories
リポジトリ・リソースを使用すると、ナレッジ管理機能領域で使用可能なロケールおよびカテゴリを表示できます。
- ビューに割り当てられたすべてのカテゴリの取得
- メソッド: getパス:
/km/api/v1/repositories/default/categoriesAssignedToView - リポジトリに割り当てられたすべてのロケールを取得
- メソッド: getパス:
/km/api/v1/repositories/default/availableLocales
コンテンツ(IM)/Userグループ
ユーザー・グループ・リソースを使用すると、ナレッジ管理機能領域で使用可能なユーザー・グループのリストを表示できます。 ユーザー・グループは、ユーザーのグループへのアクセス権を一連のナレッジ記事に付与するために使用されます。 たとえば、Tier 1エージェントとTier 2エージェントは別個のユーザー・グループになり、各グループはナレッジ・ベースの別の部分を使用できます。
- ユーザー・グループの作成
- メソッド: postパス:
/km/api/v1/userGroups - ユーザー・グループの削除
- メソッド: deleteパス:
/km/api/v1/userGroups/{id} - ユーザー・グループの取得
- メソッド: getパス:
/km/api/v1/userGroups/{id} - 参照キーによるユーザー・グループの取得
- メソッド: getパス:
/km/api/v1/userGroups/referenceKey/{referenceKey} - すべてのユーザー・グループの取得
- メソッド: getパス:
/km/api/v1/userGroups - ユーザー・グループの更新
- メソッド: 着るパス:
/km/api/v1/userGroups/{id}
コンテンツ(IM)/Userキー値
ユーザー・キー値リソースを使用すると、ユーザーの構成情報を保存できます。 たとえば、ユーザーのお気に入り記事のリストを保存できます。 ユーザー・キー値は、特定のユーザーに関連付けられた一意の名前と値のペアです。 たとえば、John Doeという名前のユーザーは、自分のお気に入り記事のリストにFAQ11を追加できます。
- ユーザー・キー値の作成
- メソッド: postパス:
/km/api/v1/users/{userId}/userKeyValues - ユーザー・キー値の削除
- メソッド: deleteパス:
/km/api/v1/userKeyValues/{id} - ユーザー・キー値の取得
- メソッド: getパス:
/km/api/v1/users/{userId}/userKeyValues/{id} - すべてのユーザー・キー値を取得
- メソッド: getパス:
/km/api/v1/users/{userId}/userKeyValues - ユーザー・キー値の更新
- メソッド: 着るパス:
/km/api/v1/users/{userId}/userKeyValues/{id}
コンテンツ(IM)/Users
ユーザー・リソースを使用すると、ユーザーに割り当てられたナレッジ管理固有の属性を表示できます。 たとえば、作成者は、ナレッジ記事を作成できる使用可能なロケールのリストを取得できます。
- 割り当てられたすべてのオーサリング・ロケールを取得
- メソッド: getパス:
/km/api/v1/users/{id}/contentLocales - 割り当てられたすべてのユーザー・キー値を取得
- メソッド: getパス:
/km/api/v1/users/{id}/customKeyValues - ユーザーの取得
- メソッド: getパス:
/km/api/v1/users/{id} - すべてのコンテンツ・ロケールの更新
- メソッド: patchパス:
/km/api/v1/users/{id}/contentLocales - すべてのカスタム・キー値の更新
- メソッド: patchパス:
/km/api/v1/users/{id}/customKeyValues
コンテンツ(IM)/Views
ビュー・リソースを使用すると、アプリケーションに基づいてナレッジ記事を分離できます。 現在、ナレッジ管理ソリューションは、サービスと人材管理(HCM)の2つの異なるアプリケーションにのみ関連付けられています。 ビュー・リソースでは、ナレッジ・ベースで使用可能なビューに関する情報を取得することもできます。
- 割り当てられたすべてのカテゴリの取得
- メソッド: getパス:
/km/api/v1/views/{id}/categories - 割り当てられたすべてのユーザー・グループの取得
- メソッド: getパス:
/km/api/v1/views/{id}/userGroups - すべてのビューの取得
- メソッド: getパス:
/km/api/v1/views - ビューの取得
- メソッド: getパス:
/km/api/v1/views/{id}