Distribute a file

This is an API function to upload a file distributed to Agent instances. This API function corresponds to the [Reception Settings] operation on the screen that is displayed by selecting a profile after selecting the [Profile] on the operation screen of Manager.

Format
curl -X POST --header 'Content-Type: multipart/form-data'
             --header 'Accept: application/json'
             --header 'X-API-KEY:APIKEY'
             --form 'file=@FILENAME'
             'http://HOSTNAME:PORTNUMBER/api/v1/distributionModules?REQUESTINQUERYFORMAT'
Request parameter (form data format)
Item name Request parameter Type Value Default value
File Name FILENAME multipart/form-data

Specify a file name of an distribution file after an @ by using an absolute path.

For details how to upload a file, confirm the specification of the client.

 Impossible to omit
Request parameter (Query format)
Item name Request parameter Type Value Default value
Reception Settings ID receivingProfileId String

 

 Impossible to omit
Response
{
   "distributionModuleId": "string",
   "success": [
                 { "name": "string", "agentId": "string" },...
              ],
   "failure": [
                 { "name": "string", "agentId": "stirng" },...
              ]
}
Response parameter
Item name Response parameter Type Value
File Distribution ID distributionModuleId String  

Succeeded in registering Receive Task in Receive Task Queue

 success Array [ {"name":"string","agentId":"string"} ,...]
Failed to register Receive Task in Receive Task Queue failure Array [ {"name":"string","agentId":"string"} ,...]

The meaning of the contents of "success" is as follows:

Item name Response parameter Type Value
Agent name name String The name and ID of the Agent instance that succeeded in registering the Receive Task in the Receive Task Queue
Agent ID agentId String

The meaning of the contents of "failure" is as follows:

Item name Response parameter Type Value
Agent name name String The name and ID of the Agent instance that could not register the Receive Task in the Receive Task Queue
Agent ID agentId String