Acquire a list of reception settings

This is an API function to acquire a list of reception settings. 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.

= Remarks =

The response parameters under the content layer of this API function are the same as the response parameters of the acquire reception settings details API function.

Format

curl -X GET --header 'Accept: application/json'

--header 'X-API-KEY:APIKEY'

'http://HOSTNAME:PORTNUMBER/api/v1/profiles/profileId/receiving-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" | "-paramater-name"

• +: Ascending order

• -: Descending order

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

+receivingProfileName
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
File Name at Send Destination fileName
Job Execution Mode jobExecMode
Contents of Job jobScript
Reception Settings ID receivingProfileId
Reception Settings Name receivingProfileName
Response

{

"content": [

{

"entryPoint": "string",

"fileName": "string",

"jobExecMode": 0,

"jobScript": "string",

"receivingProfileId": "string",

"receivingProfileName": "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 reception settings details.

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