REST APIリファレンス > データ統合 REST API > ファイル転送

ファイル転送

リモートサーバーへのファイルの送信や、リモートサーバーからのファイルの受信、REST APIを介したジョブステータスの取得を行うことができます。

ファイル転送に使用するリソースは次のとおりです。

•sendfiles。ファイルをリモートサーバーに送信するために使用します。
•receivefiles。ファイルをリモートサーバーから受信するために使用します。
•job。sendfilesまたはreceivefilesリソースを使用して開始した、サポートされるファイル転送ジョブのステータスを取得するために使用します。

これらのリソースを使用するときには、次のルールに注意してください。

•JSON形式を使用します。
•次のベースURLを使用する。

<serverUrl>/mftsaas/api/v1/<API name>

•次の要求ヘッダー形式を使用する。

<METHOD> <serverUrl>/<URI> HTTP/<HTTP version>
Content-Type: application/json
Accept: application/json
IDS-SESSION-ID: <SessionId>

注: 適切なコネクタライセンスでファイルを送信および受信する必要があります。

リモートサーバーへのファイルの転送

sendfilesリソースを使用してファイルをリモートサーバーに転送します。

以下の接続タイプは、sendfilesリソースを使用して、リモートサーバーにファイルを転送します。

•AS2
•Advanced FTP V2
•Advanced FTPS V2
•Advanced SFTP V2

sendfiles要求を作成してファイルを転送する前に、サーバーへのアクセスを提供する接続のIDを取得します。この接続IDを取得するには、connectionリソースを使用してGET要求を送信します。connectionリソースから組織の各接続の情報が返されます。

POST要求

ファイルを転送するには、次のURIに接続IDを含めます。

mftsaas/api/v1/sendfiles/<connection ID>

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

フィールド	タイプ	必須	説明
targetConnectionType	String	○	接続タイプ。サポートされている接続タイプは次のとおりです。 - Advanced FTP V2 - Advanced FTPS V2 - Advanced SFTP V2 - AS2
srcDirectoryPath	String	○	ファイルの転送元のディレクトリパスです。
tgtDirectoryPath	String	-	ファイル転送先のディレクトリパスです。このオプションは、Advanced FTP V2、Advanced FTPS V2、およびAdvanced SFTP V2接続タイプにのみ使用できます。デフォルトは'/'です。
srcFilePattern	文字列	○	ソースファイルのファイル名パターン。送信するファイルを識別するファイル名パターンを指定します。その場合はこのような正規表現タイプを使用できます。
deleteSourceFiles	文字列	-	POST要求が成功した後で、ソースファイルを削除するかどうか。以下の値を使用します。 - true。ソースファイルを削除します。 - false。ソースファイルを保存します。デフォルトはtrueです。

例えば、workspaceディレクトリにある、名前が「file_」で始まるファイルを転送するには、次のような要求を使用します。

POST <serverUrl>/mftsaas/api/v1/sendfiles/<connection ID>
Accept:application/json
IDS-SESSION-ID: <icSessionId or INFA-SESSION-ID>
{
"targetConnectionType": "as2",
"srcDirectoryPath": "C:\\server\\userdata\\workspace",
"srcFilePattern": "file_*“
}

例えば、「.txt」パターンを持つファイルを転送するには、以下の要求を使用します。

POST <serverUrl>/mftsaas/api/v1/sendfiles/<connection ID>
Accept:application/json
IDS-SESSION-ID: <icSessionId or INFA-SESSION-ID>
{
"targetConnectionType": "Advanced SFTP V2",
"srcDirectoryPath": "C:\\docstoreLocal2",
"tgtDirectoryPath": "C:\\server\\userdata\\workspace",
"srcFilePattern": ".*txt“

}

POST応答

成功すると、Informatica Intelligent Cloud Servicesからジョブの実行IDが返されます。その実行IDを使用してジョブステータスを監視します。

成功時の応答の例を以下に示します。

{
"projectId": 0,
"timeTaken": 0,
"queuePriority": 0,
"runPriority": 0,
"runMode": "UNKNOWN",
"submitSourceId": -1,
"correlationId": "OWMxOTc2YjktNzI4YS00Mm",
"runModeInteractive": false,
"runModeBatch": false,
"runModeDebug": false,
"runModeUnknown": true,
"formattedTimeTaken": "0.00",
"id": 1000000000384,
"runId": 385
}

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

リモートサーバーからのファイルの受信

receivefilesリソースを使用してファイルをリモートサーバーから取得します。

以下の接続タイプは、receivefilesリソースを使用して、リモートサーバーにファイルを転送します。

•Advanced FTP V2
•Advanced FTPS V2
•Advanced SFTP V2

receivefiles要求を作成してファイルを受信する前に、サーバーへのアクセスを提供する接続のIDを取得します。この接続IDを取得するには、connectionリソースを使用してGET要求を送信します。connectionリソースから組織の各接続の情報が返されます。

POST要求

ファイルを受信するには、次のURIに接続IDを含めます。

mftsaas/api/v1/receivefiles/<connection ID>

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

フィールド	タイプ	必須	説明
sourceConnectionType	String	○	接続タイプ。サポートされているソース接続タイプは次のとおりです。 - Advanced FTP V2 - Advanced FTPS V2 - Advanced SFTP V2
tgtDirectoryPath	String	○	ファイル転送先のディレクトリパスです。
srcDirectoryPath	String	-	ファイルの転送元のディレクトリパスです。デフォルトは'/'です。
srcFilePattern	文字列	○	ソースファイルのファイル名パターン。送信するファイルを識別するファイル名パターンを指定します。その場合はこのような正規表現タイプを使用できます。
processFilesRecursively	String	-	ベースディレクトリ内のすべてのサブフォルダからファイルを処理するかどうか。デフォルトはfalseです。
afterFilePickupAction	String	-	ファイル転送後のソースファイルの処理を決定します。選択可能なオプションは、以下のとおりです。 - ソースディレクトリ内でファイルを保持します。 - ソースディレクトリからファイルを削除します。 - ソースディレクトリ内でファイルの名前を変更します。ファイルの名前を変更する場合は、ファイル名に追加するファイル名の接尾辞を指定する必要があります。 - 別の場所にファイルをアーカイブします。アーカイブディレクトリを指定する必要があります。デフォルトは、KEEPです。
skipDuplicateFiles	String	-	重複したファイルは転送しないでください。同じ名前と作成日を持つファイルが転送済みである場合、タスクはファイルを再度転送せずにジョブログでファイルを重複とマークします。このオプションが選択されていない場合、タスクはすべてのファイルを転送します。デフォルトはfalseです。
whenFileExists	String	-	ターゲットディレクトリに同じ名前のフラットファイルがある場合に、ファイルの処理を決定します。選択可能なオプションは、以下のとおりです。 - rename - overwrite - skip - stop - error デフォルトは［名前の変更］です。

例えば、「.txt」パターンのファイルを転送して、ターゲットディレクトリに同じ名前のフラットファイルが存在する場合にそのファイルの名前を変更するには、次の要求を使用します。

POST <serverUrl>/mftsaas/api/v1/sendfiles/<connection ID>
Accept:application/json
IDS-SESSION-ID: <icSessionId or INFA-SESSION-ID>
{
"sourceConnectionType": "Advanced SFTP V2",
"tgtDirectoryPath": "C:\\docstoreLocal2",
"srcDirectoryPath": "C:\\server\\userdata\\workspace",
"srcFilePattern": ".*txt“,
"processFilesRecursively": false,
"afterFilePickupAction": "KEEP",
"skipDuplicateFiles": false,
"whenFileExists": "rename",
}

POST応答

成功すると、Informatica Intelligent Cloud Servicesからジョブの実行IDが返されます。その実行IDを使用してジョブステータスを監視します。

成功時の応答の例を以下に示します。

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

ジョブステータスの取得

REST APIを使用してファイルを送信または受信する際は、REST APIバージョン1のjobリソースを使用して、ファイル転送のステータスを取得します。

ファイル転送ジョブのステータスを取得する場合は、プラットフォームのREST APIバージョン2のjobリソースは使用しないでください。

GET要求

ファイル転送ジョブのステータス要求を送信する際には、sendfiles POST応答で返された実行IDを含めます。次のURIを使用します。

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

GET応答

成功すると、データ統合からジョブステータスが返されます。

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

GET応答の例

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

{
"jobStatus": "SUCCESS"
}

ファイル転送タスク

filetransferTaskリソースを使用して、受信ファイルを復号または解凍し、送信ファイルを暗号化または圧縮します。

次の方法でファイルを転送できます。

•ホストされているサーバー上でローカルにファイルを転送する。
•リモートサーバーとの間でファイルを転送する。

ホストされたファイルの転送タスク

サーバー上のホストされているファイルを管理し、ファイルをローカルに転送できます。

次のアクションを実行できます。

•ファイルサーバーユーザーのホームディレクトリ内のフォルダにファイルを圧縮して転送する。
•アップロードされたファイルを解凍し、ファイルサーバーユーザーのホームディレクトリからターゲットの場所に転送する。
•ファイルを暗号化して、ソースの場所からファイルサーバーユーザーのホームディレクトリに転送する。
•ファイルを復号して、ファイルサーバーユーザーのホームディレクトリからターゲットの場所に転送する。

ファイルの圧縮と転送

受信ファイルを圧縮して、ファイルサーバーユーザーのホームディレクトリで指定されたフォルダに転送します。

POST要求

ファイルを圧縮して転送するには、次のURIに接続IDを含めます。

mftsaas/api/v1/filetransferTask/execute/1003

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

フィールド	タイプ	必須	説明
agentGroupId	String	○	エージェントグループのID。
portalUser	String	-	ユーザーがポータルユーザーであるかどうかを示します。デフォルトは［false］です。
fileServerUsername	String	○	ファイルサーバーのユーザー名。
relativeTargetLocation	文字列	-	ファイルサーバーユーザーのホームディレクトリ内の相対的なターゲットの場所。
pattern	String	○	圧縮のために収集するファイルを識別するためのファイルパターン。正規表現パターンがサポートされています。
sourceLocation	String	○	圧縮するファイルを含むソースディレクトリ。
COMPRESSION_TYPE	String	○	圧縮するファイルの形式。次のいずれかの圧縮方式を選択します。 - 郵便番号 - Tar - Gzip 値の大文字と小文字は区別されません。

