REST APIリファレンス

前へ次へ

ジョブ

このリソースを使用して、IDまたは名前に基づいてタスクを開始または停止します。また、ジョブの完了ステータスを取得することも可能です。

POST要求の開始

組織でプロジェクトやフォルダを使用している場合は、REST APIバージョン3ルックアップリソースを使用してタスクIDを取得します。これにより、フェデレーションタスクIDが返されます。POST要求にはこのIDを含める必要があります。

taskリソースを使用してタスクIDを取得することもできますが、taskリソースから返されるタスクIDは、Defaultフォルダ内のタスクの実行にしか使用できません。

一括取り込み

ファイル取り込み

タスクでは、このリソースを使用しないでください。代わりに、

ファイル取り込み

ジョブリソースを使用します。詳細については、一括取り込みファイルREST APIを参照してください。

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

/api/v2/job

このURIでは、ジョブオブジェクトの次の属性を使用します。

フィールド	タイプ	必須	説明
taskId	String	taskNameかtaskFederatedIdが含まれていない場合は必須。	タスクまたはリニアタスクフローID。URIにtaskIdまたはtaskNameを使用します。タスクがDefaultフォルダにある場合はこのタスクIDを含めることができます。
taskFederatedId	String	タスクがDefaultフォルダに配置されていない場合は必須。	タスクへのフォルダパスを含む、タスクのグローバル一意識別子。
taskName	String	taskIdかtaskFederatedIdが含まれていない場合は必須。	タスクまたはリニアタスクフローの名前。URIにtaskIdまたはtaskNameを使用します。
taskType	String	○	タスクのタイプ。データ統合では、次のいずれかのコードを使用します。 DMASK。マスキングタスク。 DRS。レプリケーション DSS。同期 MTT。マッピング PCS。PowerCenterタスク。 WORKFLOW。リニアタスクフロー。
callbackURL	文字列	-	公表済みの有効なURL。サービスがcallbackURLにジョブステータスをポストします。

POST応答の開始

要求が成功すると、ジョブオブジェクトを返します。エラーが発生した場合はエラーオブジェクトを返します。

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

フィールド	タイプ	説明
taskId	String	タスクまたはリニアタスクフローID。
taskFederatedId	String	タスクへのフォルダパスを含む、タスクのグローバル一意識別子。
taskName	String	タスクまたはリニアタスクフローの名前。
taskType	String	タスクのタイプ。データ統合の次のいずれかのコードを返します。 DMASK。マスキングタスク。 DRS。レプリケーションタスク。 DSS。同期タスク。 MTT。マッピングタスク。 PCS。PowerCenterタスク。 WORKFLOW。リニアタスクフロー。
runId	Long	ジョブのID。
callbackURL	String	ジョブのステータス。

開始POST要求の例

0034J90000000MというIDのリニアタスクフローをJSONで開始するには、次の要求を使用します。

POST <serverUrl>/api/v2/job HTTP/1.0
Content-Type: application/json
Accept: application/json
icSessionId: <icSessionId>

{
"taskId": "0034J90000000M",
"taskType": "Workflow",
"callbackURL": "https://MyIICSJobStatus.com",
}

0100000Z000009というIDで

マッピング

タスクを開始するには、次の要求を使用します。タスクの複数のインスタンスを同時に実行するには、要求にランタイムオブジェクトを含めます。

POST <serverUrl>/api/v2/job HTTP/1.0
Content-Type: application/json
Accept: application/json
icSessionId: <icSessionId>

{
    "@type": "job",
    "taskId": "0100000Z000009",
    "taskType": "MTT",
    "runtime": {
        "@type": "mtTaskRuntime"
    }
}

POST要求の停止

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

/api/v2/job/stop

このURIでは、ジョブオブジェクトの次の属性を使用します。

