Acquire a list of receive tasks

This is an API function to acquire contents of the receive task queue from the specified Agent instance. This API function corresponds to the operation when you select the [Manage the Receive Task Queue] by using the [Action] button that is displayed by selecting the [Agent] on the operation screen of Manager.

Format

curl -X GET --header 'Accept: application/json'

--header 'X-API-KEY:APIKEY'

'http://HOSTNAME:PORTNUMBER/api/v1/agents/agentId/queues/receiving?REQUESTINQUERYFORMAT'

Request parameter (Path format)
Item name Request parameter Type Value Default value
Agent ID agentId String   Impossible to omit
Request parameter (Query format)
Item name Request parameter Type Value Default value
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
Response

{

   "content": [

      {

      "receivingTaskId": "string",

      "distributionModuleId": "string",

      "fileName": "string",

      "job": "string",

      "createdDate": 0

      }

   ],

   "first": true,

   "last": true,

   "number": 0,

   "numberOfElements": 0,

   "size": 0,

   "sort": [],

   "totalElements": 0,

   "totalPages": 0

}

Response parameter
Item name Response parameter Type Value
Receiving Task ID content receivingTaskId String  
File Distribution ID distributionModuleId String  
File Name at Send Destination fileName String  
Job job String  
Created Date and Time createdDate Integer

The value is returned by using a "yyyyMMddHHmmssSSS" format.

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