ナレッジ管理 REST API

オーストラリア API リファレンス

Release

australia

ft:locale

ja-JP

ft:publication_title

オーストラリア API リファレンス

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

ナレッジ管理 REST API

リリースバージョン: Australia

更新日 2026年03月12日

所要時間：48分

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

この API は、Knowledge API (sn_km_api) プラグインがアクティブ化されている場合にのみ使用できます。ナレッジ管理 REST API は、ServiceNow Store で入手可能なナレッジ API アプリを使用して Orlando 年に最初にリリースされました。

注:

ナレッジ管理 REST API は公開アクセス可能であり、非認証ユーザーを含むすべてのユーザーが公開アクセス可能なナレッジベースを利用できるようにします。バージョン 1.0.1 以降では、API が編集可能になり、アドミンは API に関連付けられた [スクリプト化された REST サービスセキュリティ] タブで [ 認証が必要] フラグを選択することで、認証されていないアクセスを禁止するように各エンドポイントを設定できるようになりました。

他のドメインがナレッジ管理 REST API エンドポイントを使用できるようにするには、クロスオリジンリソース共有 (CORS) ルールを定義します。詳細については、「 CORS ルールの定義」を参照してください。

この REST API を使用してスコープ付きナレッジベースの記事を表示するには、限定呼び出し元アクセス特権 [sys_restricted_caller_access] テーブルの要求元スコープからのsn_km_apiスコープの読み取りアクセスを許可します。詳細については、「アプリケーションリソースへのクロススコープアクセスの定義」を参照してください。

デフォルトでは、この API の非認証ユーザーおよびsnc_externalユーザーに対するレート制限は 1 時間あたり 500 です。レート制限の詳細については、「受信 REST API レート制限」を参照してください。

ナレッジ管理: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=<attr><operator><value>`。 `<attr>`:テーブル列の名前。 `<operator>`: 有効な値： =:<値>と完全に一致します。 !=:<値>と一致しません。 ^:複数の条件を論理的に AND に指定できます。 ^OR:複数の条件を論理的に OR 指定できます。 LIKE:<attr> には指定された文字列が含まれています。データタイプが文字列の <attr> フィールドでのみ機能します。 STARTSWITH:<attr> は指定された文字列で始まります。データタイプが文字列の <attr> フィールドでのみ機能します。 ENDSWITH:<attr> は指定された文字列で終わります。データタイプが文字列の <attr> フィールドでのみ機能します。 `<value>`:照合する値。すべてのパラメーターで大文字と小文字が区別されます。クエリには、次のような複数のエントリを含めることができます `filter=<attr><operator><value>[<operator><attr><operator><value>]。` データタイプ：文字列デフォルト:空
フィールド	結果に詳細を表示するための、ナレッジ [kb_knowledge] テーブルのフィールドのカンマ区切りリスト。データタイプ：文字列デフォルト：なし
KB	結果を限定するナレッジベース [kb_knowledge_base] テーブルからのナレッジベースsys_idsのカンマ区切りリスト。データタイプ：文字列
言語	結果を制限する 2 文字の ISO 639-1 言語コード形式のカンマ区切り言語のリスト。または、「all」と入力すると、インスタンスにインストールされているすべての有効な言語が検索されます。データタイプ：文字列デフォルト:ユーザーのセッション言語または en
limit	返されるレコードの最大数。limit値が異常に大きいと、システムのパフォーマンスに影響を与える可能性があります。このレコード数を超える要求の場合は、 offset パラメーターを使用してレコード取得をページネーションします。データタイプ：数値デフォルト値：30
オフセット	レコード取得を開始する開始レコードインデックス。この値を使用して、レコード取得をページネーションします。この機能を使用すると、レコードの数に関係なく、すべてのレコードを小さな管理可能なチャンクで取得できます。たとえば、このエンドポイントが初めて呼び出されるとき、 offset は「0」に設定されます。使用可能なすべてのレコードをページングするには、すべてのレコードの終わりに達するまで `offset=offset+limit` を使用します。データタイプ：数値デフォルト：0
クエリ	検索するテキスト。空の場合があります。データタイプ：文字列

表 : 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": [ { "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>	フィールドパラメーター (存在する場合) を使用して要求された各フィールドをリストします。データタイプ: オブジェクト `"<field_name>": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" }`
articles.fields.<field_name>.display_value	要求されたフィールドの表示値。データタイプ：文字列
articles.fields.<field_name>.label	要求されたフィールドを表すラベル。例: `ナレッジ`。データタイプ：文字列
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": { "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_idsのリスト。データタイプ：文字列
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"
          }
        }
      }
    ]
  }
}

