複合データタイプへのレコードのエクスポートと変換

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む5読むのに数分

    • URL パラメーターを使用して、テーブルレコードをエクスポートし、JSON、XML、PDF、CSV、XLS などの複合データタイプに変換します。

    複合データタイプとしてのレコードのエクスポート

    HTTP GET 要求を使用して、テーブルからレコードを取得し、指定された形式にすることができます。たとえば、GET 要求で PDF パラメーターを使用して、テーブルからレコードを PDF ファイルとしてエクスポートしたり、XLS パラメーターを使用して、テーブルからレコードを XLS ファイルとしてエクスポートしたりします。たとえば、インシデントレコードリストを XLS ファイルとして取得するには、次の URL を使用して HTTP GET を発行します：https://instance_name.service-now.com/incident.do?XLS。返されるファイルは incident.xlsです。incident.do は基本的に、インシデントテーブルのレコードリストを返す GET です。XLS パラメーターは、これらのレコードを XLS ファイルに変換します。

    一般的な構文：https://<serviceNow-instance-name>/<table-name>.do?<Data-type-parameter>

    URL パラメーター

    次の表には、GET 要求で使用できる URL パラメーター、不要なテーブルレコードを結果から除外するために使用できるフィルター、およびデータタイプをテーブルに直接 POST できるかどうかを示しています。パラメーターは、返されるファイルの拡張子になります。たとえば、XLS パラメーターを使用すると、<table-name>.xls 形式のファイルが返されます。
    表 : 1. URL パラメーター
    データタイプ パラメーター 有効なフィルター テーブルに直接 POST しますか？
    CSV CSV sysparm_query、sysparm_view Y
    Excel XLS、EXCEL、XLSX sysparm_query、sysparm_view Y
    JSON JSONv2 各種あります。「JSON データ検索 API」を参照してください。 Y
    PDF PDF sysparm_query、sysparm_view N
    RSS RSS sysparm_query、sysparm_view など。「ビューによる結果の制限」を参照してください。 N
    XML XML、XSD、SCHEMA sysparm_query、useUnloadFormat N

    テーブルレコードの取得と JSON ファイル形式への変換の詳細については、「JSONv2 Web サービス」を参照してください。

    テーブルレコードの取得と RSS ファイル形式への変換の詳細については、「RSS フィードジェネレーター」を参照してください。

    PDF へのレコードの変換

    PDF エクスポートでは、テーブルをターゲットにすることとそのリストをターゲットにすることは区別されます。レコードリストの PDF を生成するには、ターゲットに _list のサフィックスを付けます。単一のレコードをターゲットにするには、sys_id パラメーターを指定して、PDF を生成するレコードを識別する必要があります。

    フィルター

    すべての URL パラメーターは、テーブルレコードのサブセットをエクスポートできるようにするフィルターとともに機能します。たとえば、GET 要求の sysparm_query=active=true はアクティブなレコードのみをエクスポートします。アクティブなインシデントレコードのみを Excel 形式でエクスポートする例：https://instance_name.service-now.com/incident.do?EXCEL&sysparm_query=active=true

    一般的な構文：https://<serviceNow-instance-name>/<table_list>.do?<Data-type-parameter>&<filter>

    フィルターには次のようなものがあります。
    • sysparm_query：ファイルをエクスポートする前に、エンコードされたクエリを使用してデータをフィルタリングします。たとえば、sysparm_query=active=true はアクティブなレコードのみをエクスポートします。
    • sysparm_view：返されるフィールドを制御するリストビューの名前を指定します。たとえば、ESS ビューを返すには、sysparm_view=ess を使用します。
    • useUnloadFormat：返される XML 形式がアンロード形式であることを示します。アンロード形式は、UI のリストから [エクスポート] > [XML] > [...] を選択した場合に使用される形式と同じです。アンロード形式の XML ファイルをテーブルにインポートし直すことができます。URL からアンロード形式を有効にするには、URL パラメーターの useUnloadFormat=true を使用します (例：https://instance_name.service-now.com/incident.do?XML&useUnloadFormat=true)。

    GET クエリの例

    表 : 2. GET 要求の例
    データタイプ サンプルクエリ
    CSV https://instance_name.service-now.com/incident.do?CSV&sysparm_query=active=true
    Excel https://instance_name.service-now.com/incident.do?XLS&sysparm_query=active=true
    PDF https://instance_name.service-now.com/incident.do?PDF&sysparm_view=ess
    RSS https://instance_name.service-now.com/incident.do?RSS&sysparm_view=ess
    XML https://instance_name.service-now.com/incident.do?XML&sysparm_query=active=true

    返されるファイル

    GET クエリは、要求で指定された形式でテーブルからレコードを返します。たとえば、XLS パラメーターを使用するクエリは、.xls 拡張子のファイルのテーブルレコードを返します。

    応答の Content-Disposition ヘッダーには、返されたファイルのファイル名と拡張子が表示されます。ファイル名はエクスポート元のテーブルに基づいています (incident.xls、incident.pdf、incident.xml など)。

    テーブルへのデータのエクスポート

    次のデータタイプをテーブルに直接 POST できます。
    • CSV
    • Excel
    • JSON

    ファイルヘッダーは、ターゲットテーブルのフィールド列と一致する必要があります。詳細については、「 CSV または Excel ファイルをインポートセットに直接投稿する」を参照してください。