Acquire a list of Receive Logs

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

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

Specify the ID of Agent that received the file.

Exact match

  
Agent Name agentName String

Specify the name of Agent that received the file.

Exact match

  
Host Name hostName String

Specify the host name of Agent that received the file.

Exact match

  
Unit ID unitId String

Specify the ID of Unit to which Agent belongs.

Exact match

  
Unit Name unitName String

Specify the name of Unit to which Agent belongs.

Exact match

  
Profile ID profileId String

Specify the ID of Profile in which Reception Settings are registered.

Exact match

  
Profile Name profileName String

Specify the name of Profile in which Reception Settings are registered.

Exact match

  

Reception Settings ID

 receivingProfileId String

Specify the ID of Reception Settings that was used for the receive processing.

Exact match

  
Reception Settings Name receivingProfileName String

Specify the name of Reception Settings that was used for the receive processing.

Exact match

  
End Code exitCode Integer

Specify the end code of the receive processing.

Exact match

  

Reception Start Date and Time

(string)　(start)

 geReceivingStartDate String

Specify the value by using a "yyyyMMddHHmm" format.

•　yyyy: year

•　MM: month

•　dd: day

•　HH: hour

•　mm: minute

(Example: 201803190301)

You can specify one parameter only. If you specify both parameters, you can set a period of a search target.

  
Reception Start Date and Time

(string) (end)

 leReceivingStartDate String  

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"

Exact match

  
Reception Start Date and Time

(UTC)

 receivingStartDateUtc Integer

The number of seconds that has accumulated since midnight of 1970/1/1 (UTC)

Exact match

  

Reception Completion Date and Time

(string) (start)

 geReceivingEndDate String

Specify the value by using a "yyyyMMddHHmm" format.

•　yyyy: year

•　MM: month

•　dd: day

•　HH: hour

•　mm: minute

(Example: 201803190301)

You can specify one parameter only. If you specify both parameters, you can set a period of a search target.

  
Reception Completion Date and Time

(string) (end)

 leReceivingEndDate String  
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"

Exact match

  
Reception Completion Date and Time

(UTC)

 receivingEndDateUtc Integer

The number of seconds that has accumulated since midnight of 1970/1/1 (UTC)

Exact match

  
End Code of Job jobExitCode Integer Exact match  
Error error Boolean

•　true: to search abnormal termination only

•　false: to search all

 false
Sort Order sort String

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

•　+: Ascending order

•　-: Descending order

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

 -receivingStartDateUtc
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
Agent ID agentId
Agent Name agentName
Detail Code detailCode
End Code exitCode
File Path filePath
File Size fileSize
Host Name hostName
Job job
End Code of Job jobExitCode
Profile ID profileId
Profile Name profileName

Reception Completion Date and Time (string)

 receivingEndDateStr

Reception Completion Date and Time (UTC)

 receivingEndDateUtc
Receive Log ID receivingLogId

Reception Settings ID

 receivingProfileId
Reception Settings Name receivingProfileName

Reception Start Date and Time (string)

 receivingStartDateStr

Reception Start Date and Time (UTC)

 receivingStartDateUtc
Unit ID unitId
Unit Name unitName
Download URL url
Response
{
  "content": [
    {
      "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"
    }
  ],
  "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 Receive 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.