---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference
Release :
- xanadu
ft:locale :
- ja-JP
ft:publication_title :
- Xanadu API リファレンス
ft:clusterId :
- crapiref
bundleId :
- crapiref
workflow :
- Creator
---
# 外部コンテンツ取り込み API
# 外部コンテンツ取り込み API {#ariaid-title1}
* リリースバージョン: Xanadu
*
* 更新日 2024年08月01日
*
*  所要時間：33分
外部コンテンツ取り込み API は、ServiceNow® インスタンスの外部のソースから ServiceNow® AI 検索 アプリケーションのインデックスへ、コンテンツを取り込めるようにするエンドポイントを提供します。
## 外部コンテンツ取り込み API -- DELETE /ais/external_content/deleteByQuery/{schema_table_name} {#ariaid-title2}
指定されたクエリに一致するすべての外部ドキュメントを AI 検索 インデックスから削除します。
### URL 形式
バージョニングされた URL：/api/now/{api_version}/ais/external_content/deleteByQuery/{schema_table_name}?query={query}
### サポートされている要求パラメーター
{#ext_content-DELETE-deleteByQuery__entry__2}{#ext_content-DELETE-deleteByQuery__version-RESTAPI}
| 名前 | 説明 |
|-|-|
| api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
| schema_table_name | 削除するインデックス付きドキュメントのスキーマを定義する外部コンテンツスキーマテーブルの名前。たとえば、u_ext_content などです。 データタイプ：文字列 |
[表 : 1. パスパラメーター]
{#ext_content-DELETE-deleteByQuery__entry__8}
| 名前 | 説明 |
|-|-|
| query | schema_table_nameで指定されたスキーマテーブルの有効な URL エスケープクエリ。たとえば、title=Introduction は、タイトルが Introduction のドキュメントをクエリします。 データタイプ：文字列 |
[表 : 2. クエリパラメーター]
{#ext_content-DELETE-deleteByQuery__entry__12}
| 名前 | 説明 |
|-|-|
| なし | |
[表 : 3. 要求本文パラメーター (XML または JSON)]
### ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。
{#ext_content-DELETE-deleteByQuery__entry__16}{#ext_content-DELETE-deleteByQuery__accept-JSON-only-entry-RESTAPI}
| ヘッダー | 説明 |
|-|-|
| 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 |
[表 : 4. 要求ヘッダー]
{#ext_content-DELETE-deleteByQuery__entry__20}
| ヘッダー | 説明 |
|-|-|
| なし | |
[表 : 5. 応答ヘッダー]
### ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。
{#ext_content-DELETE-deleteByQuery__table_wwn_rhd_ct__entry__2}{#ext_content-DELETE-deleteByQuery__entry-200-status-code}{#ext_content-DELETE-deleteByQuery__entry-400-status-code}{#ext_content-DELETE-deleteByQuery__entry-500-status-code}
| ステータスコード | 説明 |
|-|-|
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 |
| 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 |
[表 : 6. ステータスコード]
{#ext_content-DELETE-deleteByQuery__table_wwn_rhd_ct}
### 応答本文のパラメーター (JSON または XML)
{#ext_content-DELETE-deleteByQuery__entry__32}
| 名前 | 説明 |
|-|-|
| error | 要求の処理中に発生した発生したエラーを説明するオブジェクト。 データタイプ：オブジェクト "error": { "detail": "String", "message": "String" } |
| error.detail | 要求の処理中に発生したエラーの詳細。 データタイプ：文字列 |
| error.message | 要求の処理中に発生したエラーのメッセージ。 データタイプ：文字列 |
| result | 正常に処理された要求の結果。 データタイプ：文字列 |
| status | 失敗した要求のステータス。 有効な値： * failure {#ext_content-DELETE-deleteByQuery__ul_h5r_z54_pnb} データタイプ：文字列 |
[ ]
### cURL 要求
u_ext_content スキーマテーブルから、タイトルフィールドの値が Introduction および Report for 31 October 2020 のドキュメントを削除します。
curl "https://instance.service-now.com/api/now/v2/ais/external_content/deleteByQuery/u_ext_content?query=title%3DIntroduction%20OR%20title%3DReport%20for%2031%20October%202020" \
--request DELETE \
--user "username":"password" \
--header "Accept: application/json"
{
"result": "Delete By Query Successfully Executed"
}
## 外部コンテンツ取り込み API -- DELETE /ais/external_content/deleteDocument/{schema_table_name}/{document_id} {#ariaid-title3}
指定された一意の識別子を持つ外部ドキュメントを AI 検索 インデックスから削除します。
### URL 形式
バージョニングされた URL：/api/now/{api_version}/ais/external_content/deleteDocument/{schema_table_name}/{document_id}
### サポートされている要求パラメーター
{#ext_content-DELETE-deleteDocument__entry__2}{#ext_content-DELETE-deleteDocument__version-RESTAPI}
| パラメーター | 説明 |
|-|-|
| api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
| document_id | 削除する外部ドキュメントの一意の識別子。たとえば、ADMIN-2027858531-16 などです。 データタイプ：文字列 |
| schema_table_name | 削除するインデックス付きドキュメントのスキーマを定義する外部コンテンツスキーマテーブルの名前。たとえば、u_ext_content などです。 データタイプ：文字列 |
[表 : 7. パスパラメーター]
{#ext_content-DELETE-deleteDocument__entry__10}
| 名前 | 説明 |
|-|-|
| なし | |
[表 : 8. クエリパラメーター]
{#ext_content-DELETE-deleteDocument__entry__14}
| 名前 | 説明 |
|-|-|
| なし | |
[表 : 9. 要求本文パラメーター (XML または JSON)]
### ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。
{#ext_content-DELETE-deleteDocument__entry__18}{#ext_content-DELETE-deleteDocument__accept-JSON-only-entry-RESTAPI}
| ヘッダー | 説明 |
|-|-|
| 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 |
[表 : 10. 要求ヘッダー]
{#ext_content-DELETE-deleteDocument__entry__22}
| ヘッダー | 説明 |
|-|-|
| なし | |
[表 : 11. 応答ヘッダー]
### ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。
{#ext_content-DELETE-deleteDocument__entry__26}{#ext_content-DELETE-deleteDocument__entry-200-status-code}{#ext_content-DELETE-deleteDocument__entry-400-status-code}{#ext_content-DELETE-deleteDocument__entry-500-status-code}
| ステータスコード | 説明 |
|-|-|
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 |
| 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 |
[表 : 12. ステータスコード]
### 応答本文のパラメーター (JSON または XML)
{#ext_content-DELETE-deleteDocument__entry__34}
| 要素 | 説明 |
|-|-|
| error | 要求の処理中に発生した発生したエラーを説明するオブジェクト。 データタイプ：オブジェクト "error": { "detail": "String", "message": "String" } |
| error.detail | 要求の処理中に発生したエラーの詳細。 データタイプ：文字列 |
| error.message | 要求の処理中に発生したエラーのメッセージ。 データタイプ：文字列 |
| result | 正常に処理された要求の結果。 データタイプ：文字列 |
| status | 失敗した要求のステータス。 有効な値： * failure {#ext_content-DELETE-deleteDocument__ul_h5r_z54_pnb} データタイプ：文字列 |
[ ]
### cURL 要求
u_ext_content スキーマテーブルから識別子 ADMIN-2587918521-27 のドキュメントを削除します。
curl 'https://instance.service-now.com/api/now/v2/ais/external_content/deleteDocument/u_ext_content/ADMIN-2587918521-27' \
--request DELETE \
--user 'username':'password' \
--header 'Accept: application/json'
{
"result":"Document removed"
}
## 外部コンテンツ取り込み API -- POST /ais/external_content/ingestDocument/{schema_table_name} {#ariaid-title4}
インデックス作成のために、外部ドキュメントのリストを AI 検索 取り込みバッチャーに送信します。インデックス作成が完了すると、取り込まれたドキュメントのコンテンツが検索可能になります。
このエンドポイントを使用して、テキストコンテンツとメタデータを含む外部ドキュメントをフィードできます。
検索可能なバイナリコンテンツとメタデータを外部ドキュメントに関連付ける必要がある場合は、次の手順を実行します。
1. [POST /ais/external_content/storeContent](https://servicenow-prod.fluidtopics.net/aOdIU2kOqrhbjbAR6yPk8Q#ext_content-POST-storeContent "バイナリコンテンツをコンテンツオブジェクトとして AI 検索 に保存します。") エンドポイントを使用して、AI 検索 にバイナリコンテンツを保存します。result 応答本文パラメーターの値を記録します。
2. このエンドポイントを使用して、外部ドキュメントを AI 検索 に送信します。記録された result 応答本文パラメーター値と一致するように、ドキュメントの content_pointer 要求本文パラメーターを設定します。
{#ext_content-POST-ingestDocument__ol_bz4_prf_ynb} 取り込み中、AI 検索 はバイナリコンテンツを解析し、その検索可能なコンテンツを外部ドキュメントを表すインデックス付きレコードに追加します。解析により、保存されているコンテンツオブジェクトが削除されます。
### URL 形式
バージョニングされた URL：/api/now/{api_version}/ais/external_content/ingestDocument/{schema_table_name}
### サポートされている要求パラメーター
{#ext_content-POST-ingestDocument__entry__2}{#ext_content-POST-ingestDocument__version-RESTAPI}
| パラメーター | 説明 |
|-|-|
| api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
| schema_table_name | 要求内の外部ドキュメントのスキーマを定義する外部コンテンツスキーマテーブルの名前。たとえば、u_ext_content などです。 データタイプ：文字列 |
[表 : 13. パスパラメーター]
{#ext_content-POST-ingestDocument__entry__8}
| 名前 | 説明 |
|-|-|
| なし | |
[表 : 14. クエリパラメーター]
{#ext_content-POST-ingestDocument__entry__12}
| 要素 | 説明 |
|-|-|
| \[array\] | 必須です。オブジェクトの名前なしアレイです。各オブジェクトは、インデックス作成のために取り込む外部ドキュメントを表します。 データタイプ：アレイ [ { "content_pointer": "String", "document_id": "String", "principals": {Object}, "properties": {Object} } ] |
| \[array\].content_pointer | [POST /ais/external_content/storeContent](https://servicenow-prod.fluidtopics.net/aOdIU2kOqrhbjbAR6yPk8Q#ext_content-POST-storeContent "バイナリコンテンツをコンテンツオブジェクトとして AI 検索 に保存します。") エンドポイントを使用して保存されたバイナリコンテンツのインスタンスの識別子。 取り込み中、AI 検索 はバイナリコンテンツを解析し、その検索可能なコンテンツを外部ドキュメントを表すインデックス付きレコードに追加します。解析により、保存されているコンテンツオブジェクトが削除されます。 注: この識別子は、storeContent エンドポイントによって返される result 応答本文要素と一致する必要があります。 データタイプ：文字列 |
| \[array\].document_id | 必須です。schema_table_name パスパラメーターで指定された外部コンテンツスキーマテーブル内の外部ドキュメントの一意の識別子。 注: ドキュメントを取り込むと、同じ document_id を持つ同じ外部コンテンツスキーマテーブル内の既存のドキュメントが上書きされます。同じ取り込み要求内の 2 つ以上のドキュメントに同じ document_id がある場合、要求は失敗します。 データタイプ：文字列 |
| \[array\].principals | 外部定義のセキュリティプリンシパル (ユーザーとグループ) に対する外部ドキュメントのアクセス権限を記述するキーと値のペアを含むオブジェクト。 注: ドキュメントでこのパラメーターを省略すると、要求は成功しますが、AI 検索 は「The principal of the document is missing」という取り込みフィードバックメッセージとともにドキュメントを却下します。 このパラメーターオブジェクトにドキュメントへのアクセス権を付与するキーと値のペアが含まれていない場合、要求は成功しますが、AI 検索 は「The principal of the document is invalid」という取り込みフィードバックメッセージとともにドキュメントを却下します。 データタイプ：オブジェクト "principals": { "everyone": Boolean, "groups.deny": [Array], "groups.read": [Array], "none": Boolean, "users.deny": [Array], "users.read": [Array] } サポートされているバージョン：API の v2 以降で利用可能です。 |
| \[array\].principals.everyone | すべてのユーザーの外部ドキュメントへのアクセスが許可されているかどうかを示すフラグ。このパラメーターを true に設定すると、すべての Now Platform ユーザーが、ドキュメントから作成されたインデックス付きレコードを表示できます。 注: ドキュメントでこのパラメーターと \[array\].principals.none の両方を true に設定すると、要求は成功しますが、AI 検索 は「The principal of the document is invalid」という取り込みフィードバックメッセージとともにドキュメントを却下します。要求では、これらの 2 つのパラメーターの片方のみを true に設定できます。 有効な値： * true：すべてのユーザーにドキュメントへのアクセスを許可します。AI 検索 は、ドキュメントのすべての \[array\].principals.groups.\* および \[array\].principals.users.\* パラメーター設定を無視します。 * false：すべてのユーザーに外部ドキュメントへのアクセスを許可しません。\[array\].principals.none が false に設定されており、ユーザーマッピングと \[array\].principals.groups.\* および \[array\].principals.users.\* パラメーターのインタラクションによって許可されている場合にのみ、ユーザーはドキュメントにアクセスできます。 {#ext_content-POST-ingestDocument__ul_kp3_w1b_ppb} データタイプ：ブーリアン デフォルト： true サポートされているバージョン：API の v2 以降で利用可能です。 |
| \[array\].principals.groups.deny | 文字列のアレイで、各文字列は、外部ドキュメントへのアクセスが拒否された外部定義グループの名前です。これらの外部グループのいずれかにマップされた Now Platform ユーザーは、ドキュメントから作成されたインデックス付き検索結果レコードを表示できません。 \[array\].principals.everyone または \[array\].principals.none のいずれかが true に設定されている場合、このパラメーターは無効です。 このパラメーターは \[array\].principals.groups.read よりも優先されます。同じユーザーが、ドキュメントの読み取りおよびアクセス拒否権限の両方を持つ外部グループにマップされている場合、AI 検索 はそのユーザーに対してインデックス付きレコードへのアクセスを拒否します。 デフォルトでは、\[array\].principals.users.read はこのパラメーターよりも優先されます。インデックス付きソースのこの優先順位を逆にするには、「 [外部コンテンツのインデックス付きソースのユーザー読み取り権限とグループ拒否権限の優先順位を変更する](https://www.servicenow.com/docs/access?context=defining-access-perms-ext-docs-ais&version=xanadu&pubname=xanadu-platform-administration&ft:locale=en-US)」を参照してください。 データタイプ：アレイ 値は、指定された外部定義グループの名前に応じて、任意の形式にすることができます。例： "groups.deny": [ "hr-admin", "legal" ] サポートされているバージョン：API の v2 以降で利用可能です。 |
| \[array\].principals.groups.read | 文字列のアレイで、各文字列は、外部ドキュメントへのアクセスが許可された外部定義グループの名前です。これらの外部グループのいずれかにマップされた Now Platform ユーザーは、ドキュメントから作成されたインデックス付き検索結果レコードを表示できます。 \[array\].principals.everyone または \[array\].principals.none のいずれかが true に設定されている場合、このパラメーターは無効です。 \[array\].principals.groups.deny はこのパラメーターよりも優先されます。同じユーザーが、ドキュメントの読み取りおよびアクセス拒否権限の両方を持つ外部グループにマップされている場合、AI 検索 はそのユーザーに対してインデックス付きレコードへのアクセスを拒否します。 データタイプ：アレイ 値は、指定された外部定義グループの名前に応じて、任意の形式にすることができます。例： "groups.read": [ "devops", "it", "report-admins" ] サポートされているバージョン：API の v2 以降で利用可能です。 |
| \[array\].principals.none | すべてのユーザーの外部ドキュメントへのアクセスが拒否されているかどうかを示すブーリアンオプション。このパラメーターを true に設定すると、昇格された ais_high_security_admin 権限ロールを持つ Now Platform ユーザーのみが、ドキュメントから作成されたインデックス付きレコードを表示できます。 注: ドキュメントでこのパラメーターと \[array\].principals.everyone の両方を true に設定すると、取り込み時に、AI 検索 は「The principal of the document is invalid」というエラーメッセージとともにドキュメントを却下します。要求では、これらの 2 つのパラメーターの片方のみを true に設定できます。 有効な値： * true：昇格された ais_high_security_admin 権限ロールを持つユーザーを除き、すべてのユーザーにドキュメントへのアクセスを拒否します。AI 検索 は、ドキュメントのすべての \[array\].principals.groups.\* および \[array\].principals.users.\* パラメーター設定を無視します。 * false：すべてのユーザーのドキュメントへのアクセスを拒否しません。\[array\].principals.everyone が true に設定されているか、そのユーザーマッピングと \[array\].principals.groups.read および \[array\].principals.users.read パラメーターのインタラクションによって許可されている場合、ユーザーはドキュメントにアクセスできます。 {#ext_content-POST-ingestDocument__ul_ufr_z1b_ppb} データタイプ：ブーリアン デフォルト： false サポートされているバージョン：API の v2 以降で利用可能です。 |
| \[array\].principals.users.deny | 文字列のアレイで、各文字列は、外部ドキュメントへのアクセスが拒否された外部定義ユーザーの名前です。これらの外部ユーザーのいずれかにマップされた Now Platform ユーザーは、ドキュメントから作成されたインデックス付き検索結果レコードを表示できません。 \[array\].principals.everyone または \[array\].principals.none のいずれかが true に設定されている場合、このパラメーターは無効です。 このパラメーターは \[array\].principals.users.read よりも優先されます。同じユーザーが、ドキュメントの読み取りおよびアクセス拒否権限の両方を持つ外部ユーザーにマップされている場合、AI 検索 はそのユーザーに対してインデックス付きレコードへのアクセスを拒否します。 データタイプ：アレイ 値は、指定された外部定義ユーザーの名前に応じて、任意の形式にすることができます。例： "users.deny": [ "ad\bow-ruggeri", "abel-tuter@sharepoint" ] サポートされているバージョン：API の v2 以降で利用可能です。 |
| \[array\].principals.users.read | 文字列のアレイで、各文字列は、外部ドキュメントへのアクセスが許可された外部定義ユーザーの名前です。これらの外部ユーザーのいずれかにマップされた Now Platform ユーザーは、ドキュメントから作成されたインデックス付き検索結果レコードを表示できます。 \[array\].principals.everyone または \[array\].principals.none のいずれかが true に設定されている場合、このパラメーターは無効です。 \[array\].principals.users.deny はこのパラメーターよりも優先されます。同じユーザーが、ドキュメントの読み取りおよびアクセス拒否権限の両方を持つ外部ユーザーにマップされている場合、AI 検索 はそのユーザーに対してインデックス付きレコードへのアクセスを拒否します。 デフォルトでは、このパラメーターは \[array\].principals.groups.deny よりも優先されます。インデックス付きソースのこの優先順位を逆にするには、「 [外部コンテンツのインデックス付きソースのユーザー読み取り権限とグループ拒否権限の優先順位を変更する](https://www.servicenow.com/docs/access?context=defining-access-perms-ext-docs-ais&version=xanadu&pubname=xanadu-platform-administration&ft:locale=en-US)」を参照してください。 データタイプ：アレイ 値は、指定された外部定義ユーザーの名前に応じて、任意の形式にすることができます。例： "users.read": [ "ad\abel-tuter", "beth-anglin@sharepoint" ] サポートされているバージョン：API の v2 以降で利用可能です。 |
| \[array\].properties | 名前と値のペアを含むオブジェクトで、各ペアは、ドキュメントのために取り込むフィールド名と値を表します。フィールド名と値は、すべて文字列として指定する必要があります。 取り込み後、これらのドキュメントフィールド値は、schema_table_name パスパラメーターで指定された外部コンテンツスキーマテーブルに定義されたインデックス付きソースを介してアクセスできます。ユーザーは、このインデックス付きソースから派生した検索ソースでこれらのフィールド値を検索できます。 データタイプ：オブジェクト フィールド名に使用できるのは、小文字とアンダースコアのみです。値には任意の文字を含めることができます。値の長さは、外部コンテンツスキーマテーブルのフィールドに定義された max_length 属性によって制限されます。フィールドの名前と値のペアの例は次のとおりです。 "properties": { "creation_date": "2020-11-03 12:27:43", "file_size": "10285", "title": "Introduction", "url": "file:///myhost/reports/Introduction.pdf" } |
[表 : 15. 要求本文パラメーター (XML または JSON)]
### ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。
{#ext_content-POST-ingestDocument__entry__36}{#ext_content-POST-ingestDocument__accept-JSON-only-entry-RESTAPI}{#ext_content-POST-ingestDocument__content_type-JSON-only-entry-RESTAPI}
| ヘッダー | 説明 |
|-|-|
| 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 |
| Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 |
[表 : 16. 要求ヘッダー]
{#ext_content-POST-ingestDocument__entry__42}
| ヘッダー | 説明 |
|-|-|
| なし | |
[表 : 17. 応答ヘッダー]
### ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。
{#ext_content-POST-ingestDocument__entry__46}{#ext_content-POST-ingestDocument__entry-200-status-code}{#ext_content-POST-ingestDocument__entry-400-status-code}{#ext_content-POST-ingestDocument__entry-500-status-code}
| ステータスコード | 説明 |
|-|-|
| 200 | 成功。要求が正常に処理されました。 |
| 202 | 部分的に成功。要求は処理されました。一部のドキュメントには、取り込みフィードバックの警告またはエラーメッセージがあります。 |
| 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 |
| 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 |
[表 : 18. ステータスコード]
### 応答本文のパラメーター (JSON または XML)
{#ext_content-POST-ingestDocument__entry__56}
| 名前 | 説明 |
|-|-|
| error | 要求の処理中に発生した発生したエラーを説明するオブジェクト。 データタイプ：オブジェクト "error": { "detail": "String", "message": "String" } |
| error.detail | 要求の処理中に発生したエラーの詳細。 データタイプ：文字列 |
| error.message | 要求の処理中に発生したエラーのメッセージ。 データタイプ：文字列 |
| result | 取り込み要求の結果オブジェクトを表す JSON 形式の文字列。 データタイプ：文字列 "result": "{\"duration_in_ms\": Number, \"feedback\": [Array] }" |
| result.duration_in_ms | 外部ドキュメントの取り込みに費やされた時間。 データタイプ：数値 単位：ミリ秒 |
| result.feedback | オブジェクトのアレイで、各オブジェクトは、要求本文から取り込まれたドキュメントのフィードバックを表します。 データタイプ：アレイ "feedback": [ { "document_id": "String", "messages": [Array] } ] |
| result.feedback.document_id | 要求本文で指定された外部ドキュメントの一意の識別子。 データタイプ：文字列 |
| result.feedback.messages | 名前なしオブジェクトのアレイで、各オブジェクトは、外部ドキュメントのインデックス作成中にログに記録された取り込みフィードバックメッセージを表します。 データタイプ：アレイ "messages": [ { "code": "String", "component": "String", "level": "String", "message": "String" } ] |
| result.feedback.messages.code | 取り込みフィードバックメッセージを記録したインデックス作成ワークフローコンポーネントによってスローされた例外のコード。 データタイプ：文字列 |
| result.feedback.messages.component | 取り込みフィードバックメッセージを記録したインデックス作成ワークフローコンポーネントの識別子。 データタイプ：文字列 |
| result.feedback.messages.level | 取り込みフィードバックメッセージのログ記録レベル。 有効な値： * ERROR * INFO * MINOR_ERROR * WARN {#ext_content-POST-ingestDocument__ul_xsh_c15_4nb} データタイプ：文字列 |
| result.feedback.messages.message | 取り込みフィードバックメッセージについてログに記録されたテキスト。 データタイプ：文字列 |
| status | 失敗した要求のステータス。 有効な値： * failure {#ext_content-POST-ingestDocument__ul_h5r_z54_pnb} データタイプ：文字列 |
[ ]
### プリンシパル権限の優先順位 {#ext_content-POST-ingestDocument__principal-precedence-section}
\[array\].principals 権限の優先順位は、外部ドキュメントの取り込みに使用されるインデックス付きソースの user_read_takes_precedence_over_group_deny 属性の値によって異なります。{#ext_content-POST-ingestDocument__table_vlm_d2t_vpb__entry__2}
| 属性値 | プリンシパル権限の優先順位 |
|-|-|
| true | 優先順位の高いものから低いものへ： 1. \[array\].principals.everyone、\[array\].principals.none 2. \[array\].principals.users.deny 3. \[array\].principals.users.read 4. \[array\].principals.groups.deny 5. \[array\].principals.groups.read {#ext_content-POST-ingestDocument__ol_y41_h2t_vpb} 注: これは、外部コンテンツのインデックス付きソースのデフォルトの属性値です。 |
| false | 優先順位の高いものから低いものへ： 1. \[array\].principals.everyone、\[array\].principals.none 2. \[array\].principals.users.deny、\[array\].principals.groups.deny 3. \[array\].principals.users.read、\[array\].principals.groups.read {#ext_content-POST-ingestDocument__ol_d5s_h2t_vpb} 注: この属性値の設定手順については、「 [外部コンテンツのインデックス付きソースに対するユーザーの読み取り権限とグループ拒否権限の優先順位を変更する](https://www.servicenow.com/docs/access?context=defining-access-perms-ext-docs-ais&version=xanadu&pubname=xanadu-platform-administration&ft:locale=en-US)」を参照してください。 |
[ ]
{#ext_content-POST-ingestDocument__table_vlm_d2t_vpb}
### cURL 要求
u_ext_content スキーマテーブルにインデックスを作成するために、2 つの外部ドキュメント ([POST /ais/external_content/storeContent](https://servicenow-prod.fluidtopics.net/aOdIU2kOqrhbjbAR6yPk8Q#ext_content-POST-storeContent "バイナリコンテンツをコンテンツオブジェクトとして AI 検索 に保存します。") エンドポイントを使用して以前に保存されたバイナリコンテンツオブジェクトへのコンテンツポインターあり) をフィードします。
curl 'https://instance.servicenow.com/api/now/v2/ais/external_content/ingestDocument/u_ext_content' \
--request POST \
--user 'username':'password' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
{
"document_id": "ADMIN-2027858531-16",
"content_pointer": "749b52a1-baa8-4556-a4f3-00404c95e6a8",
"properties": {
"title": "Introduction",
"url": "file:///myhost/reports/Introduction.pdf",
"file_name": "Introduction.pdf",
"file_size": "10285",
"creation_date": "2020-11-01 12:27:43"
},
"principals": {
"everyone": false,
"groups.read": [
"report-users",
"report-admins"
],
"users.deny": [
"ad\abel-tuter"
]
}
},
{
"document_id": "ADMIN-2587918521-27",
"content_pointer": "bd605435-268b-464f-a7c3-0c5ea894a5c2",
"properties": {
"title": "Report for 31 August 2020",
"url": "file:///myhost/reports/Report-2020-08-31.pdf",
"file_size": "27597",
"creation_date": "2020-09-01 12:48:13"
},
"principals": {
"everyone": false,
"groups.read": [
"report-users",
"report-admins"
],
"users.read": [
"ad\beth-anglin"
]
}
}
]'
{
"result":"{\"duration_in_ms\":3822,\"feedback\":[{\"messages\":[{\"level\":\"INFO\",\"message\":\"CREATED\",\"component\":\"init\"},{\"level\":\"INFO\",\"message\":\"OK\",\"component\":\"index-886de18e750030108b23bcd69cdc2dd3-indexer.index-886de18e750030108b23bcd69cdc2dd3-content-dispatcher\"},{\"level\":\"INFO\",\"message\":\"COMPLETED\",\"component\":\"sink.sink\"}],\"document_id\":\"ADMIN-2027858531-16\"},{\"messages\":[{\"level\":\"INFO\",\"message\":\"CREATED\",\"component\":\"init\"},{\"level\":\"WARN\",\"message\":\"field \\u0027text\\u0027 tokens exceed index.maxTokens\",\"code\":\"INDEX_ENGINE-32\",\"component\":\"ingestGlideDocument.standardAnalyzer\"},{\"level\":\"INFO\",\"message\":\"OK\",\"component\":\"index-886de18e750030108b23bcd69cdc2dd3-indexer.index-886de18e750030108b23bcd69cdc2dd3-content-dispatcher\"},{\"level\":\"INFO\",\"message\":\"COMPLETED\",\"component\":\"sink.sink\"}],\"document_id\":\"ADMIN-2587918521-27\"}]}"
}
## 外部コンテンツ取り込み API -- POST ais/external_content/storeContent {#ariaid-title5}
バイナリコンテンツをコンテンツオブジェクトとして AI 検索 に保存します。
保存されているバイナリコンテンツを外部ドキュメントに関連付けるには、次の手順を実行します。
1. このエンドポイントを使用してバイナリコンテンツを保存します。result 応答本文パラメーターの値を記録します。
2. [POST /ais/external_content/ingestDocument/{schema_table_name}](https://servicenow-prod.fluidtopics.net/aOdIU2kOqrhbjbAR6yPk8Q#ext_content-POST-ingestDocument "インデックス作成のために、外部ドキュメントのリストを AI 検索 取り込みバッチャーに送信します。インデックス作成が完了すると、取り込まれたドキュメントのコンテンツが検索可能になります。") エンドポイントを使用して、外部ドキュメントを AI 検索 に送信します。記録された result 応答本文パラメーター値と一致するように、ドキュメントの content_pointer 要求本文パラメーターを設定します。
{#ext_content-POST-storeContent__ol_bz4_prf_ynb} 取り込み中、AI 検索 はバイナリコンテンツを解析し、その検索可能なコンテンツを外部ドキュメントを表すインデックス付きレコードに追加します。解析により、保存されているコンテンツオブジェクトが削除されます。
### URL 形式
バージョニングされた URL：/api/now/{api_version}/ais/external_content/storeContent
### サポートされている要求パラメーター
{#ext_content-POST-storeContent__entry__2}{#ext_content-POST-storeContent__version-RESTAPI}
| パラメーター | 説明 |
|-|-|
| api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
[表 : 19. パスパラメーター]
{#ext_content-POST-storeContent__entry__6}
| 名前 | 説明 |
|-|-|
| なし | |
[表 : 20. クエリパラメーター]
{#ext_content-POST-storeContent__entry__10}
| 要素 | 説明 |
|-|-|
| \[binary data\] | 必須です。コンテンツオブジェクトとして AI 検索 に保存するバイナリコンテンツ。 |
[表 : 21. 要求本文パラメーター]
### ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。
{#ext_content-POST-storeContent__entry__14}{#ext_content-POST-storeContent__accept-JSON-only-entry-RESTAPI}
| ヘッダー | 説明 |
|-|-|
| 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 |
| Content-Type | 要求本文のデータ形式。 有効な値： * application/msword * application/octet-stream * application/pdf * application/vnd.ms-excel * application/vnd.ms-powerpoint * application/vnd.ms-powerpoint.presentation.macroenabled.12 * application/vnd.openxmlformats-officedocument.presentationml.presentation * application/vnd.openxmlformats-officedocument.presentationml.template * application/vnd.openxmlformats-officedocument.spreadsheetml.sheet * application/vnd.openxmlformats-officedocument.wordprocessingml.document * application/vnd.openxmlformats-officedocument.wordprocessingml.template * text/html * text/plain {#ext_content-POST-storeContent__ul_zkc_tb5_4nb} |
[表 : 22. 要求ヘッダー]
{#ext_content-POST-storeContent__entry__20}
| ヘッダー | 説明 |
|-|-|
| なし | |
[表 : 23. 応答ヘッダー]
### ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。
{#ext_content-POST-storeContent__entry__24}{#ext_content-POST-storeContent__entry-200-status-code}{#ext_content-POST-storeContent__entry-400-status-code}{#ext_content-POST-storeContent__entry-500-status-code}
| ステータスコード | 説明 |
|-|-|
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 |
| 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 |
[表 : 24. ステータスコード]
### 応答本文のパラメーター (JSON または XML)
{#ext_content-POST-storeContent__entry__32}
| 要素 | 説明 |
|-|-|
| error | 要求の処理中に発生した発生したエラーを説明するオブジェクト。 データタイプ：オブジェクト "error": { "detail": "String", "message": "String" } |
| error.detail | 要求の処理中に発生したエラーの詳細。 データタイプ：文字列 |
| error.message | 要求の処理中に発生したエラーのメッセージ。 データタイプ：文字列 |
| result | 成功した要求によって保存されたバイナリコンテンツオブジェクトの識別子。 データタイプ：文字列 "result" : "91841766-2a5f-4c64-a20a-27ca485eca21" 注: 保存されているコンテンツを、取り込んだ外部ドキュメントに添付するには、この識別子を ingestDocument エンドポイントへの要求の content_pointer 要求本文要素として指定します。 |
| status | 失敗した要求のステータス。 有効な値： * failure {#ext_content-POST-storeContent__ul_h5r_z54_pnb} データタイプ：文字列 |
[ ]
### cURL 要求
PDF ファイルのバイナリコンテンツをコンテンツオブジェクトとして保存します。
curl 'https://instance.servicenow.com/api/now/v2/ais/external_content/storeContent' \
--request POST \
--user 'username':'password' \
--header 'Content-Type: application/pdf' \
--data-binary '@Report-2020-08-31.pdf'
応答本文には、新しいコンテンツオブジェクトの一意の識別子が含まれています。
{
"result" : "fb439a4f-62ad-4dab-9654-5088d99a6ff9"
}