受信タスク一覧取得

指定したエージェントから受信タスクキューの内容を取得するためのAPIです。Manager画面で[エージェント]を選択したときに表示される画面の[操作]ボタンで、[受信タスクキュー管理]を選択したときの操作に相当します。

書式

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

--header 'X-API-KEY:APIキー'

'http://ホスト名:ポート番号/api/v1/agents/agentId/queues/receiving?クエリ形式のリクエスト'

リクエストパラメータ(パス形式)
項目名 リクエストパラメータ 省略値
エージェントID agentId 文字列   省略不可
リクエストパラメータ(クエリ形式)
項目名 リクエストパラメータ 省略値
ページ数 page 数値

0始まりで指定します。

ページ数が1の場合、0を指定します。

0
1ページ当たりの項目数 size 数値   10
レスポンス

{

   "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

}

レスポンスパラメータ
項目名 レスポンスパラメータ
受信タスクID content receivingTaskId 文字列  
ファイル配付ID distributionModuleId 文字列  
配置先ファイル名 fileName 文字列  
ジョブ job 文字列  
作成日 createdDate 数値

「yyyyMMddHHmmssSSS」の形式で返却されます。

ページ設定のパラメータ(first, last, number, numberOfElements, size, sort, totalElements, totalPages)については、「ページ設定に関するレスポンスパラメータ」を参照してください。