フィールド	タイプ	必須	説明
taskId	String	taskNameが含まれていない場合は必須。	タスクまたはリニアタスクフローID。URIにtaskIdまたはtaskNameを使用します。
taskFederatedId	String	タスクがDefaultフォルダに配置されていない場合は必須。	タスクへのフォルダパスを含む、タスクのグローバル一意識別子。
taskName	String	taskIdが含まれていない場合は必須。	タスクまたはリニアタスクフローの名前。URIにtaskIdまたはtaskNameを使用します。
taskType	String	○	タスクのタイプ。データ統合では、次のいずれかのコードを使用します。 DMASK。マスキングタスク。 DRS。レプリケーションタスク。 DSS。同期タスク。 MTT。マッピングタスク。 PCS。PowerCenterタスク。 WORKFLOW。リニアタスクフロー。

POST応答の停止

要求が成功すると、成功オブジェクトを返します。エラーが発生した場合にエラーオブジェクトを返します。

POSTの停止の例

IDが0034J90000000MのリニアタスクフローをJSONで停止するには、次の要求を使用できます。

POST <serverUrl>/api/v2/job/stop HTTP/1.0
Content-Type: application/json
Accept: application/json
icSessionId: <icSessionId>

{
"@type": "job",
"taskId": "0034J90000000M",
"taskType": "Workflow"
}

クリーン停止POST要求

タスクまたはリニアタスクフローをクリーン停止するには、次のURIを使用します。

/api/v2/job/stop?cleanStop=true

このURIでは、ジョブオブジェクトの次の属性を使用します。

フィールド	タイプ	必須	説明
taskId	String	taskNameが含まれていない場合は必須。	タスクまたはリニアタスクフローID。URIにtaskIdまたはtaskNameを使用します。
taskFederatedId	String	タスクがDefaultフォルダに配置されていない場合は必須。	タスクへのフォルダパスを含む、タスクのグローバル一意識別子。
taskName	String	taskIdが含まれていない場合は必須。	タスクまたはリニアタスクフローの名前。URIにtaskIdまたはtaskNameを使用します。
taskType	String	○	タスクのタイプ。データ統合では、次のいずれかのコードを使用します。 DMASK。マスキングタスク。 DRS。レプリケーションタスク。 DSS。同期タスク。 MTT。マッピングタスク。 PCS。PowerCenterタスク。 WORKFLOW。リニアタスクフロー。

クリーン停止POST応答

要求が成功すると、成功オブジェクトを返します。エラーが発生した場合にエラーオブジェクトを返します。

クリーン停止POSTの例

MappingTask1という名前のマッピングタスクをクリーン停止するには、次の要求を使用します。

POST <serverUrl>/api/v2/job/stop?cleanStop=1

{
"@type": "job",
    "taskName": "MappingTask1",
    "taskType": "MTT"
}

ジョブステータス

ジョブ要求にcallbackURLが含まれる場合は、サービスがジョブの完了時に要求をコールバックURLに送信します。サービスでは、コールバックの要求に必ずJSONを使用します。

コールバックは複数回呼び出される場合があります。例えば、次の状況では、複数のコールバックが発生する可能性があります。

コールバックサーバーは200件以外のHTTPステータスコードを返した場合。

コールバックサーバーが30秒以内に応答しない場合。

コールバックサーバーがダウンしている場合。

一時的なネットワーク障害がある場合。

これらのいずれかの状況では、URL接続が切断され、サービスではこの切断が、失敗した試行としてカウントされます。サービスは、正常な応答を受信するために3回の試行を即座に行います。その後、試行間隔は指数関数的に増加します。例えば、最初の試行は30秒間隔で始まり、合計時間が30分に達するまでに最大3分間隔まで延長されます。

サービスはコールバックURLからPOST要求を実行します。次のテキストは、戻りのサンプルです。

 {
    @type:"callbackUrlResponse"
    endTime: "2013-02-27T18:57:52.000Z",
    objectId: "0034J90000000M",
    objectName: "taskName",
    runId: 5,
    status: "COMPLETED" // or “FAILED”
}

プラットフォームREST APIバージョン2リソース

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal