受信履歴一覧取得

受信履歴の一覧を取得するためのAPIです。Manager画面で［ログ］を選択した後、［受信履歴］タブを選択したときに表示される画面での操作に相当します。

= 備考 =

受信履歴一覧取得APIのcontent階層下のレスポンスパラメータは、受信履歴詳細取得APIのレスポンスパラメータと同じです。
書式
curl -X GET --header 'Accept: application/json'
            --header 'X-API-KEY:APIキー'
            'http://ホスト名:ポート番号/api/v1/receiving-logs?クエリ形式のリクエスト'
リクエストパラメータ（クエリ形式）
項目名 リクエストパラメータ 型 値 省略値
エージェントID agentId 文字列

ファイルを受信したエージェントのID

完全一致

  
エージェント名 agentName 文字列

ファイルを受信したエージェントの名称

完全一致

  
ホスト名 hostName 文字列

ファイルを受信したエージェントのホスト名

完全一致

  
ユニットID unitId 文字列

エージェントが所属しているユニットのID

完全一致

  
ユニット名 unitName 文字列

エージェントが所属しているユニットの名称

完全一致

  
プロファイルID profileId 文字列

受信設定が登録されているプロファイルのID

完全一致

  
プロファイル名 profileName 文字列

受信設定が登録されているプロファイルの名称

完全一致

  

受信設定ID

 receivingProfileId 文字列

受信処理に用いた受信設定のID

完全一致

  
受信設定名 receivingProfileName 文字列

受信処理に用いた受信設定の名称

完全一致

  
完了コード exitCode 数値

受信処理の完了コード

完全一致

  

受信開始日時

（文字列）(開始)

 geReceivingStartDate 文字列

「yyyyMMddHHmm」の形式で指定します。

• yyyy：西暦

• MM：月

• dd：日

• HH：時

• mm：分

（例：201803190301）

一方だけを指定できます。開始と終了の両方を指定した場合、検索対象にする期間を指定できます。

  

受信開始日時

（文字列）(終了)

 leReceivingStartDate 文字列  

受信開始日時

（文字列）

 receivingStartDateStr 文字列

"曜日 月 日 時:分:秒 西暦"

例："Fri Sep 08 17:15:52 2017"

完全一致

  

受信開始日時

（UTC）

 receivingStartDateUtc 数値

協定世界時（UTC）の1970年1月1日0時0分0秒からの経過時間（単位：秒）

完全一致

  

受信終了日時

（文字列）(開始)

 geReceivingEndDate 文字列

「yyyyMMddHHmm」の形式で指定します。

• yyyy：西暦

• MM：月

• dd：日

• HH：時

• mm：分

（例：201803190301）

一方だけを指定できます。開始と終了の両方を指定した場合、検索対象にする期間を指定できます。

  

受信終了日時

（文字列）(終了)

 leReceivingEndDate 文字列  

受信終了日時

（文字列）

 receivingEndDateStr 文字列

"曜日 月 日 時:分:秒 西暦"

例："Fri Sep 08 17:15:52 2017"

完全一致

  

受信終了日時

（UTC）

 receivingEndDateUtc 数値

協定世界時（UTC）の1970年1月1日0時0分0秒からの経過時間（単位：秒）

完全一致

  
ジョブ完了コード jobExitCode 数値 完全一致  
エラー error 論理型

•　true：異常終了のみ検索

•　false：すべて検索

 false
ソート順 sort 文字列

"+パラメータ名"　|　"-パラメータ名"

•　+：昇順

•　-：降順

複数のパラメータを指定する場合は「,」で区切ります。

 -receivingStartDateUtc
ページ数 page 数値

0始まりで指定します。

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

 0
1ページ当たりの項目数 size 数値   10
ソート順に指定できるパラメータ
項目名 パラメータ名
エージェントID agentId
エージェント名 agentName
詳細コード detailCode
完了コード exitCode
ファイルパス filePath
ファイルサイズ fileSize
ホスト名 hostName
ジョブ job
ジョブ完了コード jobExitCode
プロファイルID profileId
プロファイル名 profileName
受信完了日時(文字列) receivingEndDateStr
受信完了日時(UTC) receivingEndDateUtc
受信履歴ID receivingLogId
受信設定ID receivingProfileId
受信設定名 receivingProfileName
受信開始日時(文字列) receivingStartDateStr
受信開始日時(UTC) receivingStartDateUtc
ユニットID unitId
ユニット名 unitName
ダウンロードURL url
レスポンス
{
  "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
}
レスポンスパラメータ

content階層下のパラメータについては、「受信履歴詳細取得」の「レスポンスパラメータ」を参照してください。

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