Modify transfer settings details

This is an API function to modify transfer settings details. This API function corresponds to the [Transfer Settings] operation on the screen that is displayed by selecting a profile after selecting the [Profile] on the operation screen of Manager.

= Remarks =

The request parameters in JSON format of the following API functions are the same.

  • Create transfer settings
  • Modify transfer settings details

The response parameters of the following API functions are the same.

  • Create transfer settings
  • Modify transfer settings details
  • Acquire transfer settings details
Format
curl -X PUT --header 'Content-Type: application/json'
            --header 'Accept: application/json'
            --header 'X-API-KEY:APIKEY'
            -d 'REQUESTBODYINJSONFORMAT'
            'http://HOSTNAME:PORTNUMBER/api/v1/sending-profiles/sendingProfileId'
Request body (JSON format)
{
　　"compressionMode": 0,
　　"deflateLevel": 0,
　　"deleteFile": "string",
　　"encryptKey": "string",
　　"encryptMode": 0,
　　"fileId": "string",
　　"jobExecMode": 0,
　　"jobExecModeOnError": 0,
　　"jobName": "string",
　　"jobNameOnError": "string",
　　"preJobExecMode": 0,
　　"preJobName": "string",
　　"searchOrderDescending": true,
　　"searchTarget": 0,
　　"sendingProfileName": "string",
　　"sendType": "string",
　　"temporaryFile": true,
　　"triggerElapsedTime": "string",
　　"triggerFileName": "string",
　　"triggerInterval": "string",
　　"triggerMode": "string",
　　"triggerSize": "string",
　　"dataVerify": true,
　　"fileCreation": "string",
　　"generationFileCount": 0,
　　"jobWait": "string",
　　"receiveFileName": "string",
　　"receiveJob": "string",
　　"receiveJobOnError": "string"
}
Request parameter (JSON format)

For details of the Request parameters in JSON format, see Request parameter (JSON format) described in Create transfer settings.

 
Request parameter (Path format)
Item name Request parameter Type Value Default value
Transfer Settings ID sendingProfileId String   Impossible to omit
Response
{
  "compressionMode": 0,
  "deflateLevel": 0,
  "deleteFile": "string",
  "encryptMode": 0,
  "fileId": "string",
  "jobExecMode": 0,
  "jobExecModeOnError": 0,
  "jobName": "string",
  "jobNameOnError": "string",
  "preJobExecMode": 0,
  "preJobName": "string",
  "profileId": "string",
  "searchOrderDescending": true,
  "searchTarget": 0,
  "sendingProfileId": "string",
  "sendingProfileName": "string",
  "sendType": "string",
  "temporaryFile": true,
  "triggerElapsedTime": "string",
  "triggerFileName": "string",
  "triggerInterval": "string",
  "triggerMode": "string",
  "triggerSize": "string",
  "dataVerify": true,
  "fileCreation": "string",
  "generationFileCount": 0,
  "jobWait": "string",
  "receiveFileName": "string",
  "receiveJob": "string",
  "receiveJobOnError": "string"
}
Response parameter

For details of the response parameters, see Response parameter described in Acquire transfer settings details.