REST APIリファレンス

前へ次へ

ジョブの開始

ジョブリソースを使用して、ジョブを開始します。

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
}

ジョブ

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal