Requêtes de calendriers

Récupération des calendriers en fonction de leur nom

La requête GET suivante au point de terminaison /odata/Calendars récupère un calendrier spécifique en fonction de son Name.

Obtenir

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

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Codes de réponse

200 OK

Corps de la réponse

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

Création de calendriers

La requête POST suivante au point de terminaison /odata/Calendars vous permet de créer un nouveau calendrier avec une date exclue.

Remarque : le paramètre Id est généré automatiquement. Le paramètre TimeZoneId est renseigné avec le fuseau horaire du locataire.

Publier

{OrchestratorURL}/odata/Calendars

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Corps de la requête

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

Codes de réponse

200 OK

Corps de la réponse

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

Récupération des dates exclues d'un calendrier

Le point de terminaison GET /odata/Calendars({calendar_id_value}) récupère les dates exclues du calendrier spécifié.

Utilisez le calendrier Id pour spécifier le calendrier à partir duquel vous souhaitez récupérer les dates exclues.

Pour connaître les Iddes calendriers existants dans votre locataire, effectuez d’abord une requête GET au point de terminaison /odata/Calendars .

Identifiez le calendrier souhaité et copiez la valeur Id du corps de la réponse.

Obtenir

{OrchestratorURL}/odata/Calendars

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Codes de réponse

200 OK

Corps de la réponse

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

Pour voir les dates exclues, envoyez une requête GET au /odata/Calendars({calendar_id_value}).

Remplacez {calendar_id_value} par la valeur Id précédemment copiée.

Le corps de la réponse renvoie toutes les dates qui ont été exclues du calendrier spécifié.

Par exemple, pour le calendrier dont l'ID est 1461, la requête ressemble à ce qui suit :

Obtenir

{OrchestratorURL}/odata/Calendars(1461)

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Codes de réponse

200 OK

Corps de la réponse

{
    "@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
}