本文へジャンプします。

ニフクラ ユーザーガイド

DescribeEventCalendar

処理概要

指定した年月の稼働状況を月間カレンダー形式で取得します。

リクエストURL

GET /events/calendars/{year_month}

指定するパラメーター

パスパラメーター
パラメーター 説明 必須
year_month string 表示する年月をyyyy-mm 形式で指定します。
クエリパラメーター
パラメーター 説明 必須
mode string カレンダーに表示する対象を以下から選択します。
値: user (顧客影響のあるイベント) | all (すべてのイベント)
Default: user

応答フィールド

フィールド (項目) 説明
requestID string リクエスト時に発行されるユニークキー
datetime string レスポンスを返した時刻
data object
targetDate string 指定した年/月(yyyy-mm)
mode string 指定した範囲
値: user (顧客影響のあるイベント) | all (すべてのイベント)
calendar[] object[]
day string 日付(1~31)
dayOfWeek string 曜日(1 月曜 ~ 7 日曜)
information string お知らせの有無
値: 0 (なし) | 1 (あり)
maintenance string メンテナンスの有無
値: 0 (なし) | 1 (あり)
cancelMaintenance string 中止になったメンテナンスの有無
値: 0 (なし) | 1 (あり)
completedMaintenance string 完了したメンテナンスの有無
値: 0 (なし) | 1 (あり)
trouble string 障害の有無
値: 0 (なし) | 1 (あり)
noTroubleImpact string 「影響なし」に相当する障害の有無
値: 0 (なし) | 1 (あり)
recoveredTrouble string 復旧済み障害の有無
値: 0 (なし) | 1 (あり)

リクエストサンプル

    curl -X GET https://service-activity.api.nifcloud.com/api/events/calendars/2020-06?mode=user
  -H "Authorization: NIFTY4-HMAC-SHA256 ..."

  

応答サンプル

    {
  "requestID": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
  "datetime": "2020-07-01T17:00:05+09:00",
  "data": {
    "targetDate": "2020-06",
    "mode": "all",
    "calendar": [
          {
              "day": "1",
              "dayOfWeek": "1",
              "information": "0",
              "maintenance": "0",
              "cancelMaintenance": "0",
              "complatedMaintenance": "0",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          },
          {
              "day": "2",
              "dayOfWeek": "2",
              "information": "0",
              "maintenance": "0",
              "cancelMaintenance": "0",
              "complatedMaintenance": "0",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          },
          {
              "day": "3",
              "dayOfWeek": "3",
              "information": "0",
              "maintenance": "0",
              "cancelMaintenance": "0",
              "complatedMaintenance": "0",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          },
          {
              "day": "4",
              "dayOfWeek": "4",
              "information": "0",
              "maintenance": "0",
              "cancelMaintenance": "0",
              "complatedMaintenance": "0",
              "trouble": "1",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          },
          {
              "day": "5",
              "dayOfWeek": "5",
              "information": "1",
              "maintenance": "0",
              "cancelMaintenance": "0",
              "complatedMaintenance": "0",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          },
          {
              "day": "6",
              "dayOfWeek": "6",
              "information": "0",
              "maintenance": "0",
              "cancelMaintenance": "0",
              "complatedMaintenance": "0",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          },
          {
              "day": "7",
              "dayOfWeek": "7",
              "information": "0",
              "maintenance": "0",
              "cancelMaintenance": "0",
              "complatedMaintenance": "0",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          },
          {
              "day": "8",
              "dayOfWeek": "1",
              "information": "0",
              "maintenance": "0",
              "cancelMaintenance": "0",
              "complatedMaintenance": "1",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "1"
          },
          {
              "day": "9",
              "dayOfWeek": "2",
              "information": "0",
              "maintenance": "0",
              "cancelMaintenance": "0",
              "complatedMaintenance": "0",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          },
          {
              "day": "10",
              "dayOfWeek": "3",
              "information": "0",
              "maintenance": "0",
              "cancelMaintenance": "0",
              "complatedMaintenance": "0",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          },
          {
              "day": "11",
              "dayOfWeek": "4",
              "information": "0",
              "maintenance": "0",
              "cancelMaintenance": "0",
              "complatedMaintenance": "0",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          },
          {
              "day": "12",
              "dayOfWeek": "5",
              "information": "0",
              "maintenance": "0",
              "cancelMaintenance": "0",
              "complatedMaintenance": "0",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          },
          {
              "day": "13",
              "dayOfWeek": "6",
              "information": "0",
              "maintenance": "0",
              "cancelMaintenance": "0",
              "complatedMaintenance": "1",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          },
          {
              "day": "14",
              "dayOfWeek": "7",
              "information": "0",
              "maintenance": "0",
              "cancelMaintenance": "0",
              "complatedMaintenance": "0",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          },
          {
              "day": "15",
              "dayOfWeek": "1",
              "information": "0",
              "maintenance": "0",
              "cancelMaintenance": "0",
              "complatedMaintenance": "0",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "1"
          },
          {
              "day": "16",
              "dayOfWeek": "2",
              "information": "0",
              "maintenance": "0",
              "cancelMaintenance": "0",
              "complatedMaintenance": "0",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          },
          {
              "day": "17",
              "dayOfWeek": "3",
              "information": "0",
              "maintenance": "0",
              "cancelMaintenance": "0",
              "complatedMaintenance": "0",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          },
          {
              "day": "18",
              "dayOfWeek": "4",
              "information": "0",
              "maintenance": "0",
              "cancelMaintenance": "0",
              "complatedMaintenance": "0",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          },
          {
              "day": "19",
              "dayOfWeek": "5",
              "information": "0",
              "maintenance": "0",
              "cancelMaintenance": "0",
              "complatedMaintenance": "0",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          },
          {
              "day": "20",
              "dayOfWeek": "6",
              "information": "1",
              "maintenance": "1",
              "cancelMaintenance": "0",
              "complatedMaintenance": "1",
              "trouble": "1",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          },
          {
              "day": "21",
              "dayOfWeek": "7",
              "information": "0",
              "maintenance": "0",
              "cancelMaintenance": "0",
              "complatedMaintenance": "0",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          },
          {
              "day": "22",
              "dayOfWeek": "1",
              "information": "0",
              "maintenance": "1",
              "cancelMaintenance": "0",
              "complatedMaintenance": "0",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          },
          {
              "day": "23",
              "dayOfWeek": "2",
              "information": "0",
              "maintenance": "0",
              "cancelMaintenance": "0",
              "complatedMaintenance": "0",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          },
          {
              "day": "24",
              "dayOfWeek": "3",
              "information": "0",
              "maintenance": "0",
              "cancelMaintenance": "0",
              "complatedMaintenance": "0",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          },
          {
              "day": "25",
              "dayOfWeek": "4",
              "information": "0",
              "maintenance": "0",
              "cancelMaintenance": "0",
              "complatedMaintenance": "0",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          },
          {
              "day": "26",
              "dayOfWeek": "5",
              "information": "0",
              "maintenance": "0",
              "cancelMaintenance": "0",
              "complatedMaintenance": "0",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          },
          {
              "day": "27",
              "dayOfWeek": "6",
              "information": "0",
              "maintenance": "0",
              "cancelMaintenance": "1",
              "complatedMaintenance": "0",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          },
          {
              "day": "28",
              "dayOfWeek": "7",
              "information": "0",
              "maintenance": "0",
              "cancelMaintenance": "0",
              "complatedMaintenance": "0",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          },
          {
              "day": "29",
              "dayOfWeek": "1",
              "information": "0",
              "maintenance": "0",
              "cancelMaintenance": "0",
              "complatedMaintenance": "0",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          },
          {
              "day": "30",
              "dayOfWeek": "2",
              "information": "0",
              "maintenance": "0",
              "cancelMaintenance": "0",
              "complatedMaintenance": "0",
              "trouble": "0",
              "noTroubleImpact": "0",
              "recoveredTrouble": "0"
          }
    ]
  }
}

  
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2021年9月13日時点の情報です。

推奨画面サイズ 1024×768 以上