REST APIリファレンス

前へ次へ

ワークフロー

このリソースを使用して、リニアタスクフローの詳細、または組織の全リニアタスクフローの詳細を要求します。リニアタスクフローの作成、更新、または削除を行うこともできます。

GET要求

特定のリニアタスクフローの詳細を要求する場合、URIにリニアタスクフローIDまたはリニアタスクフロー名を含めます。次のいずれかのURIを使用します。

/api/v2/workflow/<id>

/api/v2/workflow/name/<name>

URIにリニアタスクフロー名を使用し、リニアタスクフロー名にスペースが含まれる場合、スペースは

%20

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

/api/v2/workflow/name/my%20linear%20taskflow

組織の全リニアタスクフローの詳細を要求するには、次のURIを使用します。

/api/v2/workflow

必要に応じて、簡易モードで応答を受信して、パフォーマンスを大幅に改善することができます。簡易モードを有効にすると、応答にはScheduleId属性と電子メール属性が含まれません。簡易モードで応答を受信するには、要求に

simpleMode=true

を含めます。次のURIを使用して、簡易モードで全リニアタスクフローの詳細を受信します。

/api/v2/workflow/?simpleMode=true

GET応答

成功した場合、要求されたリニアタスクフローのワークフローオブジェクトを返します。または、組織の全リニアタスクフローの詳細を要求した場合は、組織の各リニアタスクフローのワークフローオブジェクトを返します。

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

ワークフローオブジェクトには次の属性が含まれます。

フィールド	タイプ	説明
id	String	リニアタスクフローID。
orgId	String	組織ID。
name	String	リニアタスクフロー名。
description	String	説明。
createTime	Date/Time	リニアタスクフローが作成された時間。
updateTime	Date/Time	リニアタスクフローの最終更新時刻。
createdBy	String	リニアタスクフローを作成したユーザー。
updatedBy	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オブジェクトに含まれます。タスクがエラーで終了すると電子メール通知を受信する電子メールアドレス。
agentId	String	タスクを実行するエージェント。
runtimeEnvironmentId	String	タスクに使用されるランタイム環境。
scheduleId	String	リニアタスクフローに関連付けられたスケジュール（ある場合）。
preProcessingCmd	String	タスクの前に実行するコマンド。
postProcessingCmd	String	タスクの完了後に実行するコマンド。
tasks		リニアタスクフローに関連付けられた各タスクを定義します。各タスクのworkflowTaskオブジェクトが含まれます。
taskId	String	workflowTaskオブジェクトに含まれます。タスクID。
type	String	workflowTaskオブジェクトに含まれます。ワークフロータスクタイプ。次のいずれかのコードを返します。 DMASK。マスキングタスク。 DRS。レプリケーションタスク。 DSS。同期タスク。 MTT。マッピングタスク。 PCS。PowerCenterタスク。
name	String	workflowTaskオブジェクトに含まれます。タスク名。
stopOnError	Boolean	workflowTaskオブジェクトに含まれます。タスクを完了できない場合にリニアタスクフローを停止します。
stopOnWarning	Boolean	workflowTaskオブジェクトに含まれます。タスクが警告で完了する場合にリニアタスクフローを停止します。

POST要求

リニアタスクフローを作成するには、次のURIを使用します。

/api/v2/workflow

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

データ統合

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

［エクスプローラ］

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

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

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

リニアタスクフローを更新するには、次の例に示すように、ワークフローIDを含めます。

/api/v2/workflow/<id>

リニアタスクフローを更新すると、

データ統合

は既存のリニアタスクフローを更新に置き換えます。

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

Update-Mode=PARTIAL

このURIで、

ワークフロー

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

フィールド	タイプ	必須	説明
name	String	○	リニアタスクフローの名前。
description	String		リニアタスクフローの説明。
containerId	String		リニアタスクフローを含めるためのプロジェクトまたはフォルダのID。要求に含まれていない場合、リニアタスクフローはDefaultフォルダに作成されます。
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オブジェクトに含めます。タスクがエラーで終了すると電子メール通知を受信する電子メールアドレス。
tasks			workflowTaskオブジェクトを使用して、リニアタスクフローに含める各タスクの以下の属性を定義します。
taskId	String	○	workflowTaskオブジェクトに含まれます。タスクID。
		はい	workflowTaskオブジェクトに含まれます。ワークフロータスクタイプ。次のコードのいずれかを使用します。 DMASK。マスキングタスク。 DRS。レプリケーションタスク。 DSS。同期タスク。 MTT。マッピングタスク。 PCS。PowerCenterタスク。
name	String	○	workflowTaskオブジェクトに含まれます。タスクの名前。
stopOnError	Boolean		workflowTaskオブジェクトに含まれます。タスクを完了できない場合にリニアタスクフローを停止します。次のいずれかのオプションを使用します。 1. True。エラー時に停止します。 2. False。エラー時に停止しません。
stopOnWarning	Boolean		workflowTaskオブジェクトに含まれます。タスクが警告で完了する場合にリニアタスクフローを停止します。次のいずれかのオプションを使用します。 1. True。エラー時に停止します。 2. False。エラー時に停止しません。
scheduleId	String		リニアタスクフローのスケジュール。

POST応答

成功した場合、作成または更新したリニアタスクフローのワークフロー応答オブジェクトを返します。

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

DELETE要求

リニアタスクフローを削除するには、次のURIでリニアタスクフローIDを使用します。

/api/v2/workflow/<id>

DELETE応答

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

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

POSTの例

IDが0000342J0000Kの既存のリニアタスクフローを更新するには、次の要求を使用できます。

POST <serverUrl>/api/v2/workflow/0000342J0000K 
Content-Type: application/json
Accept: application/json
icSessionId: <icSessionId>

{
"@type": "workflow",
"name": "linear taskflow",
"tasks":[{ 
"@type":"workflowTask",
"taskId":"0000100I00000000001G",
"type":"DSS",
"name":"DSS_DQ5",
"stopOnError":"false"
},{
"@type":"workflowTask",
"taskId":"0000100Z0000000000B8",
"type":"MTT",
"name":"CIT_SimpleTemplate2",
"stopOnError":"false"
},{
"@type":"workflowTask",
"taskId":"0000100G000000000002",
"type":"DRS",
"name":"SF2File",
"stopOnError":"false"
}]
}

成功した要求は、更新したワークフローオブジェクトを返します。

データ統合 REST API

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal