5.2.1.4.24. カレンダー(日付情報)の取得¶
カレンダー(日付情報)の取得を行うタスクです。
出力値項目の詳細は、以下のAPIドキュメントを参照してください。
5.2.1.4.24.1. 入力値¶
im_getDayInfoSummaries <object> *
├─ calendarId <string> *
├─ end <calendar> *
├─ locale <locale>
└─ start <calendar> *
項目名 | 必須/任意 | 型 | 配列/リスト | 説明 |
---|---|---|---|---|
im_getDayInfoSummaries | 必須 | object | なし | - |
calendarId | 必須 | string | なし | カレンダーID |
end | 必須 | calendar | なし | 取得期間の終わりの日(指定した日を含む)
Calendarのうち、year, month, dayOfMonthのフィールドのみを使用します。他のフィールドは無視されます。
|
locale | 任意 | locale | なし | 取得対象のロケール
省略した場合、アカウントコンテキストのロケールが設定されます。
|
start | 必須 | calendar | なし | 取得期間の最初の日
Calendarのうち、year, month, dayOfMonthのフィールドのみを使用します。他のフィールドは無視されます。
|
5.2.1.4.24.2. 出力値¶
im_getDayInfoSummaries <object[]>
├─ color <string>
├─ currentDate <calendar>
├─ dayInfoNames <string[]>
├─ dayInfos <object[]>
│ ├─ color <string>
│ ├─ dataType <string>
│ ├─ dayInfoId <string>
│ ├─ dayInfoName <string>
│ ├─ dayInfoSetId <string>
│ ├─ dayOfMonth <integer>
│ ├─ dayOfWeek <integer>
│ ├─ dayOfWeekInMonth <integer>
│ ├─ fullYear <integer>
│ ├─ mergeSortKey <long>
│ ├─ month <integer>
│ ├─ sortKey <long>
│ ├─ validEndYear <integer>
│ ├─ validStartYear <integer>
│ └─ weekOfMonth <integer>
└─ holiday <boolean>
項目名 | 型 | 配列/リスト | 説明 |
---|---|---|---|
im_getDayInfoSummaries | object | リスト | - |
color | string | なし | この日の表示色 |
currentDate | calendar | なし | この日の日付 |
dayInfoNames | string | リスト | この日に登録されている日付情報の名前。
入力値に指定された取得対象ロケールの名前が格納されます。
並び順は、日付情報の優先度です。
|
dayInfos | object | リスト | - |
color | string | なし | 表示色 |
dataType | string | なし | データタイプ |
dayInfoId | string | なし | 日付情報ID |
dayInfoName | string | なし | 日付情報名
取得対象ロケールの日付情報名が格納されます。
|
dayInfoSetId | string | なし | 日付情報セットID |
dayOfMonth | integer | なし | 対象日 |
dayOfWeek | integer | なし | 対象曜日 |
dayOfWeekInMonth | integer | なし | 対象第何曜日 |
fullYear | integer | なし | 対象年 |
mergeSortKey | long | なし | マージソートキー |
month | integer | なし | 対象月 |
sortKey | long | なし | ソートキー |
validEndYear | integer | なし | 有効終了年 |
validStartYear | integer | なし | 有効開始年 |
weekOfMonth | integer | なし | 対象週 |
holiday | boolean | なし | 休日フラグ
休日の場合 true、平日の場合 false。
|