REST APIリファレンス

前へ次へ

ファイル取り込みタスクの更新

PUT要求を使用してファイル取り込みタスクを更新します。

PUT要求

ファイル取り込み

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

mftsaas/api/v1/mitasks/<taskID>

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

フィールド	タイプ	必須	説明
id	String	-	タスクのID番号。
name	String	○	タスクの名前。
description	String	-	タスクの説明。
sourceType	String	○	ファイルの転送タイプを決定します。次のいずれかのオプションを入力します。 CONNECTION 。ソースとして接続を使用します。 FILELISTENER 。ソースとしてファイルリスナを使用します。
sourceConnection	String	-	ファイルの転送元のディレクトリです。
includeSubfolder	String	-	値は true または false です。この値を true に設定すると、定義したソースディレクトリのすべてのサブフォルダからファイルが転送されます。
checkDuplicate	String	-	値は true または false です。この値を true に設定すると、重複するファイルがチェックされてファイル転送を拒否されます。この値を false に設定すると、すべてのファイルが転送されます。
filePatternType	String	○	転送するファイルの選択に使用するファイル名パターンです。次のいずれかのオプションを入力します。 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)$ à
fileStability	Boolean	-	ファイルをピックアップする前に、ファイルが安定しているかどうかをタスクで確認するかどうかを決定します。次のいずれかの値を入力します。 true。ファイル取り込みタスクは、ファイルをピックアップする前に、ファイルが安定しているかどうかを確認します。 false。ファイル取り込みタスクは、ファイルをピックアップする前に、ファイルが安定しているかどうかを確認しません。デフォルトは false です。
stabilityCheckInterval	Int	-	ファイル取り込みタスクがファイルの安定性を確認するために待機する時間（秒単位）。 fileStabilityオプションが true に設定されている場合にのみ、stabilityCheckIntervalフィールドに値を指定できます。安定性確認間隔は、10秒から300秒の範囲です。
postPickupAction	String	-	ファイル転送後のソースファイルの処理を決定します。選択可能なオプションは、以下のとおりです。 KEEP。ソースディレクトリ内でファイルを保持します。 DELETE。ソースディレクトリからファイルを削除します。 RENAME。ソースディレクトリ内でファイルの名前を変更します。ファイル名を変更する場合は、ファイル取り込みがファイル名に追加するファイル名の接尾辞を指定する必要があります。 ARCHIVE。別の場所にファイルをアーカイブします。アーカイブディレクトリを指定する必要があります。
targetConnection	String	○	ファイルの転送先ディレクトリの詳細です。

PUT要求の例

ファイル取り込みタスクを更新する際にはこの例を参考にしてください。

PUT <serverUrl>/public/core/v1/mitasks
Content-Type: application/json
Accept:application/json
Content-Type:application/json
IDS-SESSION-ID:{{IDS-SESSION-ID}}
{
    "id": "cEMWKpibm44bNf5aMjbJ4U",
    "name": "Green Green v2",
    "description": "Green Green v2 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
}

PUT応答の例

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

{
    "id": "cEMWKpibm44bNf5aMjbJ4U",
    "name": "Green Green v2",
    "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"
}

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

tasksリソース

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal