Tabellen-API

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 29 Minuten Lesedauer
  • Die Tabellen -API bietet Endpunkte, mit denen Sie Erstellungs-, Lese-, Aktualisierungs- und Löschvorgänge (Create, Read, Update, Delete, CRUD) für vorhandene Tabellen ausführen können.

    Der aufrufende Benutzer muss über ausreichende Rollen verfügen, um auf die Daten in der in der Anforderung angegebenen Tabelle zugreifen zu können.

    Tabelle – DELETE /now/table/{tableName}/{sys_id}

    Löscht den angegebenen Datensatz aus der angegebenen Tabelle.

    URL-Format

    URL mit Versionsangabe: /api/now/{api_version}/table/{tableName}/{sys_id}

    Standard-URL: /api/now/table/{tableName}/{sys_id}

    Hinweis:
    Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge

    sys_id Sys_id des zu löschenden Datensatzes.

    Datentyp: Zeichenfolge

    tableName Name der Tabelle, aus der der angegebene Datensatz gelöscht werden soll, zum Beispiel „Incident“ oder „Asset“.

    Datentyp: Zeichenfolge

    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    sysparm_query_no_domain Kennzeichnung, die angibt, ob die Datensatzsuche nur auf die Domänen beschränkt werden soll, für die der angemeldete Benutzer konfiguriert ist.

    Gültige Werte:

    • false: Schließt den Datensatz aus, wenn er sich in einer Domäne befindet, für die der aktuell angemeldete Benutzer nicht für den Zugriff konfiguriert ist.
    • true: Bezieht den Datensatz ein, auch wenn er sich in einer Domäne befindet, für die der aktuell angemeldete Benutzer nicht für den Zugriff konfiguriert ist.

    Datentyp: Boolesch

    Standardwert: false

    Hinweis:
    Der Parameter sysparm_query_no_domain steht nur Systemadministratoren oder Benutzern zur Verfügung, die über die Rolle query_no_domain_table_api verfügen.
    Tabelle : 3. 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 : 4. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: 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 HTTP-Antwortcodes der REST-API.

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    204 Gibt an, dass die Anforderung erfolgreich abgeschlossen wurde.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Keine

    cURL-Anforderung

    Löschen Sie einen Datensatz aus der Incident-Tabelle.

    curl "https://instance.servicenow.com/api/now/table/incident/d977b66a4f411200adf9f8e18110c7b2" \
    --request DELETE \
    --header "Accept:application/json" \
    --user 'username':'password'

    Es ist kein Antworttext vorhanden.

    None

    Tabelle – GET /now/table/{tableName}

    Ruft mehrere Datensätze für die angegebene Tabelle ab.

    Grundlegende Anweisungen finden Sie unter Vorhandene Incidents abrufen.

    URL-Format

    URL mit Versionsnummer: /api/now/{api_version}/table/{tableName}

    Standard-URL: /api/now/table/{tableName}

    Hinweis:
    Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.
    Je nach Version gibt dieser Endpunkt bei einer gültigen Abfrage unterschiedliche Ergebnisse zurück.
    • Version 1 gibt den Fehlercode 404 ohne Ergebnisse zurück.
    • Version 2 gibt den Erfolgscode 200 und ein leeres Array als Antworttext zurück.

    Datentyp: Zeichenfolge

    tableName Name der Tabelle, aus der die Datensätze abgerufen werden sollen.

    Datentyp: Zeichenfolge

    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    Name-Wert-Paare Name-Wert-Paare zum Filtern des Ergebnissatzes. Dieser Parameter und sysparm_query schließen sich gegenseitig aus. Beispielweise können Sie anstelle der Verwendung von &sysparm_query=active=true die aufrufende Anweisung mithilfe von &active=true vereinfachen. Sie können auch den Anzeigewert verwenden, wenn das Feld ein Auswahl- oder ein Referenztypfeld ist, z. B. &state=closed anstatt &state=7. Um mehrere Schlüssel-Wert-Paare anzugeben, trennen Sie sie jeweils mit einem kaufmännischen Und-Zeichen, z. B. &active=true&assigned_to=john.smith.

    Datentyp: Zeichenfolge

    sysparm_display_value Bestimmt den Typ der zurückgegebenen Daten, entweder die tatsächlichen Werte aus der Datenbank oder die Anzeigewerte der Felder. Anzeigewerte werden auf Grundlage des tatsächlichen Werts in der Datenbank und der Benutzer- oder Systemeinstellungen und Voreinstellungen geändert.
    Wenn Anzeigewerte zurückgegeben werden, hängt der zurückgegebene Wert vom Feldtyp ab.
    • Auswahlfelder: Der Datenbankwert kann eine Zahl sein, der Anzeigewert ist jedoch aussagekräftiger.
    • Datumsfelder: Der Datenbankwert liegt im UTC-Format vor, während der Anzeigewert auf der Zeitzone des Benutzers basiert.
    • Verschlüsselter Text: Der Datenbankwert ist verschlüsselt, während der Anzeigewert entsprechend dem Verschlüsselungskontext des Benutzers unverschlüsselt ist.
    • Referenzfelder: Der Datenbankwert ist sys_id, der Anzeigewert ist jedoch ein Anzeigefeld des referenzierten Datensatzes.

    Datentyp: Zeichenfolge

    Gültige Werte:

    • true: Gibt die Anzeigewerte für alle Felder zurück.
    • false: Gibt die tatsächlichen Werte aus der Datenbank zurück.
    • all: Gibt sowohl die tatsächlichen als auch die Anzeigewerte zurück.

    Standardwert: false

    Hinweis:
    Es gibt keine bevorzugte Methode zum Festlegen dieses Parameters. Das Angeben des Anzeigewerts kann jedoch zu Leistungsproblemen führen, da er nicht direkt aus der Datenbank gelesen wird und möglicherweise auf andere Felder und Datensätze verwiesen werden muss. Weitere Informationen zu Anzeigewerten und tatsächlichen Werten finden Sie unter FAQs zur Table-API (KB0534905).
    sysparm_fields Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert.

    Datentyp: Zeichenfolge

    Standard: Gibt alle Felder zurück.

    sysparm_limit Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter sysparm_offset, um den Datensatzabruf zu paginieren.

    Dieser Grenzwert wird vor der ACL-Bewertung angewendet. Erfolgt keine Datensatzrückgabe, einschließlich Datensätzen, auf die Sie Zugriff haben, ordnen Sie die Datensatzreihenfolge neu, sodass Datensätze, auf die Sie zugreifen können, zuerst zurückgegeben werden.

    Hinweis:
    Ungewöhnlich große Werte für sysparm_limit können die Systemleistung beeinträchtigen.

    Datentyp: Zahl

    Standard: 20

    Maximum: 100

    sysparm_no_count Kennzeichnung, die angibt, ob eine select count(*)-Abfrage für die Tabelle ausgeführt werden soll, um die Anzahl der Zeilen in der zugehörigen Tabelle zurückzugeben.
    Gültige Werte:
    • true: select count(*) nicht ausführen.
    • false: select count(*) ausführen.

    Datentyp: Boolesch

    Standardwert: false

    sysparm_offset Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze.

    Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie sysparm_offset=sysparm_offset+sysparm_limit zum einfachen Durchblättern aller verfügbaren Datensätze, bis das Ende aller Datensätze erreicht ist.

    Übergeben Sie keine negative Zahl im Parameter sysparm_offset.

    Datentyp: Zahl

    Standard: 0

    sysparm_query Codierte Abfrage, die zum Filtern des Ergebnissatzes verwendet wird. Sie können einen UI-Filter verwenden, um eine ordnungsgemäß codierte Abfrage zu erhalten.
    Syntax: sysparm_query=<col_name><operator><value>.
    • <col_name>: Name der Tabellenspalte, nach der gefiltert werden soll.
    • <operator>: Unterstützt die folgenden Werte:
      • =: Stimmt genau überein mit <value>.
      • !=: Stimmt nicht überein mit <value>.
      • ^: Logisches UND, mehrfache Abfrageanweisungen.
      • ^OR: Logisches ODER, mehrfache Abfrageanweisungen.
      • LIKE: <col_name> enthält die angegebene Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist.
      • STARTSWITH: <col_name> beginnt mit der angegebenen Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist.
      • ENDSWITH: <col_name> endet mit der angegebenen Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist.
      <value>: Wert, mit dem abgeglichen werden soll.

    Bei allen Parametern wird zwischen Groß- und Kleinschreibung unterschieden. Abfragen können mehr als einen Eintrag enthalten, beispielsweise sysparm_query=<col_name><operator><value>[<operator><col_name><operator><value>].

    Beispiel:

    (sysparm_query=caller_id=javascript:gs.getUserID()^active=true)

    Codierte Abfragen unterstützen auch die Funktion „Sortieren nach“. Verwenden Sie die Klauseln ORDERBY und ORDERBYDESC in sysparm_query, um Antworten anhand bestimmter Felder zu sortieren.

    Syntax:
    • ORDERBY<col_name>
    • ORDERBYDESC<col_name>

    Beispiel: sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory

    Diese Abfrage filtert alle aktiven Datensätze und sortiert die Ergebnisse in aufsteigender Reihenfolge nach Nummer und dann in absteigender Reihenfolge nach Kategorie.

    Wenn ein Teil der Abfrage ungültig ist, z. B. durch Angabe eines ungültigen Feldnamens, ignoriert die Instanz den ungültigen Teil. Es werden dann nur Zeilen unter Verwendung des gültigen Teils der Abfrage zurückgegeben. Sie können dieses Verhalten mithilfe der Eigenschaft glide.invalid_query.returns_no_rows steuern. Legen Sie diese Eigenschaft auf „true“ fest, um bei einer ungültigen Abfrage keine Zeilen zurückzugeben.
    Hinweis:
    Diese Eigenschaft glide.invalid_query.returns_no_rows steuert das Verhalten aller Abfragen in der Instanz, beispielsweise in Listen, Skripts (GlideRecord.query()) und Webservice-APIs.

    Datentyp: Zeichenfolge

    sysparm_query_category Name der Kategorie, die für Abfragen verwendet werden soll.

    Datentyp: Zeichenfolge

    sysparm_query_no_domain Kennzeichnung, die angibt, ob die Datensatzsuche nur auf die Domänen beschränkt werden soll, für die der angemeldete Benutzer konfiguriert ist.

    Gültige Werte:

    • false: Schließt den Datensatz aus, wenn er sich in einer Domäne befindet, für die der aktuell angemeldete Benutzer nicht für den Zugriff konfiguriert ist.
    • true: Bezieht den Datensatz ein, auch wenn er sich in einer Domäne befindet, für die der aktuell angemeldete Benutzer nicht für den Zugriff konfiguriert ist.

    Datentyp: Boolesch

    Standardwert: false

    Hinweis:
    Der Parameter sysparm_query_no_domain steht nur Systemadministratoren oder Benutzern zur Verfügung, die über die Rolle query_no_domain_table_api verfügen.
    sysparm_suppress_pagination_header Kennzeichnung, die angibt, ob die Link-Kopfzeile aus der Antwort entfernt werden soll. Die Link-Kopfzeile stellt verschiedene URLs zu relativen Seiten im Datensatz zur Verfügung, mit denen Sie den zurückgegebenen Datensatz paginieren können.

    Gültige Werte:

    • true: Link-Header aus der Antwort entfernen.
    • false: Link-Header nicht aus der Antwort entfernen.

    Datentyp: Boolesch

    Standardwert: false

    sysparm_view UI-Ansicht, für die die Daten gerendert werden sollen. Bestimmt die Felder, die in der Antwort zurückgegeben werden.

    Gültige Werte:

    • desktop
    • mobile
    • both

    Wenn Sie auch den Parameter sysparm_fields angeben, hat dieser Vorrang.

    Datentyp: Zeichenfolge

    Tabelle : 9. 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 : 10. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json

    Tabelle : 11. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Link Relative URLs, die auf der vorherigen Anforderung basieren, die Sie zum Durchblättern des verfügbaren Datensatzes verwenden können.

    Zum Beispiel:

    https://<instance name> .servicenow.com/api/now/table/cmdb_ci?sysparm_offset=40&sysparm_limit=1000>;rel="next"

    https://<instance name> .servicenow.com/api/now/table/cmdb_ci?sysparm_offset=40&sysparm_limit=1000>;rel="prev"

    https://<instance name> .servicenow.com/api/now/table/cmdb_ci?sysparm_offset=0&sysparm_limit=1000>;rel="first" ,

    https://<instance name> .servicenow.com/api/now/table/cmdb_ci?sysparm_offset=2780&sysparm_limit=1000>;rel="last"

    Weitere Informationen zum Parameter rel finden Sie unter https://html.spec.whatwg.org/multipage/links.html#linkTypes.
    X-Gesamtzahl Gesamtzahl der von der Abfrage zurückgegebenen Datensätze.

    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 der REST-API.

    Tabelle : 12. Statuscodes
    Statuscode Beschreibung
    200 Anforderung erfolgreich abgeschlossen. Wenn eine gültige Abfrage keine Ergebnisse zurückgibt, enthält der Antwort-Haupttext nur ein leeres Event-Array.

    Parameter des Antworttexts (JSON oder XML)

    Parameter Beschreibung
    Name-Wert-Paare Feldnamen und Werte aller Parameter innerhalb des angegebenen Datensatzes oder der in den Abfrageparametern angegebenen Datensätzen.

    cURL-Anforderung

    Rufen Sie den ersten Datensatz aus der Problemtabelle ab.

    curl "https://instance.servicenow.com/api/now/table/problem?sysparm_limit=1" \
    --request GET \
    --header "Accept:application/json" \
    --user 'username':'password'

    Die Antwort enthält die Name-Wert-Paare für den angeforderten Datensatz.

    {
      "result": [
        {
          "parent": "",
          "made_sla": "true",
          "watch_list": "",
          "upon_reject": "cancel",
          "sys_updated_on": "2016-01-19 04:52:04",
          "approval_history": "",
          "number": "PRB0000050",
          "sys_updated_by": "glide.maint",
          "opened_by": {
            "link": "https://instance.servicenow.com/api/now/table/sys_user/glide.maint",
            "value": "glide.maint"
          },
          "user_input": "",
          "sys_created_on": "2016-01-19 04:51:19",
          "sys_domain": {
            "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
            "value": "global"
          },
          "state": "4",
          "sys_created_by": "glide.maint",
          "knowledge": "false",
          "order": "",
          "closed_at": "2016-01-19 04:52:04",
          "cmdb_ci": {
            "link": "https://instance.servicenow.com/api/now/table/cmdb_ci/55b35562c0a8010e01cff22378e0aea9",
            "value": "55b35562c0a8010e01cff22378e0aea9"
          },
          "delivery_plan": "",
          "impact": "3",
          "active": "false",
          "work_notes_list": "",
          "business_service": "",
          "priority": "4",
          "sys_domain_path": "/",
          "time_worked": "",
          "expected_start": "",
          "rejection_goto": "",
          "opened_at": "2016-01-19 04:49:47",
          "business_duration": "1970-01-01 00:00:00",
          "group_list": "",
          "work_end": "",
          "approval_set": "",
          "wf_activity": "",
          "work_notes": "",
          "short_description": "Switch occasionally drops connections",
          "correlation_display": "",
          "delivery_task": "",
          "work_start": "",
          "assignment_group": "",
          "additional_assignee_list": "",
          "description": "Switch occasionally drops connections",
          "calendar_duration": "1970-01-01 00:02:17",
          "close_notes": "updated firmware",
          "sys_class_name": "problem",
          "closed_by": "",
          "follow_up": "",
          "sys_id": "04ce72c9c0a8016600b5b7f75ac67b5b",
          "contact_type": "phone",
          "urgency": "3",
          "company": "",
          "reassignment_count": "",
          "activity_due": "",
          "assigned_to": "",
          "comments": "",
          "approval": "not requested",
          "sla_due": "",
          "comments_and_work_notes": "",
          "due_date": "",
          "sys_mod_count": "1",
          "sys_tags": "",
          "escalation": "0",
          "upon_approval": "proceed",
          "correlation_id": "",
          "location": ""
        }
      ]
    }

    Tabelle – GET /now/table/{tableName}/{sys_id}

    Ruft den durch die angegebene sys_id angegebenen Datensatz aus der angegebenen Tabelle ab.

    URL-Format

    URL mit Versionsangabe: /api/now/{api_version}/table/{tableName}/{sys_id}

    Standard-URL: /api/now/table/{tableName}/{sys_id}

    Hinweis:
    Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge

    sys_id Sys_id des abzurufenden Datensatzes.

    Datentyp: Zeichenfolge

    tableName Name der Tabelle, aus der der Datensatz abgerufen werden soll.

    Datentyp: Zeichenfolge

    Tabelle : 14. Abfrageparameter
    Name Beschreibung
    sysparm_display_value Bestimmt den Typ der zurückgegebenen Daten, entweder die tatsächlichen Werte aus der Datenbank oder die Anzeigewerte der Felder. Anzeigewerte werden auf Grundlage des tatsächlichen Werts in der Datenbank und der Benutzer- oder Systemeinstellungen und Voreinstellungen geändert.
    Wenn Anzeigewerte zurückgegeben werden, hängt der zurückgegebene Wert vom Feldtyp ab.
    • Auswahlfelder: Der Datenbankwert kann eine Zahl sein, der Anzeigewert ist jedoch aussagekräftiger.
    • Datumsfelder: Der Datenbankwert liegt im UTC-Format vor, während der Anzeigewert auf der Zeitzone des Benutzers basiert.
    • Verschlüsselter Text: Der Datenbankwert ist verschlüsselt, während der Anzeigewert entsprechend dem Verschlüsselungskontext des Benutzers unverschlüsselt ist.
    • Referenzfelder: Der Datenbankwert ist sys_id, der Anzeigewert ist jedoch ein Anzeigefeld des referenzierten Datensatzes.

    Datentyp: Zeichenfolge

    Gültige Werte:

    • true: Gibt die Anzeigewerte für alle Felder zurück.
    • false: Gibt die tatsächlichen Werte aus der Datenbank zurück.
    • all: Gibt sowohl die tatsächlichen als auch die Anzeigewerte zurück.

    Standardwert: false

    Hinweis:
    Es gibt keine bevorzugte Methode zum Festlegen dieses Parameters. Das Angeben des Anzeigewerts kann jedoch zu Leistungsproblemen führen, da er nicht direkt aus der Datenbank gelesen wird und möglicherweise auf andere Felder und Datensätze verwiesen werden muss. Weitere Informationen zu Anzeigewerten und tatsächlichen Werten finden Sie unter FAQs zur Table-API (KB0534905).
    sysparm_exclude_reference_link Kennzeichnung, die angibt, ob Table-API-Links für Referenzfelder ausgeschlossen werden sollen.

    Gültige Werte:

    • true: Table-API-Links für Referenzfelder ausschließen.
    • false: Table-API-Links für Referenzfelder einbeziehen.

    Datentyp: Boolesch

    Standardwert: false

    sysparm_fields Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert.

    Datentyp: Zeichenfolge

    Standard: Gibt alle Felder zurück.

    sysparm_query_no_domain Kennzeichnung, die angibt, ob die Datensatzsuche nur auf die Domänen beschränkt werden soll, für die der angemeldete Benutzer konfiguriert ist.

    Gültige Werte:

    • false: Schließt den Datensatz aus, wenn er sich in einer Domäne befindet, für die der aktuell angemeldete Benutzer nicht für den Zugriff konfiguriert ist.
    • true: Bezieht den Datensatz ein, auch wenn er sich in einer Domäne befindet, für die der aktuell angemeldete Benutzer nicht für den Zugriff konfiguriert ist.

    Datentyp: Boolesch

    Standardwert: false

    Hinweis:
    Der Parameter sysparm_query_no_domain steht nur Systemadministratoren oder Benutzern zur Verfügung, die über die Rolle query_no_domain_table_api verfügen.
    sysparm_view UI-Ansicht, für die die Daten gerendert werden sollen. Bestimmt die Felder, die in der Antwort zurückgegeben werden.

    Gültige Werte:

    • desktop
    • mobile
    • both

    Wenn Sie auch den Parameter sysparm_fields angeben, hat dieser Vorrang.

    Datentyp: Zeichenfolge

    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ützte Typen: application/json oder application/xml.

    Standard: 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 HTTP-Antwortcodes der REST-API.

    Tabelle : 18. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

    Parameter des Antworttexts (JSON oder XML)

    Parameter Beschreibung
    Name-Wert-Paare Feldnamen und Werte aller Parameter innerhalb des angegebenen Datensatzes oder der in den Abfrageparametern angegebenen Datensätzen.

    cURL-Anforderung

    Ruft einen Datensatz aus der Incident-Tabelle ab.

    curl "https://instance.servicenow.com/api/now/table/incident/a9e30c7dc61122760116894de7bcc7bd" \
    --request GET \
    --header "Accept:application/json" \
    --user 'username':'password'

    Die Antwort enthält die Name-Wert-Paare für den angeforderten Datensatz.

    {
      "result": {
        "upon_approval": "",
        "location": {
          "link": "https://instance.servicenow.com/api/now/table/cmn_location/105cf7f3c611227501e75e08b14a38ba",
          "value": "105cf7f3c611227501e75e08b14a38ba"
        },
        "expected_start": "",
        "reopen_count": "",
        "close_notes": "",
        "additional_assignee_list": "",
        "impact": "1",
        "urgency": "3",
        "correlation_id": "",
        "sys_tags": "",
        "sys_domain": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
          "value": "global"
        },
        "description": "",
        "group_list": "",
        "priority": "3",
        "delivery_plan": "",
        "sys_mod_count": "4",
        "work_notes_list": "",
        "business_service": "",
        "follow_up": "",
        "closed_at": "",
        "sla_due": "2015-11-11 22:04:15",
        "delivery_task": "",
        "sys_updated_on": "2015-11-01 22:37:27",
        "parent": "",
        "work_end": "",
        "number": "INC0000046",
        "closed_by": "",
        "work_start": "",
        "calendar_stc": "",
        "category": "software",
        "business_duration": "",
        "incident_state": "1",
        "activity_due": "",
        "correlation_display": "",
        "company": "",
        "active": "true",
        "due_date": "",
        "assignment_group": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user_group/8a4dde73c6112278017a6a4baf547aa7",
          "value": "8a4dde73c6112278017a6a4baf547aa7"
        },
        "caller_id": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user/46c6f9efa9fe198101ddf5eed9adf6e7",
          "value": "46c6f9efa9fe198101ddf5eed9adf6e7"
        },
        "knowledge": "false",
        "made_sla": "false",
        "comments_and_work_notes": "",
        "parent_incident": "",
        "state": "1",
        "user_input": "",
        "sys_created_on": "2015-11-01 22:05:30",
        "approval_set": "",
        "reassignment_count": "1",
        "rfc": "",
        "child_incidents": "",
        "opened_at": "2015-11-02 22:04:15",
        "short_description": "Can't access SFA software",
        "order": "",
        "sys_updated_by": "glide.maint",
        "resolved_by": "",
        "notify": "1",
        "upon_reject": "",
        "approval_history": "",
        "problem_id": {
          "link": "https://instance.servicenow.com/api/now/table/problem/a9e4890bc6112276003d7a5a5c774a74",
          "value": "a9e4890bc6112276003d7a5a5c774a74"
        },
        "work_notes": "",
        "calendar_duration": "",
        "close_code": "",
        "sys_id": "a9e30c7dc61122760116894de7bcc7bd",
        "approval": "not requested",
        "caused_by": "",
        "severity": "3",
        "sys_created_by": "admin",
        "resolved_at": "",
        "assigned_to": "",
        "business_stc": "",
        "wf_activity": "",
        "sys_domain_path": "/",
        "cmdb_ci": {
          "link": "https://instance.servicenow.com/api/now/table/cmdb_ci/a9c0c8d2c6112276018f7705562f9cb0",
          "value": "a9c0c8d2c6112276018f7705562f9cb0"
        },
        "opened_by": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user/46c6f9efa9fe198101ddf5eed9adf6e7",
          "value": "46c6f9efa9fe198101ddf5eed9adf6e7"
        },
        "subcategory": "",
        "rejection_goto": "",
        "sys_class_name": "incident",
        "watch_list": "",
        "time_worked": "",
        "contact_type": "phone",
        "escalation": "0",
        "comments": ""
      }
    }

    Tabelle – PATCH /now/table/{tableName}/{sys_id}

    Aktualisiert den angegebenen Datensatz mit den im Anforderungstext enthaltenen Name-Wert-Paaren.

    URL-Format

    URL mit Versionsangabe: /api/now/{api_version}/table/{tableName}/{sys_id}

    Standard-URL: /api/now/table/{tableName}/{sys_id}

    Hinweis:
    Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge

    sys_id Sys_id des zu aktualisierenden Datensatzes.

    Datentyp: Zeichenfolge

    tableName Name der Tabelle, in der sich der angegebene Datensatz befindet.

    Datentyp: Zeichenfolge

    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    sysparm_display_value Bestimmt den Typ der zurückgegebenen Daten, entweder die tatsächlichen Werte aus der Datenbank oder die Anzeigewerte der Felder. Anzeigewerte werden auf Grundlage des tatsächlichen Werts in der Datenbank und der Benutzer- oder Systemeinstellungen und Voreinstellungen geändert.
    Wenn Anzeigewerte zurückgegeben werden, hängt der zurückgegebene Wert vom Feldtyp ab.
    • Auswahlfelder: Der Datenbankwert kann eine Zahl sein, der Anzeigewert ist jedoch aussagekräftiger.
    • Datumsfelder: Der Datenbankwert liegt im UTC-Format vor, während der Anzeigewert auf der Zeitzone des Benutzers basiert.
    • Verschlüsselter Text: Der Datenbankwert ist verschlüsselt, während der Anzeigewert entsprechend dem Verschlüsselungskontext des Benutzers unverschlüsselt ist.
    • Referenzfelder: Der Datenbankwert ist sys_id, der Anzeigewert ist jedoch ein Anzeigefeld des referenzierten Datensatzes.

    Datentyp: Zeichenfolge

    Gültige Werte:

    • true: Gibt die Anzeigewerte für alle Felder zurück.
    • false: Gibt die tatsächlichen Werte aus der Datenbank zurück.
    • all: Gibt sowohl die tatsächlichen als auch die Anzeigewerte zurück.

    Standardwert: false

    Hinweis:
    Es gibt keine bevorzugte Methode zum Festlegen dieses Parameters. Das Angeben des Anzeigewerts kann jedoch zu Leistungsproblemen führen, da er nicht direkt aus der Datenbank gelesen wird und möglicherweise auf andere Felder und Datensätze verwiesen werden muss. Weitere Informationen zu Anzeigewerten und tatsächlichen Werten finden Sie unter FAQs zur Table-API (KB0534905).
    sysparm_fields Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert.

    Datentyp: Zeichenfolge

    Standard: Gibt alle Felder zurück.

    sysparm_input_display_value Kennzeichnung, die angibt, ob Feldwerte unter Verwendung des Anzeigewertes oder des tatsächlichen Wertes festgelegt werden sollen. Abhängig von den verschiedenen Feldtypen kann der Endpunkt die übergebenen Anzeigewerte modifizieren, damit in der Datenbank die richtigen Werte gespeichert werden. Wenn Sie beispielsweise den Anzeigenamen für ein Referenzfeld senden, speichert der Endpunkt die sys_id für diesen Wert in der Datenbank. Wenn dieser Parameter bei Datums- und Uhrzeitfeldern auf „true“ gesetzt ist, wird der Datums- und Uhrzeitwert an die Zeitzone des aktuellen Benutzers angepasst. Bei „false“ werden der Datums- und Uhrzeitwert mithilfe der GMT-Zeitzone eingefügt.

    Gültige Werte:

    • true: Behandelt Eingabewerte als Anzeigewerte. Sie werden so modifiziert, dass sie in der Datenbank ordnungsgemäß gespeichert werden.
    • false: Behandelt Eingabewerte als Ist-Werte und speichert sie unverändert in der Datenbank.

    Datentyp: Boolesch

    Standard: false – Entspricht dem Datentyp, der während des Datenabrufs (GET-Methoden) zurückgegeben wird, d. h. die tatsächlichen Werte.

    Hinweis:
    Um den Wert eines verschlüsselten Felds festzulegen, müssen Sie diesen Parameter festlegen auf true. Wenn dieser Parameter nicht auf „true“ festgelegt ist, werden an verschlüsselte Felder übergebene Werte nicht gespeichert. Darüber hinaus muss der anfragende Benutzer vor dem Senden der Anforderung über den entsprechenden Verschlüsselungskontext verfügen. Verschlüsselte Felder werden für Benutzer ohne den entsprechenden Verschlüsselungskontext ausgeblendet. Weitere Informationen zur Feldverschlüsselung finden Sie unter Encryption.
    sysparm_query_no_domain Kennzeichnung, die angibt, ob die Datensatzsuche nur auf die Domänen beschränkt werden soll, für die der angemeldete Benutzer konfiguriert ist.

    Gültige Werte:

    • false: Schließt den Datensatz aus, wenn er sich in einer Domäne befindet, für die der aktuell angemeldete Benutzer nicht für den Zugriff konfiguriert ist.
    • true: Bezieht den Datensatz ein, auch wenn er sich in einer Domäne befindet, für die der aktuell angemeldete Benutzer nicht für den Zugriff konfiguriert ist.

    Datentyp: Boolesch

    Standardwert: false

    Hinweis:
    Der Parameter sysparm_query_no_domain steht nur Systemadministratoren oder Benutzern zur Verfügung, die über die Rolle query_no_domain_table_api verfügen.
    sysparm_view UI-Ansicht, für die die Daten gerendert werden sollen. Bestimmt die Felder, die in der Antwort zurückgegeben werden.

    Gültige Werte:

    • desktop
    • mobile
    • both

    Wenn Sie auch den Parameter sysparm_fields angeben, hat dieser Vorrang.

    Datentyp: Zeichenfolge

    Tabelle : 21. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Name-Wert-Paare Feldname und der neue Wert für jeden zu aktualisierenden Parameter im angegebenen Datensatz.
    Hinweis:
    Möglicherweise sind nicht alle Felder in einem Datensatz für die Aktualisierung verfügbar. Zum Beispiel sind Felder mit einem Präfix „sys“ üblicherweise Systemparameter, die automatisch generiert werden und nicht aktualisiert werden können.

    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ützte Typen: application/json oder application/xml.

    Standard: application/json

    Content-Type Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json

    X-no-response-body Standardmäßig enthalten die Antworten den Inhalt des modifizierten Datensatzes. Setzen Sie diese Anforderungskopfzeile auf „true“, um den Antwort-Haupttext zu unterdrücken.
    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 HTTP-Antwortcodes der REST-API.

    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 Antworttexts (JSON oder XML)

    Name Beschreibung
    Name-Wert-Paare Feldnamen und Werte aller Parameter innerhalb des angegebenen Datensatzes oder der in den Abfrageparametern angegebenen Datensätzen.

    cURL-Anforderung

    Aktualisiert einen Datensatz in der Incident-Tabelle.

    curl "https://instance.servicenow.com/api/now/table/incident/ef43c6d40a0a0b5700c77f9bf387afe3" \
    --request PATCH \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{'assigned_to':'681b365ec0a80164000fb0b05854a0cd','urgency':'1','comments':'Elevating urgency, this is a blocking issue'}" \
    --user 'username':'password'

    Die Antwort enthält die Name-Wert-Paare für den aktualisierten Datensatz.

    {
      "result": {
        "upon_approval": "proceed",
        "location": {
          "link": "https://instance.servicenow.com/api/now/table/cmn_location/108752c8c611227501d4ab0e392ba97f",
          "value": "108752c8c611227501d4ab0e392ba97f"
        },
        "expected_start": "",
        "reopen_count": "",
        "close_notes": "",
        "additional_assignee_list": "",
        "impact": "1",
        "urgency": "1",
        "correlation_id": "",
        "sys_tags": "",
        "sys_domain": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
          "value": "global"
        },
        "description": "",
        "group_list": "",
        "priority": "1",
        "delivery_plan": "",
        "sys_mod_count": "7",
        "work_notes_list": "",
        "business_service": "",
        "follow_up": "",
        "closed_at": "",
        "sla_due": "2017-07-05 05:58:24",
        "delivery_task": "",
        "sys_updated_on": "2016-01-22 14:12:37",
        "parent": "",
        "work_end": "",
        "number": "INC0000050",
        "closed_by": "",
        "work_start": "",
        "calendar_stc": "",
        "category": "hardware",
        "business_duration": "",
        "incident_state": "2",
        "activity_due": "2016-01-22 16:12:37",
        "correlation_display": "",
        "company": {
          "link": "https://instance.servicenow.com/api/now/table/core_company/31bea3d53790200044e0bfc8bcbe5dec",
          "value": "31bea3d53790200044e0bfc8bcbe5dec"
        },
        "active": "true",
        "due_date": "",
        "assignment_group": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user_group/8a5055c9c61122780043563ef53438e3",
          "value": "8a5055c9c61122780043563ef53438e3"
        },
        "caller_id": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user/5b7c200d0a640069006b3845b5d0fa7c",
          "value": "5b7c200d0a640069006b3845b5d0fa7c"
        },
        "knowledge": "false",
        "made_sla": "true",
        "comments_and_work_notes": "",
        "parent_incident": "",
        "state": "2",
        "user_input": "",
        "sys_created_on": "2015-11-02 18:05:40",
        "approval_set": "",
        "reassignment_count": "0",
        "rfc": "",
        "child_incidents": "",
        "opened_at": "2015-11-02 21:58:24",
        "short_description": "Can't access Exchange server - is it down?",
        "order": "",
        "sys_updated_by": "admin",
        "resolved_by": "",
        "notify": "1",
        "upon_reject": "cancel",
        "approval_history": "",
        "problem_id": "",
        "work_notes": "",
        "calendar_duration": "",
        "close_code": "",
        "sys_id": "ef43c6d40a0a0b5700c77f9bf387afe3",
        "approval": "not requested",
        "caused_by": "",
        "severity": "3",
        "sys_created_by": "glide.maint",
        "resolved_at": "",
        "assigned_to": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user/681b365ec0a80164000fb0b05854a0cd",
          "value": "681b365ec0a80164000fb0b05854a0cd"
        },
        "business_stc": "",
        "wf_activity": "",
        "sys_domain_path": "/",
        "cmdb_ci": {
          "link": "https://instance.servicenow.com/api/now/table/cmdb_ci/281190e3c0a8000b003f593aa3f20ca6",
          "value": "281190e3c0a8000b003f593aa3f20ca6"
        },
        "opened_by": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user/glide.maint",
          "value": "glide.maint"
        },
        "subcategory": "",
        "rejection_goto": "",
        "sys_class_name": "incident",
        "watch_list": "",
        "time_worked": "",
        "contact_type": "phone",
        "escalation": "3",
        "comments": ""
      }
    }

    Tabelle – POST /now/table/{tableName}

    Fügt einen Datensatz in die angegebene Tabelle ein. Einfügen mehrerer Datensätze wird von dieser Methode nicht unterstützt.

    URL-Format

    URL mit Versionsnummer: /api/now/{api_version}/table/{tableName}

    Standard-URL: /api/now/table/{tableName}

    Hinweis:
    Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge

    tableName Name der Tabelle, in der der Datensatz gespeichert werden soll.

    Datentyp: Zeichenfolge

    Tabelle : 26. Abfrageparameter
    Name Beschreibung
    sysparm_display_value Bestimmt den Typ der zurückgegebenen Daten, entweder die tatsächlichen Werte aus der Datenbank oder die Anzeigewerte der Felder. Anzeigewerte werden auf Grundlage des tatsächlichen Werts in der Datenbank und der Benutzer- oder Systemeinstellungen und Voreinstellungen geändert.
    Wenn Anzeigewerte zurückgegeben werden, hängt der zurückgegebene Wert vom Feldtyp ab.
    • Auswahlfelder: Der Datenbankwert kann eine Zahl sein, der Anzeigewert ist jedoch aussagekräftiger.
    • Datumsfelder: Der Datenbankwert liegt im UTC-Format vor, während der Anzeigewert auf der Zeitzone des Benutzers basiert.
    • Verschlüsselter Text: Der Datenbankwert ist verschlüsselt, während der Anzeigewert entsprechend dem Verschlüsselungskontext des Benutzers unverschlüsselt ist.
    • Referenzfelder: Der Datenbankwert ist sys_id, der Anzeigewert ist jedoch ein Anzeigefeld des referenzierten Datensatzes.

    Datentyp: Zeichenfolge

    Gültige Werte:

    • true: Gibt die Anzeigewerte für alle Felder zurück.
    • false: Gibt die tatsächlichen Werte aus der Datenbank zurück.
    • all: Gibt sowohl die tatsächlichen als auch die Anzeigewerte zurück.

    Standardwert: false

    Hinweis:
    Es gibt keine bevorzugte Methode zum Festlegen dieses Parameters. Das Angeben des Anzeigewerts kann jedoch zu Leistungsproblemen führen, da er nicht direkt aus der Datenbank gelesen wird und möglicherweise auf andere Felder und Datensätze verwiesen werden muss. Weitere Informationen zu Anzeigewerten und tatsächlichen Werten finden Sie unter FAQs zur Table-API (KB0534905).
    sysparm_exclude_reference_link Kennzeichnung, die angibt, ob Table-API-Links für Referenzfelder ausgeschlossen werden sollen.

    Gültige Werte:

    • true: Table-API-Links für Referenzfelder ausschließen.
    • false: Table-API-Links für Referenzfelder einbeziehen.

    Datentyp: Boolesch

    Standardwert: false

    sysparm_fields Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert.

    Datentyp: Zeichenfolge

    Standard: Gibt alle Felder zurück.

    sysparm_input_display_value Kennzeichnung, die angibt, ob Feldwerte unter Verwendung des Anzeigewertes oder des tatsächlichen Wertes festgelegt werden sollen. Abhängig von den verschiedenen Feldtypen kann der Endpunkt die übergebenen Anzeigewerte modifizieren, damit in der Datenbank die richtigen Werte gespeichert werden. Wenn Sie beispielsweise den Anzeigenamen für ein Referenzfeld senden, speichert der Endpunkt die sys_id für diesen Wert in der Datenbank. Wenn dieser Parameter bei Datums- und Uhrzeitfeldern auf „true“ gesetzt ist, wird der Datums- und Uhrzeitwert an die Zeitzone des aktuellen Benutzers angepasst. Bei „false“ werden der Datums- und Uhrzeitwert mithilfe der GMT-Zeitzone eingefügt.

    Gültige Werte:

    • true: Behandelt Eingabewerte als Anzeigewerte. Sie werden so modifiziert, dass sie in der Datenbank ordnungsgemäß gespeichert werden.
    • false: Behandelt Eingabewerte als Ist-Werte und speichert sie unverändert in der Datenbank.

    Datentyp: Boolesch

    Standard: false – Entspricht dem Datentyp, der während des Datenabrufs (GET-Methoden) zurückgegeben wird, d. h. die tatsächlichen Werte.

    Hinweis:
    Um den Wert eines verschlüsselten Felds festzulegen, müssen Sie diesen Parameter festlegen auf true. Wenn dieser Parameter nicht auf „true“ festgelegt ist, werden an verschlüsselte Felder übergebene Werte nicht gespeichert. Darüber hinaus muss der anfragende Benutzer vor dem Senden der Anforderung über den entsprechenden Verschlüsselungskontext verfügen. Verschlüsselte Felder werden für Benutzer ohne den entsprechenden Verschlüsselungskontext ausgeblendet. Weitere Informationen zur Feldverschlüsselung finden Sie unter Encryption.
    sysparm_view UI-Ansicht, für die die Daten gerendert werden sollen. Bestimmt die Felder, die in der Antwort zurückgegeben werden.

    Gültige Werte:

    • desktop
    • mobile
    • both

    Wenn Sie auch den Parameter sysparm_fields angeben, hat dieser Vorrang.

    Datentyp: Zeichenfolge

    Tabelle : 27. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Name-Wert-Paare Feldname und der zugehörige Wert für jeden Parameter, der im angegebenen Datensatz definiert werden soll.
    Hinweis:
    Möglicherweise sind nicht alle Felder in einem Datensatz für die Aktualisierung verfügbar. Zum Beispiel sind Felder mit einem Präfix „sys“ üblicherweise Systemparameter, die automatisch generiert werden und nicht aktualisiert werden können.
    Felder, die nicht angegeben und nicht automatisch vom System generiert werden, werden auf den Nullwert des zugehörigen Datentyps gesetzt.

    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ützte Typen: application/json oder application/xml.

    Standard: application/json

    Content-Type Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json

    X-no-response-body Standardmäßig enthalten die Antworten den Inhalt des neuen Datensatzes. Setzen Sie diese Kopfzeile in der Anforderung auf „true“, um den Antwort-Haupttext zu unterdrücken.
    Tabelle : 29. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Standort Speicherort der erstellten Ressource.

    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 der REST-API.

    Tabelle : 30. Statuscodes
    Statuscode Beschreibung
    201 Gibt an, dass die Anforderung erfolgreich abgeschlossen wurde.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Name-Wert-Paare Feldnamen und Werte aller Parameter innerhalb des neu erstellten Datensatzes oder der in den Abfrageparametern angegebenen Datensätzen.

    cURL-Anforderung

    Fügen Sie einen neuen Datensatz in die Incident-Tabelle ein.

    curl "https://instance.servicenow.com/api/now/table/incident" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{'short_description':'Unable to connect to office wifi','assignment_group':'287ebd7da9fe198100f92cc8d1d2154e','urgency':'2','impact':'2'}" \
    --user 'username':'password'

    Die Antwort enthält die Name-Wert-Paare für den neuen Datensatz.

    {
      "result": {
        "upon_approval": "proceed",
        "location": "",
        "expected_start": "",
        "reopen_count": "0",
        "close_notes": "",
        "additional_assignee_list": "",
        "impact": "2",
        "urgency": "2",
        "correlation_id": "",
        "sys_tags": "",
        "sys_domain": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
          "value": "global"
        },
        "description": "",
        "group_list": "",
        "priority": "3",
        "delivery_plan": "",
        "sys_mod_count": "0",
        "work_notes_list": "",
        "business_service": "",
        "follow_up": "",
        "closed_at": "",
        "sla_due": "",
        "delivery_task": "",
        "sys_updated_on": "2016-01-22 14:28:24",
        "parent": "",
        "work_end": "",
        "number": "INC0010002",
        "closed_by": "",
        "work_start": "",
        "calendar_stc": "",
        "category": "inquiry",
        "business_duration": "",
        "incident_state": "1",
        "activity_due": "",
        "correlation_display": "",
        "company": "",
        "active": "true",
        "due_date": "",
        "assignment_group": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user_group/287ebd7da9fe198100f92cc8d1d2154e",
          "value": "287ebd7da9fe198100f92cc8d1d2154e"
        },
        "caller_id": "",
        "knowledge": "false",
        "made_sla": "true",
        "comments_and_work_notes": "",
        "parent_incident": "",
        "state": "1",
        "user_input": "",
        "sys_created_on": "2016-01-22 14:28:24",
        "approval_set": "",
        "reassignment_count": "0",
        "rfc": "",
        "child_incidents": "0",
        "opened_at": "2016-01-22 14:28:24",
        "short_description": "Unable to connect to office wifi",
        "order": "",
        "sys_updated_by": "admin",
        "resolved_by": "",
        "notify": "1",
        "upon_reject": "cancel",
        "approval_history": "",
        "problem_id": "",
        "work_notes": "",
        "calendar_duration": "",
        "close_code": "",
        "sys_id": "c537bae64f411200adf9f8e18110c76e",
        "approval": "not requested",
        "caused_by": "",
        "severity": "3",
        "sys_created_by": "admin",
        "resolved_at": "",
        "assigned_to": "",
        "business_stc": "",
        "wf_activity": "",
        "sys_domain_path": "/",
        "cmdb_ci": "",
        "opened_by": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user/6816f79cc0a8016401c5a33be04be441",
          "value": "6816f79cc0a8016401c5a33be04be441"
        },
        "subcategory": "",
        "rejection_goto": "",
        "sys_class_name": "incident",
        "watch_list": "",
        "time_worked": "",
        "contact_type": "phone",
        "escalation": "0",
        "comments": ""
      }
    }

    Tabelle – PUT /now/table/{tableName}/{sys_id}

    Aktualisiert den angegebenen Datensatz mit dem Anforderungstext.

    URL-Format

    URL mit Versionsangabe: /api/now/{api_version}/table/{tableName}/{sys_id}

    Standard-URL: /api/now/table/{tableName}/{sys_id}

    Hinweis:
    Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge

    sys_id Eindeutiger Identifier des zu aktualisierenden Datensatzes.

    Datentyp: Zeichenfolge

    tableName Name der Tabelle, in der sich der Datensatz befindet.

    Datentyp: Zeichenfolge

    Tabelle : 32. Abfrageparameter
    Name Beschreibung
    sysparm_display_value Bestimmt den Typ der zurückgegebenen Daten, entweder die tatsächlichen Werte aus der Datenbank oder die Anzeigewerte der Felder. Anzeigewerte werden auf Grundlage des tatsächlichen Werts in der Datenbank und der Benutzer- oder Systemeinstellungen und Voreinstellungen geändert.
    Wenn Anzeigewerte zurückgegeben werden, hängt der zurückgegebene Wert vom Feldtyp ab.
    • Auswahlfelder: Der Datenbankwert kann eine Zahl sein, der Anzeigewert ist jedoch aussagekräftiger.
    • Datumsfelder: Der Datenbankwert liegt im UTC-Format vor, während der Anzeigewert auf der Zeitzone des Benutzers basiert.
    • Verschlüsselter Text: Der Datenbankwert ist verschlüsselt, während der Anzeigewert entsprechend dem Verschlüsselungskontext des Benutzers unverschlüsselt ist.
    • Referenzfelder: Der Datenbankwert ist sys_id, der Anzeigewert ist jedoch ein Anzeigefeld des referenzierten Datensatzes.

    Datentyp: Zeichenfolge

    Gültige Werte:

    • true: Gibt die Anzeigewerte für alle Felder zurück.
    • false: Gibt die tatsächlichen Werte aus der Datenbank zurück.
    • all: Gibt sowohl die tatsächlichen als auch die Anzeigewerte zurück.

    Standardwert: false

    Hinweis:
    Es gibt keine bevorzugte Methode zum Festlegen dieses Parameters. Das Angeben des Anzeigewerts kann jedoch zu Leistungsproblemen führen, da er nicht direkt aus der Datenbank gelesen wird und möglicherweise auf andere Felder und Datensätze verwiesen werden muss. Weitere Informationen zu Anzeigewerten und tatsächlichen Werten finden Sie unter FAQs zur Table-API (KB0534905).
    sysparm_exclude_reference_link Kennzeichnung, die angibt, ob Table-API-Links für Referenzfelder ausgeschlossen werden sollen.

    Gültige Werte:

    • true: Table-API-Links für Referenzfelder ausschließen.
    • false: Table-API-Links für Referenzfelder einbeziehen.

    Datentyp: Boolesch

    Standardwert: false

    sysparm_fields Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert.

    Datentyp: Zeichenfolge

    Standard: Gibt alle Felder zurück.

    sysparm_input_display_value Kennzeichnung, die angibt, ob Feldwerte unter Verwendung des Anzeigewertes oder des tatsächlichen Wertes festgelegt werden sollen.

    Gültige Werte:

    • true: Behandelt Eingabewerte als Anzeigewerte und bearbeitet sie so, dass sie ordnungsgemäß in der Datenbank gespeichert werden können.
    • false: Behandelt Eingabewerte als Ist-Werte und speichert sie unverändert in der Datenbank.

    Datentyp: Boolesch

    Standardwert: false

    Hinweis:
    • Wenn dieser Parameter auf true eingestellt ist, achten Sie auf Eingabewerte, insbesondere Datumswerte, da diese als vom Benutzer über die Zeitzone des Benutzers bereitgestellt interpretiert und in das UTC-Format umgewandelt werden.
    • Um den Wert eines verschlüsselten Felds festzulegen, müssen Sie diesen Parameter festlegen auf true. Wenn dieser Parameter nicht auf „true“ festgelegt ist, werden an verschlüsselte Felder übergebene Werte nicht gespeichert. Darüber hinaus muss der anfragende Benutzer vor dem Senden der Anforderung über den entsprechenden Verschlüsselungskontext verfügen. Verschlüsselte Felder werden für Benutzer ohne den entsprechenden Verschlüsselungskontext ausgeblendet. Weitere Informationen zu Anzeigewerten und tatsächlichen Werten finden Sie unter FAQs zur Table-API (KB0534905). Weitere Informationen zur Feldverschlüsselung finden Sie unter Field Encryption.
    sysparm_query_no_domain Kennzeichnung, die angibt, ob die Datensatzsuche nur auf die Domänen beschränkt werden soll, für die der angemeldete Benutzer konfiguriert ist.

    Gültige Werte:

    • false: Schließt den Datensatz aus, wenn er sich in einer Domäne befindet, für die der aktuell angemeldete Benutzer nicht für den Zugriff konfiguriert ist.
    • true: Bezieht den Datensatz ein, auch wenn er sich in einer Domäne befindet, für die der aktuell angemeldete Benutzer nicht für den Zugriff konfiguriert ist.

    Datentyp: Boolesch

    Standardwert: false

    Hinweis:
    Der Parameter sysparm_query_no_domain steht nur Systemadministratoren oder Benutzern zur Verfügung, die über die Rolle query_no_domain_table_api verfügen.
    sysparm_view UI-Ansicht, für die die Daten gerendert werden sollen. Bestimmt die Felder, die in der Antwort zurückgegeben werden.

    Gültige Werte:

    • desktop
    • mobile
    • both

    Wenn Sie auch den Parameter sysparm_fields angeben, hat dieser Vorrang.

    Datentyp: Zeichenfolge

    Tabelle : 33. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Name-Wert-Paare Name-Wert-Paare für die Felder, die in der zugeordneten Tabelle aktualisiert werden sollen. Um beispielsweise die Kurzbeschreibungsdatei zu aktualisieren, geben Sie ein Name-Wert-Paar ähnlich dem folgenden ein: --data "{\"short_description\": \"my short desc\" }" \.

    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ützte Typen: application/json oder application/xml.

    Standard: application/json

    Content-Type Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.
    X-no-response-body Standardmäßig enthalten die Antworten den Inhalt des modifizierten Datensatzes. Setzen Sie diese Kopfzeile in der Anforderung auf „true“, um den Antwort-Haupttext zu unterdrücken.
    Tabelle : 35. 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 HTTP-Antwortcodes der REST-API.

    Tabelle : 36. 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 Antworttexts (JSON oder XML)

    Name Beschreibung
    Name-Wert-Paare Alle Felder (nicht nur modifizierte) mit ihren zugehörigen Werten für den Change Request.

    cURL-Anforderung

    Aktualisiert einen Datensatz in der Incident-Tabelle.

    curl "https://instance.servicenow.com/api/now/table/incident/ef43c6d40a0a0b5700c77f9bf387afe3" \
    --request PUT \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{'assigned_to':'681b365ec0a80164000fb0b05854a0cd','urgency':'1','comments':'Elevating urgency, this is a blocking issue'}" \
    --user 'username':'password'

    Die Antwort enthält die Name-Wert-Paare für den aktualisierten Datensatz.

    {
      "result": {
        "upon_approval": "proceed",
        "location": {
          "link": "https://instance.servicenow.com/api/now/table/cmn_location/108752c8c611227501d4ab0e392ba97f",
          "value": "108752c8c611227501d4ab0e392ba97f"
        },
        "expected_start": "",
        "reopen_count": "",
        "close_notes": "",
        "additional_assignee_list": "",
        "impact": "1",
        "urgency": "1",
        "correlation_id": "",
        "sys_tags": "",
        "sys_domain": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
          "value": "global"
        },
        "description": "",
        "group_list": "",
        "priority": "1",
        "delivery_plan": "",
        "sys_mod_count": "7",
        "work_notes_list": "",
        "business_service": "",
        "follow_up": "",
        "closed_at": "",
        "sla_due": "2017-07-05 05:58:24",
        "delivery_task": "",
        "sys_updated_on": "2016-01-22 14:12:37",
        "parent": "",
        "work_end": "",
        "number": "INC0000050",
        "closed_by": "",
        "work_start": "",
        "calendar_stc": "",
        "category": "hardware",
        "business_duration": "",
        "incident_state": "2",
        "activity_due": "2016-01-22 16:12:37",
        "correlation_display": "",
        "company": {
          "link": "https://instance.servicenow.com/api/now/table/core_company/31bea3d53790200044e0bfc8bcbe5dec",
          "value": "31bea3d53790200044e0bfc8bcbe5dec"
        },
        "active": "true",
        "due_date": "",
        "assignment_group": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user_group/8a5055c9c61122780043563ef53438e3",
          "value": "8a5055c9c61122780043563ef53438e3"
        },
        "caller_id": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user/5b7c200d0a640069006b3845b5d0fa7c",
          "value": "5b7c200d0a640069006b3845b5d0fa7c"
        },
        "knowledge": "false",
        "made_sla": "true",
        "comments_and_work_notes": "",
        "parent_incident": "",
        "state": "2",
        "user_input": "",
        "sys_created_on": "2015-11-02 18:05:40",
        "approval_set": "",
        "reassignment_count": "0",
        "rfc": "",
        "child_incidents": "",
        "opened_at": "2015-11-02 21:58:24",
        "short_description": "Can't access Exchange server - is it down?",
        "order": "",
        "sys_updated_by": "admin",
        "resolved_by": "",
        "notify": "1",
        "upon_reject": "cancel",
        "approval_history": "",
        "problem_id": "",
        "work_notes": "",
        "calendar_duration": "",
        "close_code": "",
        "sys_id": "ef43c6d40a0a0b5700c77f9bf387afe3",
        "approval": "not requested",
        "caused_by": "",
        "severity": "3",
        "sys_created_by": "glide.maint",
        "resolved_at": "",
        "assigned_to": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user/681b365ec0a80164000fb0b05854a0cd",
          "value": "681b365ec0a80164000fb0b05854a0cd"
        },
        "business_stc": "",
        "wf_activity": "",
        "sys_domain_path": "/",
        "cmdb_ci": {
          "link": "https://instance.servicenow.com/api/now/table/cmdb_ci/281190e3c0a8000b003f593aa3f20ca6",
          "value": "281190e3c0a8000b003f593aa3f20ca6"
        },
        "opened_by": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user/glide.maint",
          "value": "glide.maint"
        },
        "subcategory": "",
        "rejection_goto": "",
        "sys_class_name": "incident",
        "watch_list": "",
        "time_worked": "",
        "contact_type": "phone",
        "escalation": "3",
        "comments": ""
      }
    }