ナレッジ管理: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}

注:

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

表 : 7. パスパラメーター
名前	説明
api_version	オプション。アクセスするエンドポイントのバージョン。たとえば、 `v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列
article_sys_id	取得する添付ファイル付きのナレッジ記事のSys_id。データタイプ：文字列テーブル:ナレッジベース [kb_knowledge]
attachment_sys_id	添付ファイルが属するレコードのSys_id。データタイプ：文字列

表 : 8. クエリパラメーター
名前	説明
なし

表 : 9. 要求本文パラメーター (XML または JSON)
名前	説明
なし

ヘッダー

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

表 : 11. 応答ヘッダー
ヘッダー	説明
Content-Type	応答のコンテンツタイプ ( `画像/gif` や `/` など)。

ステータスコード

表 : 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).

ナレッジ管理:GET /knowledge/articles/featured

最も閲覧されたナレッジ記事と特集されたナレッジ記事のリストを返します。

URL 形式

バージョニングされた URL: /api/sn_km_api/{api_version}/knowledge/articles/featured

デフォルト URL: /api/sn_km_api/knowledge/articles/featured

注:

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

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

表 : 14. クエリパラメーター
名前	説明
フィールド	結果に詳細を表示するための、ナレッジ [kb_knowledge] テーブルのフィールドのカンマ区切りリスト。データタイプ：文字列デフォルト：なし
KB	結果を限定するナレッジベース [kb_knowledge_base] テーブルからのナレッジベースsys_idsのカンマ区切りリスト。データタイプ：文字列
言語	結果を制限する 2 文字の ISO 639-1 言語コード形式のカンマ区切り言語のリスト。または、「all」と入力すると、インスタンスにインストールされているすべての有効な言語が検索されます。データタイプ：文字列デフォルト:ユーザーのセッション言語または en
limit	返されるレコードの最大数。limit値が異常に大きいと、システムのパフォーマンスに影響を与える可能性があります。このレコード数を超える要求の場合は、 offset パラメーターを使用してレコード取得をページネーションします。データタイプ：数値デフォルト値：30
オフセット	レコード取得を開始する開始レコードインデックス。この値を使用して、レコード取得をページネーションします。この機能を使用すると、レコードの数に関係なく、すべてのレコードを小さな管理可能なチャンクで取得できます。たとえば、このエンドポイントが初めて呼び出されるとき、 offset は「0」に設定されます。使用可能なすべてのレコードをページングするには、すべてのレコードの終わりに達するまで `offset=offset+limit` を使用します。データタイプ：数値デフォルト：0

表 : 15. 要求本文パラメーター (XML または JSON)
名前	説明
なし

ヘッダー

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

表 : 17. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

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

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


名前	説明
記事	応答で返された記事のリスト。データタイプ：アレイ `"articles":[ { "fields": {Object}, "id": "String", "link": "String", "number": "String", "rank": Number, "score": Number, "snippet": "String", "title": "String" } ]`
articles.fields	要求されたフィールドの値 (存在する場合)。データタイプ: オブジェクト `"fields": { "<field_name>": {Object} }`
articles.fields.<field_name>	フィールドパラメーター (存在する場合) を使用して要求された各フィールドをリストします。データタイプ: オブジェクト `"<field_name>": { "display_value": "String", "name": "String", "label": "String", "type": "String", "value": "String" }`
articles.fields.<field_name>.display_value	要求されたフィールドの表示値。データタイプ：文字列
articles.fields.<field_name>.name	要求されたフィールドの名前。<field_name>に一致します。データタイプ：文字列
articles.fields.<field_name>.label	要求されたフィールドを表すラベル。例: `ナレッジ`。データタイプ：文字列
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": { "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_idsのリスト。データタイプ：文字列
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/featured?fields=short_description&limit=3" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "meta": {
      "start": 0,
      "end": 3,
      "fields": "short_description",
      "query": "homepage",
      "filter": "",
      "kb": "",
      "language": "en",
      "status": {
        "code": 200
      },
      "count": 2
    },
    "articles": [
      {
        "link": "?id=kb_article_view&sys_kb_id=f27d7f79c0a8011b0018f9d700d2b9aa",
        "id": "kb_knowledge:f27d7f79c0a8011b0018f9d700d2b9aa",
        "title": "Email Interruption Tonight at 11:00 PM Eastern",
        "snippet": " If the site is UP but you cant access the page, try one of the below solutions: Browser Related Problems Force a full refresh for the site. This can be achieved by pressing CTRL + F5 keys at the same time on your favourite browser (Firefox, Chrome, Explorer, etc.) Try alternative urls such as m.outlook.com Clear the temporary cache and cookies ",
        "score": -1,
        "number": "KB0000002",
        "fields": {
          "short_description": {
            "display_value": "Email Interruption Tonight at 11:00 PM Eastern\n\t\t",
            "name": "short_description",
            "label": "Short description",
            "type": "string",
            "value": "Email Interruption Tonight at 11:00 PM Eastern\n\t\t"
          }
        }
      },
      {
        "link": "?id=kb_article_view&sys_kb_id=f2765f9fc0a8011b0120ec1b352bf09b",
        "id": "kb_knowledge:f2765f9fc0a8011b0120ec1b352bf09b",
        "title": "Sales Force Automation is DOWN",
        "snippet": "  On Friday, January 20th, we experienced a widespread outage that affected all Zoho services. The outage started around 8:13 am Pacific Time. Zoho services started coming back online for customer use at 3:49 pm, and all services were fully restored at 6:22 pm PST. We absolutely realize how important our services are for businesses and users who",
        "score": -1,
        "number": "KB0000001",
        "fields": {
          "short_description": {
            "display_value": "Sales Force Automation is DOWN",
            "name": "short_description",
            "label": "Short description",
            "type": "string",
            "value": "Sales Force Automation is DOWN"
          }
        }
      }
    ]
  }
}

ナレッジ管理:GET /knowledge/articles/{id}

特定のナレッジ記事コンテンツとそのフィールド値を返します。

URL 形式

バージョニングされた URL: /api/sn_km_api/{api_version}/knowledge/articles/{id}

デフォルト URL: /api/sn_km_api/knowledge/articles/{id}

注:

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

表 : 19. パスパラメーター
名前	説明
api_version	オプション。アクセスするエンドポイントのバージョン。たとえば、 `v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列
ID	ナレッジ記事のSys_idまたはナレッジベース (KB) 番号。データタイプ：文字列テーブル:ナレッジ [kb_knowledge]

表 : 20. クエリパラメーター
名前	説明
フィールド	結果に詳細を表示するための、ナレッジ [kb_knowledge] テーブルのフィールドのカンマ区切りリスト。データタイプ：文字列デフォルト：なし
言語	2文字のISO 639-1言語コード。たとえば、フランス語の場合は「fr」です。検索でナレッジ記事の KB 番号を id として使用し、指定された言語で記事の翻訳版が利用可能な場合にのみ、結果が表示されます。注: idパラメーターを (sys_idではなく) KB 番号として設定する場合にのみ有効です。データタイプ：文字列
search_id	search_rankを使用しない限りオプションです。この記事を返した検索の一意の識別子。 articles.id要素を返す次のいずれかの API を使用してsearch_idを取得できます。ナレッジ管理:GET /knowledge/articles ナレッジ管理:GET /knowledge/articles/featured ナレッジ管理:GET ナレッジ/記事/most_viewed search_id パラメーターと search_rank パラメーターを渡すと、記事の閲覧回数が増加し、ナレッジ使用 [kb_use] テーブルに記事のエントリが記録されます。ナレッジベース [kb_view2] ページで閲覧回数の増加を確認することもできます。データタイプ：文字列
search_rank	search_idを使用しない限りオプションです。articles.rank要素を返す次のいずれかの API を使用して取得できるクリック率による記事検索ランク。ナレッジ管理:GET /knowledge/articles ナレッジ管理:GET /knowledge/articles/featured ナレッジ管理:GET ナレッジ/記事/most_viewed データタイプ：数値
update_view	閲覧回数を更新し、ナレッジ使用 [kb_use] テーブルの記事のエントリを記録します。スタンドアロンパラメーターとして存在するか、true に設定されているかは true。注: search_id と search_rank でupdate_viewを渡すと、閲覧回数が既に増加しているため、update_viewは無視されます。データタイプ:「`true」、「false」`に設定されているか、まったく設定されていないかにかかわらず渡されたときに常に true として処理されるブール値。

