ジョブ
このジョブリソースを使用して、線形タスクフローなど、IDまたは名前に基づいてタスクを開始または停止します。ジョブの完了ステータスを取得することもできます。
IDに基づいてタスクを開始または停止するには、タスクの8文字のオブジェクトIDまたはフェデレーションタスクIDを使用します。
8文字のオブジェクトIDを見つけるには、
タスクを参照してください。ただし、このリソースから返されるタスクIDは、Defaultフォルダ内のタスクの実行にのみ使用できます。
組織でプロジェクトとフォルダを使用している場合は、
ルックアップまたは
オブジェクトを参照してフェデレーションタスクIDを取得してください。
データ取り込みおよびレプリケーションの
ファイル取り込みとレプリケーションタスクの場合は、
ファイル取り込みとレプリケーションジョブリソースを使用します。詳細については、「
ファイル取り込みとレプリケーションREST API」を参照してください。
ジョブステータス
ジョブ要求に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”
}
ジョブの開始
ジョブリソースを使用して、ジョブを開始します。
POST要求
次のURIを使用します。
/api/v2/job
次の表に、ジョブオブジェクトで使用する属性とその説明を示します。
フィールド | タイプ | 必須 | 説明 |
|---|
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にジョブステータスをポストします。 |
runtime | | いいえ | ランタイムプロパティを定義する属性。 |
parameterFileName | 文字列 | いいえ | パラメータファイルの名前。 |
parameterFileDir | 文字列 | いいえ | Secure Agentマシン上のパラメータファイルのディレクトリ。 |
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の線形タスクフローを開始するには、次の要求を使用します。
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 <serverUrl>/api/v2/job HTTP/1.0
Content-Type: application/json
Accept: application/json
icSessionId: <icSessionId>
{
"@type": "job",
"taskId": "0116Q70Z0000000000N4",
"taskType": "MTT",
"runtime": {
"@type": "mtTaskRuntime",
"parameterFileName": "EmployeeDept.param",
"parameterFileDir": "/root/dev/FlatFiles"
}
}
次の応答が表示される場合があります。
{
"@type": "job",
"taskId": "0116Q70Z0000000000N4",
"taskType": "MTT",
"runId": 59,
"taskName": "mct_03126935_Oracle_FF_Parameter",
"runInParallel": false
}
ジョブの停止
ジョブリソースを使用して、ジョブを停止します。
POST要求
次のURIを使用します。
/api/v2/job/stop
次の表に、ジョブオブジェクトで使用する属性とその説明を示します。
フィールド | タイプ | 必須 | 説明 |
|---|
taskId | String | taskNameが含まれていない場合は必須。 | タスクまたはリニアタスクフローID。URIにtaskIdまたはtaskNameを使用します。 タスクがDefaultフォルダにある場合はこのタスクIDを含めることができます。 |
taskFederatedId | String | タスクがDefaultフォルダに配置されていない場合は必須。 | タスクへのフォルダパスを含む、タスクのグローバル一意識別子。 |
taskName | String | taskIdが含まれていない場合は必須。 | タスクまたはリニアタスクフローの名前。URIにtaskIdまたはtaskNameを使用します。 |
taskType | String | ○ | タスクのタイプ。データ統合では、次のいずれかのコードを使用します。 - - DMASK。マスキングタスク。
- - DRS。レプリケーションタスク。
- - DSS。同期タスク。
- - MTT。マッピングタスク。
- - PCS。PowerCenterタスク。
- - WORKFLOW。リニアタスクフロー。
|
POST応答
応答は、要求が成功した場合は成功オブジェクト、エラーが発生した場合はエラーオブジェクトを返します。
POST要求の例
0034J90000000MというIDの線形タスクフローを停止するには、次の要求を使用します。
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
次の表に、ジョブオブジェクトで使用する属性とその説明を示します。
フィールド | タイプ | 必須 | 説明 |
|---|
taskId | String | taskNameが含まれていない場合は必須。 | タスクまたはリニアタスクフローID。URIにtaskIdまたはtaskNameを使用します。 タスクがDefaultフォルダにある場合はこのタスクIDを含めることができます。 |
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=true HTTP/<HTTP version>
Content-Type: application/json
Accept: application/json
icSessionId: <SessionId>
{
"@type": "job",
"taskName": "MappingTask1",
"taskType": "MTT"
}