REST APIリファレンス

前へ次へ

mttask

このリソースを使用して、

マッピング

タスクの詳細を要求します。

マッピング

タスクを作成、更新、または削除することもできます。

REST APIを使用して、マップレットを含むマッピングを基にした

マッピング

タスクを作成することはできません。

GET要求

マッピング

タスクの詳細を要求するために、タスクID、フェデレーションタスクID、またはタスク名を使用することができます。フェデレーションタスクIDを見つけるには、ルックアップリソースを使用します。フェデレーションタスクIDは、ルックアップ応答のIDフィールドの値です。

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

/api/v2/mttask/<id>

/api/v2/mttask/frs/<id>

/api/v2/mttask/name/<name>

URIのタスク名を使用して、タスク名にスペースが含まれる場合、そのスペースを

%20

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

/api/v2/mttask/name/task%20name

GET応答

要求されたタスクIDまたはタスク名に対するmtTaskオブジェクトを返します。

エラーが発生した場合にエラーオブジェクトを返します。

以下の表に、mtTask
オブジェクトの属性を示します。

フィールド	タイプ	説明
id	String	タスクID。
orgId	String	組織ID。
name	String	タスク名。
agentId	String	タスクを実行するエージェント。
runtimeEnvironmentId	String	タスクに使用されるランタイム環境。
maxLogs	Long	データ統合が保持するセッションログファイルとインポートログファイルの数。
description	String	説明。
createTime	Date/Time	タスクが作成された日時。
updateTime	Date/Time	タスクの最終更新時刻。
createdBy	String	タスクを作成したユーザー。
updatedBy	String	タスクを最後に更新したユーザー。
schemaMode	String	データ統合がデータオブジェクトスキーマを更新するモード。
errorTaskEmail		エラー通知に対するtaskEmailオブジェクトを含むオブジェクト。
id	String	errorTaskEmailに対するtaskEmailオブジェクトに含まれます。 ID。
emails	String	errorTaskEmailに対するtaskEmailオブジェクトに含まれます。タスクの完了が失敗すると電子メール通知を受信する電子メールアドレス。
successTaskEmail		成功通知に対するtaskEmailオブジェクトを含むオブジェクト。
id	String	successTaskEmailに対するtaskEmailオブジェクトに含まれます。 ID。
emails	String	successTaskEmailに対するtaskEmailオブジェクトに含まれます。タスクが正常に完了すると電子メール通知を受信する電子メールアドレス。
warningTaskEmail		警告通知に対するtaskEmailオブジェクトを含むオブジェクト。
id	String	warningTaskEmailに対するtaskEmailオブジェクトに含まれます。 ID。
emails	String	warningTaskEmailに対するtaskEmailオブジェクトに含まれます。タスクがエラーで終了すると電子メール通知を受信する電子メールアドレス。
parameters		タスクに関連付けられているパラメータ。各パラメータのmtTaskParameterオブジェクトの属性が含まれます。
id	Long	mtTaskParameterオブジェクトに含まれます。パラメータID。
name	String	mtTaskParameterオブジェクトに含まれます。パラメータ名。
type	String	mtTaskParameterオブジェクトに含まれます。パラメータのタイプ。
text	String	mtTaskParameterオブジェクトに含まれます。パラメータ値。
label	String	mtTaskParameterオブジェクトに含まれます。パラメータラベル。
description	String	mtTaskParameterオブジェクトに含まれます。パラメータの説明。
sourceConnectionId	String	mtTaskParameterオブジェクトに含まれます。ソースの接続ID。
targetConnectionId	String	mtTaskParameterオブジェクトに含まれます。ターゲットの接続ID。
lookupConnectionId	String	mtTaskParameterオブジェクトに含まれます。ルックアップの接続ID。
transfConnectionId	String	mtTaskParameterオブジェクトに含まれます。マップレットの接続ID。将来の使用のために予約済み。
midstreamConnectionId	String	mtTaskParameterオブジェクトに含まれます。中間ストリームトランスフォーメーションの接続ID。
sourceObject	String	mtTaskParameterオブジェクトに含まれます。ソースオブジェクト名。
sourceObjectLabel	String	mtTaskParameterオブジェクトに含まれます。ソースオブジェクトラベル。
targetObject	String	mtTaskParameterオブジェクトに含まれます。ターゲットオブジェクト名。
targetObjectLabel	String	mtTaskParameterオブジェクトに含まれます。ターゲットオブジェクトラベル。
lookupObject	String	mtTaskParameterオブジェクトに含まれます。ルックアップオブジェクト名。
lookupObjectLabel	String	mtTaskParameterオブジェクトに含まれます。ルックアップオブジェクトラベル。
midstreamObject	String	mtTaskParameterオブジェクトに含まれます。中間ストリームオブジェクト名。
midstreamObjectLabel	String	mtTaskParameterオブジェクトに含まれます。中間ストリームオブジェクトラベル。
newObject	Boolean	mtTaskParameterオブジェクトに含まれます。アプリケーションが新しいフラットファイルターゲットを作成するかどうか。ターゲットを作成するときにTrueを返します。
newObjectName	String	mtTaskParameterオブジェクトに含まれます。フラットファイルターゲットの名前。
operationType	String	mtTaskParameterオブジェクトに含まれます。ターゲットのタスク操作。
truncateTarget	Boolean	mtTaskParameterオブジェクトに含まれます。書き込む前にアプリケーションがデータベースターゲットを切り捨てるかどうか。ターゲットを切り捨てるときにTrueを返します。
srcFFAttrs		mtTaskParameterオブジェクトに含まれます。 flatFileAttrsオブジェクトにソースファイル属性を含むオブジェクト。
tgtFFAttrs		mtTaskParameterオブジェクトに含まれます。 flatFileAttrsオブジェクトにターゲットファイル属性含むオブジェクト。
lkpFFAttrs		mtTaskParameterオブジェクトに含まれます。 flatFileAttrsオブジェクトにルックアップファイル属性を含むオブジェクト。
flatFileAttrs		ソース、ターゲット、ルックアップのファイルに属性を含むオブジェクト。
id	Long	flatFileAttrsオブジェクトに含まれます。フィールドID。
delimiter	String	flatFileAttrsオブジェクトに含まれます。フィールドを区切るために使用される文字
textQualifier	String	flatFileAttrsオブジェクトに含まれます。テキスト文字列の境界を定義する引用符
escapeChar	String	flatFileAttrsオブジェクトに含まれます。引用符で囲まれていない文字列におけるフィールド区切り文字の直前の文字、または引用符で囲まれた文字列内の引用符の直前の文字。
headerLineNo	Int	flatFileAttrsオブジェクトに含まれます。ヘッダー行の数
firstDataRow	Int	flatFileAttrsオブジェクトに含まれます。ファイル内でデータが始まる行番号。
rowDelimiter	Int	flatFileAttrsオブジェクトに含まれます。改行文字。ASCII文字の10進数コードを返します。
consecutiveDelimiter	Boolean	flatFileAttrsオブジェクトに含まれます。 1つ以上の連続する区切り文字を1つの文字として扱うかどうかを示します。
multiDelimitersAsAnd	Boolean	flatFileAttrsオブジェクトに含まれます。区切り文字が複数の文字である場合に、その文字を1つの区切り文字として扱うか、複数の区切り文字として扱うかを示します。
customFuncCfg		mtTaskParameterオブジェクトに含まれます。タスクに使用されるマップレットに設定を定義するオブジェクト。各マップレットのcustomFuncConfigオブジェクトに属性が含まれます。
id	Long	customFuncConfigオブジェクトに含まれます。マップレットID。
connections		customFuncConfigオブジェクトに含まれます。マップレットに使用される接続を定義するためのオブジェクト。各接続に対するpcsConnectionオブジェクトの情報が含まれます。
id	Long	pcsConnectionオブジェクトに含まれています。
name	String	pcsConnectionオブジェクトに含まれています。接続名。
type	String	pcsConnectionオブジェクトに含まれています。接続タイプ。
subtype	String	pcsConnectionオブジェクトに含まれています。接続のサブタイプ。
description	String	pcsConnectionオブジェクトに含まれています。接続の説明。
connectionId	String	pcsConnectionオブジェクトに含まれています。接続ID。
showBusinessNames	Boolean	mtTaskParameterオブジェクトに含まれます。タスクがビジネス名を表示するかどうか。ビジネス名を表示するときにTrueを返します。
naturalOrder	Boolean	mtTaskParameterオブジェクトに含まれます。フィールドを表示するためにタスクが使用する順序。接続によって返される順序の場合、Trueを返します。アルファベット順の場合、Falseを返します。
isRESTModernSource	Boolean	mtTaskParameterオブジェクトに含まれます。拡張されたオブジェクトを有効にするには常にTrueに設定します。
customQuery	String	mtTaskParameterオブジェクトに含まれます。 Mapping Designerまたはマッピングタスククエリオプションに指定されたカスタムクエリ。
overriddenFields		mtTaskParameterオブジェクトに含まれます。マッピングタスクのフィールドメタデータに変更します。上書き済みフィールドごとにmtTaskOverriddenFieldオブジェクトの情報が含まれます。
name	String	mtTaskOverriddenFieldオブジェクトに含まれます。フィールド名。
type	String	mtTaskOverriddenFieldオブジェクトに含まれます。フィールドタイプ。
precision	Int	mtTaskOverriddenFieldオブジェクトに含まれます。フィールドの長さ（バイト）。
scale	Int	mtTaskOverriddenFieldオブジェクトに含まれます。数値の小数点以下の桁数。
platformType	String	mtTaskOverriddenFieldオブジェクトに含まれます。フィールドのプラットフォームデータ型。
tgtFieldRefs	String	mtTaskParameterオブジェクトに含まれます。 Salesforceフィールド参照ID。
extendedObject		mtTaskParameterオブジェクトに含まれます。複数のオブジェクトが連結したソースまたはターゲット。
targetUpdateColumns	String	mtTaskParameterオブジェクトに含まれます。ターゲットオブジェクトでレコードの更新に使用されるカラム名のリスト。
runtimeAttrs	String	mtTaskParameterオブジェクトに含まれます。タスクに使用される接続の詳細接続プロパティ。 runtimeAttrsオブジェクトを使用して、詳細接続プロパティのキーと値のペアを定義します。各キーと値のペアにエントリオブジェクトを使用します。属性名の場合、データ統合ユーザーインタフェースに表示される詳細接続プロパティ名を使用します。詳細接続プロパティの詳細については、データ統合ヘルプを参照してください。
dataFormat		mtTaskParameterオブジェクトに含まれます。接続によって指定されたデータ形式。各コネクタのdataFormatオブジェクトに属性が含まれます。 dataFormatオブジェクトはすべてのコネクタには適用できません。使用しているコネクタにdataFormatが適用可能かどうかを確認するには、関連するコネクタのヘルプを参照してください。
formatId		dataFormatオブジェクトに含まれます。 FLAT、AVRO、PARQUET、JSON、またはXMLなど、コネクタによって指定されたデータ形式の種類。
dataFormatAttributes		dataFormatオブジェクトに含まれます。データ形式の種類の形式属性。例えば、フラットファイルの場合、dataFormatAttributesオブジェクトにはescapeChar、delimiter、およびqualifierなどの値が含まれます。
sequences		シーケンスジェネレータトランスフォーメーションの値を定義します。各シーケンストランスフォーメンションのsequenceDefinitionオブジェクトが含まれます。
txName	String	sequenceDefinitionオブジェクトに含まれます。シーケンスジェネレータトランスフォーメーションの名前。
initialValue	String	sequenceDefinitionオブジェクトに含まれます。シーケンスの初期値。
currentValue	String	sequenceDefinitionオブジェクトに含まれます。トランスフォーメーションに追加される最後の行に使用される値。
inOutParameters		タスクに使用される入出力パラメータ。各入出力パラメータのmtTaskInOutParameterオブジェクトが含まれます。
id	Long	mtTaskInOutParameterオブジェクトに含まれます。パラメータID。
name	String	mtTaskInOutParameterオブジェクトに含まれます。パラメータ名。
description	String	mtTaskInOutParameterオブジェクトに含まれます。パラメータの説明。
initialValue	String	mtTaskInOutParameterオブジェクトに含まれます。パラメータの初期値。
datatype	String	mtTaskInOutParameterオブジェクトに含まれます。パラメータのデータ型。
precision	String	mtTaskInOutParameterオブジェクトに含まれます。パラメータの精度。
scale	String	mtTaskInOutParameterオブジェクトに含まれます。パラメータの位取り。
retentionPolicy	String	mtTaskInOutParameterオブジェクトに含まれます。タスクがカレント値を保持するときを決定します。
aggregationType	String	mtTaskInOutParameterオブジェクトに含まれます。タスクが実行されるパラメータの最後のカレント値を決定します。
currentValue	String	mtTaskInOutParameterオブジェクトに含まれます。パラメータのカレント値。
lastRunTime	Date/Time	タスクが最後に実行した時間。
masterTemplateId	String	VisioテンプレートID。Visioテンプレートがタスクの基準となるときに返されます。
mappingId	String	マッピングID。マッピングがタスクの基準となる場合に返されます。
scheduleId	String	タスクに関連するスケジュール（該当する場合）。
shortDescription	String	説明の最初の50文字。
sessionProperties	String	タスクに関連付けられた詳細セッションプロパティ。 sessionPropertiesオブジェクトに詳細セッションプロパティが含まれます。
outboundMessageUrlToken	String	タスクの送信メッセージのURLトークン（存在する場合）。
outboundMessageUrlQueueTime	Long	タスクの送信メッセージのURLキュー時間（存在する場合）。
preProcessingCmd	String	タスクの前に実行するコマンド。
postProcessingCmd	String	タスクの完了後に実行するコマンド。
parameterFileName	String	タスクで使用されるパラメータファイルの名前。
verbose	Boolean	データ統合が、トラブルシューティングの目的に使用するためにログに追加のデータを生成するかどうか。TrueまたはFalseを返します。
connRuntimeAttrs		mtTaskParameterパラメータに含まれます。各接続のmtTaskConnRuntimeAttrオブジェクトを含みます。 connRuntimeAttrsオブジェクトはCDCコネクタに適用されます。
id	String	mtTaskConnRuntimeAttrオブジェクトに含まれます。各mtTaskConnRuntimeAttrオブジェクトの内部ID。
name	String	mtTaskConnRuntimeAttrオブジェクトに含まれます。 CDCコネクタの接続ランタイム属性の内部ID。
value	String	mtTaskConnRuntimeAttrオブジェクトに含まれます。名前属性に関連付けられている値。
connectionID	String	mtTaskConnRuntimeAttrオブジェクトに含まれます。 CDC接続ID。

POST要求

マッピング

タスクを作成するには、次のURIを使用します。

/api/v2/mttask/

タスクに場所を指定する場合、要求にコンテナIDを含めます。コンテナIDが要求に含まれていない場合、タスクはDefaultフォルダに作成されます。

データ統合

ユーザーインタフェースでプロジェクトまたはフォルダのコンテナIDを検索できます。

［エクスプローラ］

ページで、フォルダを選択します。URLの最後の文字列がコンテナIDです。

例えば、次のURLのコンテナIDはdH2DuGJYda7ijgW4Sm32sRです。

https://na1.dm-us.informaticacloud.com/diUI/products/integrationDesign/main/Explore/dH2DuGJYda7ijgW4Sm32sR

マッピング

タスクを更新するには、URIにタスクIDまたはフェデレーションタスクIDを含めます。フェデレーションタスクIDを見つけるには、ルックアップリソースを使用します。フェデレーションタスクIDは、ルックアップ応答のIDフィールドの値です。

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

/api/v2/mttask/<id>

/api/v2/mttask/frs/<id>

部分モードを使用して部分的な更新を送信できます。部分モードを使用してコレクション内にあるフィールドを更新する場合は、コレクションにキーフィールドを含める必要があります。以下の表に、mttaskリソースのコレクションと対応するキーフィールドを示します。

コレクション	キーフィールド
mtTaskInOutParameter	name
sequenceDefinition	txName
mtTaskOverriddenField	name
mtTaskParameter	name type
オブジェクト	name

部分モードを使用して要求を送信するには、JSON要求を使用してヘッダーに次の行を含めます。

Update-Mode=PARTIAL

以下の表に、mtTaskオブジェクトに含めることができる属性を示します。

フィールド	タイプ	必須	説明
name	String		タスクの名前。
containerId	String		タスクを含めるためのプロジェクトまたはフォルダのID。要求に含まれていない場合、タスクはDefaultフォルダに作成されます。
description	String		タスクの説明。
runtimeEnvironmentId	String	○	タスクに使用されるランタイム環境のID。
mappingId	String	マッピングがタスクの基準となる場合に必須。	タスクで使用されるマッピングのID。
scheduleId	String		タスクに関連するスケジュール（該当する場合）。
sessionProperties	String		詳細セッションプロパティ。sessionPropertiesオブジェクトを使用して、詳細セッションプロパティのキーと値のペアを定義します。各キーと値のペアにエントリオブジェクトを使用します。属性名の場合、データ統合ユーザーインタフェースに表示される詳細セッションプロパティ名を使用します。
schemaMode	String		データ統合がデータオブジェクトスキーマを更新するモード。以下のいずれかの値を使用します。非同期動的デフォルトは［非同期］です。複数のマッピングタスクを同時に実行する場合、データ統合はスキーマモードに関係なく、最新のスキーマを取得します。
errorTaskEmail			エラー通知に対するtaskEmailオブジェクトを含むオブジェクト。
id	String		errorTaskEmailのtaskEmailオブジェクトに含めます。 ID。
emails	String		errorTaskEmailのtaskEmailオブジェクトに含めます。タスクの完了が失敗すると電子メール通知を受信する電子メールアドレス。
successTaskEmail			成功通知に対するtaskEmailオブジェクトを含むオブジェクト。
id	String		successTaskEmailに対するtaskEmailオブジェクトに含めます。 ID。
emails	String		successTaskEmailに対するtaskEmailオブジェクトに含めます。タスクが正常に完了すると電子メール通知を受信する電子メールアドレス。
warningTaskEmail			警告通知に対するtaskEmailオブジェクトを含むオブジェクト。
id	String		warningTaskEmailに対するtaskEmailオブジェクトに含めます。 ID。
emails	String		warningTaskEmailに対するtaskEmailオブジェクトに含めます。タスクがエラーで終了すると電子メール通知を受信する電子メールアドレス。
parameters			タスクに関連付けられているパラメータ。mtTaskParameterオブジェクトを使用して、各パラメータの次の属性を定義します。
id	Long		mtTaskParameterオブジェクトに含めます。システムが生成したパラメータID。この値は更新できません。
name	String		mtTaskParameterオブジェクトに含めます。パラメータ名。mtTaskParameterコレクションのキーフィールド。
type	String		mtTaskParameterオブジェクトに含めます。パラメータのタイプ。mtTaskParameterコレクションのキーフィールド。以下のいずれかの値を使用します。 STRING SOURCE TARGET MAPPLET LOOKUP
text	String		mtTaskParameterオブジェクトに含めます。パラメータ値。
label	String		mtTaskParameterオブジェクトに含めます。パラメータラベル。
description	String		mtTaskParameterオブジェクトに含めます。パラメータの説明。
sourceConnectionId	String		mtTaskParameterオブジェクトに含めます。ソースの接続ID。
targetConnectionId	String		mtTaskParameterオブジェクトに含めます。ターゲットの接続ID。
lookupConnectionId	String		mtTaskParameterオブジェクトに含めます。ルックアップの接続ID。
newFlatFile	Boolean		mtTaskParameterオブジェクトに含めます。データ統合が新しいフラットファイルターゲットを作成するかどうか。以下のいずれかの値を使用します。 True。 False。
flatFileName	String		mtTaskParameterオブジェクトに含めます。フラットファイルターゲットの名前。
newObject	Boolean		mtTaskParameterオブジェクトに含めます。アプリケーションが新しいフラットファイルターゲットを作成するかどうか。ターゲットを作成するときにTrueを返します。
newObjectName	String		mtTaskParameterオブジェクトに含めます。フラットファイルターゲットの名前。
operationType	String		mtTaskParameterオブジェクトに含めます。ターゲットのタスク操作。以下のいずれかの値を使用します。挿入更新/挿入 Update Delete 行ベース行ベースの値は、ユーザーインタフェースのデータドリブンの値に対応します。
dataDrivenCondition	String		mtTaskParameterオブジェクトに含めます。 operationTypeが行ベースの場合に適用されます。挿入、更新、削除、または拒否操作の行にフラグを立てる式を定義します。例: IIF(ISNULL (ISDELETED), DD_INSERT
truncateTarget	Boolean		mtTaskParameterオブジェクトに含めます。書き込む前にアプリケーションがデータベースターゲットを切り捨てるかどうか。以下のいずれかの値を使用します。 True。 False。
srcFFAttrs			mtTaskParameterオブジェクトに含めます。ソースファイル属性のオブジェクト。flatFileAttrsオブジェクトの属性を含めます。
tgtFFAttrs			mtTaskParameterオブジェクトに含めます。ターゲットファイル属性のオブジェクト。flatFileAttrsオブジェクトの属性を含めます。
lkpFFAttrs			mtTaskParameterオブジェクトに含めます。ルックアップファイル属性のオブジェクト。flatFileAttrsオブジェクトの属性を含めます。
flatFileAttrs			ソース、ターゲット、およびルックアップファイルの属性を保持するオブジェクト。
id	Long		flatFileAttrsオブジェクトに含めます。フィールドID。
delimiter	String		flatFileAttrsオブジェクトに含めます。フィールドを区切るために使用される文字。
textQualifier	String		flatFileAttrsオブジェクトに含めます。テキスト文字列の境界を定義する引用符。
escapeChar	String		flatFileAttrsオブジェクトに含めます。引用符で囲まれていない文字列に埋め込まれたフィールド区切り文字の直前の文字、または引用符で囲まれた文字列内の引用符の直前の文字。
headerLineNo	Int		flatFileAttrsオブジェクトに含めます。ヘッダー行の数。
firstDataRow	Int		flatFileAttrsオブジェクトに含めます。ファイル内でデータが始まる行番号。
rowDelimiter	Int		flatfileAttrsオブジェクトに含めます。改行文字。1から32までのASCII文字の10進数コードを入力します。デフォルト値は10で、これは改行文字です。
consecutiveDelimiter	Boolean		flatFileAttrsオブジェクトに含まれます。 1つ以上の連続する区切り文字を1つの文字として扱うかどうかを示します。デフォルトはfalseです。
multiDelimitersAsAnd	Boolean		flatFileAttrsオブジェクトに含まれます。区切り文字が複数の文字である場合に、その文字を1つの区切り文字として扱うか、複数の区切り文字として扱うかを示します。デフォルトはtrueです。
customFuncCfg			mtTaskParameterオブジェクトに含めます。タスクで使用されるマップレットの設定を定義するためのオブジェクト。customFuncConfigオブジェクトを使用して各マップレットを定義します。
id	Long		customFuncConfigオブジェクトに含めます。マップレットID。
connections			customFuncConfigオブジェクトに含めます。マップレットに使用される接続を定義するためのオブジェクト。各接続にpcsConnectionオブジェクトを使用します。接続の詳細については、connectionを参照してください。
id	Long		pcsConnectionオブジェクトに含めます。
name	String		pcsConnectionオブジェクトに含めます。接続名。
type	String		pcsConnectionオブジェクトに含めます。接続タイプ。
subtype	String		pcsConnectionオブジェクトに含めます。接続のサブタイプ。
description	String		pcsConnectionオブジェクトに含めます。接続の説明。
connectionId	String		pcsConnectionオブジェクトに含めます。接続ID。
overriddenFields			mtTaskParameterオブジェクトに含めます。マッピングタスクのフィールドメタデータに変更します。上書き済みフィールドごとにmtTaskOverriddenFieldオブジェクトを使用します。
name	String		mtTaskOverriddenFieldオブジェクトに含めます。フィールド名。mtTaskOverriddenFieldコレクションのキーフィールド。
type	String		mtTaskOverriddenFieldオブジェクトに含めます。フィールドタイプ。
precision	Int		mtTaskOverriddenFieldオブジェクトに含めます。フィールドの長さ（バイト）。
scale	Int		mtTaskOverriddenFieldオブジェクトに含めます。数値の小数点以下の桁数。
platformType	String		mtTaskOverriddenFieldオブジェクトに含めます。フィールドのプラットフォームデータ型。
tgtFieldRefs	String		mtTaskParameterオブジェクトに含めます。 Salesforceフィールド参照ID。
runtimeAttrs	String		mtTaskParameterオブジェクトに含めます。タスクに使用される接続の詳細接続プロパティ。 runtimeAttrsオブジェクトを使用して、詳細接続プロパティのキーと値のペアを定義します。各キーと値のペアにエントリオブジェクトを使用します。属性名の場合、データ統合ユーザーインタフェースに表示される詳細接続プロパティ名を使用します。詳細接続プロパティの詳細については、データ統合のヘルプを参照してください。
parameterFileName	String		mtTaskParameterオブジェクトに含めます。タスクで使用されるパラメータファイルの名前。
parameterFileDir	String		mtTaskParameterオブジェクトに含めます。パラメータファイルを含むディレクトリのパス。
dataFormat			mtTaskParameterオブジェクトに含めます。接続によって指定されたデータ形式。各コネクタのdataFormatオブジェクトに属性を含めます。 dataFormatオブジェクトはすべてのコネクタには適用できません。使用しているコネクタにdataFormatが適用可能かどうかを確認するには、関連するコネクタのヘルプを参照してください。
formatId	String		dataFormatオブジェクトに含めます。 FLAT、AVRO、PARQUET、JSON、またはXMLなど、コネクタによって指定されたデータ形式の種類。
fwConfigId	String	formatIDがFlatに設定され、固定長モードが使用されている場合に必須。	dataFormatオブジェクトに含めます。有効な固定長形式ID。
dataFormatAttributes	String		dataFormatオブジェクトに含めます。データ形式の種類の形式属性。例えば、フラットファイルデータ形式の場合、dataFormatAttributesオブジェクトにはescapeChar、delimiter、およびqualifierなどの値を含まれます。
inOutParameters			タスクに使用される入出力パラメータ。各入出力パラメータのmtTaskInOutParameterオブジェクトを含めます。
id	Long		mtTaskInOutParameterオブジェクトに含めます。パラメータID。
name	String		mtTaskInOutParameterオブジェクトに含めます。パラメータ名。mtTaskInOutParameterコレクションのキーフィールド。
description	String		mtTaskInOutParameterオブジェクトに含めます。パラメータの説明。
initialValue	String		mtTaskInOutParameterオブジェクトに含めます。パラメータの初期値。
datatype	String		mtTaskInOutParameterオブジェクトに含めます。パラメータのデータ型。
precision	String		mtTaskInOutParameterオブジェクトに含めます。パラメータの精度。
scale	String		mtTaskInOutParameterオブジェクトに含めます。パラメータの位取り。
retentionPolicy	String		mtTaskInOutParameterオブジェクトに含めます。タスクがカレント値を保持するときを決定します。次のいずれかの値を含めます。 ON_SUCCESS_OR_WARNING ON_SUCCESS ON_WARNING NEVER
aggregationType	String		mtTaskInOutParameterオブジェクトに含めます。タスクが実行されるパラメータの最後のカレント値を決定します。
currentValue	String		mtTaskInOutParameterオブジェクトに含めます。パラメータのカレント値。
masterTemplateId	String	タスクがVisioテンプレートを使用する場合に必須。	タスクで使用されるVisioテンプレートのID。
outboundMessageUrlToken	String		タスクの送信メッセージのURLトークン（存在する場合）。
outboundMessageUrlQueueTime	Long		タスクの送信メッセージのURLキュー時間（存在する場合）。
preProcessingCmd	String		タスクの前に実行するコマンド。
postProcessingCmd	String		タスクの完了後に実行するコマンド。
maxLogs	Long		保持するセッションログファイルとインポートログファイルの数。デフォルトでは、データ統合は各タイプのログファイルを10回の実行まで保存し、その後の新しい実行ではログファイルを上書きします。
verbose	Boolean		トラブルシューティングの目的に使用するためにログに追加のデータを生成するかどうか。TrueまたはFalseを使用してください。
agentId	String		タスクを実行するエージェント。
sequences			シーケンスジェネレータトランスフォーメーションの値を定義します。各シーケンストランスフォーメンションのsequenceDefinitionオブジェクトを使用します。
txName	String		sequenceDefinitionオブジェクトに含めます。シーケンスジェネレータトランスフォーメーションの名前。sequenceDefinitionコレクションのキーフィールド。
initialValue	String		sequenceDefinitionオブジェクトに含めます。シーケンスの初期値。
currentValue	String		sequenceDefinitionオブジェクトに含めます。トランスフォーメーションに追加される最後の行に使用される値。
connRuntimeAttrs			mtTaskParameterパラメータに含めます。変更されるランタイム属性に各CDCコネクタのmtTaskConnRuntimeAttrオブジェクトを含めます。 connRuntimeAttrsオブジェクトはCDCコネクタに適用されます。
id	String	connRuntimeAttrsオブジェクトで必須。	mtTaskConnRuntimeAttrオブジェクトに含めます。 mtTaskConnRuntimeAttrオブジェクトの内部IDを含めます。
name	String	mtTaskConnRuntimeAttrで必須。	mtTaskConnRuntimeAttrオブジェクトに含めます。ランタイム属性には次のいずれかの名前を使用します。［コミットあたりの最大行数］: 101 ［コミットあたりの最小行数］: 102 ［最大待ち時間（秒）］: 103 ［リアルタイムフラッシュ待ち時間（ミリ秒）］: 104 ［再起動ポイント］: 105 ［再起動リビジョン］: 106 ［UOWカウント］: 107 ［削除または挿入として更新］: 108 ［再起動オプション］: 110
value	String		mtTaskConnRuntimeAttrオブジェクトに含めます。指定した属性名に有効な値を使用します。コミットあたりの最大行数0～999999999です。コミットあたりの最小行数。0～999999999です。最大待ち時間（秒）。2～360。リアルタイムフラッシュ待ち時間（ミリ秒）。-1～999999999。再起動ポイント［再起動オプション］と組み合わせて設定します。0（利用可能で最も早い時間）。空の文字列（ログの末尾）。有効なタイムスタンプ（ログの指定したタイムスタンプ）。有効なPWXトークン（ログの指定したトークンで再起動）。再起動リビジョン有効なリビジョン番号（0～2147483647）。 UOWカウント-1～999999999。削除または挿入として更新します。0（更新としての処理）。1（削除および挿入としての処理）。再起動オプション: ［再起動ポイント］と組み合わせて設定します。0（利用可能で最も早い時間）。1（ログの末尾）。2（時間ベース）。3（PWXトークン）。
connectionID	String	mtTaskConnRuntimeAttrオブジェクトで必須。	mtTaskConnRuntimeAttrオブジェクトに含めます。 CDC接続IDを含めます。

POST応答

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

DELETE要求

マッピング

タスクを削除するには、次のURIのタスクIDを使用します。

/api/v2/mttask/<id>

フェデレーションタスクIDを使用して

マッピング

タスクを削除することはできません。

DELETE応答

要求に成功した場合に200の応答コードを返します。

エラーが発生した場合にエラーオブジェクトを返します。

POSTの例

XMLで新しい

マッピング

タスクを作成するには、次の要求を使用できます。

POST <serverUrl>/api/v2/mttask
Content-Type: application/xml
Accept: application/xml
icSessionId: <icSessionId>

<mtTask>
  <errorTaskEmail>
    <taskEmail>
      <emails>email_dev@company.com, email2_dev@company.com</emails>
    </taskEmail>
  </errorTaskEmail>
  <successTaskEmail>
    <taskEmail>
      <emails>reviewer@company.com</emails>
    </taskEmail>
  </successTaskEmail>
  <warningTaskEmail>
    <taskEmail>
      <emails>email_dev@company.com, email2_dev@company.com</emails>
    </taskEmail>
  </warningTaskEmail>
  <parameters>
    <mtTaskParameter>
      <name>sort convert plugin</name>
      <type>MAPPLET</type>
    </mtTaskParameter>
  </parameters>
  <parameters>
    <mtTaskParameter>
      <name>DB lookup</name>
      <type>LOOKUP</type>
    </mtTaskParameter>
  </parameters>
  <sessionProperties>
      <entry>
         <key>Java Classpath</key>
         <value>C:/test/classpathnew</value>
      </entry>
      <entry>
         <key>Pushdown Optimization</key>
         <value>To Source</value>
      </entry>
      <entry>
         <key>Write Backward Compatible Session Log File</key>
         <value>no</value>
      </entry>
   </sessionProperties>
  <runtimeEnvironmentId>00000398D00000004</runtimeEnvironmentId>
  <sequences>
    <sequenceDefinition>
      <txName>SeqGen1</txName>
      <initialValue>1</initialValue>
      <currentValue>62</currentValue>
    </sequenceDefinition>
  </sequences>
  <preProcessingCmd>echo CurrentDate is 'date'</preProcessingCmd>
  <postProcessingCmd>echo PR-PostProcess</postProcessingCmd>
  <masterTemplateId>00034234M00000R</masterTemplateId>
</mtTask>

成功した要求はmtTaskオブジェクトを返します。

データ統合 REST API

マスキング方法のマスクルールパラメータ属性

マスクルールパラメータ属性値

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal