intra-mart Accel Platform IM-Workflow 仕様書 第37版 2024-04-01

6.1.9.12.6. アラート一覧情報リスト取得

アラート一覧情報リストを取得します。

6.1.9.12.6.1. HTTP リクエスト

POST /api/workflow/maintenance/alerts-data

6.1.9.12.6.2. リクエストボディ

6.1.9.12.6.2.1. JSON

{
  "count": 0,
  "index": 0,
  "orders": [
    {
      "asc": true,
      "columnId": "string"
    }
  ]
}

6.1.9.12.6.2.2. 詳細

プロパティ名 論理名 説明
count レコードの取得件数 int 取得したい件数を指定してください。
index レコードの取得位置 int 取得開始位置を指定してください。
orders ソート条件 array<object>  
- asc ソート順 boolean 昇順の場合は true 、降順の場合は false を指定してください。
- columnId カラムID string
ソートの基準にするカラムのIDを指定してください。
指定内容は カラムID を参照してください。
カラムID
プロパティ名 論理名 説明
ALERT_CLASSIFY アラート種類 string  
ALERT_LEVEL アラートレベル string  
DETECT_DATETIME 検出日時 string  
MESSAGE メッセージ string  

6.1.9.12.6.3. レスポンスデータ

6.1.9.12.6.3.1. JSON

{
  "data": {
    "records": [
      {
        "alertClassify": "string",
        "alertInfoId": "string",
        "alertLevel": "string",
        "alertMessage": "string",
        "detectDateTime": "string",
        "enableLink": true,
        "linkUrl": "string"
      }
    ]
  }
}

6.1.9.12.6.3.2. 詳細

プロパティ名 論理名 説明
records アラート一覧情報リスト array<object>  
- alertClassify アラート種類 string  
- alertInfoId アラート情報ID string  
- alertLevel アラートレベル string CodeList 」のコード値がセットされます。
- alertMessage アラートメッセージ string  
- detectDateTime 検出日時 string
アカウントコンテキストの日付時刻表示形式の値
アカウントのタイムゾーンへ変換しています。
- enableLink 遷移可能 boolean 遷移可能の場合は true 、不可の場合は false
- linkUrl 遷移先URL string  

6.1.9.12.6.4. エラーコード

エラーコード エラーメッセージ 備考
6256 アラート一覧情報の取得に失敗しました。 アラート一覧情報の取得に失敗した場合