例えば、ファイルを圧縮して転送するには、次の要求を使用します。

POST <serverUrl>/mftsaas/api/v1/filetransferTask/execute/1003
Accept:application/json
IDS-SESSION-ID: <icSessionId or INFA-SESSION-ID>
{
"agentGroupId": "01000125000000000002",
"fileServerUsername": "arun",
"portalUser":true,
"relativeTargetLocation":"",
"pattern":"arun.csv",
"sourceLocation":"C:\\Informatica_Source",
"taskVariables": {
"COMPRESSION_TYPE": "zip"
}
}

POST応答

成功すると、Informatica Intelligent Cloud Servicesからジョブの実行IDが返されます。その実行IDを使用してジョブステータスを監視します。

成功時の応答の例を以下に示します。

{
"projectId": 0,
"timeTaken": 0,
"queuePriority": 0,
"runPriority": 0,
"runMode": "UNKNOWN",
"submitSourceId": -1,
"runModeInteractive": false,
"runModeBatch": false,
"runModeDebug": false,
"runModeUnknown": true,
"formattedTimeTaken": "0.00",
"id": 1000000007154,
"runId": 13
}

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

ファイルの解凍と転送

アップロードしたファイルを解凍して、ファイルサーバーユーザーのホームディレクトリから目的の場所に転送します。

POST要求

ファイルを解凍して転送するには、次のURIに接続IDを含めます。

mftsaas/api/v1/filetransferTask/execute/1004

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

フィールド	タイプ	必須	説明
agentGroupId	String	○	エージェントグループのID。
fileServerUsername	String	○	ファイルサーバーのユーザー名。
pattern	String	○	ファイルを解凍した後に、指定したターゲットの場所にリリースするファイルのファイルパターン。正規表現パターンがサポートされています。
targetLocation	String	○	解凍後にファイルが移動されるターゲットディレクトリ。
DECOMPRESSION_TYPE	String	○	解凍するファイルの形式。次のいずれかの解凍方式を選択します。 - 郵便番号 - Tar - Gzip 値の大文字と小文字は区別されません。
PATTERN_CASE_SENSITIVE	文字列	-	ファイルパターンで大文字と小文字が区別されるかどうかを示します。値の大文字と小文字は区別されません。デフォルトはfalseです。
PATTERN_TO_COLLECT	String	○	ファイルサーバーユーザーのホームディレクトリから解凍するために収集するファイルのパターン。正規表現を使用してファイル名のパターンを照合します。

例えば、ファイルを解凍して転送するには、次の要求を使用します

POST <serverUrl>/mftsaas/api/v1/filetransferTask/execute/1004
Accept:application/json
IDS-SESSION-ID: <icSessionId or INFA-SESSION-ID>
{
"agentGroupId": "01000125000000000002",
"fileServerUsername": "arun",
"pattern":".*csv",
"targetLocation":"C:\\Informatica_Target",
"taskVariables": {
"PATTERN_CASE_SENSITIVE": "false",
"DECOMPRESSION_TYPE": "unzip",
"PATTERN_TO_COLLECT": ".*zip"
}
}

POST応答

成功すると、Informatica Intelligent Cloud Servicesからジョブの実行IDが返されます。その実行IDを使用してジョブステータスを監視します。

成功時の応答の例を以下に示します。

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

ファイルの暗号化と転送

ファイルを暗号化して、ソースの場所からファイルサーバーユーザーのホームディレクトリ、またはファイルサーバーユーザーのホームディレクトリ内のREST APIパラメータで指定されたディレクトリに転送します。単一または複数のファイルを暗号化できます。

POST要求

ファイルを暗号化するには、次のURIに接続IDを含めます。

mftsaas/api/v1/filetransferTask/execute/1001

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

フィールド	タイプ	必須	説明
agentGroupId	String	○	エージェントグループのID。
portalUser	String	-	ユーザーがポータルユーザーであるかどうかを示します。デフォルトは［false］です。
fileServerUsername	String	○	ファイルサーバーのユーザー名。
relativeTargetLocation	文字列	-	ファイルサーバーユーザーのホームディレクトリ内の相対的なターゲットの場所。
pattern	String	○	暗号化のために収集するファイルを識別するためのファイルパターン。正規表現パターンがサポートされています。
sourceLocation	String	○	暗号化するファイルを含むソースディレクトリ。
SIGN	文字列	-	ファイルがPGPによって署名されているかどうかを示します。値の大文字と小文字は区別されません。デフォルトはfalseです。
PUBLIC_KEY_ID	String	○	ファイルの暗号化に使用されるキーのID。
SECRET_KEY_ID	String	○	SIGN変数の値がtrueの場合に、ファイルの署名に使用される秘密鍵のID。
SECRET_KEY_PASSPHRASE	String	○	SIGN変数の値がtrueの場合に、秘密鍵にアクセスするために使用されるパスフレーズ。

例えば、ファイルを暗号化して転送するには、次の要求を使用します。

POST <serverUrl>/mftsaas/api/v1/filetransferTask/execute/1001
Accept:application/json
IDS-SESSION-ID: <icSessionId or INFA-SESSION-ID>
{
"agentGroupId": "01000125000000000002",
"fileServerUsername": "arun",
"portalUser":true,
"pattern":"arun.csv",
"relativeTargetLocation":"",
"sourceLocation":"C:\\Informatica_Source",
"taskVariables": {
"SIGN":"false",
"PUBLIC_KEY_ID":"0x51986F687ADACBE1",
"SECRET_KEY_ID":"0x51986F687ADACBE1",
"SECRET_KEY_PASSPHRASE":"TESTER"
}
}

POST応答

成功すると、Informatica Intelligent Cloud Servicesからジョブの実行IDが返されます。その実行IDを使用してジョブステータスを監視します。

成功時の応答の例を以下に示します。

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

ファイルの復号と転送

ファイルを復号して、ファイルサーバーユーザーのホームディレクトリからターゲットの場所に転送します。

POST要求

ファイルを復号して転送するには、次のURIに接続IDを含めます。

mftsaas/api/v1/filetransferTask/execute/1002

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

フィールド	タイプ	必須	説明
agentGroupId	String	○	エージェントグループのID。
fileServerUsername	String	○	ファイルサーバーのユーザー名。
pattern	String	○	ファイルを復号した後に、指定したターゲットの場所にリリースするファイルのファイルパターン。正規表現パターンがサポートされています。
targetLocation	String	○	復号後にファイルが移動されるターゲットディレクトリ。
PATTERN_CASE_SENSITIVE	String	○	ファイルパターンで大文字と小文字が区別されるかどうかを示します。値の大文字と小文字は区別されません。デフォルトはfalseです。
PGP_PASSPHRASE	String	○	PGPパスフレーズ。
PATTERN_TO_COLLECT	String	○	PGPが収集および復号する必要のあるファイルのファイル名パターン。正規表現を使用してファイル名のパターンを照合します。

例えば、ファイルを復号して転送するには、次の要求を使用します。

POST <serverUrl>/mftsaas/api/v1/filetransferTask/execute/1002
Accept:application/json
IDS-SESSION-ID: <icSessionId or INFA-SESSION-ID>
{
"agentGroupId": "01000125000000000002",
"fileServerUsername": "arun",
"pattern":".*csv",
"targetLocation":"C:\\Informatica_Target",
"taskVariables": {
"PATTERN_CASE_SENSITIVE": "false",
"PGP_PASSPHRASE": "TESTER",
"PATTERN_TO_COLLECT": ".*pgp"
}
}

POST応答

成功すると、Informatica Intelligent Cloud Servicesからジョブの実行IDが返されます。その実行IDを使用してジョブステータスを監視します。

成功時の応答の例を以下に示します。

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

リモートファイルの転送タスク

Advanced FTP V2、Advanced FTPS V2、およびAdvanced SFTP V2コネクタを使用してリモートサーバー上のファイルを管理し、リモートサーバーとの間でファイルを転送できます。

次のアクションを実行できます。

•ファイルサーバーユーザーのホームディレクトリ内のフォルダにファイルを圧縮して転送する。
•アップロードされたファイルを解凍し、ファイルサーバーユーザーのホームディレクトリからターゲットの場所に転送する。
•ファイルを暗号化して、ソースの場所からファイルサーバーユーザーのホームディレクトリに転送する。
•ファイルを復号して、ファイルサーバーユーザーのホームディレクトリからターゲットの場所に転送する。

ファイルの圧縮と転送

受信ファイルを圧縮して、リモートサーバーのホームディレクトリで指定されたフォルダに転送します。

POST要求

ファイルを圧縮して転送するには、次のURIに接続IDを含めます。

mftsaas/api/v1/filetransferTask/execute/1003

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

フィールド	タイプ	必須	説明
agentGroupId	String	○	エージェントグループのID。
portalUser	String	-	ユーザーがポータルユーザーであるかどうかを示します。デフォルトは［false］です。
connectionId	String	○	Advanced FTP、Advanced FTPS、またはAdvanced SFTP V2コネクタの接続ID。
relativeTargetLocation	文字列	-	リモートサーバーのホームディレクトリ内の相対的なターゲットの場所。
pattern	String	○	圧縮のために収集するファイルを識別するためのファイルパターン。正規表現パターンがサポートされています。
sourceLocation	String	○	圧縮するファイルを含むソースディレクトリ。
COMPRESSION_TYPE	String	○	圧縮するファイルの形式。次のいずれかの圧縮方式を選択します。 - 郵便番号 - Tar - Gzip 値の大文字と小文字は区別されません。

例えば、ファイルを圧縮して転送するには、次の要求を使用します。

POST <serverUrl>/mftsaas/api/v1/filetransferTask/execute/1003
Accept:application/json
IDS-SESSION-ID: <icSessionId or INFA-SESSION-ID>
{
"agentGroupId": "01000125000000000002",
"portalUser": "false",
"connectionId": "0100010B000000000002",
"pattern":"arun_zip.txt",
"relativeTargetLocation":"/",
"sourceLocation":"C:\\FIS_Home\\DOCSTORE",
"taskVariables": {
"COMPRESSION_TYPE": "gzip"
}
}

POST応答

成功すると、Informatica Intelligent Cloud Servicesからジョブの実行IDが返されます。その実行IDを使用してジョブステータスを監視します。

成功時の応答の例を以下に示します。

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

ファイルの解凍と転送

アップロードしたファイルを解凍して、リモートサーバーのホームディレクトリから目的の場所に転送します。

POST要求

ファイルを解凍して転送するには、次のURIに接続IDを含めます。

mftsaas/api/v1/filetransferTask/execute/1004

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

フィールド	タイプ	必須	説明
agentGroupId	String	○	エージェントグループのID。
portalUser	String	-	ユーザーがポータルユーザーであるかどうかを示します。デフォルトは［false］です。
relativeSourceLocation	文字列	-	リモートサーバーのホームディレクトリ内の相対的なソースの場所。
pattern	String	○	ファイルを解凍した後に、指定したターゲットの場所にリリースするファイルのファイルパターン。正規表現パターンがサポートされています。
targetLocation	String	○	解凍後にファイルが移動されるターゲットディレクトリ。
relativeTargetLocation	文字列	-	リモートサーバーのホームディレクトリ内の相対的なターゲットの場所。
connectionId	String	○	Advanced FTP、Advanced FTPS、またはAdvanced SFTP V2コネクタの接続ID。
afterFilePickupAction	文字列	-	ファイル転送後のソースファイルの処理を決定します。以下のフィルタオプションのいずれか1つを選択してください。 - KEEP。ソースディレクトリ内でファイルを保持します。 - DELETE。ソースディレクトリからファイルを削除します。 - RENAME。ソースディレクトリ内でファイルの名前を変更します。 - ARCHIVE。別の場所にファイルをアーカイブします。アーカイブディレクトリを指定する必要があります。デフォルトは、KEEPです。
renameSuffix	String	○	afterFilePickupActionに［RENAME］が選択されている場合に、ソースディレクトリ内のファイルに追加するファイル名のサフィックス。次のサフィックスタイプを使用できます。 - $date - $time - $runId - $timestamp
archiveDirectoryPath	String	○	afterFilePickupActionに［ARCHIVE］が選択されている場合、ファイルをアーカイブするアーカイブディレクトリ。
skipDuplicateFiles	文字列	-	docstoreの場所にすでに存在するソースファイルをスキップするかどうかを示します。デフォルトはfalseです。
processFilesRecursively	文字列	-	ベースディレクトリ内のすべてのサブフォルダからファイルを処理するかどうかを示します。デフォルトはfalseです。
DECOMPRESSION_TYPE	String	○	解凍するファイルの形式。次のいずれかの解凍方式を選択します。 - 郵便番号 - Tar - Gzip 値の大文字と小文字は区別されません。
PATTERN_TO_COLLECT	String	○	ファイルサーバーユーザーのホームディレクトリから解凍するために収集するファイルのパターン。正規表現を使用してファイル名のパターンを照合します。

例えば、ファイルを解凍して転送するには、次の要求を使用します。

POST <serverUrl>/mftsaas/api/v1/filetransferTask/execute/1004
Accept:application/json
IDS-SESSION-ID: <icSessionId or INFA-SESSION-ID>
{
"agentGroupId": "01000125000000000002",
"portalUser": "false",
"pattern": "arun_zip.txt",
"relativeSourceLocation": "/",
"targetLocation": "C:\\Informatica_Target",
"relativeTargetLocation": "",
"connectionId": "0100010B000000000002",
"afterFilePickupAction": "RENAME",
"renameSuffix":"_RENAME_",
"archiveDirectoryPath" :"",
"skipDuplicateFiles": true,
"processFilesRecursively": false,
"taskVariables": {
"DECOMPRESSION_TYPE": "gunzip",
"PATTERN_TO_COLLECT": ".*gz"
}
}

POST応答

成功すると、Informatica Intelligent Cloud Servicesからジョブの実行IDが返されます。その実行IDを使用してジョブステータスを監視します。

成功時の応答の例を以下に示します。

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

ファイルの暗号化と転送

ファイルを暗号化して、ソースの場所からコネクタを使用してリモートサーバーに転送するか、リモートサーバーのホームディレクトリ内のREST APIパラメータで指定されたディレクトリに転送します。単一または複数のファイルを暗号化できます。

POST要求

ファイルを暗号化するには、次のURIに接続IDを含めます。

mftsaas/api/v1/filetransferTask/execute/1001

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

フィールド	タイプ	必須	説明
agentGroupId	String	○	エージェントグループのID。
connectionId	String	○	Advanced FTP、Advanced FTPS、またはAdvanced SFTP V2コネクタの接続ID。
portalUser	String	-	ユーザーがポータルユーザーであるかどうかを示します。デフォルトは［false］です。
relativeTargetLocation	文字列	-	リモートサーバーのホームディレクトリ内の相対的なターゲットの場所。
pattern	String	○	暗号化のために収集するファイルを識別するためのファイルパターン。正規表現パターンがサポートされています。
sourceLocation	String	○	暗号化するファイルを含むソースディレクトリ。
SIGN	文字列	-	ファイルがPGPによって署名されているかどうかを示します。値の大文字と小文字は区別されません。デフォルトはfalseです。
PUBLIC_KEY_ID	String	○	ファイルの暗号化に使用されるキーのID。
SECRET_KEY_ID	String	○	SIGN変数の値がtrueの場合に、ファイルの署名に使用される秘密鍵のID。
SECRET_KEY_PASSPHRASE	String	○	SIGN変数の値がtrueの場合に、秘密鍵にアクセスするために使用されるパスフレーズ。

例えば、ファイルを暗号化して転送するには、次の要求を使用します。

POST <serverUrl>/mftsaas/api/v1/filetransferTask/execute/1001
Accept:application/json
IDS-SESSION-ID: <icSessionId or INFA-SESSION-ID>
{
"agentGroupId": "01000125000000000002",
"portalUser": "false",
"connectionId": "0100010B000000000002",
"pattern":"arun.txt",
"relativeTargetLocation":"/",
"sourceLocation":"C:\\FIS_Home\\DOCSTORE",
"taskVariables": {
"SIGN":"true",
"PUBLIC_KEY_ID":"0x51986F687ADACBE1",
"SECRET_KEY_ID":"0x51986F687ADACBE1",
"SECRET_KEY_PASSPHRASE":"TESTER"
}
}

POST応答

成功すると、Informatica Intelligent Cloud Servicesからジョブの実行IDが返されます。その実行IDを使用してジョブステータスを監視します。

成功時の応答の例を以下に示します。

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

ファイルの復号と転送

ファイルを復号して、リモートサーバーのホームディレクトリからターゲットの場所に転送します。

POST要求

ファイルを復号して転送するには、次のURIに接続IDを含めます。

mftsaas/api/v1/filetransferTask/execute/1002

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

フィールド	タイプ	必須	説明
agentGroupId	String	○	エージェントグループのID。
portalUser	String	-	ユーザーがポータルユーザーであるかどうかを示します。デフォルトは［false］です。
relativeSourceLocation	文字列	-	リモートサーバーのホームディレクトリ内の相対的なソースの場所。
pattern	String	○	ファイルを復号した後に、指定したターゲットの場所にリリースするファイルのファイルパターン。正規表現パターンがサポートされています。
targetLocation	String	○	復号後にファイルが移動されるターゲットディレクトリ。
relativeTargetLocation	文字列	-	リモートサーバーのホームディレクトリ内の相対的なターゲットの場所。
connectionId	String	○	Advanced FTP、Advanced FTPS、またはAdvanced SFTP V2コネクタの接続ID。
afterFilePickupAction	文字列	-	ファイル転送後のソースファイルの処理を決定します。以下のフィルタオプションのいずれか1つを選択してください。 - KEEP。ソースディレクトリ内でファイルを保持します。 - DELETE。ソースディレクトリからファイルを削除します。 - RENAME。ソースディレクトリ内でファイルの名前を変更します。 - ARCHIVE。別の場所にファイルをアーカイブします。アーカイブディレクトリを指定する必要があります。デフォルトは、KEEPです。
renameSuffix	String	○	afterFilePickupActionに［RENAME］が選択されている場合に、ソースディレクトリ内のファイルに追加するファイル名のサフィックス。次のサフィックスタイプを使用できます。 - $date - $time - $runId - $timestamp
archiveDirectoryPath	String	○	afterFilePickupActionに［ARCHIVE］が選択されている場合、ファイルをアーカイブするアーカイブディレクトリ。
skipDuplicateFiles	文字列	-	docstoreの場所にすでに存在するソースファイルをスキップするかどうかを示します。デフォルトはfalseです。
processFilesRecursively	文字列	-	ベースディレクトリ内のすべてのサブフォルダからファイルを処理するかどうかを示します。デフォルトはfalseです。
PATTERN_CASE_SENSITIVE	String	○	ファイルパターンで大文字と小文字が区別されるかどうかを示します。値の大文字と小文字は区別されません。デフォルトはfalseです。
PGP_PASSPHRASE	String	○	PGPパスフレーズ。
PATTERN_TO_COLLECT	String	○	ファイルサーバーユーザーのホームディレクトリから解凍するために収集するファイルのパターン。正規表現を使用してファイル名のパターンを照合します。

例えば、ファイルを復号して転送するには、次の要求を使用します。

POST <serverUrl>/mftsaas/api/v1/filetransferTask/execute/1002
Accept:application/json
IDS-SESSION-ID: <icSessionId or INFA-SESSION-ID>
{
"agentGroupId": "01000125000000000002",
"portalUser": "false",
"pattern": "arun.txt",
"relativeSourceLocation": "/",
"targetLocation": "C:\\Informatica_Target",
"relativeTargetLocation": "",
"connectionId": "0100010B000000000002",
"afterFilePickupAction": "ARCHIVE",
"renameSuffix":"_RENAME_",
"archiveDirectoryPath" :"/ARCH",
"skipDuplicateFiles": false,
"processFilesRecursively": false,
"taskVariables": {
"PATTERN_CASE_SENSITIVE": "false",
"PGP_PASSPHRASE": "TESTER",
"PATTERN_TO_COLLECT": "arun.txt.pgp"
}
}

POST応答

成功すると、Informatica Intelligent Cloud Servicesからジョブの実行IDが返されます。その実行IDを使用してジョブステータスを監視します。

成功時の応答の例を以下に示します。

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

HTTPSファイル転送

リモートHTTPSサーバーへのファイルの送信や、リモートHTTPSサーバーからのファイルの受信、REST APIを介したジョブステータスの取得を行うことができます。

リソースをHTTPSファイル転送に使用する場合は、以下を考慮してください。

•HTTPSサーバーを介してファイルを交換するには、HTTPSライセンスが必要です。
•API操作を実行するには、HTTPSサーバーにログインする必要があります。

HTTPSファイル転送には次のリソースを使用できます。

•認証。ユーザーの認証に使用します。
•標準操作。ファイル転送アクション中に使用します。
•ファイル転送。HTTPSサーバーとの間でファイルを転送するために使用します
•サーバー応答。サーバー応答の詳細。
•ステータスコード。HTTPSファイル転送ステータスコードの詳細。

認証

以下のリソースを使用して、HTTPサーバーへのログインとログアウトを行います。

ログイン: HTTPS API操作を実行するには、HTTPSサーバーにログインする必要があります。このコマンドを使用して、HTTPSサーバーにログインします。Informatica Managed File Transfer HTTPSサーバーにログインするには、ログインリソースを使用してPOST要求を送信します。クライアント証明書認証を使用しない場合は、ログイン要求を送信してユーザーセッションを開始する必要があります。

ログアウト: ログアウトリソースを使用してログアウトを行い、Informatica Managed File Transfer HTTPSサーバーのユーザーセッションを終了します。GET要求またはPOST要求を行うことができます。

標準操作

以下の標準操作コマンドを使用できます。

PWD: PWD（Print Working Directory）コマンドを使用して、サーバー上の現在の作業ディレクトリを取得します。応答には、X-GDX-Replyのヘッダーメッセージの一部として、現在の作業ディレクトリへの絶対パスが含まれます。パスは二重引用符で囲まれています。

delete: このコマンドを使用して、サーバーからファイルを削除します。fileパラメータには、削除する相対ファイルパスまたは絶対ファイルパスを含めます。

rename: このコマンドを使用して、サーバー上のファイルの名前を変更します。現在の作業ディレクトリに名前を変更するファイルが含まれている場合、fromおよびtoパラメータにはファイル名のみが含まれる可能性があります。renameコマンドを使用して、サーバー上のファイルを移動することもできます。ファイルを移動するには、fromおよびtoパラメータに絶対パスを含めます。

要求の種類	パラメータ
GETまたはPOST	- from: 名前を変更するファイルまたはディレクトリの相対パスまたは絶対パス。 - to: 新しい名前の相対パスまたは絶対パス。

list: このコマンドを使用して、サーバー上のディレクトリのコンテンツを一覧表示します。このコマンドのパラメータとして、ターゲットディレクトリを含めます。ディレクトリを含めない場合、このコマンドにより現在の作業ディレクトリのコンテンツが一覧表示されます。

checksum: このコマンドを使用して、リモートファイルのハッシュを計算します。応答は、応答本文の最初の行で返されます。ダウンロードしたローカルファイルのハッシュ値と応答を比較することで、データの整合性を確認できます。

要求の種類	パラメータ
GETまたはPOST	- file: 必須。現在の作業ディレクトリからの相対パス、またはファイルへの絶対パスです。 - algorithm: チェックサムの計算時に使用するハッシュアルゴリズム。有効な値は、SHA1、MD5、またはCRC32です。デフォルトはSHA1です。 - length: ファイル内の開始位置。この値は、部分的なファイルチェックサムの計算に使用されます。デフォルト値は「0」で、ファイル全体に対してチェックサムを実行します。

CD（Change Directory）: このコマンドを使用して、現在の作業ディレクトリを変更します。X-GDX-Replyのヘッダーメッセージの一部として、新しい作業ディレクトリへの絶対パスが返されます。パスは二重引用符で囲まれています。

CDUP（Change Directory Up）: このコマンドを使用して、現在の作業ディレクトリを親ディレクトリに変更します。X-GDX-Replyのヘッダーメッセージの一部として、新しい作業ディレクトリへの絶対パスが返されます。パスは二重引用符で囲まれています。

MKDIR（Make Directory）: このコマンドを使用して、サーバー上に新しいディレクトリを作成します。X-GDX-Replyのヘッダーメッセージの一部として、新しく作成したディレクトリへの絶対パスが返されます。パスは二重引用符で囲まれています。

file information: このコマンドを使用して、特定のファイルまたはディレクトリに関する情報を取得します。応答には、コンテンツタイプがtext/plainの応答本文の情報が含まれます。ファイル情報の形式は、Listコマンドから返されるリストと同一です。返される情報が応答本文にない場合、ファイルまたはディレクトリは存在しません。

ファイル転送

次のコマンドを使用して、サーバーとの間でHTTPSファイルのアップロードとダウンロードを行います。

upload: このコマンドを使用して、ファイルをサーバーに転送します。この要求はマルチパートのPOST要求である必要があり、要求ごとに1つのファイルのみがアップロードされます。1つのファイルはマルチパート要求の必須パートですが、ファイルパートに指定されたパラメータ名は無視されます。

