REST APIリファレンス

前へ次へ

dataPreview

このリソースを使用して、マッピングの設計中にデータをプレビューします。デフォルトでは、応答は指定したオブジェクトのデータを最大10行返します。

GET要求

プレビューデータを要求するには、接続IDまたは接続名と、URIのオブジェクト名を指定します。必要に応じて、要求にフィールド形式の情報を含めることができます。

次のいずれかのURIを使用します。

ソースデータを要求するには、次のいずれかのURIを使用します。

/api/v2/connection/source/<id>/datapreview/<objectName>

/api/v2/connection/source/name/<name>/datapreview/<objectName>

ターゲットデータを要求するには、次のいずれかのURIを使用します。

/api/v2/connection/target/<id>/datapreview/<objectName>

/api/v2/connection/target/name/<name>/datapreview/<objectName>

フラットファイル、Avro、Parquet、Orc、JSON形式の応答にフィールドメタデータを受信できます。フィールドメタデータを受信するには、要求本文に形式の情報を含めます。

フラットファイル形式の場合、flatFileAttrsオブジェクトに次の情報を含めることができます。

フィールド	タイプ	必須	説明
id	Long	はい	フィールドID。
delimiter	String	○	フィールドを区切るために使用される文字。
textQualifier	String	○	テキスト文字列の境界を定義する引用符。
escapeChar	String	○	引用符で囲まれていない文字列に埋め込まれたフィールド区切り文字の直前の文字、または引用符で囲まれた文字列内の引用符の直前の文字。
headerLineNo	Int	○	ヘッダー行の数。
firstDataRow	Int	○	ファイル内でデータが始まる行番号。
rowDelimiter	Int	--	改行文字。1から32までのASCII文字の10進数コードを入力します。デフォルト値は10で、これは改行文字です。
consecutiveDelimiter	Boolean	--	1つ以上の連続する区切り文字を1つの文字として扱うかどうかを示します。デフォルトはfalseです。
multiDelimitersAsAnd	Boolean	--	指定した区切り文字が複数の文字である場合に、その文字を1つの区切り文字として扱うか、複数の区切り文字として扱うかを示します。デフォルトはtrueです。

Avro、Parquet、Orc、またはJSON形式の場合、dataFormatオブジェクトに次の情報を含めます。

フィールド	タイプ	必須	説明
formatId	String	○	形式タイプ、例えば、Avro。
schema	String	--	スキーマ形式。

デフォルトでは、dataPreview応答は10行返します。フラットファイル接続の場合、次の例に示すように、numRowsパラメータを使用して行数を指定できます。

/api/v2/connection/source/<id>/datapreview/?objectName=<object name>&numRows=<number of rows to view>

次の例に示すように、startRowNumパラメータを使用して最初の行を指定することもできます。

/api/v2/connection/source/<id>/datapreview/?objectName=<object name>&startRowNum=<row number of row to begin with>

URIに接続名を使用し、その接続名にスペースが含まれる場合は、スペースを

%20

で置き換えます。以下に例を示します。

/api/v2/connection/target/name/my%20connection/datapreview/SF_ACCOUNT.csv

GET応答

要求された接続IDか、接続名およびオブジェクト名のdataPreviewオブジェクトを返します。

dataPreviewオブジェクトには次の属性が含まれます。

フィールド	タイプ	説明
connId	String	接続ID。
objectName	String	ソースまたはターゲットオブジェクトの名前。
header	String	列ヘッダー。
fieldName	String	フィールド名。
fieldBusinessName	String	ビジネスフィールド名。
data		dataPreviewEntryオブジェクトには次の属性が含まれます。
values	String	dataPreviewEntryオブジェクトに含まれています。ソースまたはターゲットオブジェクトのフィールド値。

GET要求の例

次の例では、

SF_ACCOUNT.csv

オブジェクトからデータをプレビューするための要求を示しています。

GET <serverUrl>/api/v2/connection/target/0000010B000000000003/datapreview/SF_ACCOUNT.csv HTTP/1.0
Accept:application/json
icSessionId: <icSessionId>

次の例では、

customer.parquet

オブジェクトからデータをプレビューするための要求を示しています。

POST <serverUrl>/api/v2/connection/source/0000010B000000000009/datapreview?objectName=customer.parquet
1.0
Content-Type: application/xml
Accept: application/xml
icSessionId: <icSessionId>
{
    "@type": "dataFormat",
    "dformatId": "Parquet",
    "schema": "message AllData_root { optional int32 c_custkey; optional binary c_name (UTF8); optional binary c_address (UTF8); optional int64 c_nationkey; optional binary c_phone (UTF8); optional double c_acctbal; optional binary c_mktsegment (UTF8); required binary c_comment (UTF8);}"
}

GET応答の例

次の例のような応答を受信します。

{

   "@type": "dataPreview",
   "connId": "0000010B000000000003",
   "objectName": "SF_ACCOUNT.csv",
   "header":    [
      "ID",
      "ISDELETED",
      "MASTERRECORDID",
      "NAME",
      "TYPE",
      "PARENTID",
      "BILLINGSTREET",
      "BILLINGCITY",
      "BILLINGSTATE",
      "BILLINGPOSTALCODE",
      "BILLINGCOUNTRY",
      "BILLINGLATITUDE",
      "BILLINGLONGITUDE",
      "SHIPPINGSTREET",
      "SHIPPINGCITY",
      "SHIPPINGSTATE",
      "SHIPPINGPOSTALCODE",
      "SHIPPINGCOUNTRY",
      "SHIPPINGLATITUDE",
      "SHIPPINGLONGITUDE",
      "PHONE",
      "FAX",
      "ACCOUNTNUMBER",
      "WEBSITE"
   ],

   "fieldName":    [
      "ID",
      "ISDELETED",
      "MASTERRECORDID",
      "NAME",
      "TYPE",
      "PARENTID",
      "BILLINGSTREET",
      "BILLINGCITY",
      "BILLINGSTATE",
      "BILLINGPOSTALCODE",
      "BILLINGCOUNTRY",
      "BILLINGLATITUDE",
      "BILLINGLONGITUDE",
      "SHIPPINGSTREET",
      "SHIPPINGCITY",
      "SHIPPINGSTATE",
      "SHIPPINGPOSTALCODE",
      "SHIPPINGCOUNTRY",
      "SHIPPINGLATITUDE",
      "SHIPPINGLONGITUDE",
      "PHONE",
      "FAX",
      "ACCOUNTNUMBER",
      "WEBSITE"
   ],

   "fieldBusinessName":    [
      "ID",
      "ISDELETED",
      "MASTERRECORDID",
      "NAME",
      "TYPE",
      "PARENTID",
      "BILLINGSTREET",
      "BILLINGCITY",
      "BILLINGSTATE",
      "BILLINGPOSTALCODE",
      "BILLINGCOUNTRY",
      "BILLINGLATITUDE",
      "BILLINGLONGITUDE",
      "SHIPPINGSTREET",
      "SHIPPINGCITY",
      "SHIPPINGSTATE",
      "SHIPPINGPOSTALCODE",
      "SHIPPINGCOUNTRY",
      "SHIPPINGLATITUDE",
      "SHIPPINGLONGITUDE",
      "PHONE",
      "FAX",
      "ACCOUNTNUMBER",
      "WEBSITE"
   ],

   "rows":    [
            {
         "@type": "dataPreviewEntry",
         "values":          [
            "001i000000KIAQGAA5",
            "0",
            "",
            "ABCPoint",
            "Customer - Channel",
            "",
            "345 ABC Park",
            "Mountain View",
            "CA",
            "94063",
            "",
            "",
            "",
            "345 ABC Park",
            "Mountain View",
            "CA",
            "94063",
            "",
            "",
            "",
            "(650) 555-3450",
            "(650) 555-9895",
            "CC978213",
            "www.ABCpoint.com"
         ]
      },

            {
         "@type": "dataPreviewEntry",
         "values":          [
            "001i000000KIAQHAA5",
            "0",
            "",
            "123 United, UK",
            "Customer - Direct",
            "",
            "123 Estate,\nGateshead, Tyne and Wear NE26 3HS\nUnited Kingdom",
            "",
            "UK",
            "94063",
            "",
            "",
            "",
            "123 Estate,\nGateshead, Tyne and Wear NE26 3HS\nUnited Kingdom",
            "",
            "",
            "94063",
            "",
            "",
            "",
            "+44 123 4567899",
            "+44 123 4567899",
            "CD355119-A",
            "http://www.123United.com"
         ]

      }

データ統合 REST API

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal