ファイル配付

Agentに配付するファイルをアップロードするためのAPIです。Manager画面で［プロファイル］を選択した後、プロファイルを選択したときに表示される画面での［受信設定］の操作に相当します。

書式
curl -X POST --header 'Content-Type: multipart/form-data'
             --header 'Accept: application/json'
             --header 'X-API-KEY:APIキー'
             --form 'file=@ファイル名'
             'http://ホスト名:ポート番号/api/v1/distributionModules?クエリ形式のリクエスト'
リクエストパラメータ（formデータ形式）
項目名 リクエストパラメータ 型 値 省略値
ファイル名 ファイル名 multipart/form-data

@に続けて、配付ファイルのファイル名を絶対パスで指定します。

アップロード方法はクライアントの仕様をご確認ください。

 省略不可
リクエストパラメータ（クエリ形式）
項目名 リクエストパラメータ 型 値 省略値
受信設定ID receivingProfileId 文字列

 

 省略不可
レスポンス
{
   "distributionModuleId": "string",
   "success": [
                 { "name": "string", "agentId": "string" },...
              ],
   "failure": [
                 { "name": "string", "agentId": "stirng" },...
              ]
}
レスポンスパラメータ
項目名 レスポンスパラメータ 型 値
ファイル配付ID distributionModuleId 文字列  
受信タスクキュー登録成功 success 配列 [ {"name":"string","agentId":"string"} ,...]
受信タスクキュー登録失敗 failure 配列 [ {"name":"string","agentId":"string"} ,...]

successの内容は、次のとおりです。

項目名 レスポンスパラメータ 型 値
エージェント名 name 文字列 受信タスクキューへの受信タスクの登録に成功したエージェントの名前とID
エージェントID agentId 文字列

failureの内容は、次のとおりです。

項目名 レスポンスパラメータ 型 値
エージェント名 name 文字列 受信タスクキューへの受信タスクの登録に失敗したエージェントの名前とID
エージェントID agentId 文字列