ジョブ
jobリソースを使用して、ファイル取り込みタスクを開始します。また、ファイル取り込みタスクのジョブステータスやジョブのログを取得することもできます。ファイル取り込みREST APIバージョン1のtaskリソースを使用して、タスクのIDと名前を取得します。
RUN要求
ファイル取り込みタスクジョブを開始するには、次のURIを使用します。
mftsaas/api/v1/job
要求に次の情報を含めます。
フィールド | タイプ | 必須 | 説明 |
---|
taskId | String | ○ | ファイル取り込みID。 |
taskName | String | | ファイル取り込み名。 |
次のサンプルを参照として使用して、ファイル取り込みタスクジョブを開始します。
{
"taskId": "k1YHA1blhcBjbJvCIRQX2s",
"taskName": "localtolocal_param2"
}
次のサンプル要求を使用して、ユーザーインタフェースに渡されたソースオプション値を上書きします。
"variables": [{
"variable": "<string>",
"value": "<string>"
}]
次の例では、ユーザーインタフェースで渡されたパラメータ値/${Parentfolder}/test2が、REST APIを使用してrootに上書きされます。
{
"taskId": "k1YHA1blhcBjbJvCIRQX2s",
"taskName": "localtolocal_param2",
"parameters": {
"category": [{
"id": "Source",
"parameter": [{
"id": "sourceDirectory",
"value": "/${Parentfolder}/test1"
},
{
"id": "filePattern",
"value": "*.txt"
},
{
"id": "batchSize",
"value": "5"
}
]
},
{
"id": "Target",
"parameter": [{
"id": "targetDirectory",
"value": "/${Parentfolder}/test2"
}]
}
]
},
"variables": [{
"variable": "Parentfolder",
"value": "root"
}]
}
RUN応答
成功すると、ファイル取り込みでジョブの実行IDを返します。実行IDを使用して、ジョブのステータスを監視したり、ジョブのログファイルを要求したりします。
失敗すると、応答にエラーの理由が含まれます。
GETステータス要求
特定のファイル取り込みタスクジョブのステータスを取得するには、次のURIを使用します。
mftsaas/api/v1/job/<runId>/status
GETステータス応答
成功すると、ファイル取り込みでジョブのステータスと詳細が返されます。これにはファイルのリストと、各ファイルの詳細およびステータスが含まれます。
失敗すると、応答にエラーの理由が含まれます。
GETジョブのログ要求
特定のファイル取り込みタスクジョブのログファイルを取得するには、次のURIを使用します。
mftsaas/api/v1/job/<runId>/logs
GETジョブのログ応答
成功すると、ファイル取り込みでジョブのログファイルを返します。
失敗すると、応答にエラーの理由が含まれます。