REST APIリファレンス > データ統合 REST API > 固定幅の設定
  

固定幅の設定

fwConfigリソースを使用して、フラットファイルのソース、ルックアップ、およびターゲットオブジェクトのカラムの幅を設定します。

GET要求

すべての固定幅形式を要求するには、次のURIを使用します。
/api/v2/fwConfig
特定の固定幅形式の詳細を要求するには、URIに固定幅形式のID、固定幅のフェデレーションID、または固定幅形式の名前を含めることができます。フェデレーションIDを含めた場合、応答には固定幅形式のプロジェクトとフォルダの場所が含まれます。次のいずれかのURIを使用します。
/api/v2/fwConfig/<id>
/api/v2/fwConfig/frs/<id>
/api/v2/fwConfig/name/<name>
URIに固定幅形式名を使用し、固定幅形式名にスペースが含まれる場合は、スペースを%20で置き換えます。以下に例を示します。
/api/v2/fwConfig/name/my%20fixedwidth%20format

GET応答

fwConfigオブジェクトで、次の属性を返します。
フィールド
タイプ
説明
id
String
固定幅形式のID。
name
String
固定幅形式名。
description
String
固定幅形式の説明。
createTime
Date/Time
固定幅形式が作成された時刻。
updateTime
Date/Time
固定幅形式が最後に更新された時刻。
createdBy
String
固定幅形式を作成したユーザー。
updatedBy
String
固定幅形式を最後に更新したユーザー。
lineSequential
Boolean
各行が改行で終わるかどうかを示します。
  • - True。[改行コードあり]が有効になっています。
  • - False。[改行コードあり]が有効になっていません。
padBytes
Int
行の最後のカラムと次の行の最初のカラムの間のバイト数。
skipRows
Int
スキップする行数。空白やヘッダー行をスキップできます。
nullChar
String
NULL値を表す文字。
dateFormat
String
日付形式がフラットファイル接続で指定されていない場合に使用する、デフォルトの日付形式。
nullCharType
String
NULL文字がシングルバイトかマルチバイトかを決定します。
repeatNullChar
Boolean
単一フィールドでのNULL文字の処理方法を決定します。
  • - True。[NULL文字を繰り返す]を単一のNULL値として読み取ります。
  • - False。[NULL文字を繰り返す]を単一のNULL値として読み取りません。
stripTrailingBlank
Boolean
文字列値内の末尾にある空白の処理方法を決定します。
  • - True。末尾の空白を文字列値から削除します。
  • - False。末尾の空白を文字列値から削除しません。
location
文字列
固定幅ファイルが存在するプロジェクトとフォルダ。
columns
String
各カラムに次の属性を含めます。
  • - name。カラムの名前。
  • - nativeType。ネイティブデータ型
  • - precision。フィールドの長さ(バイト)。
  • - scale。数値の小数点以下の桁数。

GETの例

次の例では、固定幅形式IDを使用して固定幅形式の詳細を取得する要求を示しています。
GET <serverUrl>/api/v2/fwConfig/00001R29000000000002
Accept:application/json
icSessionId: <icSessionId>
次のテキストは、応答のサンプルです。
{
"@type": "fwConfig",
"id": "00001R29000000000002",
"orgId": "00001R",
"name": "item",
"description": "",
"createTime": "2016-10-06T17:08:09.000Z",
"updateTime": "2016-10-06T17:08:09.000Z",
"createdBy": "org1@infa.com",
"updatedBy": "org1@infa.com",
"lineSequential": true,
"padBytes": 0,
"skipRows": 0,
"nullChar": "*",
"nullCharType": "ASCII",
"repeatNullChar": false,
"stripTrailingBlank": false,
"location": Default\\MyProject
"dateFormat": "",
"columns": [
{
"@type": "fwColumn",
"name": "COLUMN_0",
"nativeType": "string",
"precision": 1,
"physicalLength": 0,
"scale": 0
},
{
"@type": "fwColumn",
"name": "COLUMN_1",
"nativeType": "string",
"precision": 9,
"physicalLength": 0,
"scale": 0
},
{
"@type": "fwColumn",
"name": "COLUMN_2",
"nativeType": "string",
"precision": 10,
"physicalLength": 0,
"scale": 0
}
]
}

POST要求

固定幅形式を作成するには、次のURIを使用します。
/api/v2/fwConfig
固定幅形式の場所を指定する場合、要求にコンテナIDを含めます。コンテナIDが要求に含まれていない場合、固定幅形式はDefaultフォルダに作成されます。データ統合ユーザーインタフェースでプロジェクトまたはフォルダのコンテナIDを検索できます。[エクスプローラ]ページで、フォルダを選択します。URLの最後の文字列がコンテナIDです。
例えば、次のURLのコンテナIDはdH2DuGJYda7ijgW4Sm32sRです。
https://na1.dm-us.informaticacloud.com/diUI/products/integrationDesign/main/Explore/dH2DuGJYda7ijgW4Sm32sR
固定幅形式を更新するには、次のURIに固定幅形式IDを含めます。
/api/v2/fwConfig/<id>
部分モードを使用して部分的な更新を送信できます。部分モードを使用してfwColumnオブジェクト内のフィールドを更新する場合は、名前を含める必要があります。部分モードを使用して要求を送信するには、JSON要求を使用してヘッダーに次の行を含めます。
Update-Mode=PARTIAL
fwConfig POST要求では、次の属性を使用できます。
フィールド
タイプ
必須
説明
id
String
固定幅形式のID。
name
String
固定幅形式名。
description
String
固定幅形式の説明。
containerId
String
リニアタスクフローを含めるためのプロジェクトまたはフォルダのID。
要求に含まれていない場合、リニアタスクフローはDefaultフォルダに作成されます。
lineSequential
Boolean
はい
各行が改行で終わるかどうかを示します。
  • - True。[改行コードあり]が有効になっています。
  • - False。[改行コードあり]が有効になっていません。
padBytes
Int
行の最後のカラムと次の行の最初のカラムの間のバイト数。
skipRows
Int
スキップする行数。空白やヘッダー行をスキップできます。
nullChar
String
NULL値を表す文字。
dateFormat
String
日付形式がフラットファイル接続で指定されていない場合に使用する、デフォルトの日付形式。
nullCharType
String
NULL文字がシングルバイトかマルチバイトかを決定します。
repeatNullChar
Boolean
はい
単一フィールドでのNULL文字の処理方法を決定します。
  • - True。[NULL文字を繰り返す]を単一のNULL値として読み取ります。
  • - False。[NULL文字を繰り返す]を単一のNULL値として読み取りません。
stripTrailingBlank
Boolean
はい
文字列値内の末尾にある空白の処理方法を決定します。
  • - True。末尾の空白を文字列値から削除します。
  • - False。末尾の空白を文字列値から削除しません。
columns
String
各カラムに次の属性を含めます。
  • - name。カラムの名前。
  • - nativeType。ネイティブデータ型
  • - precision。フィールドの長さ(バイト)。
  • - scale。数値の小数点以下の桁数。

POST応答

成功すると、作成または更新されたfwConfigオブジェクトを返します。エラーが発生した場合にエラーオブジェクトを返します。

POSTの例

POST <serverURL>/api/v2/fwConfig/00000103000000000004
Content-Type: application/json
Accept: application/json
{
"@type": "fwConfig",
"name": "FW_FILE_CONFIG_1",
"description": "Test description",
"lineSequential": false,
"padBytes": 1,
"skipRows": 2,
"nullChar": "*",
"nullCharType": "ASCII",
"repeatNullChar": false,
"stripTrailingBlank": false,
"columns": [
{
"@type": "fwColumn",
"name": "ASCII",
"nativeType": "string",
"precision": 10
}
]
}

DELETE要求

固定幅形式を削除するには、次のURIに固定幅形式IDを使用します。
/api/v2/fwConfig/<id>

DELETE応答

要求に成功した場合に200の応答コードを返します。
エラーが発生した場合にエラーオブジェクトを返します。