Knowledge Management REST API

  • リリースバージョン: Zurich
  • 更新日 2025年07月31日
  • 所要時間：48分

    • ナレッジ管理 API は、最も閲覧された注目のナレッジ記事のリストを検索、表示、およびフェッチするためのエンドポイントを提供します。

    この API は、ナレッジ API (sn_km_api) プラグインが有効になっている場合にのみ使用できます。ナレッジ管理 REST API は当初、ServiceNow Store で利用可能なナレッジ API アプリを使用して Orlando 年にリリースされました。

    注:
    Knowledge Management REST API は公的にアクセス可能であり、公的にアクセス可能なナレッジベースを、非認証ユーザーを含むすべてのユーザーが利用できるようにします。バージョン 1.0.1 以降では API が編集可能になっており、管理者は API に関連付けられた [スクリプト化済み REST サービスセキュリティ (Scripted REST Service Security)] タブで [認証が必要] フラグを選択することで、非認証アクセスを禁止するように各エンドポイントを構成できます。

    他のドメインで 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

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

    サポートされている要求パラメーター

    表 : 1. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 2. クエリパラメーター
    名前 説明
    filter 結果セットのフィルタリングに使用するエンコードされたクエリ。

    構文：filter=<attr><operator><value>.

    • <attr>：テーブル列の名前。
    • <operator>：
      有効な値：
      • =：<value> と完全一致します。
      • !=：<value> と一致しません。
      • ^：複数の条件を指定し、それらに論理的 AND を指定することができます。
      • ^OR：複数の条件を指定し、それらに論理的 OR を指定することができます。
      • LIKE：<attr> に指定された文字列が含まれています。データタイプが文字列である <attr> フィールドに対してのみ機能します。
      • STARTSWITH：<attr> は指定された文字列で始まります。データタイプが文字列である <attr> フィールドに対してのみ機能します。
      • ENDSWITH：<attr> は指定した文字列で終了します。データタイプが文字列である <attr> フィールドに対してのみ機能します。
    • <value>：照合する値。

    すべてのパラメーターで大文字と小文字が区別されます。クエリには、 filter=<attr><operator><value>[<operator><attr><operator><value>].

    データタイプ：文字列

    デフォルト：空
    fields 結果の詳細を表示するナレッジ [kb_knowledge] テーブルのフィールドのカンマ区切りリスト。

    データタイプ：文字列

    デフォルト：なし
    kb 結果を制限するナレッジ ベース [kb_knowledge_base] テーブルのナレッジベース sys_id のカンマ区切りリスト。

    データタイプ：文字列
    language 結果を制限する 2 文字の ISO 639-1 言語コード形式でのカンマ区切りの言語のリスト。または、「all」と入力すると、インスタンスにインストールされているすべての有効な言語で検索できます。

    データタイプ：文字列

    デフォルト：ユーザーのセッション言語または en
    limit 返されるレコードの最大数。異常に大きい limit 値はシステムパフォーマンスに影響する可能性があります。このレコード数を超える要求の場合は、offset パラメーターを使用してレコード取得をページネーションします。

    データタイプ：数値

    デフォルト：30
    offset レコード取得を開始するレコードのインデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。

    たとえば、このエンドポイントを初めて呼び出すときに、offset は「0」に設定されます。利用可能なすべてのレコードをページングするには、すべてのレコードの最後に達するまで offset=offset+limit を使用します。

    データタイプ：数値

    デフォルト：0
    query 検索するテキスト。空にすることができます。

    データタイプ：文字列
    表 : 3. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 4. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 5. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 6. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    articles 応答で返される記事のリスト。

    データタイプ：アレイ

    "articles": [
  {
    "fields": {Object},
    "link": "String",
    "id": "String",
    "number": "String",
    "rank": Number,
    "score": Number,
    "snippet": "String",
    "title": "String"
  }
]
    articles.fields 要求されたフィールドの値 (存在する場合)。

    データタイプ：オブジェクト

    "fields": {
  "<field_name>": {Object}
}
    articles.fields.<field_name> fields パラメーターを使用して要求された各フィールドを一覧表示します (存在する場合)。

    データタイプ：オブジェクト

    "<field_name>": {
  "display_value": "String",
  "label": "String",
  "name": "String",
  "type": "String",
  "value": "String"
}
    articles.fields.<field_name>.display_value 要求されたフィールドの表示値。

    データタイプ：文字列
    articles.fields.<field_name>.label 要求されたフィールドを表すラベル。たとえば、Knowledge などです。

    データタイプ：文字列
    articles.fields.<field_name>.name 要求されたフィールドの名前。<field_name> に一致します。

    データタイプ：文字列
    articles.fields.<field_name>.type 要求されたフィールドのデータタイプ。

    データタイプ：文字列
    articles.fields.<field_name>.value 要求されたフィールドの値。

    データタイプ：文字列
    articles.id ナレッジ [kb_knowledge] テーブルのナレッジ記事の sys_id。

    データタイプ：文字列
    articles.link 記事へのリンク。

    データタイプ：文字列
    articles.number ナレッジ記事の番号。

    データタイプ：文字列
    articles.rank この検索に固有の記事の検索ランク。

    データタイプ：数値 (浮動小数点)
    articles.snippet ナレッジ記事の一部を示すテキスト。

    データタイプ：文字列
    articles.score 関連性スコア。スコアの降順でソートされた結果です。

    データタイプ：文字列
    articles.title ナレッジ記事の簡単な説明またはタイトル。

    データタイプ：文字列
    meta 結果と要求パラメーターのメタ情報。

    データタイプ：オブジェクト

    "meta": {
  "count": Number,
  "end": Number,
  "fields": "String",
  "filter": "String",
  "kb": "String",
  "language": "String",
  "query": "String",
  "start": Number,
  "status": {Object},
  "ts_query_id": "String"
}
    meta.count 利用可能な KB 記事の数。

    データタイプ：数値
    meta.end 結果セットの終了インデックス。

    データタイプ：数値
    meta.fields 記事のフィールド。

    データタイプ：文字列
    meta.filter データの取得に使用されるフィルター。

    データタイプ：文字列
    meta.kb ナレッジベース記事の sys_id のリスト。

    データタイプ：文字列
    meta.language 要求された KB 記事のカンマ区切りの言語のリスト。

    データタイプ：文字列
    meta.query 指定された要求クエリ。

    データタイプ：文字列
    meta.start 結果セットの開始インデックス。

    データタイプ：数値
    meta.status コールのステータス。

    データタイプ：文字列
    meta.ts_query_id クエリの sys_id。

    データタイプ：文字列

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_km_api/knowledge/articles?query=Windows&limit=2&fields=short_description&fields=sys_class_name" \
--request GET \
--header "Accept:application/xml" \
--user "username":"password"
    {
  "result": {
    "meta": {
      "start": 0,
      "end": 2,
      "fields": "short_description,sys_class_name",
      "query": "Windows",
      "filter": "",
      "kb": "",
      "language": "en",
      "count": 19,
      "ts_query_id": "7976f36129c30410f877796e70786991",
      "status": {
        "code": 200
      }
    },
    "articles": [
      {
        "link": "?sys_kb_id=9e528db1474321009db4b5b08b9a71a6&id=kb_article_view&sysparm_rank=1&sysparm_tsqueryId=7976f36129c30410f877796e70786991",
        "rank": 1,
        "id": "kb_knowledge:9e528db1474321009db4b5b08b9a71a6",
        "title": "Windows: Should I upgrade to Windows 8.x?",
        "snippet": "    Should I upgrade to <B>Windows</B> 8.x? <B>Windows</B> 8.x is designed for using touch, mouse, and keyboard the <B>Windows</B> Store and access apps such as Calendar, Mail, and Messaging. By most accounts, <B>Windows</B> boot times, smaller memory footprint, and more free memory for the programs you run. <B>Windows</B>",
        "score": 14.869,
        "number": "KB0000020",
        "fields": {
          "short_description": {
            "display_value": "Windows: Should I upgrade to Windows 8.x?\n\t\t",
            "name": "short_description",
            "label": "Short description",
            "type": "string",
            "value": "Windows: Should I upgrade to Windows 8.x?\n\t\t"
          },
          "sys_class_name": {
            "display_value": "Knowledge",
            "name": "sys_class_name",
            "label": "Class",
            "type": "sys_class_name",
            "value": "kb_knowledge"
          }
        }
      },
      {
        "link": "?sys_kb_id=3b07857187032100deddb882a2e3ec20&id=kb_article_view&sysparm_rank=2&sysparm_tsqueryId=7976f36129c30410f877796e70786991",
        "rank": 2,
        "id": "kb_knowledge:3b07857187032100deddb882a2e3ec20",
        "title": "What is the Windows key?",
        "snippet": "What is the <B>Windows</B> key? The <B>Windows</B> key is a standard key on most keyboards on computers built to use a <B>Windows</B> operating system. It is labeled with a <B>Windows</B> logo, and is usually placed between on the right side as well. Pressing Win (the <B>Windows</B> key) on its own will do the following: <B>Windows</B> 8.x: Toggle",
        "score": 13.4826,
        "number": "KB0000017",
        "fields": {
          "short_description": {
            "display_value": "What is the Windows key?\t\t",
            "name": "short_description",
            "label": "Short description",
            "type": "string",
            "value": "What is the Windows key?\t\t"
          },
          "sys_class_name": {
            "display_value": "Knowledge",
            "name": "sys_class_name",
            "label": "Class",
            "type": "sys_class_name",
            "value": "kb_knowledge"
          }
        }
      }
    ]
  }
}

    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}

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

    サポートされている要求パラメーター

    表 : 7. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    article_sys_id 取得しようとしている添付ファイルを含むナレッジ記事の sys_id。

    データタイプ：文字列

    テーブル:ナレッジベース [kb_knowledge]
    attachment_sys_id 添付ファイルが属しているレコードの sys_id。

    データタイプ：文字列
    表 : 8. クエリパラメーター
    名前 説明
    なし
    表 : 9. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 10. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 11. 応答ヘッダー
    ヘッダー 説明
    Content-Type 応答のコンテンツタイプ (例：image/gif または */*)。

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 12. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    404 見つかりません。要求されたアイテムが見つかりませんでした。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター

    名前 説明
    ファイルは応答として返されます。

    サンプル cURL 要求

    curl "https://instance.service-now.com/api/sn_km_api/knowledge/articles/0b48fd75474321009db4b5b08b9a71c2/attachments/fedf5614294f4010f877796e70786956" \
--request GET \
--header "Accept:*/*" \
--user "username":"password"
    Binary response not shown (file is returned as a response).

    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}

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

    サポートされている要求パラメーター

    表 : 19. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    ID ナレッジ記事のSys_idまたはナレッジベース (KB) 番号。

    データタイプ：文字列

    テーブル:ナレッジ [kb_knowledge]
    表 : 20. クエリパラメーター
    名前 説明
    fields 結果の詳細を表示するナレッジ [kb_knowledge] テーブルのフィールドのカンマ区切りリスト。

    データタイプ：文字列

    デフォルト：なし
    language 2 文字の ISO 639-1 言語コード。たとえば、フランス語の場合は「fr」です。検索でナレッジ記事の KB 番号が id として使用され、指定された言語で記事の翻訳版が利用可能な場合にのみ、結果が表示されます。
    注:
    id パラメーターを (sys_id ではなく) KB 番号として設定している場合にのみ有効です。

    データタイプ：文字列
    search_id search_rank を使用する場合を除き、オプションです。この記事を返した検索の一意の識別子。
    articles.id 要素を返す次のいずれかの API を使用して、search_id を取得できます。

    search_id および search_rank パラメーターを渡すと、記事の閲覧数がインクリメントされ、ナレッジ使用 [kb_use] テーブルに記事のエントリが記録されます。インクリメントされた閲覧数は、ナレッジベース [kb_view2] ページでも確認できます。

    データタイプ：文字列
    search_rank search_id を使用する場合を除き、オプションです。クリック率による記事 検索ランク 。 articles.rank 要素を返す次のいずれかの API を使用して取得できます。

    データタイプ：数値
    update_view 記事の閲覧数が更新され、ナレッジ使用 [kb_use] テーブルに記事のエントリが記録されます。スタンドアロンパラメーターとして存在するか、true に設定されるかに関係なく、true となります。
    注:
    update_view を search_id および search_rank とともに渡すと、閲覧数が既にインクリメントされるため、update_view は無視されます。

    データタイプ：ブール値。"true"、"false" に設定されているか、まったく設定されていないかにかかわらず、渡されると、常に true として処理されます。
    表 : 21. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 22. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 23. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 24. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    添付ファイル 添付ファイルが存在する場合、各インスタンスの添付ファイルの詳細を提供します。

    display_attachments = true の場合にのみ表示されます。

    データタイプ：オブジェクトのアレイ

    "attachments": [
  {
    "file_name": "String",
    "size_bytes": "String",
    "state": "String",
    "sys_id": "String"
  }
]
    attachments.file_name 添付ファイルのファイル名。

    データタイプ：文字列
    attachments.size_bytes ファイルサイズ。

    データタイプ：文字列

    単位：バイト
    attachments.state ステータス。
    可能な値：
    • available
    • available_conditionally
    • not_available
    • pending

    データタイプ：文字列
    attachments.sys_id 添付ファイルの sys_id。

    データタイプ：文字列
    content 記事の HTML コンテンツ全体。

    データタイプ：文字列
    display_attachments その記事に対して display_attachments フラグがアクティブであるかどうかを示すフラグ。添付ファイルは、ナレッジ記事レコードで display_attachments が true (アクティブ) の場合にのみ返されます。
    • true：display_attachments はアクティブです。
    • false：display_attachments は非アクティブです。

    データタイプ：ブーリアン
    embedded_content 埋め込みコンテンツを含む各添付ファイルを sys_id 別に一覧表示し、関連する添付ファイル情報を含めます。

    display_attachments = true の場合にのみ表示されます。

    データタイプ：オブジェクトのアレイ

    "attachments": [
  {
    "file_name": "String",
    "size_bytes": "String",
    "state": "String",
    "sys_id": "String"
  }
]
    embedded_content.file_name 添付ファイルのファイル名。

    データタイプ：文字列
    embedded_content.size_bytes 添付ファイルのサイズ。

    データタイプ：文字列

    単位：バイト
    embedded_content.state 添付ファイルのステータス。
    可能な値：
    • available
    • available_conditionally
    • not_available
    • pending

    データタイプ：文字列
    embedded_content.sys_id 添付ファイルの sys_id。

    データタイプ：文字列
    fields 要求されたフィールドの値 (存在する場合)。

    データタイプ：オブジェクト

    "fields": {
  "<field_name>": {Object}
}
    fields.<field_name> fields パラメーターを使用して要求された各フィールドを一覧表示します (存在する場合)。

    データタイプ：オブジェクト

    "<field_name>": {
  "display_value": "String",
  "label": "String",
  "name": "String",
  "type": "String",
  "value": "String"
}
    fields.<field_name>.display_value 要求されたフィールドの表示値。

    データタイプ：文字列
    fields.<field_name>.label 要求されたフィールドを表すラベル。たとえば、Knowledge などです。

    データタイプ：文字列
    fields.<field_name>.name 要求されたフィールドの名前。<field_name> に一致します。

    データタイプ：文字列
    fields.<field_name>.type 要求されたフィールドのデータタイプ。

    データタイプ：文字列
    fields.<field_name>.value 要求されたフィールドの値。

    データタイプ：文字列
    language 現在の記事の 2 文字の ISO 639-1 言語コード (翻訳が利用可能な場合)。

    データタイプ：文字列
    languages ナレッジ記事の翻訳版ごとに (翻訳されている場合)：
    "languages": [
  {
    "label": "String",
    "language": "String",
    "sys_id": "String"
  }
]

    データタイプ：アレイ
    languages.label 言語の文字列表現。

    データタイプ：文字列
    languages.language 2 文字の ISO 639-1 コード言語。

    データタイプ：文字列
    languages.sys_id ナレッジ記事の翻訳版の一意の識別子。

    データタイプ：文字列
    number 記事番号。

    データタイプ：文字列
    short_description ナレッジ記事の簡単な説明またはタイトル。

    データタイプ：文字列
    sys_id ナレッジ [kb_knowledge] テーブルのナレッジ記事の sys_id。

    データタイプ：文字列
    template 返された記事がテンプレートかどうかを示すフラグ。
    可能な値：
    • true：記事はテンプレートです。
    • false：記事はテンプレートではありません。

    データタイプ：ブーリアン
    template_table テンプレートテーブルの名前。ナレッジ記事がテンプレートの場合にのみ返されます。

    データタイプ：文字列

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_km_api/knowledge/articles/0b48fd75474321009db4b5b08b9a71c2?search_id=spam&search_rank=26.426" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
    {
  "result": {
    "content": "<p><span style=\"font-size: 18pt;\"><strong>How to Deal with Spam</strong></span></p>\r\n<p>Spam has increasingly become a problem on the Internet. While every Internet user receives some spam, email  addresses posted to web sites or in newsgroups and chat rooms attract the most spam.</p>\r\n<p>To reduce the amount of spam you receive:</p>\r\n<p>
    "template": false,
    "number": "KB0000011",
    "sys_id": "0b48fd75474321009db4b5b08b9a71c2",
    "short_description": "How to Deal with Spam",
    "display_attachments": true,
    "attachments": [
      {
        "sys_id": "dc27ae18294f4010f877796e707869c8",
        "file_name": "image.jpg",
        "size_bytes": "66792",
        "state": "available_conditionally"
      },
      {
        "sys_id": "fedf5614294f4010f877796e70786956",
        "file_name": "attachment.txt",
        "size_bytes": "75",
        "state": "available_conditionally"
      }
    ],
    "embedded_content": []
  }
}

    サンプル cURL 要求 (update_view)

    curl "https://instance.servicenow.com/api/sn_km_api/knowledge/KB0000020?update_view=' \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
    {
  "result": {
    "content": "<p> </p>\r\n<p> </p>\r\n<p><strong><span style=\"font-size: 18pt;\">Should I upgrade to Windows 8.x?</span></strong></p>\r\n<p>Windows 8.x is designed for using touch, mouse, and keyboard together, on hardware ranging from touch-enabled tablets and laptops to PCs and all-in-one computers...(intentionally truncated)</p>",
    "template": false,
    "number": "KB0000020",
    "sys_id": "9e528db1474321009db4b5b08b9a71a6",
    "short_description": "Windows: Should I upgrade to Windows 8.x?\t\t",
    "display_attachments": true,
    "attachments": [],
    "embedded_content": []
  }
}

    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

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

    サポートされている要求パラメーター

    表 : 25. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 26. クエリパラメーター
    名前 説明
    fields 結果の詳細を表示するナレッジ [kb_knowledge] テーブルのフィールドのカンマ区切りリスト。

    データタイプ：文字列

    デフォルト：なし
    kb 結果を制限するナレッジ ベース [kb_knowledge_base] テーブルのナレッジベース sys_id のカンマ区切りリスト。

    データタイプ：文字列
    language 結果を制限する 2 文字の ISO 639-1 言語コード形式でのカンマ区切りの言語のリスト。または、「all」と入力すると、インスタンスにインストールされているすべての有効な言語で検索できます。

    データタイプ：文字列

    デフォルト：ユーザーのセッション言語または en
    limit 返されるレコードの最大数。異常に大きい limit 値はシステムパフォーマンスに影響する可能性があります。このレコード数を超える要求の場合は、offset パラメーターを使用してレコード取得をページネーションします。

    データタイプ：数値

    デフォルト：30
    offset レコード取得を開始するレコードのインデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。

    たとえば、このエンドポイントを初めて呼び出すときに、offset は「0」に設定されます。利用可能なすべてのレコードをページングするには、すべてのレコードの最後に達するまで offset=offset+limit を使用します。

    データタイプ：数値

    デフォルト：0
    表 : 27. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 28. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 29. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 30. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    articles 応答で返される記事のリスト。

    データタイプ：アレイ

    [
  {
    "fields": {Object},
    "id": "String",
    "link": "String",
    "number": "String",
    "rank": Number,
    "score": Float,
    "snippet": "String",
    "title": "String"
  }
]
    articles.fields 要求されたフィールドの値 (存在する場合)。

    データタイプ：オブジェクト

    "fields": {
  "<field_name>": {Object}
}
    articles.fields.<field_name> fields パラメーターを使用して要求された各フィールドを一覧表示します (存在する場合)。

    データタイプ：オブジェクト

    "<field_name>": {
  "display_value": "String",
  "label": "String",
  "name": "String",
  "type": "String",
  "value": "String"
}
    articles.fields.<field_name>.display_value 要求されたフィールドの表示値。

    データタイプ：文字列
    articles.fields.<field_name>.label 要求されたフィールドを表すラベル。たとえば、Knowledge などです。

    データタイプ：文字列
    articles.fields.<field_name>.name 要求されたフィールドの名前。<field_name> に一致します。

    データタイプ：文字列
    articles.fields.<field_name>.type 要求されたフィールドのデータタイプ。

    データタイプ：文字列
    articles.fields.<field_name>.value 要求されたフィールドの値。

    データタイプ：文字列
    articles.id ナレッジ [kb_knowledge] テーブルのナレッジ記事の sys_id。

    データタイプ：文字列
    articles.link 記事へのリンク。

    データタイプ：文字列
    articles.number ナレッジ記事の番号。

    データタイプ：文字列
    articles.rank この検索に固有の記事の検索ランク。

    データタイプ：浮動小数点
    articles.score 関連性スコア。スコアの降順でソートされた結果です。

    データタイプ：文字列
    articles.snippet ナレッジ記事の一部を示すテキスト。

    データタイプ：文字列
    articles.title ナレッジ記事の簡単な説明またはタイトル。

    データタイプ：文字列
    meta 結果と要求パラメーターのメタ情報。

    データタイプ：オブジェクト

    "meta": {
  "count": Number,
  "end": Number,
  "fields": "String",
  "filter": "String",
  "kb": "String",
  "language": "String",
  "query": "String",
  "start": Number,
  "status": {Object},
  "ts_query_id": "String"
}
    meta.count 利用可能な KB 記事の数。

    データタイプ：数値
    meta.end 結果セットの終了インデックス。

    データタイプ：数値
    meta.fields 記事のフィールド。

    データタイプ：文字列
    meta.filter データの取得に使用されるフィルター。

    データタイプ：文字列
    meta.kb ナレッジベース記事の sys_id のリスト。

    データタイプ：文字列
    meta.language 要求された KB 記事のカンマ区切りの言語のリスト。

    データタイプ：文字列
    meta.query 指定された要求クエリ。

    データタイプ：文字列
    meta.start 結果セットの開始インデックス。

    データタイプ：数値
    meta.status 呼び出しの HTTP ステータス。

    データタイプ：文字列
    meta.ts_query_id クエリの sys_id。

    データタイプ：文字列

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_km_api/knowledge/articles/most_viewed?limit=5" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
    {
  "result": {
    "meta": {
      "start": 0,
      "end": 5,
      "fields": "",
      "query": "",
      "filter": "workflow_state=published^valid_to>=javascript:gs.beginningOfToday()^active=true^sys_class_name!=kb_knowledge_block^sys_view_count>0^ORDERBYDESCsys_view_count^ORDERBYshort_description",
      "kb": "",
      "count": 2,
      "status": {
        "code": 200
      },
      "language": "en"
    },
    "articles": [
      {
        "link": "?id=kb_article_view&sys_kb_id=0b48fd75474321009db4b5b08b9a71c2",
        "id": "kb_knowledge:0b48fd75474321009db4b5b08b9a71c2",
        "title": "How to Deal with Spam",
        "snippet": "How to Deal with Spam Spam has increasingly become a problem on the Internet. While every Internet user receives some spam, email addresses posted to web sites or in newsgroups and chat rooms attract the most spam. To reduce the amount of spam you receive: Don't reply to spam Be careful releasing your email address, and know how it will be used ",
        "score": 7,
        "tags": [],
        "number": "KB0000011"
      },
      {
        "link": "?id=kb_article_view&sys_kb_id=c85cd2519f77230088aebde8132e70c2",
        "id": "kb_knowledge:c85cd2519f77230088aebde8132e70c2",
        "title": "Microsoft Outlook Issues",
        "snippet": "Microsoft Outlook Issues This article explains how to use automatic replies in Outlook 2010 for Exchange accounts. Setting Up Automatic Replies Click the File tab. Click Automatic Replies. Select Send automatic replies. If desired, select the Only send during this time range check box to schedule when your out of office replies are active. If yo",
        "score": 6,
        "tags": [],
        "number": "KB99999999"
      }
    ]
  }
}