Acquire a list of Profiles

This is an API function to acquire a list of profiles. This API function corresponds to the operation on the screen that is displayed by 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 profile details API function.
Format
curl -X GET --header 'Accept: application/json'
            --header 'X-API-KEY:APIKEY'
            'http://HOSTNAME:PORTNUMBER/api/v1/profiles?REQUESTINQUERYFORMAT'
Request parameter (Query format)
Item name Request parameter Type Value Default value
Unit ID unitId String Exact match  
Unit Name unitName String

Maximum 64 characters

Exact match

  
Profile ID profileId String Exact match  
Profile Name profileName String

Maximum 64 characters

Exact match

  
Sort Order sort String

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

•　+: Ascending order

•　-: Descending order

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

 +profileName
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
Profile ID profileId
Profile Name profileName
Profile Version profileVersion
Unit ID unit.unitId
Unit Name unit.unitName
Response
{
   "content": [
      {
         "profileId": "string",
         "profileName": "string",
         "profileVersion": 0,
         "receivingProfiles": [
            {
               "entryPoint": "string",
               "fileName": "string",
               "jobExecMode": 0,
               "jobScript": "string",
               "receivingProfileId": "string",
               "receivingProfileName": "string"
            }
         ],
         "sendingProfiles": [
            {
               "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"
            }
         ],
         "unitId": "string",
         "unitName": "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 profile details.

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