Acquire profile details

This is an API function to acquire details of a specified Profile. This API function corresponds to the operation on the screen that is displayed by selecting a profile after selecting the [Profile] on the operation screen of Manager.

= Remarks =

It is the difference between the acquire a list of profiles API function and this API function that the following parameters are not included in the response of this API function.

  • content layer (Parameters under the content layer of the acquire a list API function are the same as the parameters of the acquire details API function.)

  • first

  • last

  • number

  • numberOfElements

  • size

  • sort

  • totalElements

  • totalPages

Format
curl -X GET --header 'Accept: application/json'
            --header 'X-API-KEY:APIKEY'
            'http://HOSTNAME:PORTNUMBER/api/v1/profiles/profileId'
Request parameter (Path format)
Item name Request parameter Type Value Default value
Profile ID profileId String   Impossible to omit
Response
{
   "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"
}
Response parameter
Item name Response parameter Type Value
Profile ID profileId String  
Profile Name profileName String Maximum 64 characters
Profile Version profileVersion Integer  
URL for uploading a file receivingProfiles entryPoint String URL
File Name at Send Destination fileName String  

Job Execution Mode

(Reception Settings)

 jobExecMode Integer

0 | 1

•　0: Script execution

•　1: Step execution
Contents of Job jobScript String  
Reception Settings ID receivingProfileId String The ID of Reception Settings
Reception Settings Name receivingProfileName String

The name of Reception Settings
Compression Method sendingProfiles compressionMode Integer

0 | 1

•　0: No compression

•　1: DEFLATE compression
DEFLATE level deflateLevel Integer

1 | 2　| 3

•　1: Default

•　2: Prioritize Compression Ratio

•　3: Prioritize Compression Speed
File Deletion after Transfer (From) deleteFile String

"K" | "D"

•　K: Keep (Do not delete)

•　D: Delete
Encryption Type encryptMode Integer

0 | 1

• 0: No encryption*

• 1: HULFT encryption

* If the product is a region edition, always 0 is specified.
File ID fileId String  
Successful Job Execution Mode (From) jobExecMode Integer

0 | 1

•　0: Script execution

•　1: Step execution
Unsuccessful Job Execution Mode (From) jobExecModeOnError Integer

0 | 1

•　0: Script execution

•　1: Step execution
Successful Job (From) jobName String Maximum 2048 ASCII characters (without NULL)
Unsuccessful Job (From) jobNameOnError String Maximum 2048 ASCII characters (without NULL)
Pre-send Job Execution Mode (From) preJobExecMode Integer

0 | 1

•　0: Script execution

•　1: Step execution
Pre-send Job (From) preJobName String Maximum 2048 ASCII characters (without NULL)
Profile ID sendingProfiles profileId String  
Search Order (From) searchOrderDescending Boolean

•　true: Descending order

•　false: Ascending order
Search Target (From) searchTarget Integer

1　|　2

•　1: File name

•　2: Update date and time
Transfer Settings ID sendingProfileId String  
Transfer Settings Name sendingProfileName String Maximum 64 characters
Transfer Type sendType String

"B"　|　"T"

•　B: Binary

•　T: Text
Temporary File Transfer (From) temporaryFile

Boolean

•　true: Do temporary file transfer

•　false: Do not temporary file transfer
Elapsed Monitoring Time (From) triggerElapsedTime String

"1s" to "59d"

Numeral (1 to 59) with a unit (second: s, minute: m, hour: h, or day: d) is returned.
Monitored File Name (From) triggerFileName String

Maximum 256-byte character string (without NULL)

A wild card character can be included.
Monitoring Interval (From) triggerInterval String

"1s" to "59d"

Numeral (1 to 59) with a unit (second: s, minute: m, hour: h, or day: d) is returned.
Monitoring Mode (From) triggerMode String

"SIZE" | "TIMESTAMP"
Monitoring Size (From) triggerSize String

"1b" to "1023g"

Numeral (1 to 1023) with a unit (byte: b, kilobyte: k, megabyte: m, or gigabyte: g) is returned.
Unit ID unitId String  
Unit Name unitName String