Knowledge Management REST API
-
- 更新日2025年1月30日
- 所要時間:57 分
- Yokohama
- "API の実装とリファレンス"
ナレッジ管理 API は、最も閲覧された注目のナレッジ記事のリストを検索、表示、およびフェッチするためのエンドポイントを提供します。
この API は、ナレッジ API (sn_km_api) プラグインが有効になっている場合にのみ使用できます。ナレッジ管理 REST API は当初、ServiceNow Store で利用可能なナレッジ API アプリを使用して Orlando 年にリリースされました。
他のドメインで Knowledge Management REST API エンドポイントを使用できるようにするには、クロスオリジンリソース共有 (CORS) ルールを定義します。詳細については、「 CORS ルールの定義」を参照してください。
この REST API を使用してスコープ付きナレッジベースから記事を表示するには、制限付きの申請者アクセス特権 [sys_restricted_caller_access] テーブルで要求スコープからの sn_km_api スコープ読み取りアクセスを許可します。詳細については、「 アプリケーション リソースへのクロススコープ アクセスを定義する」を参照してください。
デフォルトでは、非認証ユーザーおよび snc_external ユーザーに対して、この API には 1 時間当たり 500 のレート制限があります。レート制限の詳細については、「 受信 REST API のレート制限」を参照してください。
Knowledge Management - GET /knowledge/articles
さまざまなパラメーターを使用して検索およびフィルタリングできるナレッジベース (KB) 記事のリストを返します。
URL 形式
バージョニングされた URL:/api/sn_km_api/{api_version}/knowledge/articles
デフォルトの URL:/api/sn_km_api/knowledge/articles
サポートされている要求パラメーター
名前 | 説明 |
---|---|
api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
名前 | 説明 |
---|---|
なし |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
ヘッダー | 説明 |
---|---|
承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
ヘッダー | 説明 |
---|---|
なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
ステータスコード | 説明 |
---|---|
200 | 成功。要求が正常に処理されました。 |
401 | 権限がありません。ユーザー資格情報が間違っているか、渡されていません。 |
500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。 |
応答本文のパラメーター (JSON または XML)
例: cURL 要求
Knowledge Management - GET /knowledge/articles/{article_sys_id}/attachments/{attachment_sys_id}
ナレッジ記事の添付ファイルをファイルとして返します。
URL 形式
バージョニングされた URL:/api/sn_km_api/{api_version}/knowledge/articles/{article_sys_id}/attachments/{attachment_sys_id}
デフォルトの URL:/api/sn_km_api/knowledge/articles/{article_sys_id}/attachments/{attachment_sys_id}
サポートされている要求パラメーター
名前 | 説明 |
---|---|
api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
article_sys_id | 取得しようとしている添付ファイルを含むナレッジ記事の sys_id。 データタイプ:文字列 テーブル:ナレッジベース [kb_knowledge] |
attachment_sys_id | 添付ファイルが属しているレコードの sys_id。 データタイプ:文字列 |
名前 | 説明 |
---|---|
なし |
名前 | 説明 |
---|---|
なし |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
ヘッダー | 説明 |
---|---|
承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
ヘッダー | 説明 |
---|---|
Content-Type | 応答のコンテンツタイプ (例:image/gif または */*)。 |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
応答本文のパラメーター
名前 | 説明 |
---|---|
ファイルは応答として返されます。 |
例: サンプル cURL 要求
Knowledge Management - GET /knowledge/articles/featured
最も多く閲覧されたナレッジ記事と注目のナレッジ記事のリストを返します。
URL 形式
バージョニングされた URL:/api/sn_km_api/{api_version}/knowledge/articles/featured
デフォルトの URL:/api/sn_km_api/knowledge/articles/featured
サポートされている要求パラメーター
名前 | 説明 |
---|---|
api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
名前 | 説明 |
---|---|
なし |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
ヘッダー | 説明 |
---|---|
承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
ヘッダー | 説明 |
---|---|
なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
ステータスコード | 説明 |
---|---|
200 | 成功。要求が正常に処理されました。 |
401 | 権限がありません。ユーザー資格情報が間違っているか、渡されていません。 |
500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。 |
応答本文のパラメーター (JSON または XML)
例: cURL 要求
Knowledge Management - GET /knowledge/articles/{id}
特定のナレッジ記事のコンテンツとそのフィールド値を返します。
URL 形式
バージョニングされた URL:/api/sn_km_api/{api_version}/knowledge/articles/{id}
デフォルトの URL:/api/sn_km_api/knowledge/articles/{id}
サポートされている要求パラメーター
名前 | 説明 |
---|---|
api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
ID | ナレッジ記事のSys_idまたはナレッジベース (KB) 番号。 データタイプ:文字列 テーブル:ナレッジ [kb_knowledge] |
名前 | 説明 |
---|---|
なし |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
ヘッダー | 説明 |
---|---|
承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
ヘッダー | 説明 |
---|---|
なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
ステータスコード | 説明 |
---|---|
200 | 成功。要求が正常に処理されました。 |
401 | 権限がありません。ユーザー資格情報が間違っているか、渡されていません。 |
500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。 |
応答本文のパラメーター (JSON または XML)
例: cURL 要求
例: サンプル cURL 要求 (update_view)
Knowledge Management - GET knowledge/articles/most_viewed
最も多く閲覧された順に優先順位付けしてナレッジ記事のリストを返します。
URL 形式
バージョニングされた URL:/api/sn_km_api/{api_version}/knowledge/articles/most_viewed
デフォルトの URL:/api/sn_km_api/knowledge/articles/most_viewed
サポートされている要求パラメーター
名前 | 説明 |
---|---|
api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
名前 | 説明 |
---|---|
なし |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
ヘッダー | 説明 |
---|---|
承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
ヘッダー | 説明 |
---|---|
なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
ステータスコード | 説明 |
---|---|
200 | 成功。要求が正常に処理されました。 |
401 | 権限がありません。ユーザー資格情報が間違っているか、渡されていません。 |
500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。 |
応答本文のパラメーター (JSON または XML)
例: cURL 要求
このページについて
- Knowledge Management - GET /knowledge/articles
- Knowledge Management - GET /knowledge/articles/{article_sys_id}/attachments/{attachment_sys_id}
- Knowledge Management - GET /knowledge/articles/featured
- Knowledge Management - GET /knowledge/articles/{id}
- Knowledge Management - GET knowledge/articles/most_viewed