API „Termin öffnen“

Die Termin Offen API ist eine Telekommunikations-API, mit der Sie mit der Terminbuchungsanwendung interagieren können. Verwenden Sie diese API, um Termine zu buchen und verfügbare Zeitfenster zu durchsuchen.

Die Termin Offen API ist ein ServiceNow® Implementierung der Open API TMForum TMF646 Termin-REST API-Spezifikation und ist von TM Forum zertifiziert. Diese Implementierung basiert auf TMF646 Termin-API – REST-Spezifikation R16.0.1 .

Diese API erfordert die folgenden Plugins, die auf der verfügbar sind ServiceNow Store.

• Terminbuchung (com.snc.appointment_booking)
• Field Service Management (com.snc.work_management_pa)
• Außendienst-Management für Telekommunikation (com.sn_fsmt)
• Offene APIs für Telekommunikation (com.sn_tmf_api)

Vor der Verwendung dieser API müssen die Terminbuchungskonfiguration und die Servicekonfiguration eingerichtet werden. Darüber hinaus muss eine Aufgabe vorhanden sein, für die der Termin gebucht wird.

Diese API wird in bereitgestellt sn_tmf_api Namespace. Der aufrufende Anwender muss über die Rolle sn_tmf_api.appointment_Integrator verfügen.

Termin offen – GET /api/sn_tmf_api/appointment/searchTimeSlot

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

URL-Format

/api/sn_tmf_api/appointment/searchTimeSlot

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter

Name	Beschreibung
Keine

Tabelle : 2. Abfrageparameter

Name	Beschreibung
catalog_id	Erforderlich. SYS_ID des Datensatzerstellers, der mit einer Konfiguration des Terminbuchungsservice konfiguriert ist. Datentyp: Zeichenfolge Tabelle: Datensatzersteller [sc_Cat_item_Producer]
end_date	Erforderlich. Enddatum und -Uhrzeit des Zeitraums, in dem Sie nach dem Termin suchen möchten. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 12:00:00 .
location	SYS_ID des Standorts des Termins. Tabelle: Standort [cmn_location] Datentyp: Zeichenfolge Standard: Gibt alle Standorte zurück, wenn nicht angegeben.
opened_for	Erforderlich. SYS_ID des Anwenders, für den der Termin gebucht wird. Tabelle: Kontakt [Customer_contact] Datentyp: Zeichenfolge
start_date	Erforderlich. Startdatum und -Uhrzeit des Zeitraums, in dem Sie nach dem Termin suchen möchten. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:00:00 .

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
VerfügbarZeitfenster	Liste der Terminfenster innerhalb des angegebenen angeforderten Zeitblocks. Datentyp: Array von Objekten 'availableTimeSlot': [ { "available": Boolean, "end_date": "String", "end_date_display": "String", "end_dateUTC": "String", "start_date": "String", "start_date_display": "String", "start_dateUTC": "String" } ]
VerfügbarZeitfenster.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
VerfügbarTimeSlot.end_date	Enddatum und -Uhrzeit des zugehörigen Termins. Die Zeitzone basiert auf dem Wert in timeZoneParameter. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 2025 31.01.2009 09:35:43.
VerfügbarTimeSlot.end_date_Display	Enddatum und -Uhrzeit des zugehörigen Termins anzeigen. Die Zeitzone basiert auf dem Wert in timeZoneParameter. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 2025 31.01.2009 09:35:43.
VerfügbarTimeSlot.end_dateUTC	Enddatum und -Uhrzeit des zugehörigen Termins. Datentyp: Zeichenfolge Format: UTC
VerfügbarTimeSlot.Start_date	Startdatum und -Uhrzeit des zugehörigen Termins. Spiegelt den Wert von wider timeZoneParameter. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 2025 31.01.2009 09:35:43.
VerfügbarTimeSlot.Start_date_Display	Zeigen Sie Startdatum und -Uhrzeit des zugehörigen Termins an. Spiegelt den Wert von wider timeZoneParameter. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 2025 31.01.2009 09:35:43.
VerfügbarTimeSlot.Start_dateUTC	Startdatum und -Uhrzeit des zugehörigen Termins. Datentyp: Zeichenfolge Format: UTC
hasMore	Kennzeichnung, die angibt, ob nach Rückgabe des Grenzwerts weitere Terminfenster abgerufen werden sollen. Der Grenzwert ist in der Terminbuchungseigenschaft sn_apptmnt_booking.max_Termine_Returned (Standard: 100) angegeben. Siehe Appointment booking components Um weitere Details zu dieser Eigenschaft zu erhalten. Mögliche Werte: Wahr: Es können weitere Terminfenster abgerufen werden. Falsch: Es sind keine weiteren Terminfenster verfügbar. Datentyp: Boolesch
NoApptVerfügbar	Kennzeichnung, die angibt, ob für das angegebene Datum und die angegebene Uhrzeit weitere Terminfenster verfügbar sind. Gültige Werte: Wahr: Für das angegebene Datum und die angegebene Uhrzeit sind weitere Terminfenster verfügbar. Falsch: Für das angegebene Datum und die angegebene Uhrzeit sind keine weiteren Terminfenster verfügbar. Datentyp: Boolesch
Suchergebnis	Ergebnisse für die Terminverfügbarkeit innerhalb des festgelegten Suchzeitfensters. Mögliche Werte: Erfolg fehlgeschlagen Datentyp: Zeichenfolge
status	Abschlussstatus der Suche nach verfügbaren Zeitfenstern. Beispiel: Fertig. Datentyp: Zeichenfolge
Zeitzone	Zeitzone, die beim Buchen oder Aktualisieren des angegebenen Terminfensters verwendet wird. Datumstyp: Zeichenfolge Format: Format für Land/Stadt oder Region, z. B. USA/Osten

cURL-Anforderung

Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird.

curl --location --request GET 'https://instance.service-now.com/api/sn_tmf_api/appointment/searchTimeSlot?
start_date=2024-07-10 09:00:00&end_date=2024-07-20 23:00:00&catalog_id=ada50a93f0220210f8776517d8c8e776&
opened_for=51670151c35420105252716b7d40ddfe&location=f48b21850a0a0ba7004182b18099696d ' \
--user 'username':'password'

Ergebnis:

{
  "searchResult": "success",
  "status": "done",
  "availableTimeSlot": [
    {
      "start_date": "2024-07-10 09:00:00",
      "end_date": "2024-07-10 12:00:00",
      "start_date_display": "09:00",
      "end_date_display": "12:00",
      "start_dateUTC": "2024-07-10 16:00:00",
      "end_dateUTC": "2024-07-10 19:00:00",
      "available": false
    },
    {
      "start_date": "2024-07-11 13:00:00",
      "end_date": "2024-07-11 16:00:00",
      "start_date_display": "13:00",
      "end_date_display": "16:00",
      "start_dateUTC": "2024-07-11 20:00:00",
      "end_dateUTC": "2024-07-11 23:00:00",
      "available": true
    },
    {
      "start_date": "2024-07-12 09:00:00",
      "end_date": "2024-07-12 12:00:00",
      "start_date_display": "09:00",
      "end_date_display": "12:00",
      "start_dateUTC": "2024-07-12 16:00:00",
      "end_dateUTC": "2024-07-12 19:00:00",
      "available": true
    },
    {
      "start_date": "2024-07-12 13:00:00",
      "end_date": "2024-07-12 16:00:00",
      "start_date_display": "13:00",
      "end_date_display": "16:00",
      "start_dateUTC": "2024-07-12 20:00:00",
      "end_dateUTC": "2024-07-12 23:00:00",
      "available": true
    },
    {
      "start_date": "2024-07-19 13:00:00",
      "end_date": "2024-07-19 16:00:00",
      "start_date_display": "13:00",
      "end_date_display": "16:00",
      "start_dateUTC": "2024-07-19 20:00:00",
      "end_dateUTC": "2024-07-19 23:00:00",
      "available": true
    }
  ],
  "hasMore": false,
  "noApptAvailable": false,
  "timeZone": "US/Arizona"
}

Termin offen: NACH /api/sn_tmf_api/Termin/Termin

Ermöglicht Ihnen das Buchen von Terminen für einen Arbeitsauftrag.

URL-Format

/api/sn_tmf_api/Termin/Termin

Unterstützte Anforderungsparameter

Tabelle : 7. Pfadparameter

Name	Beschreibung
Keine

Tabelle : 8. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 9. Anforderungstextparameter

Name	Beschreibung
Kategorie	Erforderlich. SYS_ID des Datensatzerstellers, der für die Konfiguration des Terminbuchungsservice konfiguriert ist. Datentyp: Zeichenfolge Tabelle: Im Feld Katalogelement der Tabelle „Konfiguration des Terminbuchungsservice“ [sn_apptmnt_booking_Service_config].
Zugehörige Entität	Erforderlich. Liste der betroffenen Arbeitsaufträge, die dem Termin zugeordnet werden sollen. Datentyp: Array von Objekten "relatedEntity": [ { "@referredType": "String" "id": "String", } ]
RelatedEntity.@referredType	Erforderlich. Typ des Artikels oder Service. Nur gültiger Wert: Arbeitsauftrag Datentyp: Zeichenfolge Tabelle: Arbeitsauftrag [wm_order]
relatedEntity.id	Erforderlich. SYS_ID der zugehörigen Entität. Datentyp: Zeichenfolge Tabelle: Arbeitsauftrag [wm_order] Standard: Gibt alle zurück, wenn „sys_ID“ nicht angegeben ist.
Zugehörige Entität.Rolle	Erforderlich. Rollenbeschreibung der zugehörigen Entität. Nur gültiger Wert: Arbeitsauftrag Datentyp: Zeichenfolge Tabelle: Arbeitsauftrag [wm_order]
Zugehörige Partei	Erforderlich. Liste der Kontakte für den Termin. Jeder Kontakt ist ein Objekt im Array. In der Anforderung muss mindestens ein Element aufgeführt werden, das Kundenaccount-Informationen enthält. Datentyp: Array von Objekten "relatedParty": [ { "@referredType": "String", "id": "String", "name": "String", "role": "String" } ]
RelatedParty.@referredType	Typ des Kunden. Nur gültiger Wert: Einzeln Datentyp: Zeichenfolge
relatedParty.id	Erforderlich. SYS_ID oder external_ID des Kontakts, der dem Arbeitsauftrag zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Kontakt [Customer_contact]
relatedParty.name	Name des Kontakts. Datentyp: Zeichenfolge Tabelle: Kontakt [Customer_contact]
ZugehörigPartei.Rolle	Erforderlich. Rolle des Kontakts. Mögliche Werte: Kunde: Der Kontakt hat eine Kundenrolle. Techniker: Der Kontakt hat eine Technikerrolle. Datentyp: Zeichenfolge Tabelle: Kontakt [Customer_contact]
RelatedPlace	Erforderlich. Liste der Standorte im Zusammenhang mit dem Termin. Datentyp: Array von Objekten "relatedPlace": [ { "@referredType": "String", "id": "String", "name": "String", "role": "String" } ]
RelatedPlace.@referredType	Erforderlich. Typ des Standorts. Beispiel: Stadt. Datentyp: Zeichenfolge Tabelle: Standorte [cmn_location]
relatedPlace.id	Erforderlich. SYS_ID des zugehörigen Standorts. Datentyp: Zeichenfolge Tabelle: Standorte [cmn_location]
relatedPlace.name	Name des Standorts, der sich auf den Kontakt bezieht. Beispiel: 251 Reddy St, Darwin, CA 93522. Datentyp: Zeichenfolge Tabelle: Standorte [cmn_location]
RelatedPlace.role	Erforderlich. Beschreibung der Standortrolle. Beispiel: Arbeitsauftrag. Datentyp: Zeichenfolge
Zeitzone	Erforderlich. Zeitzone, die bei der Buchung des angegebenen Terminfensters verwendet werden soll. Datumstyp: Zeichenfolge Format: Format für Land/Stadt oder Region, z. B. USA/Osten
Validiertfür	Erforderlich. Datumsbereich, für den der Termin gültig ist. Datentyp: Objekt "validFor": { "endDateTime": "String", "startDateTime": "String" }
ValidFor.endDateTime	Erforderlich. Enddatum und -Uhrzeit des Zeitfensters. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 2025 31.01.2009 09:35:43.
ValidFor.startDateTime	Erforderlich. Startdatum und -Uhrzeit des Zeitfensters. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 2025 31.01.2009 09:35:43.

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 : 10. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.