要求の種類	パラメータ
POST/マルチパート	- to: アップロード先のファイルの相対パスまたは絶対パス。 - file: マルチパートの要求の一部としてアップロードされるファイル。

upload2: このコマンドを使用して、ファイルをサーバーに転送します。この要求はマルチパートのPOST要求である必要があり、要求ごとに1つのファイルのみがアップロードされます。1つのファイルはマルチパート要求の必須パートですが、ファイルパートに指定されたパラメータ名は無視されます。

要求の種類	パラメータ
POST/マルチパート	- to: アップロード先のファイルの相対パスまたは絶対パス。 - append: オプション。ファイルがターゲットディレクトリに存在する場合は、このパラメータをtrueに設定して、既存のファイルに新しいファイルが付加されるようにします。 - transferMode: バイナリ転送にはBを使用し、ASCII転送にはAを使用します。デフォルトはBです。 - file: マルチパートの要求の一部としてアップロードされるファイル。

upload3: このコマンドを使用して、ファイルをサーバーに転送します。この要求はマルチパートのPOST要求である必要があり、要求ごとに1つのファイルのみがアップロードされます。1つのファイルはマルチパート要求の必須パートですが、ファイルパートに指定されたパラメータ名は無視されます。

要求の種類	パラメータ
POST/マルチパート	- to: アップロード先のファイルの相対パスまたは絶対パス。 - append: オプション。ファイルがターゲットディレクトリに存在する場合は、このパラメータをtrueに設定して、既存のファイルに新しいファイルが付加されるようにします。 - transferMode: バイナリ転送にはBを使用し、ASCII転送にはAを使用します。デフォルトはBです。 - file: マルチパートの要求の一部としてアップロードされるファイル。

uploadRawData: このコマンドを使用して、データが要求本文のコンテンツであるサーバーに直接データをアップロードします。要求はPOST要求である必要があります。ファイルの名前は自動的に生成され、X-GDX-Replyのヘッダーメッセージの一部として返されます。これは特別なコマンドで、アップロードされるファイルデータが要求本文に含まれている必要があります。

uploadRawData2: このコマンドを使用して、データが要求本文のコンテンツであるサーバーに直接データをアップロードします。要求はPOST要求である必要があります。ファイルの名前は自動的に生成され、X-GDX-Replyのヘッダーメッセージの一部として返されます。これは特別なコマンドで、アップロードされるファイルデータが要求本文に含まれている必要があります。

download: このコマンドを使用して、ファイルをサーバーからダウンロードします。ファイルは応答本文として返されます。コンテンツタイプは、常にアプリケーションまたは強制ダウンロードで、ファイルの名前を含むコンテンツ処理フィールドです。content-lengthヘッダーは、ファイルのサイズを示す応答にも含まれます。

要求の種類	パラメータ
GETまたはPOST	- file: 必須。ダウンロードするファイル。これは、現在の作業ディレクトリからの相対パス、またはファイルへの絶対パスです。 - offset: 部分ファイルをダウンロードするためのオフセット。ファイルのダウンロードを開始する位置を入力します。 - transferMode: バイナリ転送にはBを使用し、ASCII転送にはAを使用します。デフォルトはBです。

サーバー応答

すべての要求に対して、サーバーは、X-CDX-ReplyヘッダーのHTTPSサービスに固有の成功メッセージあるいはエラーコードとエラーメッセージで応答します。ヘッダーメッセージの形式は、ステータスコードの後に1つの空白が続き、その後にメッセージの詳細が続きます。

例: 200 Welcome, testuser!

ヘッダーコードとメッセージを確認することで、操作の成功または失敗を判断できます。

ステータスコード

応答には、次のいずれかのHTTPSファイル転送ステータスコードが含まれる場合があります。

200-299: 情報または成功のステータスコード: サーバーに対して正常に実行された操作。

500-509: 内部サーバーエラー: サーバーで重大なエラーが発生しました。直ちにサーバーの管理者に連絡してください。

510-519: 不正または無効な要求: 無効または不完全な情報により、サーバーは要求を処理できませんでした。詳細については、X-GDX-Replyのヘッダーメッセージを参照してください。

530-539: ログインまたはアカウント関連のエラー: 無効なログインやアカウントが無効になっている場合など、アカウントまたはログインでエラーが発生したことを示します。詳細については、X-GDX-Replyのヘッダーメッセージを参照してください。

550-559: 権限エラー: ユーザーには、要求されたアクションの実行が許可されていないか、アクションを実行する権限がありません。詳細については、X-GDX-Replyのヘッダーメッセージを参照してください。

560-569: システム上のファイルまたはディレクトリに関連するエラー: ファイルまたはディレクトリが存在しないなど、サーバー上のファイルまたはディレクトリへのアクセス中にエラーが発生しました。

580-589: ファイルI/Oエラー: ファイルまたはディレクトリにアクセスしようとした際に内部サーバーエラーが発生しました。

590: 不明なエラー: コマンドの処理中に予期しないエラーが発生しました。詳細については、X-GDX-Replyのヘッダーメッセージを参照してください。