Termin-API

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 24 Minuten Lesedauer

    • Die Termin Die API stellt Endpunkte für die Interaktion mit der Terminbuchungsanwendung bereit. Verwenden Sie diese API, um Termine zu buchen und zu verschieben, verfügbare Terminfenster zu überprüfen und Konfigurationsdetails für Terminbuchungen abzurufen.

    Vor der Verwendung dieser API müssen die Terminbuchungskonfiguration und die Servicekonfiguration eingerichtet werden. Darüber hinaus muss bereits eine Aufgabe vorhanden sein, für die der Termin gebucht wird. Weitere Informationen finden Sie unter Configuring Appointment Booking.

    Die Termin Die API erfordert das Plugin „Terminbuchung“ (com.snc.appointment_booking) und wird in bereitgestellt sn_apptmnt_booking Namespace. Für den Zugriff auf diese API benötigen Sie die Rolle „snc_internal“.

    Termin – GET /sn_apptmnt_booking/date/Calendar

    Gibt den Zeitbereich zurück, für den Sie Termine buchen können. Die Rückgabeergebnisse berücksichtigen die Vorlaufzeit und die maximalen zukünftigen buchbaren Daten, die in der Konfiguration des Terminbuchungsservice konfiguriert sind.

    Weitere Informationen zur Konfiguration der Vorlaufzeit und der maximalen zukünftigen buchbaren Daten finden Sie unter Create or modify an application configuration for Appointment Booking.

    Sie müssen entweder über die Rolle „snc_internal“ oder „snc_external“ verfügen, um auf diesen Endpunkt zuzugreifen.

    URL-Format

    Versionierte URL: /api/sn_apptmnt_booking/{api_Version}/appointment/Calendar

    Standard-URL: /api/sn_apptmnt_booking/date/Calendar

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    catalog_id Erforderlich. SYS_ID des Datensatzerstellers, der mit einer Konfiguration des Terminbuchungsservice konfiguriert ist.

    Tabelle: Datensatzersteller [sc_Cat_item_Producer]

    Datentyp: Zeichenfolge
    location Erforderlich. SYS_ID des Standorts des Termins.

    Tabelle: Standort [cmn_location]

    Datentyp: Zeichenfolge
    opened_for Erforderlich. SYS_ID des Anwenders, für den der Termin gebucht wird.

    Tabelle: Benutzer [sys_user]

    Datentyp: Zeichenfolge
    Tabelle : 3. Anforderungstextparameter
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 4. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 5. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    Ergebnis Informationen zu den Ergebnissen der Endpunktanforderung.

    Datentyp: Objekt

    "result": {
  "range_end": "String",
  "range_start": "String"
}
    Ergebnis.Bereich_Ende Ende des Bereichs, in dem die Termine gebucht werden können.

    Bereichsende = heute + maximale Anzahl zukünftiger buchbarer Tage

    Datentyp: Zeichenfolge

    Format: Zeitzone des Termins im internen Datums-/Uhrzeitformat.
    Ergebnis.Bereich_Start Beginn des Bereichs, in dem die Termine gebucht werden können.

    Bereichsstart = heute + Vorlaufzeit

    Datentyp: Zeichenfolge

    Format: Zeitzone des Termins im internen Datums-/Uhrzeitformat.

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird.

    curl "http://instance.servicenow.com/api/sn_apptmnt_booking/v1/appointment/calendar?catalog_id=e4c1116b3b810300ce8a4d72f3efc40f&location=32e8499cdb2d2200d75270f5bf9619d6&opened_for=6816f79cc0a8016401c5a33be04be441" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Ergebnis:

    {
  "result": {
    "range_start": "2023-02-08 03:52:27",
    "range_end": "2023-02-21 23:52:27"
  }
}

    Termin: RUFT /sn_apptmnt_booking/date/Configuration ab

    Gibt die Konfiguration zurück, die in einer angegebenen Konfiguration des Terminbuchungsservice definiert ist.

    Darüber hinaus werden die Übersetzungen sowie die Datums- und Uhrzeiteinstellungen des Anwenders zurückgegeben, die zum Rendern der Zeitfenster in den Terminbuchungs-Widgets erforderlich sind.

    Sie müssen entweder über die Rolle „snc_internal“ oder „snc_external“ verfügen, um auf diesen Endpunkt zuzugreifen.

    URL-Format

    Versionierte URL: /api/sn_apptmnt_booking/{api_Version}/appointment/Configuration

    Standard-URL: /api/sn_apptmnt_booking/date/Configuration

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    catalog_id Erforderlich. SYS_ID des Datensatzerstellers, der mit der Konfiguration des Terminbuchungsservice konfiguriert wurde.

    Datentyp: Zeichenfolge

    Tabelle: Datensatzersteller [sc_Cat_item_Producer]
    Tabelle : 9. Anforderungstextparameter
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 10. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 11. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 12. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    Ergebnis Ergebnisse der Endpunktanforderung.

    Datentyp: Objekt

    "result": {
  "active": Boolean,
  "active_string": "String",
  "advanced_calendar_view_portal": Boolean,
  "auto_acceptance": Boolean,
  "locale_language": "String",
  "service_config": {Object},
  "task_table": "String",
  "translations": {Object},
  "userDateFormatOptions": {Object},
  "useRR": Boolean,
  "userTimeFormat": {Object},
  "userTimeFormatOptions": {Object},
  "view_scale": "String"
}
    Ergebnis.aktiv Kennzeichnung, die angibt, ob das Setup der Servicekonfiguration für die zugehörige Katalog-ID aktiv ist.
    Mögliche Werte:
    • Wahr: Das Setup der Servicekonfiguration für die Katalog-ID ist aktiv.
    • Falsch: Das Setup der Servicekonfiguration für die Katalog-ID ist nicht aktiv.

    Datentyp: Boolesch
    Ergebnis.Active_string Textdarstellung des Status des Servicekonfigurations-Setups für die zugehörige Katalog-ID.

    Datentyp: Zeichenfolge
    Ergebnis.Advanced_Calendar_View_Portal Kennzeichnung, die angibt, ob die erweiterte Kalenderansicht im Portal oder die Basisansicht angezeigt wird. Weitere Informationen zur erweiterten Kalenderansicht finden Sie unter Create or modify an application configuration for Appointment Booking.
    Mögliche Werte:
    • Wahr: Die erweiterte Kalenderansicht wird im Portal angezeigt.
    • Falsch: Die Standardansicht wird im Portal angezeigt.

    Datentyp: Boolesch
    result.auto_acceptance Kennzeichnung, die angibt, ob der Termin automatisch in den Status akzeptiert übergeht.
    Mögliche Werte:
    • Wahr: Termin wechselt automatisch in den Status akzeptiert.
    • Falsch: Service Desk-Mitarbeiter muss den Termin manuell annehmen.

    Datentyp: Boolesch
    Ergebnis.Gebietsschema_Sprache Spracheinstellung des Anwenders.

    Datentyp: Zeichenfolge

    Format: ISO 639,1-Sprachcode
    result.service_config Details zur Servicekonfiguration.

    Datentyp: Objekt

    "service_config": {
  "active": Boolean,
  "active_string": "String",
  "appointment_booking_config": "String",
  "appointment_duration": "String",
  "appointments_per_bookable_slot": "String",
  "bookable_days": "String",
  "cancel_by_time": "String",
  "default_timezone": "String",
  "enable_advanced_config": Boolean,
  "field_mapping": {Object},
  "future_bookable_max_days": "String",
  "lead_time": "String",
  "mandatory": "String",
  "use_slot_end_time_as": "String",
  "work_duration": "String"
}
    result.service_config.active Kennzeichnung, die den aktiven Status der Konfiguration des Terminbuchungsservice angibt.
    Mögliche Werte:
    • Wahr: Aktiv
    • Falsch: Inaktiv

    Datentyp: Boolesch
    result.service_config.active_string Textdarstellung des Status der Konfiguration des Terminbuchungsservice.

    Datentyp: Zeichenfolge
    result.service_config.​Appointment_booking_config SYS_ID des Setup der Konfiguration des Terminbuchungsservice für die zugehörige Katalog-ID.

    Datentyp: Zeichenfolge

    Tabelle: Konfiguration des Terminbuchungsservice [sn_apptmnt_booking_Service_config]
    result.service_config.​Appointment_duration Dauer des Termins.

    Datentyp: Zeichenfolge

    Einheit: Minuten
    result.service_config.​Termine_per_bookable_Slot Anzahl der Termine, die für das zugehörige Zeitfenster gebucht werden können.

    Datentyp: Zeichenfolge
    result.service_config.​Bookable_days Kommagetrennte Werte, die die Tage darstellen, an denen Termine gebucht werden können.

    Tage werden als Ganzzahlen dargestellt, wobei Montag = 1 und Sonntag = 7.

    Datentyp: Zeichenfolge
    result.service_config.cancel_by_time Mindestzeitraum vor Beginn eines Termins, in dem ein Anwender den Termin stornieren kann. Wenn Sie beispielsweise einen Termin für 13:00 Uhr gebucht haben und eine Stornierung von 2 Stunden nach Zeit erfolgt, müssen Sie den Termin spätestens um 10:59 Uhr stornieren.

    Format: Dieser Wert ist die Datums- und Uhrzeitdifferenz von „01.01.1970 00:00:00“. Wenn der zurückgegebene Wert also „1970 01.01.04:00:00:00“ ist, bedeutet dies, dass der Raum vier Stunden vor Beginn der Besprechung storniert werden muss.

    Datentyp: Zeichenfolge
    result.service_config.default_timezone Zeitzonenkonfiguration, in der Termine gebucht werden.
    Mögliche Werte:
    • Standort: Verwenden Sie die Zeitzone des Standorts des Termins.
    • Anwender: Verwenden Sie die Zeitzone der Person, für die der Termin gebucht wird.

    Datentyp: Zeichenfolge
    result.service_config.​Enable_Advanced_config Kennzeichnung, die angibt, ob Terminbuchungskonfigurationen und Terminbuchungsregeln bei der Buchung von Terminen berücksichtigt werden. Weitere Informationen finden Sie unter Create appointment booking advanced configuration.
    Mögliche Werte:
    • Wahr: Terminbuchungskonfigurationen und Terminbuchungsregeln werden bei der Buchung von Terminen berücksichtigt.
    • Falsch: Terminbuchungskonfigurationen und Terminbuchungsregeln werden bei der Buchung von Terminen nicht berücksichtigt.

    Datentyp: Boolesch
    result.service_config.field_mapping Details zu den Katalogvariablen, die dem Standort zugeordnet sind, und Kontaktwerte, die zum Buchen des Termins verwendet werden.

    Datentyp: Objekt

    "field_mapping": {
  "contact": "String",
  "contactRPVariable": {Object},
  "location": "String",
  "locationRPVariable": {Object}
}
    result.service_config.​Field_Mapping.contact Name der Katalogvariablen, die den Kontaktwert enthält.

    Datentyp: Zeichenfolge
    result.service_config.field_mapping.​ContactRPVariable Details zu den Standortkatalog-Variablendaten.

    Datentyp: Objekt

    "contactRPVariable": {
  "displayName": "String",
  "label": "String",
  "name": "String"
}
    result.service_config.field_mapping.​ContactRPVariable.displayName Anzeigename der Kontaktkatalogvariablen.

    Datentyp: Zeichenfolge
    result.service_config.field_mapping.​ContactRPVariable.label Bezeichnung der Kontaktkatalogvariablen.

    Datentyp: Zeichenfolge
    result.service_config.field_mapping.​contactRPVariable.name Name der Kontaktkatalogvariablen.

    Datentyp: Zeichenfolge
    result.service_config.​Field_Mapping.location Name der Katalogvariablen, die den Standortwert enthält.

    Datentyp: Zeichenfolge
    result.service_config.field_mapping.​LocationRPVariable Details zu den Standortkatalog-Variablendaten.

    Datentyp: Objekt

    "locationRPVariable": {
  "displayName": "String",
  "label": "String",
  "name": "String"
}
    result.service_config.field_mapping.​LocationRPVariable.displayName Anzeigename der Standortkatalogvariablen.

    Datentyp: Zeichenfolge
    result.service_config.field_mapping.​LocationRPVariable.label Bezeichnung der Standortkatalogvariablen.

    Datentyp: Zeichenfolge
    result.service_config.field_mapping.​locationRPVariable.name Name der Standortkatalogvariablen.

    Datentyp: Zeichenfolge
    result.service_config.​Future_bookable_max_days Maximale Anzahl von Tagen in der Zukunft, für die ein Termin gebucht werden kann.

    Datentyp: Zeichenfolge
    result.service_config.lead_time Mindestzeitraum vor Beginn eines Termins, für den ein Anwender den Termin buchen kann. Wenn Sie beispielsweise einen Termin um 13:00 Uhr buchen möchten und eine Vorlaufzeit von 2 Stunden besteht, müssen Sie den Termin spätestens um 10:59 Uhr buchen.

    Format: Dieser Wert ist die Datums- und Uhrzeitdifferenz von „01.01.1970 00:00:00“. Wenn der zurückgegebene Wert also „1970 01.01.04:00:00:00“ ist, bedeutet dies, dass der Raum vier Stunden vor Beginn der Besprechung gebucht werden muss.

    Datentyp: Zeichenfolge
    result.service_config.mandatory Indikator, der angibt, ob der Termin obligatorisch ist.
    Mögliche Werte:
    • 0: Termin ist nicht obligatorisch.
    • 1: Termin ist obligatorisch.

    Datentyp: Zeichenfolge
    result.service_config.​Use_Slot_end_time_as Indikator, wann ein Service Desk-Mitarbeiter ankommt oder die für den zugehörigen Termin geplante Arbeit abschließt.
    Mögliche Werte:
    • Arrival_by: Der Service Desk-Mitarbeiter kommt innerhalb des angegebenen Zeitfensters am Standort für den Termin an.
    • Complete_by: Der Service Desk-Mitarbeiter schließt die Arbeit für den Termin innerhalb des angegebenen Zeitfensters ab.
    • Leer: Entspricht „completed_by“.

    Datentyp: Zeichenfolge
    result.service_config.work_duration Zeit, die für die Bearbeitung des Termins benötigt wird. Die Arbeitsdauer wird in der Konfiguration des Terminbuchungsservice konfiguriert. Weitere Informationen finden Sie unter Create or modify service configuration for Appointment Booking.

    Datentyp: Zeichenfolge

    Einheit: Minuten
    Ergebnis.Task_table Name der Tabelle, für die der Termin gebucht werden kann. Konfiguriert in der Konfiguration des Terminbuchungsservice.

    Datentyp: Zeichenfolge
    Ergebnis.Übersetzungen Name-Wert-Paare von Textübersetzungen, die vom Widget „Terminbuchung“ verwendet werden. Enthält übersetzte Werte für Aktionen, Nachrichten, Tage und Monate.

    Datentyp: Objekt
    result.userDateFormatOptions Beschreibt die Datumsformatoptionen, die zum Rendern von JS-Datumsobjekten erforderlich sind. Diese Werte werden in Terminbuchungskonstanten festgelegt, die nicht geändert werden können.
    Datentyp: Objekt 
    "userDateFormatOptions": {
  "day": "String",
  "month": "String",
  "week": "String",
  "weekday": "String"
}
    result.userDateFormatOptions.day Datumsformat des Tages.

    Datentyp: Zeichenfolge

    Format: Numerisch (Werte oder 1–31)
    result.userDateFormatOptions.month Monatsdatumsformat.

    Datentyp: Zeichenfolge

    Format: Kurz (Werte für Jan, Feb, Mar usw.)
    result.userDateFormatOptions.week Wochendatumsformat.

    Datentyp: Zeichenfolge

    Format: Numerisch (Werte von 1–5)
    result.userDateFormatOptions.weekday Datumsformat für Wochentage.

    Datentyp: Zeichenfolge

    Format: Kurz (Werte von Mo, Di, Mi usw.)
    result.useRR Wert der Eigenschaft sn_apptmnt_booking.use_read_replica_from_ui. Dieser Wert definiert, ob die Datenbank mit Lesereplikat zum Abrufen von Terminfenstern verwendet werden soll, wenn die Abfrage über die Anwenderoberfläche ausgeführt wird.
    Mögliche Werte:
    • Wahr: Verwenden Sie die Lesereplikatdatenbank, um die Slots abzurufen.
    • Falsch: Verwenden Sie nicht die Lesereplikatdatenbank, um die Slots abzurufen.

    Datentyp: Boolesch
    result.userTimeFormat Beschreibt das Zeitformat des Anwenders.

    Der Anwender ist die Person, die die Endpunktanforderung stellt. Wenn über die Plattform erfolgt, ist dies ein Service Desk-Mitarbeiter. Wenn über das Portal erfolgt, handelt es sich um einen Kunden.

    Datentyp: Objekt 
    "userTimeFormat": {
  "type": "String",
  "value": "String"
}
    result.userTimeFormat.type Typ des Zeitformats.
    Mögliche Werte:
    • 12hr
    • 24hr

    Datentyp: Zeichenfolge
    result.userTimeFormat.value Bevorzugtes Zeitformat, z. B. „HH:mm:ss“.

    Datentyp: Zeichenfolge
    result.userTimeFormatOptions Beschreibt die Zeitformatoptionen, die zum Rendern von JS-Zeitobjekten erforderlich sind. Diese Werte werden in den Terminbuchungskonstanten festgelegt, die nicht geändert werden können.
    Datentyp: Objekt 
    "userTimeFormatOptions": {
  "hour": "String",
  "hourCycle": "String",
  "minute": "String"
}
    result.userTimeFormatOptions.hour Format für Stunden.

    Format: Numerisch (Werte 1–12)
    result.userTimeFormatOptions.hourCycle Format für Stundenzyklus.

    Nur möglicher Wert ist h23 .
    result.userTimeFormatOptions.minute Format für Minuten.

    Format: Numerisch (Werte von 1–60)
    Ergebnis.Ansicht_Skala In der Servicekonfiguration konfigurierte Ansicht.
    Mögliche Werte:
    • Tag
    • Woche

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird.

    curl "http://instance.servicenow.com/api/sn_apptmnt_booking/v1/appointment/configuration?catalog_id=e4c1116b3b810300ce8a4d72f3efc40f" \
--request GET \
--header "Accept:application/json" \
--user ‘username':'password'

    Antwort:

    {
  "result": {
    "active": true,
    "activeString": "true"
    "view_scale": "day",
    "auto_acceptance": true,
    "task_table": "wm_order",
    "advanced_calendar_view_portal": false,
    "service_config": {
      "appointment_booking_config": "deb1d2fd3b033200ce8a4d72f3efc4c2",
      "future_bookable_max_days": "14",
      "appointments_per_bookable_slot": "20",
      "bookable_days": "1,2,3,4,5",
      "active": true,
      "activeString": "true",
      "mandatory": "1",
      "lead_time": "1970-01-01 04:00:00",
      "cancel_by_time": "1970-01-01 04:00:00",
      "appointment_duration": "120",
      "default_timezone": "location",
      "work_duration": "60",
      "enable_advanced_config": true,
      "field_mapping": {
        "location": "location"
        "opened_for": "contact",
        "locationRPVariable": {
          "name": "location",
          "label": "Location",
          "displayName": "location"
        },
        "contactRPVariable": {
          "name": "contact",
          "label": "Contact",
          "displayName": "contact"
        }
      },
      "use_slot_end_time_as": ""
    },
    "translations": {
      "submit_btn_text": "Select",
      "cancel_btn_text": "Cancel",
      "calendar_prev_text": "Previous",
      "select_appointment_calendar_text": "Select Appointment Calendar",
      "calendar_next_text": "Next",
      "previous_btn_text": "Previous day",
      "next_btn_text": "Next day",
      "date_input_placeholder_text": "Pick a date",
      "show_calendar_btn_text": "Show Calendar",
      "app_window_btn_text_start_time": "Start time",
      "app_window_btn_text_end_time": "End time",
      "appointment_window_aria_label_start_text": "Available appointment window ",
      "no_appointment": "No appointments",
      "time_zone": "Time zone",
      "selected_window": "The window which has been selected is ",
      "day_names": {
        "1": "Monday",
        "2": "Tuesday",
        "3": "Wednesday",
        "4": "Thursday",
        "5": "Friday",
        "6": "Saturday",
        "7": "Sunday"
      },
      "days": [
        "Sunday",
        "Monday",
        "Tuesday",
        "Wednesday",
        "Thursday",
        "Friday",
        "Saturday"
      ],
      "daysShort": [
        "Sun",
        "Mon",
        "Tue",
        "Wed",
        "Thu",
        "Fri",
        "Sat"
      ],
      "daysMin": [
        "Su",
        "Mo",
        "Tu",
        "We",
        "Th",
        "Fr",
        "Sa"
      ],
      "months": [
        "January",
        "February",
        "March",
        "April",
        "May",
        "June",
        "July",
        "August",
        "September",
        "October",
        "November",
        "December"
      ],
      "monthsShort": [
        "Jan",
        "Feb",
        "Mar",
        "Apr",
        "May",
        "Jun",
        "Jul",
        "Aug",
        "Sep",
        "Oct",
        "Nov",
        "Dec"
      ],
      "today": "Today",
      "clear": "Clear",
      "language": "en",
      "arrive_by_msg": "The agent will arrive within the selected slot."
    },
    "useRR": true,
    "locale_language": "en",
    "userTimeFormat": {
      "value": "HH:mm:ss",
      "type": "24hr"
    },
    "userDateFormatOptions": {
      "weekday": "short",
      "year": "numeric",
      "month": "short",
      "day": "numeric"
    },
    "userTimeFormatOptions": {
      "hour": "numeric",
      "minute": "numeric",
      "hourCycle": "h23"
    }
  }
}

    Termin – GET /sn_apptmnt_booking/appointment/execute_rule_conditions

    Gibt die sys_ID der Konfigurationsregel für den Terminbuchungsservice zurück, die einer angegebenen Aufgaben-sys_ID oder einer Reihe angegebener Katalogelementdaten entspricht.

    Die übergebenen Aufgaben-ID- oder Katalogelementdaten werden anhand der für eine Servicekonfiguration definierten Regeln ausgewertet. Die sys_ID für die erste Regel, für die diese Bedingungen übereinstimmen, wird zurückgegeben. Sie müssen diese Regel-sys_ID dann an nachfolgende Verfügbarkeitsanforderungen übergeben, um die richtigen Slots abzurufen, die in der Regel definiert sind.

    Sie müssen entweder über die Rolle „snc_internal“ oder „snc_external“ verfügen, um auf diesen Endpunkt zuzugreifen.

    URL-Format

    Versionierte URL: /api/sn_apptmnt_booking/{api_Version}/appointment/execute_rule_conditions

    Standard-URL: /api/sn_apptmnt_booking/appointment/execute_rule_conditions

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 13. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 14. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 15. Anforderungstextparameter
    Name Beschreibung
    catalogId Erforderlich. SYS_ID des Datensatzerstellers, der mit der Konfiguration des Terminbuchungsservice konfiguriert wurde.

    Datentyp: Zeichenfolge

    Tabelle: Datensatzersteller [sc_Cat_item_Producer]
    Sonstige Eingaben Erforderlich, wenn taskIdParameter ist nicht angegeben.

    Name-Wert-Paare von Katalogelementvariablen zum Vergleich mit den für eine Servicekonfiguration definierten Regeln.

    Zum Beispiel:
    "otherInputs": {
  "u_sn_point_of_sale_variable_set": "true",
  "short_description": "Point-of-Sale Installation",
  "contact": "6816f79cc0a8016401c5a33be04be441",
  "description": "Install new point-of-sale system with cash tray",
  "location": "32e8499cdb2d2200d75270f5bf9619d6"
}

    Datentyp: Objekt
    Aufgaben-ID Erforderlich, wenn otherInputsParameter ist nicht angegeben.

    SYS_ID des Aufgabendatensatzes, für den der Termin gebucht wird. Befindet sich in der Aufgabentabelle, für die der Termin gebucht wird. Die catalogIdEntspricht einer bestimmten Terminbuchungskonfiguration, und jede Konfiguration verfügt über eine Aufgabentabelle, in der der Termin gebucht wird.

    Datentyp: Zeichenfolge

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 16. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 17. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 18. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    Ergebnis Beschreibung der vom Endpunkt zurückgegebenen Informationen.

    Datentyp: Objekt

    “result": {
  "dedicatedCapacity": Boolean,
  "futureMaxBookableDays": "String",
  "ruleId": "String",
  "ruleName": "String"
}
    result.dedicatedCapacity Kennzeichnung, die angibt, ob die zugeordnete Regel über dedizierte Kapazität verfügt. Weitere Informationen zur dedizierten Kapazität finden Sie unter Create service configuration rules for a service configuration.
    Mögliche Werte:
    • Wahr: Regel hat dedizierte Kapazität.
    • Falsch: Kapazität wird zwischen der zugehörigen Regel und der Basiskonfiguration geteilt. Es wird auch für andere Regeln freigegeben, die keine dedizierte Kapazität haben.

    Datentyp: Boolesch
    Ergebnis.ZukunftMaxBookableTage Maximale Anzahl von Tagen in der Zukunft, für die ein Termin mit der Übereinstimmungsregel gebucht werden kann.

    Datentyp: Zeichenfolge
    result.ruleId SYS_ID der Konfigurationsregel für Terminbuchungsservice, die mit übereinstimmt taskIdOder otherInputsParameter, die in der Anforderung übergeben wurden.

    Datentyp: Zeichenfolge

    Tabelle: Servicekonfigurationsregel [sn_apptmnt_booking_config_rule]
    result.ruleName Name der Regel, die mit den übergebenen Parametern übereinstimmte.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt die Verwendung von taskIdParameter zum Erstellen der Regelvergleichsanforderung.

    curl "http://instance.servicenow.com/api/sn_apptmnt_booking/v1/appointment/execute_rule_conditions" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"catalogId\": \"e4c1116b3b810300ce8a4d72f3efc40f\",
  \"taskId\": \"ce1f397c43b861105e0dbcba6ab8f298\"}" \
--user 'username':'password'

    Antwort:

    {
  "result": {
    "ruleId": "f7d5d98f437c21105e0dbcba6ab8f2fc",
    "ruleName": "Priority 1 rule",
    "dedicatedCapacity": true,
    "futureMaxBookableDays": "14"
  }
}

    cURL-Anforderung

    Das folgende Codebeispiel zeigt die Verwendung von otherInputsParameter zum Erstellen der Regelvergleichsanforderung.

    curl "http://instance.servicenow.com/api/sn_apptmnt_booking/v1/appointment/execute_rule_conditions" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"catalogId\": \"e4c1116b3b810300ce8a4d72f3efc40f\",
  \"otherInputs\": {
    \"u_sn_point_of_sale_variable_set\": \"true\",
    \"short_description\": \"Point-of-Sale Installation\",
    \"contact\": \"6816f79cc0a8016401c5a33be04be441\",
    \"description\": \"Install new point-of-sale system with cash tray\",
    \"location\": \"32e8499cdb2d2200d75270f5bf9619d6\"
  }
}" \
--user 'username':'password'

    Antwort:

    {
  "result": {
    "ruleId": " 1d1bb72b4334a1105e0dbcba6ab8f275",
    "ruleName": "Lake View SC rule",
    "dedicatedCapacity": false,
    "futureMaxBookableDays": "21"
  }
}

    Termin: NACH /sn_apptmnt_booking/Termin/Termin

    Mit können Sie Termine für buchen und verschieben Außendienst-Management Aufgabe.

    Hinweis:
    Mit diesem Endpunkt können Sie nur Termine buchen und planen, deren Start- und Endzeiten in der zugehörigen Konfiguration des Terminbuchungsservice definiert sind und über verfügbare Zeitfenster verfügen.

    Für zusätzliche Informationen zu Außendienst-Management Aufgaben, siehe Configuring Appointment Booking.

    URL-Format

    Versionierte URL: /api/sn_apptmnt_booking/{api_Version}/Termin/Termin

    Standard-URL: /api/sn_apptmnt_booking/Termin/Termin

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 19. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 21. Anforderungstextparameter
    Name Beschreibung
    ActualEndDate Erforderlich. Enddatum und -Uhrzeit für das Terminfenster in der Zeitzone des Termins.

    Datumstyp: Zeichenfolge

    Format: JJJJ-MM-TT HH:mm:ss
    ActualStartDate Erforderlich. Startdatum und -Uhrzeit für das Terminfenster in der Zeitzone des Termins.

    Datumstyp: Zeichenfolge

    Format: JJJJ-MM-TT HH:mm:ss
    catalogId SYS_ID des Datensatzerstellers, der für die Konfiguration des Terminbuchungsservice konfiguriert ist.

    Wenn Sie diesen Parameter nicht übergeben, versucht der Endpunkt, diese Informationen von zu unterscheiden taskIdUnd taskTableParameter. Wenn dies nicht der Fall ist, schlägt der Endpunkt fehl, und ein Fehler wird zurückgegeben.

    Datumstyp: Zeichenfolge

    Tabelle: Feld „Katalogelement“ der Tabelle „Konfiguration des Terminbuchungsservice“ [sn_apptmnt_booking_Service_config].
    EndDateUTC Erforderlich. Enddatum und -Uhrzeit für das Terminfenster in der UTC-Zeitzone.

    Datumstyp: Zeichenfolge

    Format: JJJJ-MM-TT HH:mm:ss
    location Erforderlich. SYS_ID des Standortdatensatzes, der sich auf den Termin bezieht.

    Datumstyp: Zeichenfolge

    Tabelle: Standort [cmn_location]
    Geöffnet für Erforderlich. SYS_ID des Anwenders, für den der Termin gebucht wird.

    Datumstyp: Zeichenfolge

    Tabelle: Benutzer [sys_user]
    neu planen Erforderlich. Kennzeichnung, die angibt, ob der Termin neu geplant wird.
    Gültige Werte:
    • Wahr: Termin ist derzeit vorhanden und wird neu geplant.
    • Falsch: Neuer Termin.

    Datentyp: Boolesch
    Service_cofig_rule Wenn der Termin unter einer Regel gebucht wird, die sys_ID der Servicekonfigurationsregel.

    Datumstyp: Zeichenfolge

    Tabelle: Servicekonfigurationsregel [sn_apptmnt_booking_config_rule]
    StartDateUTC Erforderlich. Startdatum und -Uhrzeit für das Terminfenster in der UTC-Zeitzone.

    Datumstyp: Zeichenfolge

    Format: JJJJ-MM-TT HH:mm:ss
    Aufgaben-ID Erforderlich. SYS_ID des Aufgabendatensatzes, für den der Termin gebucht wird.

    Datumstyp: Zeichenfolge

    Tabelle: Definiert in taskTableParameter.
    taskTable Erforderlich. Name der Tabelle, die den Aufgabendatensatz enthält, für den der Termin gebucht wird.

    Datumstyp: Zeichenfolge
    Feld Erforderlich. Zeitzone, die beim Buchen oder Aktualisieren des angegebenen Terminfensters verwendet werden soll.

    Format: Format für Land/Stadt oder Gebiet, z. B. USA/Osten

    Datumstyp: Zeichenfolge
    Validieren_Anforderung Kennzeichnung, die angibt, ob die Terminanforderung validiert werden soll. Wenn eine der Validierungen fehlschlägt, schlägt der Endpunkt fehl und gibt eine Fehlermeldung zurück, die das Problem beschreibt.
    Die folgenden Validierungen werden durchgeführt:
    • Katalog-ID-Validierung: Verifiziert, dass bestanden wurde catalogIdParameter ist eine gültige sys_ID
    • Zeitzonenvalidierung: Überprüft, ob bestanden wurde timezoneParameter ist eine gültige Zeitzone.
    • Validierung der Aufgaben-ID: Verifiziert, dass bestanden wurde taskIdParameter ist eine gültige sys_ID, und die Aufgabe befindet sich im Status „Versand ausstehend“.
    • Validierung doppelter Zeitfenster: Wenn Sie bei Neuzeitplänen dasselbe Zeitfenster wie der ursprüngliche Termin übergeben, ist das Zeitfenster ungültig, da das Zeitfenster technisch bereits gebucht ist.
    • Slot-Validierung: Überprüft, ob die übergebenen Slot-Informationen mit den konfigurierten übereinstimmen und ob der Slot denselben Zeitrahmen hat. Wenn in der Konfiguration beispielsweise ein zweistündiges Zeitfenster konfiguriert ist, Sie jedoch ein dreistündiges Zeitfenster übergeben, ist das Zeitfenster ungültig. Ebenso gilt: Wenn das Zeitfenster von 9:00 Uhr bis 11:00 Uhr verfügbar ist, das übergebene Zeitfenster jedoch von 9:30 Uhr bis 11:30 Uhr ist, ist das übergebene Zeitfenster ungültig.
    Gültige Werte:
    • Wahr: Validieren Sie die Termininformationen.
    • Falsch: Validieren Sie die Termininformationen nicht.

    Datentyp: Boolesch

    Standardwert: false

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 22. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 23. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 24. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    Ergebnis Informationen zu den Ergebnissen der Endpunktanforderung.

    Datentyp: Objekt

    "result": {
  "data": "String",
  "message": "String",
  "reason": "String",
  "success": Boolean
}
    Ergebnis.Daten SYS_ID des Termindatensatzes, der erstellt oder neu geplant wurde.

    Datentyp: Zeichenfolge
    Ergebnis.Nachricht Nachricht, die erklärt, ob die Terminanforderung geplant wurde oder fehlgeschlagen ist. Fehlerantworten können beispielsweise Folgendes umfassen:
    • Ihr Termin kann nicht geplant werden.
    • Ihr Termin kann nicht neu geplant werden.
    Wenn der Vorgang erfolgreich ist, wird eine ähnliche Nachricht wie die folgende zurückgegeben: Ihr Termin wurde erfolgreich geplant.

    Datentyp: Zeichenfolge
    Ergebnis.Grund Zusätzliche Informationen zu den Ergebnissen der Terminanforderung.

    Datentyp: Zeichenfolge
    Ergebnis.Erfolg Kennzeichnung, die angibt, ob die Anforderung erfolgreich war.
    Mögliche Werte:
    • Wahr: Anforderung erfolgreich
    • Falsch: Anforderung fehlgeschlagen

    Datentyp: Boolesch

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Sie eine neue Terminbuchung für eine Aufgabe in der Tabelle „Arbeitsauftrag“ [wm_order] erstellen.

    curl "https://instance.servicenow.com/api/sn_apptmnt_booking/appointment/appointment" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"startDateUTC\": \"2023-02-01 20:00:00\",
\"endDateUTC\": \"2023-02-01 22:00:00\",
\"actualStartDate\": \"2023-02-01 15:00:00\",
\"actualEndDate\": \"2023-02-01 17:00:00\",
\"taskTable\": \"wm_order\",
\"location\": \"32e8499cdb2d2200d75270f5bf9619d6\",
\"catalogId\": \"e4c1116b3b810300ce8a4d72f3efc40f\",
\"openedFor\": \"ddce70866f9331003b3c498f5d3ee417\"
\"taskId\": \"ce1f397c43b861105e0dbcba6ab8f298\",
\"reschedule\": false,
\"service_configuration_rule\": \"\",
\"timezone\": \"US/Eastern\"
}" \

--user 'username':'password'

    Antwort:

    {
"result": {
  "success": true,
  "message": "Your appointment has been scheduled successfully.",
  "reason": "Appointment created!",
  "data": "7a5f393c43b861105e0dbcba6ab8f29f"
  }
}

    Termin: NACH /sn_apptmnt_booking/Termin/Verfügbarkeit

    Gibt die Zeitfenster zurück, die in der Konfiguration des Terminbuchungsservice konfiguriert wurden, zusammen mit ihrer Verfügbarkeit.

    Wenn erweiterte Konfigurationen für die Servicekonfiguration aktiviert sind, berücksichtigt der Endpunkt diese Konfigurationen und gibt die Daten gemäß den Regeln und der erweiterten Konfiguration zurück. Sie können diesen Endpunkt auch verwenden, um den ersten verfügbaren Slot zu finden, indem Sie übergeben get_next_available_slotParameter oder get_next_available_day_dataParameter im Anforderungstext als Wahr .

    Sie müssen entweder über die Rolle „snc_internal“ oder „snc_external“ verfügen, um auf diesen Endpunkt zuzugreifen.

    URL-Format

    Versionierte URL: /api/sn_apptmnt_booking/{api_Version}/Termin/Verfügbarkeit

    Standard-URL: /api/sn_apptmnt_booking/date/Availability

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 25. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 26. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 27. Anforderungstextparameter
    Name Beschreibung
    catalog_id SYS_ID des Datensatzerstellers, der für die Konfiguration des Terminbuchungsservice konfiguriert ist.

    Wenn Sie diesen Parameter nicht übergeben, versucht der Endpunkt, diese Informationen von zu unterscheiden taskIdUnd task_tableParameter. Wenn dies nicht der Fall ist, schlägt der Endpunkt fehl, und ein Fehler wird zurückgegeben.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld Katalogelement im zugehörigen Datensatz der Tabelle „Konfiguration des Terminbuchungsservice“ [sn_apptmnt_booking_Service_config].
    end_date Erforderlich. Enddatum und -Uhrzeit, für die Termine abgerufen werden sollen.

    Datentyp: Zeichenfolge

    Format: UTC-Zeitzone im Format JJJJ-MM-TT HH:mm:ss
    Abrufen_Tage_Slot Kennzeichnung, die angibt, ob das erste verfügbare Zeitfenster an jedem Tag für den angeforderten Datumsbereich zurückgegeben werden soll.
    Gültige Werte:
    • Wahr: Gibt das erste verfügbare Zeitfenster für jeden Tag zurück.
    • Falsch: Geben Sie nicht das erste verfügbare Zeitfenster für jeden Tag zurück.

    Datentyp: Boolesch

    Standardwert: false
    Full_day Erforderlich. Kennzeichnung, die angibt, ob alle übergebenen Termine für den angegebenen Datumsbereich unabhängig von den Zeitwerten im Start- und Enddatum zurückgegeben werden sollen.
    Gültige Werte:
    • Wahr: Gibt alle Termine unabhängig von den angegebenen Zeiten zurück.
    • Falsch: Geben Sie nur Termine zurück, die den angegebenen Daten und Uhrzeiten entsprechen.

    Datentyp: Boolesch
    Get_next_available_Slot Kennzeichnung, die angibt, ob das erste verfügbare Terminfenster mit der Antwort zurückgegeben werden soll, auch wenn sie nicht Teil der übergebenen ist start_dateUnd end_dateParameter.
    Gültige Werte:
    • Wahr: Geben Sie die ersten verfügbaren Terminfenster zurück.
    • Falsch: Geben Sie nicht die ersten verfügbaren Terminfenster zurück.

    Datentyp: Boolesch

    Standardwert: false
    limit Maximale Anzahl der zurückzugebenden Termine.

    Datentyp: Zahl

    Standard: Wert, der in der zurückgegebenen Eigenschaft „sn_apptmnt_booking .max_terminments_“ oder „1000“ angegeben ist, wenn die Eigenschaft leer ist.
    location Erforderlich. SYS_ID des Standortdatensatzes, der dem Termin zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Standort [cmn_location]
    opened_for Erforderlich. SYS_ID des Anwenders, für den der Termin gebucht wird.

    Datentyp: Zeichenfolge

    Tabelle: Benutzer [sys_user]
    Sonstige Eingaben Name-Wert-Paare aller anderen Werte, die zur Berechnung der Verfügbarkeit in der geskripteten Methode erforderlich sind. Normalerweise sind diese Werte Katalogelementvariablen. Wenn Sie jedoch Ihre Buchungsanwendung anpassen, können Sie alle Werte übergeben, die für Ihre Implementierung erforderlich sind.
    Zum Beispiel:
    "otherInputs": {
  "u_sn_point_of_sale_variable_set": "true",
  "short_description": "Point-of-Sale Installation",
  "contact": "6816f79cc0a8016401c5a33be04be441",
  "description": "Install new point-of-sale system with cash tray",
  "location": "32e8499cdb2d2200d75270f5bf9619d6"
}

    Datentyp: Objekt
    Service_config_rule SYS_ID der Servicekonfigurationsregel, die zur Berechnung der Terminfenster und der Verfügbarkeit verwendet werden soll.

    Datentyp: Zeichenfolge

    Tabelle: Servicekonfigurationsregel [sn_apptmnt_booking_config_rule]
    start_date Erforderlich. Startdatum und -Uhrzeit, für die Termine abgerufen werden sollen.

    Datentyp: Zeichenfolge

    Format: UTC-Zeitzone im Format JJJJ-MM-TT HH:mm:ss
    Aufgaben-ID SYS_ID des Aufgabendatensatzes, für den der Termin gebucht wird.

    Datumstyp: Zeichenfolge

    Tabelle: Definiert in taskTableParameter.
    task_table Erforderlich. Name der Tabelle, die den Aufgabendatensatz enthält, für den der Termin gebucht wird.

    Datentyp: Zeichenfolge
    Use_read_replica Kennzeichnung, die angibt, ob das Lesereplikat der Datenbank beim Abrufen der Terminfenster und ihrer Verfügbarkeit verwendet werden soll.
    Gültige Werte:
    • Wahr: Verwenden Sie das Lesereplikat der Datenbank.
    • Falsch: Verwenden Sie nicht das Lesereplikat der Datenbank.

    Standardwert: false
    Ansicht Erforderlich. Ursprungspunkt der Anforderung.
    Gültige Werte: (Groß-/Kleinschreibung beachten)
    • platform
    • Portal

    Datentyp: Zeichenfolge

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 28. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 29. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 30. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    Ergebnis Details zu den Terminen, die der Anforderung entsprechen.

    Datentyp: Objekt

    "result": {
 "availability": [Array], 
 "has_more": Boolean,
 "next_available_slot": {Object},
 "no_appt_available": Boolean,
 "success": Boolean,
 "time_zone": "String",
 "time_zone_display_value": "String"
}
    Ergebnis.Verfügbarkeit Liste der Terminfenster, die die angegebene Anforderung erfüllen.

    Datentyp: Array von Objekten

    "availability": [{
  "available": Boolean,
  "end_date": "String",
  "end_date_display": "String",
  "end_dateUTC": "String",
  "start_date": "String", 
  "start_date_display": "String",
  "start_dateUTC": "String"
}]
    Ergebnis.Verfügbarkeit.verfügbar Kennzeichnung, die angibt, ob das zugehörige Zeitfenster verfügbar ist.
    Mögliche Werte:
    • Wahr: Zeitfenster ist verfügbar.
    • Falsch: Zeitfenster ist nicht verfügbar.

    Datentyp: Boolesch
    Ergebnis.Verfügbarkeit.End_date Enddatum und -Uhrzeit des zugehörigen Termins. Die Zeitzone basiert auf dem Wert in time_zoneParameter.

    Datentyp: Zeichenfolge

    Format: JJJJ-MM-TT hh:mm:ss
    Ergebnis.Verfügbarkeit.end_date_Display Enddatum und -Uhrzeit des zugehörigen Termins anzeigen. Die Zeitzone basiert auf dem Wert in time_zone_display_valueParameter.

    Datentyp: Zeichenfolge

    Format: Datums-/Uhrzeitformat des anfordernden Anwenders.
    Ergebnis.Verfügbarkeit.end_dateUTC Enddatum und -Uhrzeit des zugehörigen Termins in UTC-Zeit.

    Datentyp: Zeichenfolge

    Format: JJJJ-MM-TT hh:mm:ss
    Ergebnis.Verfügbarkeit.Start_date Startdatum und -Uhrzeit des zugehörigen Termins. Die Zeitzone basiert auf dem Wert in time_zoneParameter.

    Datentyp: Zeichenfolge

    Format: JJJJ-MM-TT hh:mm:ss
    Ergebnis.Verfügbarkeit.Start_date_Display Zeigen Sie Startdatum und -Uhrzeit des zugehörigen Termins an. Die Zeitzone basiert auf dem Wert in time_zone_display_valueParameter.

    Datentyp: Zeichenfolge

    Format: Datums-/Uhrzeitformat des anfordernden Anwenders.
    Ergebnis.Verfügbarkeit.Start_dateUTC Startdatum und -Uhrzeit des zugehörigen Termins in UTC-Zeit.

    Datentyp: Zeichenfolge

    Format: JJJJ-MM-TT hh:mm:ss
    Ergebnis.hat_mehr Kennzeichnung, die angibt, ob nach Rückgabe des Grenzwerts weitere Terminfenster abgerufen werden sollen.
    Mögliche Werte:
    • Wahr: Weitere Terminfenster sind verfügbar.
    • Falsch: Es sind keine weiteren Slots verfügbar.

    Datentyp: Boolesch
    Ergebnis.Next_available_Slot Wenn get_next_available_slotParameter wurde als „wahr“ übergeben, Details zum ersten verfügbaren Slot unabhängig vom übergebenen Start- und Enddatum.

    Datentyp: Objekt

    "next_available_slot": {
  "available": Boolean,
  "end_date": "String",
  "end_date_display": "String",
  "end_dateUTC": "String",
  "start_date": "String", 
  "start_date_display": "String",
  "start_dateUTC": "String"
}
    Ergebnis.Next_available_Slot.available Kennzeichnung, die angibt, ob das zugehörige Zeitfenster verfügbar ist.
    Mögliche Werte:
    • Wahr: Zeitfenster ist verfügbar.
    • Falsch: Zeitfenster ist nicht verfügbar.

    Datentyp: Boolesch
    Ergebnis.Next_available_Slot.end_date Enddatum und -Uhrzeit des zugehörigen Termins. Die Zeitzone basiert auf dem Wert in time_zoneParameter.

    Datentyp: Zeichenfolge

    Format: JJJJ-MM-TT hh:mm:ss
    Ergebnis.Next_available_Slot.end_date_Display Enddatum und -Uhrzeit des zugehörigen Termins anzeigen. Die Zeitzone basiert auf dem Wert in time_zone_display_valueParameter.

    Datentyp: Zeichenfolge
    Ergebnis.next_available_Slot.end_dateUTC Enddatum und -Uhrzeit des zugehörigen Termins in UTC-Zeit.

    Datentyp: Zeichenfolge

    Format: JJJJ-MM-TT hh:mm:ss
    Ergebnis.Next_available_Slot.Start_date Startdatum und -Uhrzeit des zugehörigen Termins. Die Zeitzone basiert auf dem Wert in time_zoneParameter.

    Datentyp: Zeichenfolge

    Format: JJJJ-MM-TT hh:mm:ss
    Ergebnis.Next_available_Slot.Start_date_Display Zeigen Sie Startdatum und -Uhrzeit des zugehörigen Termins an. Die Zeitzone basiert auf dem Wert in time_zone_display_valueParameter.

    Datentyp: Zeichenfolge
    Ergebnis.next_available_Slot.Start_dateUTC Startdatum und -Uhrzeit des zugehörigen Termins in UTC-Zeit.

    Datentyp: Zeichenfolge

    Format: JJJJ-MM-TT hh:mm:ss
    result.no_appt_available Kennzeichnung, die angibt, ob für das angegebene Datum und die angegebene Uhrzeit weitere Terminfenster verfügbar sind.
    Mögliche Werte:
    • Wahr: Weitere Terminzeitfenster sind verfügbar.
    • Falsch: Es sind keine weiteren Terminzeitfenster verfügbar.

    Datentyp: Boolesch
    Ergebnis.Erfolg Kennzeichnung, die angibt, ob der Endpunktaufruf erfolgreich war.
    Mögliche Werte:
    • Wahr: Endpunktaufruf war erfolgreich.
    • Falsch: Endpunktaufruf fehlgeschlagen.

    Datentyp: Boolesch
    Ergebnis.Time_Zone Zeitzone, in der die Terminfenster gerendert wurden. Basierend auf den Werten in der Konfiguration des Terminbuchungsservice.

    Datentyp: Zeichenfolge
    Ergebnis.time_Zone_Display_value Zeitzone anzeigen, in der die Terminfenster gerendert wurden. Basierend auf den Werten in der Konfiguration des Terminbuchungsservice.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird.

    curl "http://instance.servicenow.com/api/sn_apptmnt_booking/v1/appointment/availability" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"start_date\": \"2023-02-05 05:00:00\",
  \"end_date\": \"2023-02-07 04:59:59\",
  \"location\": \"32e8499cdb2d2200d75270f5bf9619d6\",
  \"catalog_id\": \"e4c1116b3b810300ce8a4d72f3efc40f\",
  \"opened_for\": \"6816f79cc0a8016401c5a33be04be441\",
  \"full_day\": false,
  \"task_table\": \"wm_order\",
  \"view\": \"portal\",
  \"get_next_available_slot\": true,
  \"use_read_replica\": true,
  \"service_config_rule\": \"f7d5d98f437c21105e0dbcba6ab8f2fc\"
}" \
--user 'username':'password

    Antwort:

    {
"result": {
  "success": true,
  "availability": [
    {
      "start_date": "2023-02-06 09:00:00",
      "end_date": "2023-02-06 11:00:00",
      "start_date_display": "09:00",
      "end_date_display": "11:00",
      "start_dateUTC": "2023-02-06 14:00:00",
      "end_dateUTC": "2023-02-06 16:00:00",
      "available": false
    },
    {
      "start_date": "2023-02-06 13:00:00",
      "end_date": "2023-02-06 15:00:00",
      "start_date_display": "13:00",
      "end_date_display": "15:00",
      "start_dateUTC": "2023-02-06 18:00:00",
      "end_dateUTC": "2023-02-06 20:00:00",
      "available": false
    },
    {
      "start_date": "2023-02-06 15:00:00",
      "end_date": "2023-02-06 17:00:00",
      "start_date_display": "15:00",
      "end_date_display": "17:00",
      "start_dateUTC": "2023-02-06 20:00:00",
      "end_dateUTC": "2023-02-06 22:00:00",
      "available": false
    }
  ],
  "has_more": false,
  "no_appt_available": true,
  "time_zone": "US/Eastern",
  "time_zone_display_value": "US/Eastern",
  "next_available_slot": {
    "start_date": "2023-02-10 13:00:00",
    "end_date": "2023-02-10 15:00:00",
    "start_date_display": "13:00",
    "end_date_display": "15:00",
    "start_dateUTC": "2023-02-10 18:00:00",
    "end_dateUTC": "2023-02-10 20:00:00",
    "available": true
}