Acquire Transfer Log details

This is an API function to acquire Transfer Log details. This API function corresponds to the operation on the screen that is displayed by clicking the [Transfer Log] tab after selecting the [Logs] on the operation screen of Manager.

= Remarks =

It is the difference between the acquire a list of Transfer Logs 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/transfer-logs/transferLogId'
Request parameter (Path format)
Item name Request parameter Type Value Default value
Transfer Log ID transferLogId String   Impossible to omit
Response
{
  "hulrcvLog": {
    "cipherType": "string",
    "dataSize": 0,
    "detailCode": 0,
    "exitCode": 0,
    "fileId": "string",
    "hostName": "string",
    "hulrcvLogId": "string",
    "jobId": "string",
    "latestProcessId": "string",
    "latestTransferId": "string",
    "rcvEndTimeStr": "string",
    "rcvEndTimeUtc": 0,
    "rcvFileName": "string",
    "rcvStartTimeStr": "string",
    "rcvStartTimeUtc": 0,
    "recordCount": 0,
    "startProcessId": "string",
    "startTransferId": "string"
    "transferRate": 0,
    "transferType": "string"
  },
  "sendLog": {
    "agentId": "string",
    "agentName": "string",
    "cipherType": "string",
    "compressedRate": 0,
    "dTelegramLen": 0,
    "dataSize": 0,
    "detailCode": 0,
    "errorJobExitCode": 0,
    "errorJobName": "string",
    "exitCode": 0,
    "fileId": "string",
    "hostName": "string",
    "latestProcessId": "string",
    "latestTransferId": "string",
    "preJobExitCode": 0,
    "preJobName": "string",
    "profileId": "string",
    "profileName": "string",
    "recordCount": 0,
    "sendLogId": "string",
    "sndEndTimeStr": "string",
    "sndEndTimeUtc": 0,
    "sndFileName": "string",
    "sndStartTimeStr": "string",
    "sndStartTimeUtc": 0,
    "startProcessId": "string",
    "startTransferId": "string",
    "successJobExitCode": 0,
    "successJobName": "string",
    "transferRate": 0,
    "transferType": "string",
    "triggerEvent": 0,
    "triggerStatus": 0,
    "unitId": "string",
    "unitName": "string"
  },
  "transferLogId":"string"
}
Response parameter
Item name Response parameter Type Value
Encryption Type hulrcvLog cipherType String

"0" | "1"

Type of encryption that was used when reception data was encrypted is returned.

• 0: Encryption function was not used.*

• 1: HULFT encryption was used.

* If the product is a region edition, always 0 is specified.

Data Size (Receive) dataSize Integer The size of the reception data is returned.

Detail Code (Receive)

 detailCode Integer The detail code of the receive processing on manager environment is returned.

End Code (Receive)

 exitCode Integer The end code of the receive processing on manager environment is returned.
File ID (Receive file) fileId String The ID of the received file is returned.
Host Name (Agent ID) hostName String

The ID of Agent instance from which the file was sent is returned.

The parameter name is hostName, however the Agent ID that is displayed on the Agent List screen of Manager is returned.
Receive Log ID hulrcvLogId String  
Job ID jobId String The ID of the job that was executed after the reception is returned.
Latest Processing Identifier latestProcessId String  
Latest Transfer Identifier latestTransferId String  
Receive End Date and Time (string) rcvEndTimeStr String The value is returned by using a "yyyyMMddHHmmss" format.
Receive End Date and Time (UTC) rcvEndTimeUtc Integer The number of seconds that has accumulated since midnight of 1970/1/1 (UTC)
Receive File Name rcvFileName String  
Receive Start Date and Time (string) rcvStartTimeStr String The value is returned by using a "yyyyMMddHHmmss" format.
Receive Start Date and Time (UTC) rcvStartTimeUtc Integer The number of seconds that has accumulated since midnight of 1970/1/1 (UTC)
Record Count recordCount Integer

The record count of the actually received file is returned.
Starting Identifier startProcessId String  
Start Transfer Identifier startTransferId String  
Transmission Rate transferRate Integer

The transmission rate that is calculated by the following formula is returned:

Received data size (bytes) ÷ Receive time (seconds)
Transfer Type transferType String

"B" | "T"

•　B: Binary

•　T: Text
Item name Response parameter Type Value

Agent ID

 sendLog agentId String

The ID of Agent that executed the send processing is returned.
Agent Name agentName String

The name of Agent that executed the send processing is returned.
Encryption Type cipherType String

"0" | "1"

Type of encryption that was used when sending data was encrypted:

• 0: Encryption function was not used.*

• 1: HULFT encryption was used.

* If the product is a region edition, always 0 is specified.

Compression Ratio compressedRate Integer

The compression ratio (%) that is calculated by the following formula:

(Data size after compression ÷ Data size before compression) × 100

Transfer Block Length

 dTelegramLen Integer

 
Data Size (Send) dataSize Integer The size of the send data is returned.
Detail Code (Send) detailCode Integer The detail code of the send processing is returned.
End Code of Unsuccessful Job errorJobExitCode Integer  
Unsuccessful Job errorJobName String Job itself is returned.
End Code (Send) exitCode Integer The end code of the send processing is returned.
File ID (Send file) fileId String The ID of the send file is returned.

Host name (Send destination)

 hostName String Name of the host to which the file was sent is returned.
Latest Processing Identifier latestProcessId String  
Latest Transfer Identifier latestTransferId String  
End Code of Pre-send Job preJobExitCode Integer  
Pre-send Job preJobName String Job itself is returned.
Profile ID profileId String The ID of Profile that was used for the send processing is returned.
Profile Name profileName String The name of Profile that was used for the send processing is returned.
Record Count recordCount Integer

The record count of the file that Agent has sent is returned.
Send Log ID sendLogId String  
Item name Response parameter Type Value
Send End Date and Time (string) sendLog sndEndTimeStr String

"day-of-week month day hour:minute:second year"

Example: "Fri Sep 08 17:15:52 2017"
Send End Date and Time (UTC) sndEndTimeUtc Integer

The number of seconds that has accumulated since midnight of 1970/1/1 (UTC)
Send File name sndFileName String Character code is UTF-8.
Send Start Date and Time (string) sndStartTimeStr String

"day-of-week month day hour:minute:second year"

Example: "Fri Sep 08 17:15:52 2017"
Send Start Date and Time (UTC) sndStartTimeUtc Integer The number of seconds that has accumulated since midnight of 1970/1/1 (UTC)
Starting Identifier startProcessId String  
Start Transfer Identifier startTransferId String  
End code of Successful Job successJobExitCode Integer  
Successful Job successJobName String Job itself is returned.
Transmission Rate transferRate Integer

The transmission rate that is calculated by the following formula is returned:

Send data size (bytes) ÷ Send time (seconds)
Transfer Type transferType String

"B" | "T"

•　B: Binary

•　T: Text
Trigger Fire Event triggerEvent Integer

0 | 1

•　0: The event was fired by a result of a size monitoring

•　1: The event was fired by a result of a time stamp monitoring
File Status When Firing Trigger triggerStatus Integer

File Size | Date and Time

•　If the event was fired by a result of a size monitoring: File Size (byte)

•　If the event was fired by a result of a time stamp monitoring: Date and Time
Unit ID unitId String The ID of Unit in which the send processing was executed is returned.
Unit Name unitName String The name of Unit in which the send processing was executed is returned.
Transfer Log ID transferLogId String