REST APIリファレンス

前へ次へ

job リソース

job

リソースを使用して、

ファイル取り込み

ジョブを開始します。

また、

ファイル取り込み

タスクのジョブステータスやジョブのログを取得することもできます。

ファイル取り込み

REST APIバージョン1のtaskリソースを使用して、タスクのIDと名前を取得します。

RUN要求

ファイル取り込み

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

mftsaas/api/v1/job

要求に次の情報を含めます。

フィールド	タイプ	必須	説明
taskId	String	○	ファイル取り込み ID。
taskName	String	-	ファイル取り込み名。

ファイル取り込み

ジョブを開始するときは、指定したコネクタに対して次のソースディレクトリキーとターゲットディレクトリキーを使用します。

コネクタ	srcDir	tgtDir
ローカル	sourceDirectory	targetDirectory
ftp,ftps,sftp	sourceDirectory	targetDirectory
gcs	sourceDirectory	gcsTargetLocation
hdfs	sourceDirectory	hdfsTargetLocation
adlsgen2	sourceDirectory	adlsGen2TargetLocation
s3	s3SourceLocation	s3TargetLocation
blob	blobSourceLocation	blobContainer

ジョブリソースREST APIを使用して、次のようなパラメータを上書きできます。

カテゴリ	パラメータ	ID
全般	ソース接続	sourceConnection
全般	ターゲット接続	targetConnection
全般	並列バッチログレベル	parallelBatch
全般	ログレベル	logLevel
ソース	ソースディレクトリ	sourceDirectory
ソース	ファイルパターン	filePattern
ソース	バッチサイズ	batchSize
ソース	サブフォルダのファイルを含む	includeSubfolder
ソース	重複するファイルをスキップ	checkDuplicate
ソース	ファイルの安定性を確認	fileStability
ソース	安定性確認間隔	stabilityCheckInterval
ターゲット	ターゲットディレクトリ	targetDirectory

ソース接続パラメータとターゲット接続パラメータを上書きするには、接続IDを渡す必要があります。

次のサンプルを参照として使用して、

ファイル取り込み

タスクジョブを開始します。

{
        "taskId": "k1YHA1blhcBjbJvCIRQX2s",
        "taskName": "localtolocal_param2"
}

次のサンプル要求を使用して、ユーザーインタフェースに渡されたソースオプション値を上書きします。

"variables": [{
        "variable": "<string>",
        "value": "<string>"
    }]

次の例では、ジョブリソースREST APIの使用中に、ユーザーインタフェースで渡されたパラメータ値が、JSON POSTで指定された対応する値で上書きされます。

{
    "taskId": "0efdVUEZeV2cB0quomeksd",
    "taskName": "localtolocal_param2",
    "parameters": {
        "category": [{

                "id": "General",

                "parameter": [

                    {

                        "id":"sourceConnection",

                        "value":"AdvancedSFTPV2"

                    },

                    {

                        "id":"targetConnection",

                        "value":"AdvancedSFTPV2"

                    },

                    {

                        "id":"parallelBatch",

                        "value":"10"

                    },

                    {

                        "id":"logLevel",

                        "value":"DEBUG"

                    }

                ]

            },{

                "id": "Source",

                "parameter": [{

                        "id": "sourceDirectory",

                        "value": "/root/test1"

                    },

                    {

                        "id":"filePatternType",

                        "value":"reg"

                    },

                    {

                        "id": "filePattern",

                        "value": "*.txt"

                    },

                    {

                        "id": "batchSize",

                        "value": "5"

                    },

                    {

                        "id":"includeSubfolder",

                        "value":"true"

                    },

                    {

                        "id":"checkDuplicate",

                        "value":"true"

                    },

                    {

                        "id":"fileStability",

                        "value":"true"

                    },

                    {

                        "id":"stabilityCheckInterval",

                        "value":"30"

                    }

                ]

            },

            {

                "id": "Target",

                "parameter": [{

                    "id": "targetDirectory",

                    "value": "/root/test2"

                }]

            }

        ]

    }

}

次の例は、

filename

を変数としてファイル取り込みタスクを上書きする方法を示しています。

{
  "taskId": "4m24k3UFWMkkqd55YDefIB",
  "taskName": "R41_Local_Local",
  "parameters": {
    "category": [
      {
        "id": "Source",
        "parameter": [
          {
            "id": "sourceDirectory",
            "value": "/${Parentfolder}"
          },
          {
            "id": "filePickupFilePath",
            "value": "${filename}"
          },
          {
            "id": "batchSize",
            "value": "5"
          }
        ]
      },
      {
        "id": "Target",
        "parameter": [
          {
            "id": "targetDirectory",
            "value": "/${Parentfolder}/Target"
          }
        ]
      }
    ]
  },
  "variables": [
    {
      "variable": "Parentfolder",
      "value": "root/Arun"
    },
    {
      "variable": "filename",
      "value": "filepath.txt"
    }
  ]
}

次の例は、

filelist

を変数としてファイル取り込みタスクを上書きする方法を示しています。

{
  "taskId": "4m24k3UFWMkkqd55YDefIB",
  "taskName": "R41_Local_Local",
  "parameters": {
    "category": [
      {
        "id": "Source",
        "parameter": [
          {
            "id": "sourceDirectory",
            "value": "/${Parentfolder}"
          },
          {
            "id": "filePickupFileList",
            "value": "${filelist}"
          },
          {
            "id": "batchSize",
            "value": "5"
          }
        ]
      },
      {
        "id": "Target",
        "parameter": [
          {
            "id": "targetDirectory",
            "value": "/${Parentfolder}/Target"
          }
        ]
      }
    ]
  },
  "variables": [
    {
      "variable": "Parentfolder",
      "value": "root/Arun"
    },
    {
      "variable": "filelist",
      "value": "File1.txt,File2.txt,File3.txt,File4.txt"
    }
  ]
}

RUN応答

成功すると、

ファイル取り込み

でジョブの実行IDを返します。実行IDを使用して、ジョブのステータスを監視したり、ジョブのログファイルを要求したりします。

失敗すると、応答にエラーの理由が含まれます。

GETステータス要求

特定の

ファイル取り込み

タスクジョブのステータスを取得するには、次のURIを使用します。

mftsaas/api/v1/job/<runId>/status

GETステータス応答

成功すると、

ファイル取り込み

でジョブのステータスと詳細が返されます。これにはファイルのリストと、各ファイルの詳細およびステータスが含まれます。

失敗すると、応答にエラーの理由が含まれます。

GETジョブのログ要求

特定の

ファイル取り込み

タスクジョブのログファイルを取得するには、次のURIを使用します。

mftsaas/api/v1/job/<runId>/logs

GETジョブのログ応答

成功すると、

ファイル取り込み

でジョブのログファイルを返します。

失敗すると、応答にエラーの理由が含まれます。

一括取り込みファイルREST API

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal

Rename Saved Search

目次

REST APIリファレンス

REST APIリファレンス

job リソース

job リソース

RUN要求

RUN応答

GETステータス要求

GETステータス応答

GETジョブのログ要求

GETジョブのログ応答