REST APIリファレンス

前へ次へ

ファイル取り込みタスクの作成

POST要求を使用してファイル取り込みタスクを作成します。

POST要求

APIを使用して

ファイル取り込み

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

mftsaas/api/v1/mitasks

要求に次のフィールドを含めます。

フィールド	タイプ	必須	説明
name	String	○	タスクの名前。
location	String	-	プロジェクトの場所。
projectId	String	-	プロジェクトに関連付けられているID番号。
projectName	String	-	プロジェクトの名前。
description	String	-	タスクの説明。
sourceConnection	String	-	ファイルの転送元のディレクトリです。
sourceType	String	○	ファイルの転送タイプを決定します。次のいずれかのオプションを入力します。 CONNECTION 。ソースとして接続を使用します。 FILELISTENER 。ソースとしてファイルリスナを使用します。
includesubfolder	String	-	サブフォルダのファイルを転送に含めるかどうかを決定します。この値を true に設定すると、定義したソースディレクトリのすべてのサブフォルダからファイルが転送されます。値は true または false です。
checkDuplicate	String	-	重複するファイルをチェックするかどうかを決定します。値は true または false です。この値を true に設定すると、重複するファイルがチェックされてファイル転送を拒否されます。この値を false に設定すると、すべてのファイルが転送されます。
filePickupOption	String	○	ファイルのピックアップ方法を決定します。次のいずれかのオプションを入力します。 FILELIST 。ファイル取り込みタスクは、ファイルリストに基づいてファイルをピックアップします。 PATTERN 。ファイル取り込みタスクは、パターン別にファイルをピックアップします。
allowConcurrency	String	-	複数のジョブを同時に実行するかどうかを決定します。複数のジョブを同時に実行する場合は、値を true に設定します。しない場合は、値を false に設定します。ターゲットに重複ファイルが含まれている場合、同時ジョブを実行すると予期しない結果が生じる可能性があります。
filePatternType	String	○	これは、filePickupOptionがPATTERNの場合に適用されます。転送するファイルの選択に使用するファイルパターンタイプです。次のいずれかのオプションを入力します。 wildcard regex
filePattern	String	○	選択したファイルパターンに応じてファイルパターンタイプを入力します。 wildcard。以下のワイルドカード文字フィルタを使用できます。アスタリスク（）はどんな数の文字とも一致します。疑問符（?）は1つの文字と一致します。 regex。正規表現を使用してファイルパターンを照合します。以下に例を示します。次の構文を使用すると、名前にout、foo、bazを含むファイルを除くすべてのファイルをリスニングします。 ^(?!.(?:out\|baz\|foo)).*$ all except 次の構文を使用すると、拡張子がdoc、docx、pdfのすべてのファイルをリスニングします。 ([a-zA-Z0-9\s_\\.\-:])+(.doc\|.docx\|.pdf)$
filepickupByName	String	○	これは、filePickupOptionがFILELISTの場合に適用されます。次のいずれかのオプションを入力します。 filepath 。ピックアップするファイルのリストを含むパスを指定し、ファイルパスを入力します。 listoffiles 。ピックアップするファイルのリストを指定し、ファイル名のカンマ区切りリストを入力します。ファイル名を指定する前後にスペースがないことを確認します。
fileStability	Boolean	-	ファイルをピックアップする前に、ファイルが安定しているかどうかをタスクで確認するかどうかを決定します。次のいずれかの値を入力します。 true。ファイル取り込みタスクは、ファイルをピックアップする前に、ファイルが安定しているかどうかを確認します。 false。ファイル取り込みタスクは、ファイルをピックアップする前に、ファイルが安定しているかどうかを確認しません。デフォルトは false です。
stabilityCheckInterval	Int	-	ファイル取り込みタスクがファイルの安定性を確認するために待機する時間（秒単位）。 fileStabilityオプションが true に設定されている場合にのみ、stabilityCheckIntervalフィールドに値を指定できます。安定性確認間隔は、10秒から300秒の範囲です。
postPickupAction	String	-	ファイル転送後のソースファイルの処理を決定します。選択可能なオプションは、以下のとおりです。 KEEP。ソースディレクトリ内でファイルを保持します。 DELETE。ソースディレクトリからファイルを削除します。 RENAME。ソースディレクトリ内でファイルの名前を変更します。ファイル名を変更する場合は、ファイル取り込みがファイル名に追加するファイル名の接尾辞を指定する必要があります。 ARCHIVE。別の場所にファイルをアーカイブします。アーカイブディレクトリを指定する必要があります。
targetConnection	String	○	ファイルの転送先ディレクトリの詳細です。
taskActions	String	-	ファイル取り込みタスクのファイルを処理するアクション。複数のアクションを追加する場合、ファイル取り込みはファイルを順番に処理します。
actions			ファイル処理アクション。次のファイル処理アクションを入力します。ファイルを圧縮するには、 Compression と入力します。ファイルを圧縮解除するには、 Decompression と入力します。ファイルを暗号化するには、 Encryption と入力します。ファイルを復号化するには、 Decryption と入力します。複数のフォルダから単一のフォルダにファイルを移動し、ターゲットディレクトリ内のファイルの名前を変更するには、 File Operations と入力します。 ICAPプロトコルを使用してファイルにウイルスがないかどうかをスキャンするには、 Virus Scan と入力します。
action type			追加するアクションに応じたアクションタイプを入力します。ファイルを圧縮するには、次のいずれかの方法を使用します。 Zip Tar Gzip Bzip2 ファイルを圧縮解除するには、次のいずれかの方法を使用します。 Unzip Untar Gunzip Bunzip2 ファイルを暗号化するには、PGPを追加します。プロパティにキーIDを入力します。ファイル取り込みタスクは、ファイルの暗号化にPGP方式を使用します。CLIを使用してキーリングを生成します。［キーID］にキーリングを入力します。キーリングCLIの詳細については、『タスク』のキーリングコマンドリファレンスを参照してください。ファイルを復号化するには、PGPを追加します。プロパティにキーパスフレーズを入力します。ファイル取り込みタスクは、ファイルの暗号化にPGP方式を使用します。CLIを使用してキーパスフレーズを生成します。［キーパスフレーズ］にキーパスフレーズを入力します。キーリングCLIの詳細については、『タスク』のキーリングコマンドリファレンスを参照してください。

POST要求の例

ファイルピックアップオプションとしてファイルパターンを使用してファイル取り込みタスクを作成する際にはこの例を参考にしてください。

POST <serverURL>/public/core/v1/mitasks
Content-Type: application/json
Accept:application/json
Content-Type:application/json
IDS-SESSION-ID:{{IDS-SESSION-ID}}
{    
    "name": "Green Green v2",
    "location": {
        "projectId": "9JDNOBX9M31e2AD1dIUv6M",
        "projectName": "Default"
    },
    "description": "",
    "sourceType": "CONNECTION",
    "sourceConnection": {
        "id": "",
        "name": "",
        "type": "local"
},
        "sourceParameters": {
            "filePattern": "*.txt",
            "filePatternType": "WILDCARD",
            "includeSubfolder": "false",
            "sourceDirectory": "C:\\Monitor",
            "checkDuplicate": "false",
            "fileStability": "true",
            "stabilityCheckInterval": "60",
            "postPickupAction": "KEEP"
        
    },
    "targetConnection": {
        "id": "0100000B000000000002",
        "name": "ADLS",
        "type": "Azure Data Lake"
},
        "targetParameters": {
        "adlsTargetLocation": "/satyen/green"
        
    },
    "agentGroupId": "01000025000000000002",
	"filePickupOption": "PATTERN",
    "logLevel": "NORMAL", 
	"allowConcurrency": "true",
		taskActions":[
				 	{ 
					"action": "Compression", 
					"actionType": "Zip", 
					"properties": {}
					 } 
					]
}

ファイルピックアップオプションとしてファイルパスを使用してファイル取り込みタスクを作成する際にはこの例を参考にしてください。

