REST APIリファレンス

前へ次へ

masterTemplate

このリソースを使用して、組織内の1つのVisioテンプレートの詳細またはすべてのVisioテンプレートの詳細を要求します。Visioテンプレートを作成または更新して、テンプレートを使用する

マッピング

タスクのリストを要求できます。Visioテンプレートを削除することもできます。

GET要求

組織内のすべてのVisioテンプレートの詳細を要求するには、次のURIを使用します。

/api/v2/masterTemplate

特定のVisioテンプレートの詳細を要求するには、URIにVisioテンプレートIDまたはVisioテンプレート名を含めます。次のいずれかのURIを使用します。

/api/v2/masterTemplate/<id>

/api/v2/masterTemplate/name/<name>

URIのVisioテンプレート名を使用して、Visioテンプレート名にスペースが含まれる場合、そのスペースを

%20

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

/api/v2/masterTemplate/name/my%20Visio%20template

Visioテンプレートを使用する

マッピング

タスクのリストを要求するには、次のURIのVisioテンプレートIDを使用します。

/api/v2/masterTemplate/<id>/tasks

GET応答

正常に実行された場合、要求したVisioテンプレートのmasterTemplateオブジェクトを返します。すべてのVisioテンプレートの詳細を要求した場合、組織内のすべてのVisioテンプレートのパラメータの詳細がないmasterTemplateオブジェクトを返します。

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

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

フィールド	タイプ	説明
id	String	VisioテンプレートID。
orgId	String	組織ID。
name	String	Visioテンプレート名。
description	String	Visioテンプレートの説明。
createTime	dateTime	Visioテンプレートが作成された日時。
updateTime	dateTime	Visioテンプレートの最終更新日時。
createdBy	String	Visioテンプレートを作成したユーザー。
updatedBy	String	Visioテンプレートを最後に更新したユーザー。
diFileRecordId	String	VisioテンプレートのXMLファイルのID。
templateImageId	String	VisioテンプレートのイメージファイルのID。
parameters		Visioテンプレートで使用されるパラメータ。各パラメータにmtParameterオブジェクトが含まれます。
id	Long	mtParameterオブジェクトに含まれます。パラメータID。
name	String	mtParameterオブジェクトに含まれます。パラメータ名。
label	String	mtParameterオブジェクトに含まれます。パラメータラベル。
type	String	mtParameterオブジェクトに含まれます。パラメータのタイプ。
description	String	mtParameterオブジェクトに含まれます。パラメータの説明。
customFuncId	String	mtParameterオブジェクトに含まれます。マップレットタイプのパラメータのマップレットID。
uiProperties	String	mtParameterオブジェクトに含まれます。パラメータのプロパティを表示します。以下の情報が含まれます。 cnxtype。パラメータの接続タイプ。 logcnx。論理接続。 order。表示順序。 wizstep。パラメータを表示するウィザードステップ。 default。デフォルト値。 visible。パラメータが表示可能かどうか。 editable。パラメータが編集可能かどうか。 required。パラメータが必要かどうか。 paramtype。文字列パラメータのUIコントロールタイプ。次のいずれかの応答を返します。条件。検索条件のプロンプト。式。式エディタのプロンプト。フィールド。フィールド選択のプロンプト。フィールドマップ。フィールドマッピングのプロンプト。以下の属性が含まれます。 lefttitle。フィールドマッピング表示の左側のタイトル。 righttitle。フィールドマッピング表示の右側のタイトル。 leftfs。フィールドマッピング表示の左側のテーブルに表示するフィールドのセット。 rightfs。フィールドマッピング表示の右側のテーブルに表示するフィールドのセット。 leftfilter。フィールドマッピング表示の左側のテーブルに表示されるフィールドを制限する正規表現。 rightfilter。フィールドマッピング表示の右側のテーブルに表示されるフィールドを制限する正規表現。 staticlist。フィールドマッピング表示の右側に表示するフィールドのリスト。
sessionAttrs	String	タスクの全般プロパティおよびパフォーマンスセッションプロパティ。次の属性に値を含むことができます。下位互換性のあるセッションログファイルの書き込み。セッションログをファイルに書き込みます。セッションログファイル名。セッションログの名前。セッションログファイルディレクトリ。セッションログの保存先ディレクトリ。 $Source接続値。ソース接続名。 $Target接続値。ターゲット接続名。ソース行の扱い。マッピングタスクでソースデータが読み取られると、行がターゲットに到達するときに実行される操作を指定するインジケータを使用して、各行にマークが付けられます。挿入。すべての行は、ターゲットへの挿入対象としてマークされます。更新。すべての行は、ターゲットでの更新対象としてマークされます。削除。すべての行は、ターゲットからの削除対象としてマークされます。データドリブン。データフロー内のアップデートストラテジオブジェクトを使用して、ソース行ごとに操作がマークされます。コミットタイプ。コミットタイプは次を使用します。ソース。ソース行の数に基づいてコミットを実行します。ターゲット。ターゲット行の数に基づいてコミットを実行します。ユーザー定義。Visioテンプレートで定義されているコミットロジックに基づいてコミットを実行します。コミットタイプを設定しない場合、ターゲットコミットが実行されます。コミット間隔。コミット間の行間隔。コミット間隔を設定しない場合、10,000行ごとにコミットが実行されます。ファイルの最後でコミット。エンドオブファイルでデータをコミットします。trueまたはfalseを返します。エラー時のロールバックトランザクション。タスクにより非致命的エラーが検出された場合は、次のコミットポイントでトランザクションのロールバックを選択できます。トランスフォーメーションエラーが発生すると、そのエラーがターゲットの有効なトランザクションジェネレータの後で発生した場合には、トランザクションがロールバックされます。 Javaクラスパス。使用するJavaクラスパス。 DTMバッファサイズ。DTMプロセスからタスクに割り当てられるメモリの量。差分集計。差分集計を実行します。trueまたはfalseを返します。集計キャッシュの再初期化。差分集計タスクごとに既存の集計ファイルを上書きします。trueまたはfalseを返します。高精度10進演算を有効にする。Decimalデータ型を精度28で処理します。trueまたはfalseを返します。デッドロック時のセッションリトライ。デッドロックが発生したときにマッピングタスクではターゲットでの書き込みが再試行されます。trueまたはfalseを返します。
wizardMetadata		マッピングタスクウィザードのステップのメタデータ。各ステップにmtWizardStepオブジェクトが含まれます。
name	String	mtWizardStepオブジェクトに含まれます。ステップの名前。
title	String	mtWizardStepオブジェクトに含まれます。マッピングタスクウィザードのユーザーインタフェースに表示される、ステップのタイトル。

POST要求

Visioテンプレートを更新するには、次のURIのVisioテンプレートIDを使用します。新しいVisioテンプレートを作成するには、オプションのVisioテンプレートIDを省略します。

/api/v2/masterTemplate/<id>

部分モードを使用して部分的な更新を送信できます。部分モードを使用してmtParameterオブジェクトのフィールドを更新する場合は、名前またはタイプのフィールドを含める必要があります。部分モードを使用して要求を送信するには、JSON要求を使用してヘッダーに次の行を含めます。

Update-Mode=PARTIAL

masterTemplate

オブジェクトで次の属性を使用できます。

フィールド	タイプ	必須	説明
name	String	○	Visioテンプレートの名前。
description	String		Visioテンプレートの説明。
diFileRecordId	String	○	VisioテンプレートのXMLファイルID。 fileRecordリソースで組織にファイルをアップロードするときに返されるIDを使用します。
templateImageId	String		VisioテンプレートのイメージファイルID。このIDは、fileRecordリソースで組織にファイルをアップロードするときに返されます。
parameters			テンプレートに関連付けられているパラメータを定義するオブジェクト。mtParameterオブジェクトを使用して各パラメータを定義します。
name	String	○	mtParameterオブジェクトに含めます。 mtParameterコレクションのキーフィールド。パラメータ名。
label	String		mtParameterオブジェクトに含めます。パラメータラベル。
type	String	○	mtParameterオブジェクトに含めます。 mtParameterコレクションのキーフィールド。パラメータのタイプ。以下のいずれかの値を使用します。 STRING SOURCE TARGET MAPPLET LOOKUP
description	String		mtParameterオブジェクトに含めます。パラメータの説明。
customFuncId	String		mtParameterオブジェクトに含めます。マップレットタイプのパラメータのマップレットID。
uiProperties	String		mtParameterオブジェクトに含めます。パラメータのプロパティを表示します。UIPropertyTypeオブジェクトを使用して、次の表示プロパティを定義します。 cnxtype。パラメータの接続タイプ。有効な接続タイプを使用してください。詳細については、接続リソースを参照してください。 logcnx。論理接続。 order。表示順序。 wizstep。パラメータを表示するウィザードステップ。 default。デフォルト値。 visible。パラメータが表示可能かどうか。TrueまたはFalseを使用してください。 editable。パラメータが編集可能かどうか。TrueまたはFalseを使用してください。 required。パラメータが必要かどうか。TrueまたはFalseを使用してください。 paramtype。文字列パラメータのUIコントロールタイプ。以下のいずれかの値を使用します。条件。検索条件のプロンプト。式。式エディタのプロンプト。フィールド。フィールド選択のプロンプト。フィールドマップ。フィールドマッピングのプロンプト。次の属性を含めます。 lefttitle。フィールドマッピング表示の左側のタイトル。 righttitle。フィールドマッピング表示の右側のタイトル。 leftfs。フィールドマッピング表示の左側のテーブルに表示するフィールドのセット。 rightfs。フィールドマッピング表示の右側のテーブルに表示するフィールドのセット。 leftfilter。フィールドマッピング表示の左側のテーブルに表示されるフィールドを制限する正規表現。 rightfilter。フィールドマッピング表示の右側のテーブルに表示されるフィールドを制限する正規表現。 staticlist。フィールドマッピング表示の右側に表示するフィールドのリスト。rightfsの代わりに使用してください。改行またはセミコロンによって区切られたリストフィールド名と関連するデータ型。
sessionAttrs	String		mtParameterオブジェクトに含めます。タスクの全般プロパティおよびパフォーマンスセッションプロパティ。次の属性に値を含むことができます。下位互換性のあるセッションログファイルの書き込み。セッションログをファイルに書き込みます。セッションログファイル名。セッションログの名前。セッションログファイルディレクトリ。セッションログの保存先ディレクトリ。 $Source接続値。ソース接続名。 $Target接続値。ターゲット接続名。ソース行の扱い。マッピングタスクでソースデータが読み取られると、行がターゲットに到達するときに実行される操作を指定するインジケータを使用して、各行にマークが付けられます。挿入。すべての行は、ターゲットへの挿入対象としてマークされます。更新。すべての行は、ターゲットでの更新対象としてマークされます。削除。すべての行は、ターゲットからの削除対象としてマークされます。データドリブン。データフロー内のアップデートストラテジオブジェクトを使用して、ソース行ごとに操作がマークされます。コミットタイプ。コミットタイプは次を使用します。ソース。ソース行の数に基づいてコミットを実行します。ターゲット。ターゲット行の数に基づいてコミットを実行します。ユーザー定義。Visioテンプレートで定義されているコミットロジックに基づいてコミットを実行します。コミットタイプを設定しない場合、ターゲットコミットが実行されます。コミット間隔。コミット間の行間隔。コミット間隔を設定しない場合、10,000行ごとにコミットが実行されます。ファイルの最後でコミット。エンドオブファイルでデータをコミットします。trueまたはfalseを返します。エラー時のロールバックトランザクション。タスクにより非致命的エラーが検出された場合は、次のコミットポイントでトランザクションのロールバックを選択できます。トランスフォーメーションエラーが発生すると、そのエラーがターゲットの有効なトランザクションジェネレータの後で発生した場合には、トランザクションがロールバックされます。 Javaクラスパス。使用するJavaクラスパス。 DTMバッファサイズ。DTMプロセスからタスクに割り当てられるメモリの量。差分集計。差分集計を実行します。trueまたはfalseを返します。集計キャッシュの再初期化。差分集計タスクごとに既存の集計ファイルを上書きします。trueまたはfalseを返します。高精度10進演算を有効にする。Decimalデータ型を精度28で処理します。trueまたはfalseを返します。デッドロック時のセッションリトライ。デッドロックが発生したときにマッピングタスクではターゲットでの書き込みが再試行されます。trueまたはfalseを返します。
wizardMetadata			マッピングタスクウィザードのステップのメタデータ。各ステップにmtWizardStepオブジェクトが含まれます。
name	String		mtWizardStepオブジェクトに含まれます。ステップの名前。
title	String		mtWizardStepオブジェクトに含まれます。マッピングタスクウィザードのユーザーインタフェースに表示される、ステップのタイトル。

POST応答

Visioテンプレートを作成または更新するための要求が正常に実行された場合、作成または更新したVisioテンプレートのマスタテンプレートオブジェクトを返します。

エラーが発生した場合はエラーコードを返します。

DELETE要求

Visioテンプレートを削除するには、次のURIのVisioテンプレートIDを使用します。

/api/v2/masterTemplate/<id>

DELETE応答

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

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

GETの例

ID 000043T1000003GでVisioテンプレートを使用するタスクのリストを要求するには、次の要求を使用できます。

GET <serverUrl>/api/v2/masterTemplate/000043T1000003G/tasks 
Accept: application/xml
icSessionId: <icSessionId>

正常に実行された場合、Visioテンプレートを使用する各タスクにid、orgId、name、およびmasterTemplateIdがあるmtTaskオブジェクトを返します。

データ統合 REST API

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal

Rename Saved Search

目次

REST APIリファレンス

REST APIリファレンス

masterTemplate

masterTemplate

GET要求

GET応答

POST要求

POST応答

DELETE要求

DELETE応答

GETの例