orchestrator
2023.10
true
- Erste Schritte
- Swagger-Definition
- Orchestrator-APIs
- Warnungsanforderungen
- Anfragen zu Assets
- Kalenderanforderungen
- Umgebungsabfragen
- Ordneranforderungen
- Generische Aufgabenanforderungen
- Jobanfragen
- Bibliotheksabfragen
- Lizenzabfragen
- Paketanfragen
- Berechtigungsabfragen
- Anfragen für persönliche Arbeitsbereiche
- Prozessabfragen
- Anforderungen von Warteschlangenelementen
- Anforderungen an Warteschlangenaufbewahrungsrichtlinien
- Roboteranfragen
- Rollenanfragen
- Zeitplanabfragen
- Anfragen zu Einstellungen
- Anforderungen für Speicher-Buckets
- Aufgabenanforderungen
- Aufgabenkataloganforderungen
- Aufgabenformularanforderungen
- Mandantenabfragen
- Transaktionsanfragen
- Benutzerabfragen
- Webhook-Abfragen
Kalenderanforderungen
Anleitung für die Orchestrator-API
Last updated 22. Juni 2024
Kalenderanforderungen
Die folgende GET-Anforderung an den
/odata/Calendars
-Endpunkt ruft einen bestimmten Kalender basierend auf seiner Name
ab.
Abrufen
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Calendars?$filter=Name%20eq%20'BankHoliday'
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Calendars",
"value": [
{
"TimeZoneId": null,
"ExcludedDates": [],
"Name": "BankHoliday",
"Id": 18845
}
]
}
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Calendars",
"value": [
{
"TimeZoneId": null,
"ExcludedDates": [],
"Name": "BankHoliday",
"Id": 18845
}
]
}
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
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Calendars
{
"Name": "VacationCal",
"TimeZoneId": "string",
"ExcludedDates": [
"2019-11-12T14:31:44.778Z"
]
}
{
"Name": "VacationCal",
"TimeZoneId": "string",
"ExcludedDates": [
"2019-11-12T14:31:44.778Z"
]
}
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Calendars/$entity",
"TimeZoneId": "GTB Standard Time",
"ExcludedDates": [
"2019-11-12T00:00:00Z"
],
"Name": "VacationCal",
"Id": 32718
}
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Calendars/$entity",
"TimeZoneId": "GTB Standard Time",
"ExcludedDates": [
"2019-11-12T00:00:00Z"
],
"Name": "VacationCal",
"Id": 32718
}
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
Id
s 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
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Calendars
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Calendars",
"value": [
{
"TimeZoneId": null,
"ExcludedDates": [],
"Name": "November_excluded_dates",
"Id": 1461
}
]
}
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/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
1461
sieht die Anforderung beispielsweise wie folgt aus:
Abrufen
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Calendars(1461)
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/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
}
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/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
}