Acquire a list of transfer settings

This is an API function to acquire a list of transfer settings. 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 response parameters under the content layer of this API function are a part of the response parameters of the acquire transfer settings details API function.
Format
curl -X GET --header 'Accept: application/json'
            --header 'X-API-KEY:APIKEY'
            'http://HOSTNAME:PORTNUMBER/api/v1/profiles/profileId/sending-profiles?REQUESTINQUERYFORMAT'
Request parameter (Path format)
Item name Request parameter Type Value Default value
Profile ID profileId String   Impossible to omit
Request parameter (Query format)
Item name Request parameter Type Value Default value
Sort Order sort String

"+parameter-name" | "-parameter-name"

•　+: Ascending order

•　-: Descending order

If you specify multiple parameters, divide values by a comma (,).

 +sendingProfileName
Number of pages page Integer

Specify a number from zero.

If the number of pages is 1, specify 0.

 0
Number of items per page size Integer   10
Parameters that can be set to Sort Order
Item name Parameter name
Compression Method compressionMode
DEFLATE level deflateLevel
File Deletion after Transfer (From) deleteFile
Encryption Key encryptKey
Encryption Type encryptMode
File ID fileId
Successful Job Execution Mode (From) jobExecMode
Unsuccessful Job Execution Mode (From) jobExecModeOnError
Successful Job (From) jobName
Unsuccessful Job (From) jobNameOnError
Pre-send Job Execution Mode (From) preJobExecMode
Pre-send Job (From) preJobName
Search Order (From) searchOrderDescending
Search Target (From) searchTarget
Transfer Settings ID sendingProfileId
Transfer Settings Name sendingProfileName
Transfer Type sendType
Monitored File Name (From) triggerFileName
Monitoring Mode (From) triggerMode
Response
{
   "content": [
            {
               "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"
            }
         ],
   "first": true,
   "last": true,
   "number": 0,
   "numberOfElements": 0,
   "size": 0,
   "sort": [],
   "totalElements": 0,
   "totalPages": 0
}
Response parameter

For details of the parameters under the content layer, see Response parameter described in Acquire transfer settings details.

Note

The following response parameters are not returned by this API.

  • dataVerify
  • fileCreation
  • generationFileCount
  • jobWait
  • receiveFileName
  • receiveJob
  • receiveJobId
  • receiveJobIdOnError
  • receiveJobOnError

Also, for details about the parameters for page settings (first, last, number, numberOfElements, size, sort, totalElements, totalPages), see Response parameters for page settings.