POST <serverURL>/public/core/v1/mitasks
Content-Type: application/json
Accept:application/json
Content-Type:application/json
IDS-SESSION-ID:{{IDS-SESSION-ID}}
{
    "name": "FilePath_RestAPI1",
    "location": {
        "projectId": "0ggRhrI8ZziguyBxHBzuG0",
        "projectName": "Default"
    },
    "description": "",
    "sourceType": "CONNECTION",
    "sourceConnection": {
        "id": "",
        "name": "",
        "type": "local"
    },
    "targetConnection": {
        "id": "",
        "name": "",
        "type": "local"
    },
    "sourceParameters": {
        "filePickupFilePath": "test.txt",
        "sourceDirectory": "/root/test",
        "checkDuplicate": "false",
        "fileStability": "true",
        "stabilityCheckInterval": "60",
        "postPickupAction": "KEEP",
        "filepickupByName": "FILEPATH",
        "batchSize": "5"
 
    },
    "targetParameters": {
    "fileExistsAction": "OVERWRITE",
    "targetDirectory": "/root/testCheckStability"
    },
    "agentGroupId": "01001D25000000000002",
    "logLevel": "NORMAL",
    "filePickupOption": "FILELIST",
	"allowConcurrency": "true"
}

ファイルピックアップオプションとしてファイルリストを使用してファイル取り込みタスクを作成する際にはこの例を参考にしてください。

POST <serverURL>/public/core/v1/mitasks
Content-Type: application/json
Accept:application/json
Content-Type:application/json
IDS-SESSION-ID:{{IDS-SESSION-ID}}
{
 
    "name": "DedupFilelist_RestAPI",
    "location": {
        "projectId": "0ggRhrI8ZziguyBxHBzuG0",
        "projectName": "Default"
    },
    "description": "",
    "sourceType": "CONNECTION",
    "sourceConnection": {
        "id": "01001D0B0000000005PP",
        "name": "ADLSGen2",
        "type": "Azure Data Lake Gen2"
    },
    "targetConnection": {
        "id": "01001D0B0000000005PU",
        "name": "AzureDW_Gen2",
        "type": "Azure DW"
    },
    "sourceParameters": {
        "sourceDirectory": "/B2B/MI",
        "checkDuplicate": "true",
        "postPickupAction": "KEEP",
        "filepickupByName": "LISTOFFILES",
        "blockSize": "8388608",
        "filePickupFileList": "File1.txt,File2.txt",
        "batchSize": "5",
        "timeoutInterval": "60",
        "fileStability": "true",
        "stabilityCheckInterval": "60"
            
    },
    "targetParameters": {
        "commandType": "auto",
        "targetTableName": "test1234",
        "isPushdown": "true",
        "ingestionMethod": "polybase",
        "targetSchemaName": "testing",
        "isTruncateTarget": "true"
    },
    "agentGroupId": "01001D25000000000002",
    "logLevel": "NORMAL",
    "filePickupOption": "FILELIST",
	"allowConcurrency": "true"
}

POST応答の例

要求が成功した場合、次の例のような応答を受信します。


{
    "id": "cEMWKpibm44bNf5aMjbJ4U",
    "name": "Green Green v2",
    "location": {
        "projectId": "9JDNOBX9M31e2AD1dIUv6M",
        "projectName": "Default"
    },
    "description": "",
    "sourceType": "CONNECTION",
    "sourceConnection": {
        "id": "",
        "name": "",
        "type": "local"
},
        "sourceParameters": {
            "filePattern": "*.txt",
            "filePatternType": "WILDCARD",
            "includeSubfolder": "false",
            "sourceDirectory": "C:\\Monitor",
            "checkDuplicate": "false",
            "fileStability": "true",
            "stabilityCheckInterval": "60",
            "postPickupAction": "KEEP"
        
    },
    "targetConnection": {
        "id": "0100000B000000000002",
        "name": "ADLS",
        "type": "Azure Data Lake"
},
        "targetParameters": {
            "adlsTargetLocation": "/satyen/green"
        
    },
    "agentGroupId": "01000025000000000002",
    "createdTime": "2018-08-27T07:03:32Z",
    "updatedTime": "2018-08-29T12:14:58Z""
				taskActions":[
				 { 
							"action": "Compression", 
							"actionType": "Zip", 
							"properties": {}
					} 
				]
}
}

応答に表示される作成日時と更新日時はUTC時間です。

tasksリソース

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal