Kalenderanforderungen

Abfragen von Prozessen nach deren Namen

Die folgende GET-Anforderung an den /odata/Calendars -Endpunkt ruft einen bestimmten Kalender basierend auf seiner Nameab.

Abrufen

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

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Antwortcode

200 OK

Antworttext

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

Erstellen neuer Kalender

Mit der folgenden POST-Anforderung an den /odata/Calendars -Endpunkt können Sie einen neuen Kalender mit einem ausgeschlossenen Datum erstellen.

Hinweis: Der Parameter Id wird automatisch generiert. Der Parameter TimeZoneId wird mit der Zeitzone des Mandanten ausgefüllt.

Posten

{OrchestratorURL}/odata/Calendars

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Anforderungstext

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

Antwortcode

200 OK

Antworttext

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

Abrufen ausgeschlossener Daten eines Kalenders

Der GET-Endpunkt /odata/Calendars({calendar_id_value}) ruft die ausgeschlossenen Daten des angegebenen Kalenders ab.

Verwenden Sie den Kalender Id , um den Kalender anzugeben, aus dem Sie die ausgeschlossenen Daten abrufen möchten.

Um die Ids der vorhandenen Kalender in Ihrem Mandanten zu ermitteln, stellen Sie zuerst eine GET-Anforderung an den /odata/Calendars -Endpunkt.

Identifizieren Sie den gewünschten Kalender und kopieren Sie den Wert Id aus dem Antworttext.

Abrufen

{OrchestratorURL}/odata/Calendars

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Antwortcode

200 OK

Antworttext

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

Um die ausgeschlossenen Daten anzuzeigen, stellen Sie eine GET-Anforderung an /odata/Calendars({calendar_id_value}).

Ersetzen Sie {calendar_id_value} durch den zuvor kopierten Id -Wert.

Der Antworttext gibt alle Daten zurück, die im angegebenen Kalender ausgeschlossen wurden.

Für den Kalender mit dem ID-Wert 1461sieht die Anforderung beispielsweise wie folgt aus:

Abrufen

{OrchestratorURL}/odata/Calendars(1461)

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Antwortcode

200 OK

Antworttext

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