Tabelle : 11. Antwortkopfzeilen

Kopfzeile	Beschreibung
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

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.
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
Kategorie	SYS_ID des Datensatzerstellers, der für die Konfiguration des Terminbuchungsservice konfiguriert ist. Datentyp: Zeichenfolge Gespeichert in: Feld „Katalogelement“ der Tabelle „Konfiguration des Terminbuchungsservice“ [sn_apptmnt_booking_Service_config].
creationDate	Datum und Uhrzeit der Erstellung des Termins. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 2025 31.01.2009 09:35:43.
href	Hyperlink zum Termindatensatz. Verwenden Sie diesen Link in einer anderen API-Anforderung zum Öffnen von Terminen, um den Termin neu zu planen oder zu löschen. Datentyp: Zeichenfolge
id	SYS_ID des Termins. Datentyp: Zeichenfolge Gespeichert in der Tabelle „Konfiguration des Terminbuchungsservice“ [sn_apptmnt_booking_Service_config]
Letztes Update	Datum und Uhrzeit der letzten Aktualisierung des Termins. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 2025 31.01.2009 09:35:43.
Zugehörige Entität	Details zur zugehörigen Entität des Termins. Datentyp: Array von Objekten "relatedEntity": [ { "@referredType": "String", "id": "String", "role": "String" } ]
RelatedEntity.@referredType	Typ des Artikels oder Service. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Arbeitsauftrag“ [wm_order]
Zugehörige Entität.ID	SYS_ID der zugehörigen Entität. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Arbeitsauftrag“ [wm_order]
Zugehörige Entität.Rolle	Rollenbeschreibung der zugehörigen Entität. Möglicher Wert: Arbeitsauftrag Datentyp: Zeichenfolge Gespeichert in: Tabelle „Arbeitsauftrag“ [wm_order]
Zugehörige Partei	Liste der Kontakte für den Termin. Jeder Kontakt ist ein Objekt im Array. Datentyp: Array von Objekten "relatedParty": [ { "@referredType": "String", "id": "String", "name": " String", "role": "String" } ]
RelatedParty.@referredType	Typ des Kunden. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Kontakt“ [Customer_contact]
ZugehörigPartei.ID	SYS_ID des Kundenkontakts, der dem Arbeitsauftrag zugeordnet ist. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Kontakt“ [Customer_contact]
relatedParty.name	Name des Kundenkontakts. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Kontakt“ [Customer_contact]
ZugehörigPartei.Rolle	Rolle des Kundenkontakts. Mögliche Werte: Kunde: Der Kontakt hat eine Kundenrolle. Techniker: Der Kontakt hat eine Technikerrolle. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Kontakt“ [Customer_contact]
RelatedPlace	Standortdetails des zugehörigen Termins. Datentyp: Objekt "relatedPlace": { "@referredType": "String", "id": "String", "name": "String", "role": "String" }
RelatedPlace.@referredType	Geografische Adresse des Termins. Möglicher Wert: GeographicLocation. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Standort“ [cmn_location]
ZugehörigPlatz.ID	SYS_ID des Standorts. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Standort“ [cmn_location]
relatedPlace.name	Name des Standorts, der sich auf den Kontakt bezieht. Beispiel: 100 South Charles Street, Baltimore, MD. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Standort“ [cmn_location]
RelatedPlace.role	Rolle des Terminstandorts als Interventionsadresse. Möglicher Wert: InterventionAddress Datentyp: Zeichenfolge Gespeichert in: Tabelle „Standort“ [cmn_location]
Erfolg	Kennzeichnung, die angibt, ob die Anforderung erfolgreich war. Mögliche Werte: Wahr: Anforderung erfolgreich. Falsch: Anforderung fehlgeschlagen. Datentyp: Boolesch
Zeitzone	Zeitzone, die beim Buchen oder Aktualisieren des angegebenen Terminfensters verwendet wird. Datumstyp: Zeichenfolge Format: Format für Land/Stadt oder Region, z. B. USA/Osten
Validiertfür	Datumsbereich, für den der Termin gültig ist. Datentyp: Objekt "validFor": { "endDateTime": "String" "startDateTime": "String" }
ValidFor.endDateTime	Enddatum und -Uhrzeit des Termins. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 2025 31.01.2009 09:35:43.
ValidFor.startDateTime	Startdatum und -Uhrzeit des Termins. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 2025 31.01.2009 09:35:43.

cURL-Anforderung

Das folgende Beispiel zeigt, wie Sie eine neue Terminbuchung erstellen.

curl "https://instance.servicenow.com/api/sn_tmf_api/appointment/appointment" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"validFor\": {
    \"startDateTime\": \"2024-08-19 09:00:00\",
    \"endDateTime\": \"2024-08-19 11:00:00\"
  },
  \"category\": \"e4c1116b3b810300ce8a4d72f3efc40f\",
  \"relatedParty\": [
    {
      \"id\": \"eaf68911c35420105252716b7d40ddde\",
      \"name\": \"Sally Thomas\",
      \"role\": \"customer\",
      \"@referredType\": \"Individual\"
    }
  ],
  \"relatedPlace\": {
    \"id\": \"25ab9c4d0a0a0bb300f7dabdc0ca7c1c\",
    \"name\": \"100 South Charles Street, Baltimore,MD\",
    \"role\": \"interventionAddress\",
    \"@referredType\": \"GeographicAddress\"
  },
  \"relatedEntity\": [
    {
      \"id\": \"48dbfbf9201f0250f877303e8a020dcd\",
      \"role\": \"work order\",
      \"@referredType\": \"WorkOrder\"
    }
  ],
  \"timeZone\": \"US/Arizona\"
}" \
--user 'username':'password'

Antwort:

{
  "validFor": {
    "startDateTime": "2024-07-19 09:00:00",
    "endDateTime": "2024-07-19 11:00:00"
  },
  "category": "e4c1116b3b810300ce8a4d72f3efc40f",
  "relatedParty": [
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "role": "customer",
      "@referredType": "Individual"
    }
  ],
  "relatedPlace": {
    "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
    "name": "100 South Charles Street, Baltimore,MD",
    "role": "interventionAddress",
    "@referredType": "GeographicAddress"
  },
  "relatedEntity": [
    {
      "id": "48dbfbf9201f0250f877303e8a020dcd",
      "role": "work order",
      "@referredType": "WorkOrder"
    }
  ],
  "timeZone": "US/Arizona",
  "success": true,
  "id": "feacb7f9201f0250f877303e8a020d38",
  "href": "api/sn_tmf_api/appointment/appointment/feacb7f9201f0250f877303e8a020d38",
  "creationDate": "2024-07-10 22:45:01",
  "lastUpdate": "2024-07-10 22:45:01"
}

Termin offen: LÖSCHEN SIE /api/sn_tmf_api/appointment/appointment/{ID}

Löscht einen Termindatensatz mit einer bestimmten ID.

URL-Format

Standard-URL: /api/sn_tmf_api/Termin/Termin/{ID}

Unterstützte Anforderungsparameter

Tabelle : 13. Pfadparameter

Name	Beschreibung
id	SYS_ID des zu löschenden Termindatensatzes. Datentyp: Zeichenfolge Tabelle: Terminbuchung [sn_apptmnt_booking_appointment_booking]

Tabelle : 14. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 15. Anforderungstextparameter (XML oder JSON)

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 : 16. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.

Tabelle : 17. Antwortkopfzeilen

Kopfzeile	Beschreibung
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

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.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)

Name

Beschreibung

Nachricht

Antwortnachricht zur Bestätigung der erfolgreichen Löschung. Erfolg: „Der Termin (<id>) wurde erfolgreich storniert.“ Fehler: „Terminstornierung fehlgeschlagen.“: Die ID kann nicht im System gefunden werden und gibt einen Statuscode 404 zurück. „Terminstornierung fehlgeschlagen.“: Der Termin befindet sich bereits im Status „Storniert“ oder „Abgeschlossen“ oder kann nicht gelöscht werden, und gibt einen Statuscode 404 zurück. „Der Termin (<id>) kann nicht storniert werden, da er über die Zeit „Abbrechen nach“ hinausgeht.“: Der Termin liegt bereits über die in der Konfiguration des Terminbuchungsservice konfigurierte Option „Abbrechen nach Zeit“ hinaus. Gibt einen 400-Statuscode zurück. Datentyp: Zeichenfolge

cURL-Anforderung

Im folgenden Beispiel wird ein Termin mit einer bestimmten ID gelöscht.

curl "http://instance.servicenow.com/api/sn_tmf_api/appointment/appointment/68cc0a5a9314521060320dd548373" \ 
--request GET\ 
--user 'username':'password' 

Antworttext:

"The appointment (68cc0a5a9314521060320dd548373cbd) is successfully cancelled."

Termin offen – GET /api/sn_tmf_api/appointment/appointment/{ID}

Ruft einen Termindatensatz ab, der einer angegebenen ID zugeordnet ist.

URL-Format

Standard-URL: /api/sn_tmf_api/Termin/Termin/{ID}

Unterstützte Anforderungsparameter

Tabelle : 19. Pfadparameter

Name	Beschreibung
id	SYS_ID des abzurufenden Termins. Datentyp: Zeichenfolge Tabelle: Terminbuchung [sn_apptmnt_booking_appointment_booking]

Tabelle : 20. Abfrageparameter

Name	Beschreibung
Kategorie	Filtern Sie den Termin nach Kategorie „sys_ID“ Datentyp: Zeichenfolge Tabelle: Standort [cmn_location] Standard: Gibt alle Termine zurück, wenn die Kategorie „sys_ID“ nicht angegeben ist.
Zugehörige Entität	Details zur zugehörigen Entität, die dem Arbeitsauftrag zugeordnet ist. Datentyp: Objekt "relatedEntity": { "id": "String" }
relatedEntity.id	Erforderlich. SYS_ID der zugehörigen Entität. Datentyp: Zeichenfolge Tabelle: Arbeitsauftrag [wm_order] Standard: Gibt alle zurück, wenn „sys_ID“ nicht angegeben ist.
Zugehörige Partei	Filtern Sie den Termin nach der sys_ID der zugehörigen Partei, die dem Termin zugeordnet ist. Datentyp: Objekt "relatedParty": { "id": "String", "name": "String" } Standard: Gibt alle Termine zurück, wenn relatedPartyIst nicht angegeben.
relatedParty.id	SYS_ID der zugehörigen Partei. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]
relatedParty.name	Name der zugehörigen Partei. Datentyp: Zeichenfolge
RelatedPlace	Filtern Sie den Termin nach dem Ort, an dem der Service oder die Reparatur geplant ist. Datentyp: Objekt "relatedPlace": { "id": "String" } Standard: Gibt alle Termine zurück, wenn relatedPlaceIst nicht angegeben.
relatedPlace.id	SYS_ID des zugehörigen Orts. Datentyp: Zeichenfolge Tabelle: Standort [cmn_location]
Validiertfür	Filtern Sie den Termin nach einem Datumsbereich, für den der Termin gültig ist. Datentyp: Objekt "validFor": { "endDateTime": "String", "startDateTime": "String" } Standard: Gibt alle Termine zurück, wenn validForIst nicht angegeben.
ValidFor.endDateTime	Enddatum und -Uhrzeit des Termins. Nur Termine mit dem angegebenen Enddatum und der angegebenen Endzeit werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 2025 31.01.2009 09:35:43. Tabelle: Standort [cmn_location]
ValidFor.startDateTime	Startdatum und -Uhrzeit des Termins. Nur Termine mit dem angegebenen Startdatum und der angegebenen Startzeit werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 2025 31.01.2009 09:35:43. Tabelle: Standort [cmn_location]

Tabelle : 21. Anforderungstextparameter (XML oder JSON)

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 : 22. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.

Tabelle : 23. Antwortkopfzeilen

Kopfzeile	Beschreibung
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

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.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antwort-Haupttexts

Name	Beschreibung
Kategorie	SYS_ID des Datensatzerstellers, der für die Konfiguration des Terminbuchungsservice konfiguriert ist. Datentyp: Zeichenfolge Gespeichert in: Feld „Katalogelement“ der Tabelle „Konfiguration des Terminbuchungsservice“ [sn_apptmnt_booking_Service_config].
creationDate	Datum und Uhrzeit der Erstellung des Termins. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 2025 31.01.2009 09:35:43.
href	Hyperlink zum Termindatensatz. Verwenden Sie diesen Link in einer anderen API-Anforderung zum Öffnen von Terminen, um den Termin neu zu planen oder zu löschen. Datentyp: Zeichenfolge
id	SYS_ID des Termins. Datentyp: Zeichenfolge Gespeichert in der Tabelle „Konfiguration des Terminbuchungsservice“ [sn_apptmnt_booking_Service_config]
Letztes Update	Datum und Uhrzeit der letzten Aktualisierung des Termins. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 2025 31.01.2009 09:35:43.
Zugehörige Entität	Details zur zugehörigen Entität des Termins. Datentyp: Array von Objekten "relatedEntity": [ { "@referredType": "String", "id": "String", "role": "String" } ]
RelatedEntity.@referredType	Typ des Artikels oder Service. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Arbeitsauftrag“ [wm_order]
Zugehörige Entität.ID	SYS_ID der zugehörigen Entität. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Arbeitsauftrag“ [wm_order]
Zugehörige Entität.Rolle	Rollenbeschreibung der zugehörigen Entität. Möglicher Wert: Arbeitsauftrag Datentyp: Zeichenfolge Gespeichert in: Tabelle „Arbeitsauftrag“ [wm_order]
Zugehörige Partei	Liste der Kontakte für den Termin. Jeder Kontakt ist ein Objekt im Array. Datentyp: Array von Objekten "relatedParty": [ { "@referredType": "String", "id": "String", "name": " String", "role": "String" } ]
RelatedParty.@referredType	Typ des Kunden. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Kontakt“ [Customer_contact]
ZugehörigPartei.ID	SYS_ID des Kundenkontakts, der dem Arbeitsauftrag zugeordnet ist. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Kontakt“ [Customer_contact]
relatedParty.name	Name des Kundenkontakts. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Kontakt“ [Customer_contact]
ZugehörigPartei.Rolle	Rolle des Kundenkontakts. Mögliche Werte: Kunde: Der Kontakt hat eine Kundenrolle. Techniker: Der Kontakt hat eine Technikerrolle. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Kontakt“ [Customer_contact]
RelatedPlace	Standortdetails des zugehörigen Termins. Datentyp: Objekt "relatedPlace": { "@referredType": "String", "id": "String", "name": "String", "role": "String" }
RelatedPlace.@referredType	Geografische Adresse des Termins. Möglicher Wert: GeographicLocation. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Standort“ [cmn_location]
ZugehörigPlatz.ID	SYS_ID des Standorts. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Standort“ [cmn_location]
relatedPlace.name	Name des Standorts, der sich auf den Kontakt bezieht. Beispiel: 100 South Charles Street, Baltimore, MD. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Standort“ [cmn_location]
RelatedPlace.role	Rolle des Terminstandorts als Interventionsadresse. Möglicher Wert: InterventionAddress Datentyp: Zeichenfolge Gespeichert in: Tabelle „Standort“ [cmn_location]
Validiertfür	Datumsbereich, für den der Termin gültig ist. Datentyp: Objekt "validFor": { "endDateTime": "String" "startDateTime": "String" }
ValidFor.endDateTime	Enddatum und -Uhrzeit des Termins. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 2025 31.01.2009 09:35:43.
ValidFor.startDateTime	Startdatum und -Uhrzeit des Termins. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 2025 31.01.2009 09:35:43.

cURL-Anforderung

Das folgende Beispiel gibt Termindetails gemäß der angegebenen Termindatensatz-ID zurück.

curl "http://instance.servicenow.com/api/sn_tmf_api/appointment/appointment/201071ad4f80d210f8992fec52ce0ba9" \ 
--request GET\ 
--user 'username':'password'

Antworttext:

[
  {
    "id": "201071ad4f80d210f8992fec52ce0ba9",
    "href": "api/sn_tmf_api/appointment/appointment/201071ad4f80d210f8992fec52ce0ba9",
    "validFor": {
      "startDateTime": "2024-08-16 17:00:00",
      "endDateTime": "2024-08-16 19:00:00"
    },
    "category": "4a34a64d4f4c1210f8992fec52ce0b63",
    "relatedParty": [
      {
        "id": "eaf68911c35420105252716b7d40ddde",
        "name": " null",
        "role": "customer",
        "@referredType": "Individual"
      }
    ],
    "relatedPlace": {
      "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
      "name": "100 South Charles Street, Baltimore,MD",
      "role": "interventionAddress",
      "@referredType": "Individual"
    },
    "relatedEntity": [
      {
        "id": "b440a5694f40d210f8992fec52ce0ba3",
        "role": "work order",
        "@referredType": "WorkOrder"
      }
    ],
    "creationDate": "2024-08-16 00:39:22",
    "lastUpdate": "2024-08-16 00:39:22"
  }
]

Termin offen – GET /api/sn_tmf_api/appointment/appointment

Ruft eine Liste von Termindatensätzen ab.

URL-Format

Standard-URL: /api/sn_tmf_api/Termin/Termin

Unterstützte Anforderungsparameter

Tabelle : 25. Pfadparameter

Name	Beschreibung
Keine

Tabelle : 26. Abfrageparameter

Name	Beschreibung
Kategorie	Filtern Sie den Termin nach Kategorie „sys_ID“ Datentyp: Zeichenfolge Tabelle: Standort [cmn_location] Standard: Gibt alle Termine zurück, wenn die Kategorie „sys_ID“ nicht angegeben ist.
Zugehörige Entität	Details zur zugehörigen Entität, die dem Arbeitsauftrag zugeordnet ist. Datentyp: Objekt "relatedEntity": { "id": "String" }
relatedEntity.id	Erforderlich. SYS_ID der zugehörigen Entität. Datentyp: Zeichenfolge Tabelle: Arbeitsauftrag [wm_order] Standard: Gibt alle zurück, wenn „sys_ID“ nicht angegeben ist.
Zugehörige Partei	Filtern Sie den Termin nach der sys_ID der zugehörigen Partei, die dem Termin zugeordnet ist. Datentyp: Objekt "relatedParty": { "id": "String", "name": "String" } Standard: Gibt alle Termine zurück, wenn relatedPartyIst nicht angegeben.
relatedParty.id	SYS_ID der zugehörigen Partei. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]
relatedParty.name	Name der zugehörigen Partei. Datentyp: Zeichenfolge
RelatedPlace	Filtern Sie den Termin nach dem Ort, an dem der Service oder die Reparatur geplant ist. Datentyp: Objekt "relatedPlace": { "id": "String" } Standard: Gibt alle Termine zurück, wenn relatedPlaceIst nicht angegeben.
relatedPlace.id	SYS_ID des zugehörigen Orts. Datentyp: Zeichenfolge Tabelle: Standort [cmn_location]
Validiertfür	Filtern Sie den Termin nach einem Datumsbereich, für den der Termin gültig ist. Datentyp: Objekt "validFor": { "endDateTime": "String", "startDateTime": "String" } Standard: Gibt alle Termine zurück, wenn validForIst nicht angegeben.
ValidFor.endDateTime	Enddatum und -Uhrzeit des Termins. Nur Termine mit dem angegebenen Enddatum und der angegebenen Endzeit werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 2025 31.01.2009 09:35:43. Tabelle: Standort [cmn_location]
ValidFor.startDateTime	Startdatum und -Uhrzeit des Termins. Nur Termine mit dem angegebenen Startdatum und der angegebenen Startzeit werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 2025 31.01.2009 09:35:43. Tabelle: Standort [cmn_location]

Tabelle : 27. Anforderungstextparameter (XML oder JSON)

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 : 28. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 29. Antwortkopfzeilen

Kopfzeile	Beschreibung
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

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.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Kategorie	SYS_ID des Datensatzerstellers, der für die Konfiguration des Terminbuchungsservice konfiguriert ist. Datentyp: Zeichenfolge Gespeichert in: Feld „Katalogelement“ der Tabelle „Konfiguration des Terminbuchungsservice“ [sn_apptmnt_booking_Service_config].
creationDate	Datum und Uhrzeit der Erstellung des Termins. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 2025 31.01.2009 09:35:43.
href	Hyperlink zum Termindatensatz. Verwenden Sie diesen Link in einer anderen API-Anforderung zum Öffnen von Terminen, um den Termin neu zu planen oder zu löschen. Datentyp: Zeichenfolge
id	SYS_ID des Termins. Datentyp: Zeichenfolge Gespeichert in der Tabelle „Konfiguration des Terminbuchungsservice“ [sn_apptmnt_booking_Service_config]
Letztes Update	Datum und Uhrzeit der letzten Aktualisierung des Termins. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 2025 31.01.2009 09:35:43.
Zugehörige Entität	Details zur zugehörigen Entität des Termins. Datentyp: Array von Objekten "relatedEntity": [ { "@referredType": "String", "id": "String", "role": "String" } ]
RelatedEntity.@referredType	Typ des Artikels oder Service. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Arbeitsauftrag“ [wm_order]
Zugehörige Entität.ID	SYS_ID der zugehörigen Entität. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Arbeitsauftrag“ [wm_order]
Zugehörige Entität.Rolle	Rollenbeschreibung der zugehörigen Entität. Möglicher Wert: Arbeitsauftrag Datentyp: Zeichenfolge Gespeichert in: Tabelle „Arbeitsauftrag“ [wm_order]
Zugehörige Partei	Liste der Kontakte für den Termin. Jeder Kontakt ist ein Objekt im Array. Datentyp: Array von Objekten "relatedParty": [ { "@referredType": "String", "id": "String", "name": " String", "role": "String" } ]
RelatedParty.@referredType	Typ des Kunden. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Kontakt“ [Customer_contact]
ZugehörigPartei.ID	SYS_ID des Kundenkontakts, der dem Arbeitsauftrag zugeordnet ist. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Kontakt“ [Customer_contact]
relatedParty.name	Name des Kundenkontakts. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Kontakt“ [Customer_contact]
ZugehörigPartei.Rolle	Rolle des Kundenkontakts. Mögliche Werte: Kunde: Der Kontakt hat eine Kundenrolle. Techniker: Der Kontakt hat eine Technikerrolle. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Kontakt“ [Customer_contact]
RelatedPlace	Standortdetails des zugehörigen Termins. Datentyp: Objekt "relatedPlace": { "@referredType": "String", "id": "String", "name": "String", "role": "String" }
RelatedPlace.@referredType	Geografische Adresse des Termins. Möglicher Wert: GeographicLocation. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Standort“ [cmn_location]
ZugehörigPlatz.ID	SYS_ID des Standorts. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Standort“ [cmn_location]
relatedPlace.name	Name des Standorts, der sich auf den Kontakt bezieht. Beispiel: 100 South Charles Street, Baltimore, MD. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Standort“ [cmn_location]
RelatedPlace.role	Rolle des Terminstandorts als Interventionsadresse. Möglicher Wert: InterventionAddress Datentyp: Zeichenfolge Gespeichert in: Tabelle „Standort“ [cmn_location]
Validiertfür	Datumsbereich, für den der Termin gültig ist. Datentyp: Objekt "validFor": { "endDateTime": "String" "startDateTime": "String" }
ValidFor.endDateTime	Enddatum und -Uhrzeit des Termins. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 2025 31.01.2009 09:35:43.
ValidFor.startDateTime	Startdatum und -Uhrzeit des Termins. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 2025 31.01.2009 09:35:43.

cURL-Anforderung

Das folgende Beispiel zeigt, wie Sie mit der Methode „Termin ABRUFEN“ eine Liste von Terminen zurückgeben.

curl "http://instance.servicenow.com/api/sn_tmf_api/appointment/appointment" \ 
--request GET\ 
--user 'username':'password' 

Der Antworttext enthält die Details zweier verschiedener Termine, die in der Konfiguration des Terminbuchungsservice konfiguriert sind:

[
  {
    "id": "201071ad4f80d210f8992fec52ce0ba9",
    "href": "api/sn_tmf_api/appointment/appointment/201071ad4f80d210f8992fec52ce0ba9",
    "validFor": {
      "startDateTime": "2024-08-16 17:00:00",
      "endDateTime": "2024-08-16 19:00:00"
    },
    "category": "4a34a64d4f4c1210f8992fec52ce0b63",
    "relatedParty": [
      {
        "id": "eaf68911c35420105252716b7d40ddde",
        "name": " null",
        "role": "customer",
        "@referredType": "Individual"
      }
    ],
    "relatedPlace": {
      "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
      "name": "100 South Charles Street, Baltimore,MD",
      "role": "interventionAddress",
      "@referredType": "Individual"
    },
    "relatedEntity": [
      {
        "id": "b440a5694f40d210f8992fec52ce0ba3",
        "role": "work order",
        "@referredType": "WorkOrder"
      }
    ],
    "creationDate": "2024-08-16 00:39:22",
    "lastUpdate": "2024-08-16 00:39:22"
  },
  {
    "id": "25c012c07f5c5610f8994fa63c866523",
    "href": "api/sn_tmf_api/appointment/appointment/25c012c07f5c5610f8994fa63c866523",
    "validFor": {
      "startDateTime": "2024-08-26 17:00:00",
      "endDateTime": "2024-08-26 19:00:00"
    },
    "category": "4a34a64d4f4c1210f8992fec52ce0b63",
    "relatedParty": [
      {
        "id": "eaf68911c35420105252716b7d40ddde",
        "name": " null",
        "role": "customer",
        "@referredType": "Individual"
      }
    ],
    "relatedPlace": {
      "id": "f48b21850a0a0ba7004182b18099696d",
      "name": "11251 Rancho Carmel Drive, San Diego,CA",
      "role": "interventionAddress",
      "@referredType": "Individual"
    },
    "relatedEntity": [
      {
        "id": "c0b09a047f109610f8994fa63c8665b4",
        "role": "work order",
        "@referredType": "WorkOrder"
      }
    ],
    "creationDate": "2024-08-23 22:18:43",
    "lastUpdate": "2024-08-23 22:18:43"
  }
]

Termin offen: PATCH /api/sn_tmf_api/appointment/appointment/{ID}

Planen Sie Termine mit einer bestimmten ID für einen Arbeitsauftrag neu.

URL-Format

Standard-URL: PATCH /api/sn_tmf_api/appointment/date/{ID}

Unterstützte Anforderungsparameter

Tabelle : 31. Pfadparameter

Name	Beschreibung
id	SYS_ID des Termins, der neu geplant werden soll. Datentyp: Zeichenfolge Tabelle: Terminbuchung [sn_apptmnt_booking_appointment_booking]

Tabelle : 32. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 33. Anforderungstext-Parameter (JSON)

Name	Beschreibung
note	Wenn Sie den Termin absagen, können Sie hier Arbeitsnotizen hinzufügen. Aktualisiert die Arbeitsnotizen des Arbeitsauftrags und die Nachricht des Termins. Datentyp: Array von Objekten "note": [ { "author": "String", "date": "String", "text": "String" } ] Gespeichert in: Tabelle „Terminbuchung“ [sn_apptmnt_booking_appointment_booking]
note.author	Name der Person, die die Notiz schreibt. Datentyp: Zeichenfolge
Hinweis.Datum	Datum und Uhrzeit der Veröffentlichung der Notiz. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 2018-02-04T11:00:18.071Z.
Hinweis.Text	Beschreibender Text über den Arbeitsauftrag, der an den Termin angehängt ist. Zum Beispiel Aktualisierungen des Fortschritts des Arbeitsauftrags. Datentyp: Zeichenfolge
status	Status des Termins. Gültige Werte: Storniert: Die Terminverschiebung wurde storniert. Abgeschlossen: Der neu geplante Termin ist abgeschlossen. Bestätigt: Die Terminverschiebung wird akzeptiert und gebucht. Neu: Die Anforderung zur Terminumplanung wurde kürzlich erstellt. Ausstehend: Die Terminverschiebung steht aus. Bereit: Die Terminverschiebung wird angefordert. Datentyp: Zeichenfolge
Validiertfür	Filtern Sie den Termin nach einem Datumsbereich, für den der Termin gültig ist. Datentyp: Objekt "validFor": { "endDateTime": "String", "startDateTime": "String" } Standard: Gibt alle Termine zurück, wenn validForIst nicht angegeben.
ValidFor.endDateTime	Enddatum und -Uhrzeit des Termins. Nur Termine mit dem angegebenen Enddatum und der angegebenen Endzeit werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 2025 31.01.2009 09:35:43. Tabelle: Standort [cmn_location]
ValidFor.startDateTime	Startdatum und -Uhrzeit des Termins. Nur Termine mit dem angegebenen Startdatum und der angegebenen Startzeit werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 2025 31.01.2009 09:35:43. Tabelle: Standort [cmn_location]

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 : 34. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.

Tabelle : 35. Antwortkopfzeilen

Kopfzeile	Beschreibung
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

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 : 36. 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 (JSON)

Name	Beschreibung
creationDate	Datum und Uhrzeit der Erstellung des Termins. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 2025 31.01.2009 09:35:43.
href	Eindeutiger Referenzlink des Termins. Sie können diesen Link in einer anderen Anforderung verwenden, um einen Termin zu erhalten. Datentyp: Zeichenfolge
id	SYS_ID des Termins, der neu geplant wurde. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Terminbuchung“ [sn_apptmnt_booking_appointment_booking]
Letztes Update	Datum und Uhrzeit der letzten Aktualisierung des Termins. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 2025 31.01.2009 09:35:43.
Grund	Zweck der Aktualisierung des Termins. Mögliche Werte: „Termin neu geplant.“: Die PATCH-Methode wurde verwendet, um den Termin neu zu planen. „Der Termin (ID) wurde erfolgreich storniert.“: Die PATCH-Methode wurde verwendet, um den Termin zu stornieren. Datentyp: Zeichenfolge
Zugehörige Partei	Kundendetails des zugehörigen Termins. Datentyp: Array von Objekten "relatedParty": [ { "@referredType": "String", "id": "String", "name": "String", "role": "String" } ]
relatedParty.id	SYS_ID des Kundenkontakts. Datentyp: Zeichenfolge Gespeichert in: Tabelle „Kontakt“ [Customer_contact]
relatedParty.name	Name des Kundenkontakts. Datentyp: Zeichenfolge
RelatedPlace.@referredType	Typ des Kunden. Datentyp: Zeichenfolge Nur möglicher Wert: Einzeln
ZugehörigPartei.Rolle	Rolle des Kontakts. Datentyp: Zeichenfolge Nur möglicher Wert: Kontakt
Erfolg	Kennzeichnung, die angibt, ob die Anforderung erfolgreich war. Mögliche Werte: Wahr: Der Termin wurde erfolgreich neu geplant. Falsch: Der Termin konnte nicht neu geplant werden. Datentyp: Boolesch

cURL-Anforderung

Das folgende Beispiel zeigt, wie Sie eine PATCH-Methode verwenden, um einen Termin mit einer bestimmten ID neu zu planen.

curl -X POST 'https://instance.service-now.com/api/sn_tmf_api/appointment/appointment/68cc0a5a9314521060320dd548373cbd ' \ 
-H "Accept: application/json" \ 
-H "Content-Type: application/json" \ 
-u "username":"password" \ 
-data {
  "validFor": { 
      "startDateTime": "2024-07-30 00:0:00", 
      "endDateTime": "2024-08-30 00:00:00" 
              }
  "note": {
      "date": "85388c25b71011104eed4643ae11a993",
      "author": "Sarah Johnson",
      "text": "customer"
    }
  "state": "active"
   }
  ]
}

Der Antworttext zeigt eine Erfolgsmeldung an, dass der Termin neu geplant wurde.

{
  "relatedParty": [
    {
      "id": "85388c25b71011104eed4643ae11a993",
      "name": "Sarah Johnson",
      "role": "customer",
      "@referredType": "Individual"
    }
  ],
  "success": true,
  "reason": "Appointment rescheduled!",
  "id": "68cc0a5a9314521060320dd548373cbd",
  "href": "api/sn_tmf_api/appointment/appointment/68cc0a5a9314521060320dd548373cbd",
  "creationDate": "2024-08-30 20:56:54",
  "lastUpdate": "2024-08-30 20:56:54"
}