表 : 21. 要求本文パラメーター (XML または JSON)
名前	説明
なし

ヘッダー

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

表 : 23. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

表 : 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_conditionally not_available 保留中データタイプ：文字列
attachments.sys_id	添付ファイルのSys_id。データタイプ：文字列
コンテンツ	記事の 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_conditionally not_available 保留中データタイプ：文字列
embedded_content.sys_id	添付ファイルのSys_id。データタイプ：文字列
フィールド	要求されたフィールドの値 (存在する場合)。データタイプ: オブジェクト `"fields": { "<field_name>": {Object} }`
fields.<field_name>	フィールドパラメーター (存在する場合) を使用して要求された各フィールドをリストします。データタイプ: オブジェクト `"<field_name>": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" }`
fields.<field_name>.display_value	要求されたフィールドの表示値。データタイプ：文字列
fields.<field_name>.label	要求されたフィールドを表すラベル。例: `ナレッジ`。データタイプ：文字列
fields.<field_name>.name	要求されたフィールドの名前。<field_name>に一致します。データタイプ：文字列
fields.<field_name>.type	要求されたフィールドのデータタイプ。データタイプ：文字列
fields.<field_name>.value	要求されたフィールドの値。データタイプ：文字列
言語	現在の記事の 2 文字の ISO 639-1 言語コード (翻訳可能な場合)。データタイプ：文字列
言語	ナレッジ記事の翻訳済みバージョンごとに (翻訳されている場合): `"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": []
  }
}

ナレッジ管理:GET ナレッジ/記事/most_viewed

最も閲覧された順に優先順位付けされたナレッジ記事のリストを返します。

URL 形式

バージョニングされた URL: /api/sn_km_api/{api_version}/knowledge/articles/most_viewed

デフォルト URL: /api/sn_km_api/knowledge/articles/most_viewed

注:

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

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

表 : 26. クエリパラメーター
名前	説明
フィールド	結果に詳細を表示するための、ナレッジ [kb_knowledge] テーブルのフィールドのカンマ区切りリスト。データタイプ：文字列デフォルト：なし
KB	結果を限定するナレッジベース [kb_knowledge_base] テーブルからのナレッジベースsys_idsのカンマ区切りリスト。データタイプ：文字列
言語	結果を制限する 2 文字の ISO 639-1 言語コード形式のカンマ区切り言語のリスト。または、「all」と入力すると、インスタンスにインストールされているすべての有効な言語が検索されます。データタイプ：文字列デフォルト:ユーザーのセッション言語または en
limit	返されるレコードの最大数。limit値が異常に大きいと、システムのパフォーマンスに影響を与える可能性があります。このレコード数を超える要求の場合は、 offset パラメーターを使用してレコード取得をページネーションします。データタイプ：数値デフォルト値：30
オフセット	レコード取得を開始する開始レコードインデックス。この値を使用して、レコード取得をページネーションします。この機能を使用すると、レコードの数に関係なく、すべてのレコードを小さな管理可能なチャンクで取得できます。たとえば、このエンドポイントが初めて呼び出されるとき、 offset は「0」に設定されます。使用可能なすべてのレコードをページングするには、すべてのレコードの終わりに達するまで `offset=offset+limit` を使用します。データタイプ：数値デフォルト：0

表 : 27. 要求本文パラメーター (XML または JSON)
名前	説明
なし

ヘッダー

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

表 : 29. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

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

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


名前	説明
記事	応答で返された記事のリスト。データタイプ：アレイ `[ { "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>	フィールドパラメーター (存在する場合) を使用して要求された各フィールドをリストします。データタイプ: オブジェクト `"<field_name>": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" }`
articles.fields.<field_name>.display_value	要求されたフィールドの表示値。データタイプ：文字列
articles.fields.<field_name>.label	要求されたフィールドを表すラベル。例: `ナレッジ`。データタイプ：文字列
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": { "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_idsのリスト。データタイプ：文字列
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"
      }
    ]
  }
}