Acquire Receive Log details

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

= Remarks =

It is the difference between the acquire a list of Receive 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/receiving-logs/receivingLogId'
Request parameter (Path format)
Item name Request parameter Type Value Default value
Receive Log ID receivingLogId String   Impossible to omit
Response
{
  "agentId": "string",
  "agentName": "string",
  "detailCode": 0,
  "exitCode": 0,
  "filePath": "string",
  "fileSize": 0,
  "hostName": "string",
  "job": "string",
  "jobExitCode": 0,
  "profileId": "string",
  "profileName": "string",
  "receivingEndDateStr": "string",
  "receivingEndDateUtc": 0,
  "receivingLogId": "string",
  "receivingProfileId": "string",
  "receivingProfileName": "string",
  "receivingStartDateStr": "string",
  "receivingStartDateUtc": 0,
  "unitId": "string",
  "unitName": "string",
  "url": "string"
}
Response parameter
Item name Response parameter Type Value
Agent ID agentId String The ID of Agent that received the file is returned.
Agent Name agentName String The name of Agent that received the file is returned.
Detail Code detailCode Integer The detail code of the receive processing on agent environment is returned.
End Code exitCode Integer The end code of the receive processing on agent environment is returned.
File Path filePath String  
File Size fileSize Integer  
Host Name hostName String Host name of Agent that received the file is returned.
Job job String  
End Code of Job jobExitCode Integer  
Profile ID profileId String The ID of Profile in which Reception Settings are registered is returned.
Profile Name profileName String The name of Profile in which Reception Settings are registered is returned.

Reception Completion Date and Time (string)

 receivingEndDateStr String

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

Example: "Fri Sep 08 17:15:52 2017"

Reception Completion Date and Time (UTC)

 receivingEndDateUtc Integer

The number of seconds that has accumulated since midnight of 1970/1/1 (UTC)
Receive Log ID receivingLogId String  

Reception Settings ID

 receivingProfileId String The ID of Reception Settings that was used for the receive processing.
Reception Settings Name receivingProfileName String The name of Reception Settings that was used for the receive processing.

Reception Start Date and Time (string)

 receivingStartDateStr String

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

Example: "Fri Sep 08 17:15:52 2017"

Reception Start Date and Time (UTC)

 receivingStartDateUtc Integer

The number of seconds that has accumulated since midnight of 1970/1/1 (UTC)
Unit ID unitId String The ID of Unit to which Agent belongs is returned.
Unit Name unitName String The name of Unit to which Agent belongs is returned.
Download URL url String The URL from which Agent actually downloaded the file.