---
sourceDocument: Xanadu-API-Referenz
sourceDocumentLink: https://www.servicenow.com/docs/r/de-DE/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - de-DE

ft:publication_title :

    - Xanadu-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Termin offen: POST /sn_tmf_api/appointment/appointment

# Termin offen: POST /sn_tmf_api/appointment/appointment {#ariaid-title1}

* Freigeben Version: Xanadu
* 
* Aktualisiert 1. August 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 Minuten Lesedauer

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

## URL-Format

/api/sn_tmf_api/appointment/appointment

## Unterstützte Anforderungsparameter

{#apptOpen-POST-appointment__table_lr2_mwt_dcc__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 1. Pfadparameter]

{#apptOpen-POST-appointment__table_lr2_mwt_dcc} {#apptOpen-POST-appointment__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 2. Abfrageparameter]

{#apptOpen-POST-appointment__entry__10}{#apptOpen-POST-appointment__serviceTest-response-testMeasureDefinition.thresholdRule.consequence.validFor}{#apptOpen-POST-appointment__serviceTest-response-testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime}{#apptOpen-POST-appointment__serviceTest-response-testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime}

| Name | Beschreibung |
|-|-|
| category | Erforderlich. Die sys_id des Datensatzerstellers, der für die Konfiguration des Terminbuchungsservice konfiguriert ist Der Datensatzersteller ist im Feld Katalogelement in der zugehörigen Tabelle mit der Konfiguration des Terminbuchungsservice -- Konfiguration des Terminbuchungsservice \[sn_apptmnt_booking_service_config\] definiert. Datentyp: Zeichenfolge |
| ZugehörigeEntität | Liste der betroffenen Arbeitsaufträge. Datentyp: Array "relatedEntity": [ { "id": "String", "@referredType": "String" } ] |
| relatedEntity.id | Erforderlich. Die sys_id des Datensatzes in der Tabelle „Arbeitsauftrag" \[wm_order\]. Datentyp: Zeichenfolge |
| relatedEntity.@referredType | Typ des Artikels oder Services. Beispiel: `Arbeitsauftrag`. Datentyp: Zeichenfolge |
| ZugehörigeEntität.Rolle | Beschreibung der Entitätsrolle. Beispiel: `Arbeitsauftrag`. Datentyp: Zeichenfolge |
| Zugehörige Partei | Liste der Kontakte für den Termin Jeder Kontakt ist ein Objekt im Array. In der Anforderung muss mindestens ein Artikel aufgeführt werden, der Kunden-Account-Informationen enthält. Datentyp: Array "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String" } ] |
| relatedParty.id | Erforderlich. Die sys_id oder external_id des Kundenkontakts, der dem Arbeitsauftrag zugeordnet ist. Befindet sich in der Kontakttabelle \[customer_contact\]. Datentyp: Zeichenfolge |
| relatedParty.name | Name des Kunden Datentyp: Zeichenfolge |
| zugehörigepartei.@referenztyp | Typ des Kunden Beispiel: `Einzelperson`. Datentyp: Zeichenfolge |
| zugehörigePartei.Rolle | Erforderlich. Vordefinierte Rolle des Kontakts. Beispiel: `Kunde`. Datentyp: Zeichenfolge |
| ZugehörigerOrt | Liste der Standorte im Zusammenhang mit dem Termin "relatedPlace": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String" } ] Datentyp: Array |
| relatedPlace.id | Erforderlich. Die sys_id des Orts, der in der Tabelle „Standorte" \[cmn_location\] aufgeführt ist. Datentyp: Zeichenfolge |
| relatedPlace.name | Der Name des Ortes, der in der Standorttabelle \[cmn_location\] aufgeführt ist. Beispiel: `251 Reddy St, Darwin, CA 93522`. Datentyp: Zeichenfolge |
| relatedplace.@referredType | Standorttyp Beispiel: `Stadt`. Datentyp: Zeichenfolge |
| ZugehörigerOrt.Rolle | Beschreibung der Standortrolle. Beispiel: Arbeitsauftrag. Datentyp: Zeichenfolge |
| Zeitzone | Erforderlich. Zeitzone für die Buchung des angegebenen Terminfensters. |
| validFor | Erforderlich. Datumsbereich, für den der Termin gültig ist. Datentyp: Objekt "validFor": { "startDateTime": "String", "endDateTime": "String" } |
| validFor.startDateTime | Startdatum des Zeitfensters. Format: JJJJ-MM-TT 00:00:00. Beispiel: `2025-01-31 09:35:43`. Datentyp: Zeichenfolge |
| validFor.endDateTime | Enddatum des Zeitfensters. Format: JJJJ-MM-TT 00:00:00. Beispiel: `2025-01-31 09:35:43`. Datentyp: Zeichenfolge |
[Tabelle : 3. Anforderungstextparameter]

## 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](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#apptOpen-POST-appointment__entry__50}{#apptOpen-POST-appointment__accept-JSON-only-entry-RESTAPI}

| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
[Tabelle : 4. Anforderungskopfzeilen]

{#apptOpen-POST-appointment__entry__54}{#apptOpen-POST-appointment__content_type-JSON-only-entry-RESTAPI}

| Kopfzeile | Beschreibung |
|-|-|
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
[Tabelle : 5. Antwortkopfzeilen]

## 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 [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#apptOpen-POST-appointment__entry__58}{#apptOpen-POST-appointment__entry-200-status-code}{#apptOpen-POST-appointment__entry-500-status-code}

| 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. |
[Tabelle : 6. Statuscodes]

## Parameter des Antwort-Haupttexts

{#apptOpen-POST-appointment__entry__64}

| Name | Beschreibung |
|-|-|
| category | Die sys_id des Datensatzerstellers, der für die Konfiguration des Terminbuchungsservice konfiguriert ist Der Datensatzersteller ist im Feld Katalogelement in der zugehörigen Tabelle mit der Konfiguration des Terminbuchungsservice -- Konfiguration des Terminbuchungsservice \[sn_apptmnt_booking_service_config\] definiert. Datentyp: Zeichenfolge |
| creationDate | Datum und Uhrzeit der Erstellung des Termindatensatzes. Datentyp: Zeichenfolge |
| id | Die sys_id des erstellten Termins Befindet sich in der Tabelle „Konfigurationen für Terminbuchungsservice" \[sn_apptmnt_booking_service_config\]. Datentyp: Zeichenfolge |
| href | Relativer Link zum Termindatensatz. Datentyp: Zeichenfolge |
| lastUpdate | Datum und Uhrzeit der letzten Aktualisierung des Termindatensatzes. Datentyp: Zeichenfolge |
| ZugehörigeEntität | Liste der betroffenen Arbeitsaufträge. Datentyp: Array "relatedEntity": [ { "id": "String", "@referredType": "String" } ] |
| relatedEntity.id | Die sys_id des Datensatzes in der Tabelle „Arbeitsauftrag" \[wm_order\]. Datentyp: Zeichenfolge |
| relatedEntity.@referredType | Typ des Artikels oder Services. Datentyp: Zeichenfolge |
| ZugehörigeEntität.Rolle | Beschreibung der Entitätsrolle. Datentyp: Zeichenfolge |
| Zugehörige Partei | Liste der Kontakte für den Termin Jeder Kontakt ist ein Objekt im Array. In der Anforderung muss mindestens ein Artikel aufgeführt werden, der Kunden-Account-Informationen enthält. Datentyp: Array "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String" } ] |
| Zugehörigepartei.id | Die sys_id oder external_id des Kundenkontakts, der dem Arbeitsauftrag zugeordnet ist. Befindet sich in der Kontakttabelle \[customer_contact\]. Datentyp: Zeichenfolge |
| Zugehörigepartei.name | Name des Kunden Datentyp: Zeichenfolge |
| zugehörigepartei.@referenztyp | Typ des Kunden Datentyp: Zeichenfolge |
| zugehörigePartei.Rolle | Vordefinierte Rolle des Kontakts. Datentyp: Zeichenfolge |
| ZugehörigerOrt | Liste der Standorte im Zusammenhang mit dem Termin "relatedPlace": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String" } ] Datentyp: Array |
| ZugehörigerOrt.ID | Die sys_id des Orts, der in der Tabelle „Standorte" \[cmn_location\] aufgeführt ist. Datentyp: Zeichenfolge |
| ZugehörigerOrt.name | Der Name des Ortes, der in der Standorttabelle \[cmn_location\] aufgeführt ist. Datentyp: Zeichenfolge |
| relatedplace.@referredType | Standorttyp Datentyp: Zeichenfolge |
| ZugehörigerOrt.Rolle | Beschreibung der Standortrolle. Datentyp: Zeichenfolge |
| Zeitzone | Zeitzone für die Buchung des angegebenen Terminfensters. |
| validFor | Datumsbereich, für den der Termin gültig ist. Datentyp: Objekt "validFor": { "startDateTime": "String", "endDateTime": "String" } |
| validFor.startDateTime | Startdatum des Zeitfensters. Datentyp: Zeichenfolge |
| validFor.endDateTime | Enddatum des Zeitfensters. Datentyp: Zeichenfolge |
| Erfolg | Kennzeichnung, die angibt, ob die Anforderung erfolgreich war. Mögliche Werte: * true: Anforderung erfolgreich. * „falsch": Anforderung fehlgeschlagen. Datentyp: Boolesch |
[ ]

## 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"
    }