Acquire a list of Transfer Logs

This is an API function to acquire a list of Transfer Logs. 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 =

The response parameters under the content layer of this API function are the same as the response parameters of the acquire Transfer Log details API function.
Format
curl -X GET --header 'Accept: application/json'
            --header 'X-API-KEY:APIKEY'
            'http://HOSTNAME:PORTNUMBER/api/v1/transfer-logs?REQUESTINQUERYFORMAT'
Request parameter (Query format)
Item name Request parameter Type Value Default value
File ID fileId String

Specify a file ID that was used in the file transfer.

Partial match

  
Agent ID agentId String

Specify the ID of Agent that executed the send processing.

Exact match

  
Agent Name agentName String

Specify the name of Agent that executed the send processing.

Partial match

  
Profile ID profileId String

Specify the ID of Profile that was used for the send processing.

Exact match

  
Profile Name profileName String

Specify the name of Profile that was used for the send processing.

Partial match

  
Unit ID unitId String

Specify the ID of Unit in which the send processing was executed.

Exact match

  
Unit Name unitName String

Specify the name of Unit in which the send processing was executed.

Partial match

  

Host Name of Receiver

 shushinHostName String

Partial match

  
Sort Order sort String

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

•　+: Ascending order

•　-: Descending order

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

-modifiedOn
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
Send End Code sndExitCode Integer Exact match  
Receive End Code rcvExitCode Integer Exact match  
Starting Identifier startProcessId String Exact match  
Latest Processing Identifier latestProcessId String Exact match  
Search Target filter String

"sndErrorOnly" | "rcvErrorOnly" | "sndOnly" | "rcvOnly"

•　"sndErrorOnly": to search Transfer Logs of which Send log recorded a send error

•　"rcvErrorOnly": to search Transfer Logs of which Receive Log recorded a reception error

•　"sndOnly": to search Transfer Logs that have Send Log only (there is no Receive Log)

•　"rcvOnly": to search Transfer Logs that have Receive Log only (there is no Send Log)

  
Parameters that can be set to Sort Order
Item name Parameter name
Encryption Type hulrcvLog.cipherType
Data Size (Receive) hulrcvLog.dataSize

Detail Code (Receive)

 hulrcvLog.detailCode

End Code (Receive)

 hulrcvLog.exitCode
File ID (Receive file) hulrcvLog.fileId
Host Name (Agent ID) hulrcvLog.hostName
Receive Log ID hulrcvLog.hulrcvLogId
Job ID hulrcvLog.jobId
Latest Processing Identifier hulrcvLog.latestProcessId
Receive End Date and Time (string) hulrcvLog.rcvEndTimeStr
Receive End Date and Time (UTC) hulrcvLog.rcvEndTimeUtc
Receive File Name hulrcvLog.rcvFileName
Receive Start Date and Time (string) hulrcvLog.rcvStartTimeStr
Receive Start Date and Time (UTC) hulrcvLog.rcvStartTimeUtc
Record Count hulrcvLog.recordCount
Starting Identifier hulrcvLog.startProcessId
Start Transfer Identifier hulrcvLog.startTransferId
Transmission Rate hulrcvLog.transferRate
Transfer Type hulrcvLog.transferType

Agent ID

 sendLog.agentId
Agent Name sendLog.agentName
Encryption Type sendLog.cipherType
Compression Ratio sendLog.compressedRate

Transfer Block Length

 sendLog.dTelegramLen
Data Size (Send) sendLog.dataSize
Detail Code (Send) sendLog.detailCode
End Code of Unsuccessful Job sendLog.errorJobExitCode
Unsuccessful Job sendLog.errorJobName
End Code (Send) sendLog.exitCode
File ID (Send file) sendLog.fileId

Host name (Send destination)

 sendLog.hostName
Latest Processing Identifier sendLog.latestProcessId
Latest Transfer Identifier sendLog.latestTransferId
End Code of Pre-send Job sendLog.preJobExitCode
Pre-send Job sendLog.preJobName
Profile ID sendLog.profileId
Profile Name sendLog.profileName
Record Count sendLog.recordCount
Send Log ID sendLog.sendLogId
Send End Date and Time (string) sendLog.sndEndTimeStr
Send End Date and Time (UTC) sendLog.sndEndTimeUtc
Send File name sendLog.sndFileName
Send Start Date and Time (string) sendLog.sndStartTimeStr
Send Start Date and Time (UTC) sendLog.sndStartTimeUtc
Starting Identifier sendLog.startProcessId
Start Transfer Identifier sendLog.startTransferId
End code of Successful Job sendLog.successJobExitCode
Successful Job sendLog.successJobName
Transmission Rate sendLog.transferRate
Transfer Type sendLog.transferType
Trigger Fire Event sendLog.triggerEvent
File Status When Firing Trigger sendLog.triggerStatus
Unit ID sendLog.unitId
Unit Name sendLog.unitName
Transfer Log ID transferLogId
Update Date and Time modifiedOn
Response
{
  "content": [
     {
       "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"
     }
  ],
  "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 Log details.

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