外部コンテンツ取り込み API

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間:34分
  • 外部コンテンツ取り込み API は、ServiceNow® インスタンスの外部のソースから ServiceNow® AI 検索 アプリケーションのインデックスにコンテンツを取り込むことができるエンドポイントを提供します。

    外部コンテンツ取り込み API – DELETE /ais/external_content/deleteByQuery/{schema_table_name}

    指定されたクエリに一致するすべての外部ドキュメントを AI 検索 インデックスから削除します。

    URL 形式

    バージョニングされた URL: /api/now/{api_version}/ais/external_content/deleteByQuery/{schema_table_name}?query={query}

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

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

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

    データタイプ:文字列

    schema_table_name

    削除するインデックス付きドキュメントのスキーマを定義する外部コンテンツスキーマテーブルの名前。例: u_ext_content

    データタイプ:文字列

    表 : 2. クエリパラメーター
    名前 説明
    クエリ

    schema_table_name で指定されたスキーマテーブルに対する有効な URL エスケープクエリ。たとえば、 title=Introduction と入力すると、タイトルが [Introduction] であるドキュメントのクエリを実行します。

    データタイプ:文字列

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

    ヘッダー

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

    表 : 4. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    表 : 5. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 6. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

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

    名前 説明
    エラー

    要求の処理中に発生したエラーを説明するオブジェクト。

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

    "error": {
      "detail": "String",
      "message": "String"
    }
    error.detail

    要求の処理中に発生したエラーの詳細。

    データタイプ:文字列

    error.message

    要求の処理中に発生したエラーのメッセージ。

    データタイプ:文字列

    result

    正常に処理された要求の結果。

    データタイプ:文字列

    status

    失敗した要求のステータス。

    有効な値:
    • failure

    データタイプ:文字列

    cURL 要求

    2020 年 10 月 31 日の [タイトル] フィールド値を含むドキュメントを削除します (u_ext_contentスキーマテーブルから 2020 年 10 月 31 日の前書きとレポート)。

    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}

    指定された一意の識別子を持つ外部ドキュメントを AI 検索 インデックスから削除します。

    URL 形式

    バージョニングされた URL: /api/now/{api_version}/ais/external_content/deleteDocument/{schema_table_name}/{document_id}

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

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

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

    データタイプ:文字列

    document_id

    削除する外部ドキュメントの一意の識別子。例: ADMIN-2027858531-16

    データタイプ:文字列

    schema_table_name

    削除するインデックス付きドキュメントのスキーマを定義する外部コンテンツスキーマテーブルの名前。例: u_ext_content

    データタイプ:文字列

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

    ヘッダー

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

    表 : 10. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    表 : 11. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 12. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

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

    要素 説明
    エラー

    要求の処理中に発生したエラーを説明するオブジェクト。

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

    "error": {
      "detail": "String",
      "message": "String"
    }
    error.detail

    要求の処理中に発生したエラーの詳細。

    データタイプ:文字列

    error.message

    要求の処理中に発生したエラーのメッセージ。

    データタイプ:文字列

    result

    正常に処理された要求の結果。

    データタイプ:文字列

    status

    失敗した要求のステータス。

    有効な値:
    • failure

    データタイプ:文字列

    cURL 要求

    識別子 ADMIN-2587918521-27 を持つドキュメントをu_ext_contentスキーマテーブルから削除します。

    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}

    インデックス作成のために外部ドキュメントのリストを AI 検索 取り込みバッチャーに送信します。インデックス作成が完了すると、取り込まれたドキュメントのコンテンツが検索可能になります。

    このエンドポイントを使用して、外部ドキュメントにテキストコンテンツとメタデータをフィードできます。

    検索可能なバイナリコンテンツとメタデータを外部ドキュメントに関連付ける必要がある場合は、次の手順を実行します。
    1. POST /ais/external_content/storeContent エンドポイントを使用して、バイナリコンテンツを AI 検索 に格納します。result応答本文パラメーターの値を記録します。
    2. このエンドポイントを使用して、外部ドキュメントを AI 検索 に送信します。記録されたresult応答本文のパラメーター値と一致するように、ドキュメントのcontent_pointer要求本文パラメーターを設定します。
    取り込み中に、 AI 検索 はバイナリコンテンツを解析し、その検索可能なコンテンツを外部ドキュメントを表すインデックス付きレコードに追加します。解析すると、保存されているコンテンツオブジェクトが削除されます。

    URL 形式

    バージョニングされた URL: /api/now/{api_version}/ais/external_content/ingestDocument/{schema_table_name}

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

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

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

    データタイプ:文字列

    schema_table_name

    要求内の外部ドキュメントのスキーマを定義する外部コンテンツスキーマテーブルの名前。例: u_ext_content

    データタイプ:文字列

    表 : 14. クエリパラメーター
    名前 説明
    なし
    表 : 15. 要求本文パラメーター (XML または JSON)
    要素 説明
    [アレイ]

    必須です。各オブジェクトがインデックス作成のために取り込む外部ドキュメントを表す、名前のないオブジェクトのアレイ。

    データタイプ:アレイ

    [
      {
        "content_pointer": "String",
        "document_id": "String",
        "principals": {Object},
        "properties": {Object}
      }
    ]
    [アレイ].content_pointer
    POST /ais/external_content/storeContent エンドポイントを使用して保存されるバイナリコンテンツのインスタンスの識別子。 取り込み中に、 AI 検索 はバイナリコンテンツを解析し、その検索可能なコンテンツを外部ドキュメントを表すインデックス付きレコードに追加します。解析すると、保存されているコンテンツオブジェクトが削除されます。
    注:
    この識別子は、storeContent エンドポイントによって返されるresult応答本文要素と一致する必要があります。

    データタイプ:文字列

    [アレイ].document_id

    必須です。schema_table_nameパスパラメーターで指定された外部コンテンツスキーマテーブル内の外部ドキュメントの一意の識別子。

    注:
    ドキュメントを取り込むと、同じ document_idを持つ同じ外部コンテンツスキーマテーブル内の既存のドキュメントが上書きされます。同じ取り込み要求内の 2 つ以上のドキュメントの document_idが同じ場合、要求は失敗します。

    データタイプ:文字列

    [アレイ].principals
    外部定義のセキュリティプリンシパル (ユーザーとグループ) に対する外部ドキュメントのアクセス権限を記述するキーと値のペアを含むオブジェクト。
    注:

    ドキュメントのこのパラメーターを省略した場合、要求は成功しますが、取り込みフィードバックメッセージとともにドキュメント AI 検索 却下されます ドキュメント のプリンシパルがありません

    このパラメーターオブジェクトにドキュメントへのアクセスを許可するキーと値のペアが含まれていない場合、要求は成功しますが、取り込みフィードバックメッセージを含むドキュメント AI 検索 却下されます ドキュメントのプリンシパルが無効です

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

    "principals": {
      "everyone": Boolean,
      "groups.deny": [Array],
      "groups.read": [Array],
      "none": Boolean,
      "users.deny": [Array],
      "users.read": [Array]
    }

    サポートされているバージョン:API の v2 以降で利用可能です。

    [アレイ].principals.everyone
    外部ドキュメントへのアクセスをすべてのユーザーに許可するかどうかを示すフラグ。このパラメーターを true に設定すると、すべての ServiceNow AI Platform ユーザーがドキュメントから作成されたインデックス付きレコードを表示できます。
    注:
    このパラメーターと [array].principals.none の両方をドキュメントの true に設定すると、要求は成功しますが、取り込みフィードバックメッセージとともにドキュメントが却下されます AI 検索ドキュメントのプリンシパルが無効です。これら 2 つのパラメーターのうち 1 つのみを要求で true に設定できます。
    有効な値:
    • true:すべてのユーザーに対してドキュメントへのアクセスを許可します。 AI 検索 は、ドキュメントのすべての [array].principals.groups.* および [array].principals.users.* パラメーター設定を無視します。
    • false:すべてのユーザーに外部ドキュメントへのアクセスを許可しません。ユーザーは、 [array].principals.none が false に設定されていて、ユーザーマッピングと [array].principals.groups.* パラメーターと [array].principals.users.* パラメーターのインタラクションによって許可されている場合にのみ、ドキュメントにアクセスできます。

    データタイプ:ブーリアン

    デフォルト: true

    サポートされているバージョン:API の v2 以降で利用可能です。

    [アレイ].principals.groups.deny

    文字列のアレイ。各文字列は、外部ドキュメントへのアクセスが拒否された外部定義グループの名前です。これらの外部グループのいずれかにマップされた ServiceNow AI Platform ユーザーは、ドキュメントから作成されたインデックス付き検索結果レコードを表示できません。

    [array].principals.everyone または [array].principals.none のいずれかが true に設定されている場合、このパラメーターは効果がありません。

    このパラメーターは [array].principals.groups.readよりも優先されます。同じユーザーがドキュメントの読み取りおよび拒否の両方のアクセス権限を持つ外部グループにマッピングされている場合、 AI 検索 はそのユーザーのインデックス付きレコードへのアクセスを拒否します。

    デフォルトでは、 [array].principals.users.read がこのパラメーターよりも優先されます。インデックス付きソースのこの優先順位を逆にするには、「 外部コンテンツのインデックス付きソースのユーザー読み取りおよびグループ拒否のアクセス許可の優先順位を変更する」を参照してください。

    データタイプ:アレイ

    値は、指定された外部定義グループの名前に応じて、任意の形式にすることができます。例:

    "groups.deny": [
      "hr-admin",
      "legal"
    ]

    サポートされているバージョン:API の v2 以降で利用可能です。

    [array].principals.groups.read

    文字列のアレイ。各文字列は、外部ドキュメントへのアクセスが許可されている外部定義グループの名前です。これらの外部グループのいずれかにマップされた ServiceNow AI Platform ユーザーは、ドキュメントから作成されたインデックス付き検索結果レコードを表示できます。

    [array].principals.everyone または [array].principals.none のいずれかが true に設定されている場合、このパラメーターは効果がありません。

    [array].principals.groups.deny はこのパラメーターよりも優先されます。同じユーザーがドキュメントの読み取りおよび拒否の両方のアクセス権限を持つ外部グループにマッピングされている場合、 AI 検索 はそのユーザーのインデックス付きレコードへのアクセスを拒否します。

    データタイプ:アレイ

    値は、指定された外部定義グループの名前に応じて、任意の形式にすることができます。例:

    "groups.read": [
      "devops",
      "it",
      "report-admins"
    ]

    サポートされているバージョン:API の v2 以降で利用可能です。

    [アレイ].principals.none
    すべてのユーザーの外部ドキュメントへのアクセスが拒否されているかどうかを示すブーリアンオプション。このパラメーターを true に設定すると、ais_high_security_admin昇格した権限ロールを持つ ServiceNow AI Platform ユーザーのみが、ドキュメントから作成されたインデックス付きレコードを表示できます。
    注:
    ドキュメントでこのパラメーターと [array].principals.everyone の両方を true に設定すると、取り込み時に、AI 検索 は「The principal of the document is invalid」というエラーメッセージとともにドキュメントを却下します。これら 2 つのパラメーターのうち 1 つのみを要求で true に設定できます。
    有効な値:
    • true:ais_high_security_admin昇格した権限ロールを持つユーザーを除くすべてのユーザーのドキュメントへのアクセスを拒否します。 AI 検索 では、ドキュメントのすべての [array].principals.groups.* および [array].principals.users.* パラメーター設定は無視されます。
    • false:すべてのユーザーのドキュメントへのアクセスを拒否しません。[array].principals.everyonetrue に設定されている場合、またはユーザーマッピングと[array].principals.groups.readパラメーターと[array].principals.users.readパラメーターのインタラクションによって許可されている場合、ユーザーはドキュメントにアクセスできます。

    データタイプ:ブーリアン

    デフォルト: false

    サポートされているバージョン:API の v2 以降で利用可能です。

    [アレイ].principals.users.deny

    文字列のアレイ。各文字列は、外部ドキュメントへのアクセスを拒否された外部定義ユーザーの名前です。これらの外部ユーザーのいずれかにマップされた ServiceNow AI 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

    文字列のアレイ。各文字列は、外部ドキュメントへのアクセスが許可されている外部定義ユーザーの名前です。これらの外部ユーザーのいずれかにマップされた ServiceNow AI Platform ユーザーは、ドキュメントから作成されたインデックス付き検索結果レコードを表示できます。

    [array].principals.everyone または [array].principals.none のいずれかが true に設定されている場合、このパラメーターは効果がありません。

    [array].principals.users.deny はこのパラメーターよりも優先されます。同じユーザーがドキュメントの読み取りおよび拒否アクセス権限の両方を持つ外部ユーザーにマップされている場合、 AI 検索 はそのユーザーのインデックス付きレコードへのアクセスを拒否します。

    デフォルトでは、このパラメーターは [array].principals.groups.denyよりも優先されます。インデックス付きソースのこの優先順位を逆にするには、「 外部コンテンツのインデックス付きソースのユーザー読み取りおよびグループ拒否のアクセス許可の優先順位を変更する」を参照してください。

    データタイプ:アレイ

    値は、指定された外部定義ユーザーの名前に応じて、任意の形式にすることができます。例:

    "users.read": [
      "ad\abel-tuter",
      "beth-anglin@sharepoint"
    ]

    サポートされているバージョン:API の v2 以降で利用可能です。

    [アレイ].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"
    }

    ヘッダー

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

    表 : 16. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    Content-Type 要求本文のデータ形式。application/json のみをサポートします。
    表 : 17. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 18. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    202 部分的に成功。要求が処理されました。一部のドキュメントに、取り込みフィードバックの警告またはエラーメッセージが表示されます。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

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

    名前 説明
    エラー

    要求の処理中に発生したエラーを説明するオブジェクト。

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

    "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

    データタイプ:文字列

    result.feedback.messages.message

    取り込みフィードバックメッセージに対してログに記録されるテキスト。

    データタイプ:文字列

    status

    失敗した要求のステータス。

    有効な値:
    • failure

    データタイプ:文字列

    プリンシパル権限の優先順位

    [array].principals権限の優先順位は、外部ドキュメントの取り込みに使用されるインデックス付きソースの user_read_takes_precedence_over_group_deny 属性の値によって異なります。
    属性値 プリンシパル権限の優先順位
    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
    注:
    これは、外部コンテンツのインデックス付きソースのデフォルトの属性値です。
    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

    cURL 要求

    u_ext_contentスキーマテーブルにインデックスを作成するために、2 つの外部ドキュメント ( POST /ais/external_content/storeContent エンドポイントを使用して以前に保存されたバイナリコンテンツオブジェクトへのコンテンツポインターを含む) をフィードします。

    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

    バイナリコンテンツをコンテンツオブジェクトとして AI 検索 に格納します。

    保存されたバイナリコンテンツを外部ドキュメントに関連付けるには、次の手順に従います。
    1. このエンドポイントを使用してバイナリコンテンツを保存します。result応答本文パラメーターの値を記録します。
    2. POST /ais/external_content/ingestDocument/{schema_table_name} エンドポイントを使用して、外部ドキュメントを AI 検索 に送信します。記録されたresult応答本文のパラメーター値と一致するように、ドキュメントのcontent_pointer要求本文パラメーターを設定します。
    取り込み中に、 AI 検索 はバイナリコンテンツを解析し、その検索可能なコンテンツを外部ドキュメントを表すインデックス付きレコードに追加します。解析すると、保存されているコンテンツオブジェクトが削除されます。

    URL 形式

    バージョニングされた URL: /api/now/{api_version}/ais/external_content/storeContent

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

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

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

    データタイプ:文字列

    表 : 20. クエリパラメーター
    名前 説明
    なし
    表 : 21. 要求本文のパラメーター
    要素 説明
    [バイナリデータ] 必須です。AI 検索 にコンテンツオブジェクトとして保存するバイナリコンテンツ。

    ヘッダー

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

    表 : 22. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。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
    表 : 23. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 24. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

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

    要素 説明
    エラー

    要求の処理中に発生したエラーを説明するオブジェクト。

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

    "error": {
      "detail": "String",
      "message": "String"
    }
    error.detail

    要求の処理中に発生したエラーの詳細。

    データタイプ:文字列

    error.message

    要求の処理中に発生したエラーのメッセージ。

    データタイプ:文字列

    result

    成功した要求によって保存されたバイナリコンテンツオブジェクトの識別子。

    データタイプ:文字列

    "result" : "91841766-2a5f-4c64-a20a-27ca485eca21"
    注:
    取り込まれた外部ドキュメントに保存されたコンテンツを添付するには、この識別子を ingestDocument エンドポイントへの要求のcontent_pointer要求本文要素として指定します。
    status

    失敗した要求のステータス。

    有効な値:
    • failure

    データタイプ:文字列

    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"
    }