カレンダーの要求

Retrieving Calendars According to Their Name

The following GET request to the /odata/Calendars endpoint retrieves a specific calendar based on its Name.

GET

{OrchestratorURL}/odata/Calendars?$filter=Name%20eq%20'BankHoliday'

要求ヘッダー

キー	値 (Value)
認可	Bearer

応答コード

200 OK

応答本文

{
  "@odata.context": "{OrchestratorURL}/odata/$metadata#Calendars",
  "value": [
    {
      "TimeZoneId": null,
      "ExcludedDates": [],
      "Name": "BankHoliday",
      "Id": 18845
    }
  ]
}

Creating a Calendar

The following POST request to the /odata/Calendars endpoint enables you to create a new calendar with an excluded date.

Note: The Id parameter is automatically generated. The TimeZoneId parameter is populated with the tenant's timezone.

POST

{OrchestratorURL}/odata/Calendars

要求ヘッダー

キー	値 (Value)
認可	Bearer

要求本文

{
  "Name": "VacationCal",
  "TimeZoneId": "string",
  "ExcludedDates": [
    "2019-11-12T14:31:44.778Z"
  ]
}

応答コード

200 OK

応答本文

{
  "@odata.context": "{OrchestratorURL}/odata/$metadata#Calendars/$entity",
  "TimeZoneId": "GTB Standard Time",
  "ExcludedDates": [
    "2019-11-12T00:00:00Z"
  ],
  "Name": "VacationCal",
  "Id": 32718
}

カレンダーの除外日を取得する

GET /odata/Calendars({calendar_id_value}) エンドポイントは、指定されたカレンダーの除外日を取得します。

カレンダー Id を使用して、除外日を取得するカレンダーを指定します。

テナントの既存のカレンダーの Id を確認するには、まず /odata/Calendars エンドポイントに GET 要求を送信します。

目的のカレンダーを特定し、応答本文から Id の値をコピーします。

GET

{OrchestratorURL}/odata/Calendars

要求ヘッダー

キー	値 (Value)
認可	Bearer

応答コード

200 OK

応答本文

{
    "@odata.context": "{OrchestratorURL}/odata/$metadata#Calendars",
    "value": [
        {
            "TimeZoneId": null,
            "ExcludedDates": [],
            "Name": "November_excluded_dates",
            "Id": 1461
        }
    ]
}

除外日を確認するには、/odata/Calendars({calendar_id_value}) に GET 要求を送信します。

{calendar_id_value} は、先ほどコピーした Id の値に置き換えます。

応答本文は、指定したカレンダーのすべての除外日を返します。

たとえば、ID の値が 1461 のカレンダーの場合、要求は以下のようになります。

GET

{OrchestratorURL}/odata/Calendars(1461)

要求ヘッダー

キー	値 (Value)
認可	Bearer

応答コード

200 OK

応答本文

{
    "@odata.context": "{OrchestratorURL}/odata/$metadata#Calendars/$entity",
    "TimeZoneId": "UTC",
    "ExcludedDates": [
        "2021-11-01T00:00:00Z",
        "2021-11-04T00:00:00Z",
        "2021-11-08T00:00:00Z",
        "2021-11-11T00:00:00Z",
        "2021-11-15T00:00:00Z",
        "2021-11-18T00:00:00Z",
        "2021-11-22T00:00:00Z",
        "2021-11-25T00:00:00Z"
    ],
    "Name": "November_excluded_dates",
    "Id": 1461
}