Offene Trouble Ticket-API

Die Trouble Ticket Open API bietet Endpunkte zum Erstellen, Aktualisieren und Abrufen von Daten aus den Tabellen „Fall“ [sn_customerservice_case] und „Incident“ [incident].

Verwenden Sie diese API, um Ticketinformationen zwischen externen Ticketsystemen und Now Platformzu verwalten.

Diese API ist in der Anwendung Telecommunications Assurance Workflows enthalten, die unter ServiceNow Storeverfügbar ist. Die Anwendungen Kundenservice (com.sn_customerservice) und „Customer Service Install Base Management“ (com.snc.install_base) sind erforderlich, um diese API mit der Tabelle „Fall“ [sn_customerservice_case] zu verwenden.

Diese API wird im Namespace sn_ind_tsm_sdwan bereitgestellt.

Der anrufende Benutzer muss über die Rolle ticket_integrator verfügen.

Diese API kann erweitert werden, um Anpassungen für erforderliche Parameter, die Validierung des Anforderungstexts, zusätzliche REST-Vorgänge und Feldzuordnungen vorzunehmen. Weitere Informationen finden Sie unter das Problem Ticket Open API Developer Guide.

Die Trouble Ticket Open -API ist eine ServiceNow® -Implementierung der REST-Spezifikation der TM Forum Trouble Ticket Management API. Diese Implementierung basiert auf der REST-Spezifikation TMF621 Trouble Ticket Management API Release 19, Juni 2019. Die Trouble Ticket Open API ist vom TM Forum zertifiziert.

Problemticket: GET /sn_ind_tsm_sdwan/ticket/troubleTicket

Ruft eine Liste aller Problemticket-Datensätze aus den Tabellen „Fall“ [sn_customerservice_case] und „Incident“ [incident] ab.

URL-Format

Standard-URL: /api/sn_ind_tsm_sdwan/ticket/troubleTicket

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter

Name	Beschreibung
Keine

Tabelle : 2. Abfrageparameter

Name	Beschreibung
Felder	Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Felder: channel creationDate Beschreibung href id lastUpdate name Hinweis ZugehörigeEntität Zugehörige Partei Schweregrad status ticketType @type Standard: Gibt alle Felder zurück. Datentyp: Zeichenfolge
id	Filtern Sie Problemtickets nach sys_id. In der Antwort werden nur Tickets mit der angegebenen sys_id zurückgegeben. Datentyp: Zeichenfolge
limit	Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter offset, um den Datensatzabruf zu paginieren. Standard: 25 Maximum: 100 Sie können die Standard- und Höchstwerte ändern, indem Sie die Systemeigenschaften sn_ind_tsm_sdwan.pagination.set_limit und sn_ind_tsm_sdwan.pagination.max_limit aktualisieren. Datentyp: Zahl
Offset	Startindex, ab dem mit dem Abrufen von Datensätzen begonnen 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. Standard: 0 Datentyp: Zahl
Schweregrad	Filtern Sie Problemtickets nach Schweregrad. In der Antwort werden nur Tickets mit dem angegebenen Schweregrad zurückgegeben. Datentyp: Zeichenfolge
status	Filtern Sie Problemtickets nach Status. In der Antwort werden nur Tickets mit dem angegebenen Status zurückgegeben. Datentyp: Zeichenfolge
ticketType	Filtern Sie Problemtickets nach Tickettyp. In der Antwort werden nur Tickets des angegebenen Typs zurückgegeben. Gültige Werte: Fall Incident Datentyp: Zeichenfolge

Tabelle : 3. Parameter des Anforderungstexts (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
Keine

Tabelle : 5. Antwortkopfzeilen

Kopfzeile	Beschreibung
Inhaltsbereich	Gibt den Inhaltsbereich an, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn Offset=2 und Limit=3, ist der Wert des Content-Range -Headers Elemente 3-5.
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur application/json.
Verknüpfung	Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse. zuerst letzte Weiter previous
X-Gesamtzahl	Für paginierte Abfragen gibt dieser Header die Gesamtzahl der auf dem Server verfügbaren Datensätze an.

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

Tabelle : 6. Statuscodes

Statuscode	Beschreibung
200	Anforderung erfolgreich verarbeitet. Vollständige Ressource, die als Antwort zurückgegeben wird (keine Paginierung).
206	Teilressource, die als Antwort zurückgegeben wird (mit Paginierung).
400	Ungültige Anforderung. Mögliche Gründe: Ungültiger Pfadparameter Ungültiger URI
404	Datensatz nicht gefunden In der Tabelle wurden keine Datensätze gefunden, die den Abfrageparametern entsprechen.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
channel	Die Kontaktmethode, mit der dieses Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
Kanalname	Der Name der Kontaktmethode Wird dem Feld „ Kanal “ [contact_type] für Fälle und dem Feld „ Kontakttyp“ [contact_type] für Incidents zugewiesen. Datentyp: Zeichenfolge
creationDate	Das Datum, an dem der Fall- oder Incident-Datensatz erstellt wurde. Wird dem Feld „ Erstellt “ zugeordnet. Datentyp: Zeichenfolge
Beschreibung	Die Beschreibung des Problems aus dem Ticket. Wird dem Feld „ Beschreibung “ zugeordnet. Datentyp: Zeichenfolge
href	Relativer Link zum Fall- oder Incident-Datensatz. Datentyp: Zeichenfolge
id	Die sys_id des Fall- oder Incident-Datensatzes. Datentyp: Zeichenfolge
lastUpdate	Das Datum, an dem der Datensatz zuletzt aktualisiert wurde. Wird dem Feld „ Aktualisiert “ zugeordnet. Datentyp: Zeichenfolge
name	Der Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Wird dem Feld Kurzbeschreibung zugeordnet. Datentyp: Zeichenfolge
Hinweis	Eine Liste aller Kommentare zum Ticket. Diese Liste enthält keine Arbeitsnotizen. Datentyp: Array "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
Anmerkung.@Typ	Der Typ der Notiz. Es werden nur Kommentare zurückgegeben (keine Arbeitsnotizen), daher ist dieser Wert immer Kommentare. Datentyp: Zeichenfolge
Anmerkung.Autor	Der Name des ServiceNow -Integrationsanwenders, der die POST- oder PATCH-Anforderung erstellt hat, von der der Kommentar erstellt wurde. Datentyp: Zeichenfolge
Notiz.Datum	Das Datum, an dem der Kommentar in der Instanz ServiceNow erstellt wurde. Datentyp: Zeichenfolge
Anmerkung.Text	Der Kommentartext. Datentyp: Zeichenfolge
ZugehörigeEntität	Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselemente oder Services. Datentyp: Array "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
relatedEntity.id	Sys_id des betroffenen Artikels oder Services. Bei Fällen stammt dieser Wert aus einer der folgenden Tabellen: Asset [alm_asset] Produktmodell [cmdb_model] Verkauftes Produkt [sn_install_base_sold_product] „Produktbestand“ [sn_prd_invt_product_inventory], der die Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product] erweitert Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: Konfigurationselement [cmdb_ci] Service [cmdb_ci_service] Datentyp: Zeichenfolge
relatedEntity.href	Gibt eine leere Zeichenfolge zurück. Datentyp: Zeichenfolge
relatedEntity.name	Name des betroffenen Artikels oder Services. Datentyp: Zeichenfolge
ZugehörigeEntität.Rolle	Beschreibung des betroffenen Artikels oder Services. Datentyp: Zeichenfolge
relatedEntity.@referredType	Typ des Artikels oder Services. Gültige Werte für Falltickets: Asset product product_inventory Gültige Werte für Incident-Tickets: cmdb_ci cmdb_ci_service Datentyp: Zeichenfolge
ZugehörigeEntität.@Typ	Dieser Wert ist immer „relatedEntity“. Datentyp: Zeichenfolge
Zugehörige Partei	Details zu Kontakten für das Ticket. Datentyp: Array "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
Zugehörigepartei.id	Sys_id der zugehörigen Partei. Die sys_id kann je nach Tickettyp und Typ der zugehörigen Partei aus den folgenden Tabellen stammen. Fall: Account [customer_account]: Typ der zugehörigen Partei ist „ Kunde“. Kontakt [customer_contact]: Typ der zugehörigen Partei ist „ customer_contact“. Vorfall: Unternehmen [core_company]: Typ der zugehörigen Partei ist „ Kunde“. Benutzer [sys_user]: Typ der zugehörigen Partei ist „ customer_contact“. Fall oder Incident: Gruppe [sys_user_group]: Typ der zugehörigen Partei ist „ assignment_group“. Anwender [sys_user]: Der zugehörige Parteityp ist assigned_to Datentyp: Zeichenfolge
relatedParty.name	Name der zugehörigen Partei. Datentyp: Zeichenfolge
zugehörigepartei.@referenztyp	Typ der zugehörigen Partei Mögliche Werte: assigned_to: Der Anwender, der für die Bearbeitung des Tickets zugewiesen ist. assignment_group: Die Gruppe, die für die Bearbeitung des Tickets zugewiesen ist. Kunde: Das Unternehmen oder der Account für das Ticket. Customer_contact: Der Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
Schweregrad	Der Schweregrad des im Problemticket beschriebenen Problems. Wird dem Feld „ Priorität“ zugewiesen. Datentyp: Zeichenfolge
status	Der aktuelle Status des Problemtickets. Wird dem Feld „Status“ zugeordnet. Datentyp: Zeichenfolge
ticketType	Der Typ des Tickets. Mögliche Werte: Fall Incident Datentyp: Zeichenfolge
@type	Dieser Wert ist immer TroubleTicket. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel werden die angegebenen Felder für die ersten fünf Problemticket-Falldatensätze zurückgegeben.

curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/ticket/troubleTicket?limit=5&fields=id%2Cname%2Cdescription%2Cstatus%2Cseverity%2CticketType&ticketType=case" \
--request GET \
--user 'username':'password'

Antworttext.

[
   {
      "id": "0004609eb9830110f877b3758cd21d37",
      "name": "Compliant Over 2796",
      "description": "checkNo2796",
      "status": "New",
      "severity": "3 - Moderate",
      "ticketType": "Case"
   },
   {
      "id": "000560d2b9c30110f877b3758cd21d36",
      "name": "Compliant Over 4696",
      "description": "checkNo4696",
      "status": "New",
      "severity": "3 - Moderate",
      "ticketType": "Case"
   },
   {
      "id": "0007ac5eb9c30110f877b3758cd21d34",
      "name": "Compliant Over 8817",
      "description": "checkNo8817",
      "status": "New",
      "severity": "3 - Moderate",
      "ticketType": "Case"
   },
   {
      "id": "0007ac5eb9c30110f877b3758cd21d39",
      "name": "Compliant Over 8819",
      "description": "checkNo8819",
      "status": "New",
      "severity": "3 - Moderate",
      "ticketType": "Case"
   },
   {
      "id": "0007ac5eb9c30110f877b3758cd21d3e",
      "name": "Compliant Over 8821",
      "description": "checkNo8821",
      "status": "New",
      "severity": "3 - Moderate",
      "ticketType": "Case"
   }
]

Problemticket – GET /sn_ind_tsm_sdwan/ticket/troubleTicket/{id}

Ruft einen angegebenen Datensatz aus der Tabelle „Fall“ [sn_customerservice_case] oder „Incident“ [incident] ab.

URL-Format

Standard-URL: /api/sn_ind_tsm_sdwan/ticket/troubleTicket/{id}

Unterstützte Anforderungsparameter

Tabelle : 7. Pfadparameter

Name	Beschreibung
id	Sys_id des abzurufenden Fall- oder Incident-Datensatzes. Befindet sich in der Tabelle „Fall“ [sn_customerservice_case] oder „Incident“ [incident]. Datentyp: Zeichenfolge

Tabelle : 8. Abfrageparameter

Name	Beschreibung
Felder	Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Werte: channel creationDate Beschreibung href id lastUpdate name Hinweis ZugehörigeEntität Zugehörige Partei Schweregrad status ticketType @type Standard: Gibt alle Felder zurück. Datentyp: Zeichenfolge

Tabelle : 9. Parameter des Anforderungstexts (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ützt nur application/json.

Tabelle : 11. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

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

Tabelle : 12. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Aus einem oder mehreren der folgenden Gründe wurde ein ungültiger Anforderungstyp oder eine falsch formatierte Anforderung erkannt. Ungültiger Pfadparameter. Ungültiger URI.
404	Datensatz nicht gefunden Ein Datensatz, der der ID zugeordnet ist, wurde in der Tabelle „Fall“ [sn_customerservice_case] oder „Incident“ [incident] nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
channel	Die Kontaktmethode, mit der dieses Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
Kanalname	Der Name der Kontaktmethode Wird dem Feld „ Kanal “ [contact_type] für Fälle und dem Feld „ Kontakttyp“ [contact_type] für Incidents zugeordnet. Datentyp: Zeichenfolge
creationDate	Das Datum, an dem der Fall- oder Incident-Datensatz erstellt wurde. Wird dem Feld „ Erstellt “ zugeordnet. Datentyp: Zeichenfolge
Beschreibung	Die Beschreibung des Problems aus dem Ticket. Wird dem Feld „ Beschreibung “ zugeordnet. Datentyp: Zeichenfolge
href	Relativer Link zum Fall- oder Incident-Datensatz. Datentyp: Zeichenfolge
id	Die sys_id des Fall- oder Incident-Datensatzes. Datentyp: Zeichenfolge
lastUpdate	Das Datum, an dem der Datensatz zuletzt aktualisiert wurde. Wird dem Feld „ Aktualisiert “ zugeordnet. Datentyp: Zeichenfolge
name	Der Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Wird dem Feld Kurzbeschreibung zugeordnet. Datentyp: Zeichenfolge
Hinweis	Eine Liste aller Kommentare zum Ticket. Diese Liste enthält keine Arbeitsnotizen. Datentyp: Array "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
Anmerkung.@Typ	Der Typ der Notiz. Es werden nur Kommentare zurückgegeben (keine Arbeitsnotizen), daher ist dieser Wert immer Kommentare. Datentyp: Zeichenfolge
Anmerkung.Autor	Der Name des Anwenders, der den Kommentar geschrieben hat. Datentyp: Zeichenfolge
Notiz.Datum	Das Datum, an dem der Kommentar in der Instanz ServiceNow erstellt wurde. Datentyp: Zeichenfolge
Anmerkung.Text	Der Kommentartext. Datentyp: Zeichenfolge
ZugehörigeEntität	Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselemente oder Services. Datentyp: Array "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
relatedEntity.id	Sys_id des betroffenen Artikels oder Services. Bei Fällen stammt dieser Wert aus einer der folgenden Tabellen: Asset [alm_asset] Produktmodell [cmdb_model] Verkauftes Produkt [sn_install_base_sold_product] „Produktbestand“ [sn_prd_invt_product_inventory], der die Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product] erweitert Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: Konfigurationselement [cmdb_ci] Service [cmdb_ci_service] Datentyp: Zeichenfolge
relatedEntity.href	Gibt eine leere Zeichenfolge zurück. Datentyp: Zeichenfolge
relatedEntity.name	Name des betroffenen Artikels oder Services. Datentyp: Zeichenfolge
ZugehörigeEntität.Rolle	Beschreibung des betroffenen Artikels oder Services. Datentyp: Zeichenfolge
relatedEntity.@referredType	Typ des Artikels oder Services. Gültige Werte für Falltickets: Asset product product_inventory Gültige Werte für Incident-Tickets: cmdb_ci cmdb_ci_service Datentyp: Zeichenfolge
ZugehörigeEntität.@Typ	Dieser Wert ist immer „relatedEntity“. Datentyp: Zeichenfolge
Zugehörige Partei	Details zu Kontakten für das Ticket. Datentyp: Array "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
Zugehörigepartei.id	Sys_id der zugehörigen Partei. Die sys_id kann je nach Tickettyp und Typ der zugehörigen Partei aus den folgenden Tabellen stammen. Fall: Account [customer_account]: Typ der zugehörigen Partei ist „ Kunde“. Kontakt [customer_contact]: Typ der zugehörigen Partei ist „ customer_contact“. Vorfall: Unternehmen [core_company]: Typ der zugehörigen Partei ist „ Kunde“. Benutzer [sys_user]: Typ der zugehörigen Partei ist „ customer_contact“. Fall oder Incident: Gruppe [sys_user_group]: Typ der zugehörigen Partei ist „ assignment_group“. Anwender [sys_user]: Der zugehörige Parteityp ist assigned_to Datentyp: Zeichenfolge
relatedParty.name	Name der zugehörigen Partei. Datentyp: Zeichenfolge
zugehörigepartei.@referenztyp	Typ der zugehörigen Partei Mögliche Werte: assigned_to: Der Anwender, der für die Bearbeitung des Tickets zugewiesen ist. assignment_group: Die Gruppe, die für die Bearbeitung des Tickets zugewiesen ist. Kunde: Das Unternehmen oder der Account für das Ticket. Customer_contact: Der Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
Schweregrad	Der Schweregrad des im Problemticket beschriebenen Problems. Wird dem Feld „ Priorität“ zugewiesen. Datentyp: Zeichenfolge
status	Der aktuelle Status des Problemtickets. Wird dem Feld „Status“ zugeordnet. Datentyp: Zeichenfolge
ticketType	Der Typ des Tickets. Mögliche Werte: Fall Incident Datentyp: Zeichenfolge
@type	Dieser Wert ist immer TroubleTicket. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird ein Problemticketdatensatz aus der Tabelle „Fall“ [sn_customerservice_case] abgerufen.

curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Antworttext.

{
    "id": "370415f03c20e910f8772f1bc332b31b",
    "href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/370415f03c20e910f8772f1bc332b31b",
    "creationDate": "2023-01-19 22:39:28",
    "lastUpdate": "2023-01-19 22:41:39",
    "description": "Router is not working, my devices cannot detect any signals from the router. First button from the left is flashing red, all others are black. Resetting the router does not solve the problem, I need urgent assistance.",
    "severity": "2 - High",
    "ticketType": "Case",
    "name": "My router is not working properly",
    "status": "Open",
    "channel": {
        "name": "e_bonding"
    },
    "relatedParty": [
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@referredType": "customer"
        },
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@referredType": "customer_contact"
        },
        {
            "id": "",
            "name": "",
            "@referredType": "assignment_group"
        },
        {
            "id": "",
            "name": "",
            "@referredType": "assigned_to"
        }
    ],
    "relatedEntity": [
        {
            "id": "b7fa12c7532520103b6bddeeff7b123b",
            "href": "",
            "name": "Deduplication and Compression PRD00001965",
            "role": "This is the product associated with the case.",
            "@type": "relatedEntity",
            "@referredType": "product"
        },
        {
            "id": "71e73d87c3e23010ff00ed23a140dde8",
            "href": "",
            "name": "",
            "role": "This is the asset associated with the case.",
            "@type": "relatedEntity",
            "@referredType": "asset"
        },
        {
            "id": "a1913c3577b301108e191e599a5a99e8",
            "href": "",
            "name": "Deduplication and Compression PI0000037",
            "role": "This is the product inventory associated with the case.",
            "@type": "relatedEntity",
            "@referredType": "product_inventory"
        }
    ],
    "note": [
        {
            "text": "This is a testing comment<script>gs.info('Hello World')</script>",
            "date": "2023-01-19 14:41:39",
            "author": "System Administrator",
            "@type": "comments"
        },
        {
            "text": "This is a testing comment<script>gs.info('Hello World')</script>",
            "date": "2023-01-19 14:39:28",
            "author": "System Administrator",
            "@type": "comments"
        }
    ],
    "@type": "TroubleTicket"
}

Problemticket – GET /sn_ind_tsm_sdwan/troubleticket/{ticketType}/{id}

Ruft einen angegebenen Datensatz aus der Tabelle „Fall“ [sn_customerservice_case] oder „Incident“ [incident] ab.

Wichtig:

Ab Release Tokyo ist dieser Endpunkt veraltet. Die neue Version dieses Endpunkts ist Problemticket – GET /sn_ind_tsm_sdwan/ticket/troubleTicket/{id}.

URL-Format

Standard-URL: /api/sn_ind_tsm_sdwan/troubleticket/{ticketType}/{id}

Unterstützte Anforderungsparameter

Tabelle : 13. Pfadparameter

Name	Beschreibung
ticketType	Der Typ des Tickets. Dieser Wert bestimmt, ob ein Datensatz aus der Tabelle „Fall“ [sn_customerservice_case] oder „Incident“ [incident] abgerufen wird. Gültige Werte: Fall Incident Datentyp: Zeichenfolge
id	Sys_id des abzurufenden Fall- oder Incident-Datensatzes. Datentyp: Zeichenfolge

Tabelle : 14. Abfrageparameter

Name	Beschreibung
Felder	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Wenn dieser Wert nicht übergeben wird, werden alle Felder zurückgegeben. Gültige Felder: channel creationDate Beschreibung id lastUpdate name Hinweis ZugehörigeEntität Zugehörige Partei Schweregrad status ticketType @type 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ützt nur application/json.

Tabelle : 17. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

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

Tabelle : 18. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Aus einem oder mehreren der folgenden Gründe wurde ein ungültiger Anforderungstyp oder eine falsch formatierte Anforderung erkannt. Ungültiger Pfadparameter. Ungültiger URI.
404	Datensatz nicht gefunden Ein Datensatz, der der ID zugeordnet ist, wurde in der Tabelle „Fall“ [sn_customerservice_case] oder „Incident“ [incident] nicht gefunden.

Parameter des Antworttexts (JSON oder XML)

Name	Beschreibung
@type	Dieser Wert ist immer TroubleTicket. Datentyp: Zeichenfolge
channel	Die Kontaktmethode, mit der dieses Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
Kanalname	Der Name der Kontaktmethode Wird dem Feld „ Kanal “ [contact_type] für Fälle und dem Feld „ Kontakttyp“ [contact_type] für Incidents zugewiesen. Datentyp: Zeichenfolge
creationDate	Das Datum, an dem der Fall- oder Incident-Datensatz erstellt wurde. Wird dem Feld „ Erstellt “ zugeordnet. Datentyp: Zeichenfolge
Beschreibung	Die Beschreibung des Problems aus dem Ticket. Wird dem Feld „ Beschreibung “ zugeordnet. Datentyp: Zeichenfolge
id	Die sys_id des Fall- oder Incident-Datensatzes. Datentyp: Zeichenfolge
lastUpdate	Das Datum, an dem der Datensatz zuletzt aktualisiert wurde. Wird dem Feld „ Aktualisiert “ zugeordnet. Datentyp: Zeichenfolge
name	Der Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Wird dem Feld Kurzbeschreibung zugeordnet. Datentyp: Zeichenfolge
Hinweis	Eine Liste aller Kommentare zum Ticket. Diese Liste enthält keine Arbeitsnotizen. Datentyp: Array "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
Anmerkung.@Typ	Der Typ der Notiz. Es werden nur Kommentare zurückgegeben (keine Arbeitsnotizen), daher ist dieser Wert immer Kommentare. Datentyp: Zeichenfolge
Anmerkung.Autor	Der Name des ServiceNow-Integrationsanwenders, der die POST- oder PATCH-Anforderung erstellt hat, von der der Kommentar erstellt wurde. Datentyp: Zeichenfolge
Notiz.Datum	Das Datum, an dem der Kommentar in der ServiceNow-Instanz erstellt wurde. Datentyp: Zeichenfolge
Anmerkung.Text	Der Kommentartext. Datentyp: Zeichenfolge
ZugehörigeEntität	Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselemente oder Services. Datentyp: Array "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
relatedEntity.id	Sys_id des betroffenen Artikels oder Services. Bei Fällen stammt dieser Wert aus einer der folgenden Tabellen: Asset [alm_asset] Produktmodell [cmdb_model] Verkauftes Produkt [sn_install_base_sold_product] „Produktbestand“ [sn_prd_invt_product_inventory], der die Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product] erweitert Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: Konfigurationselement [cmdb_ci] Service [cmdb_ci_service] Datentyp: Zeichenfolge
relatedEntity.href	Gibt eine leere Zeichenfolge zurück. Datentyp: Zeichenfolge
relatedEntity.name	Name des betroffenen Artikels oder Services. Datentyp: Zeichenfolge
ZugehörigeEntität.Rolle	Beschreibung des betroffenen Artikels oder Services. Datentyp: Zeichenfolge
relatedEntity.@referredType	Typ des Artikels oder Services. Gültige Werte für Falltickets: Asset product product_inventory Gültige Werte für Incident-Tickets: cmdb_ci cmdb_ci_service Datentyp: Zeichenfolge
ZugehörigeEntität.@Typ	Dieser Wert ist immer „relatedEntity“. Datentyp: Zeichenfolge
Zugehörige Partei	Details zu den Unternehmen und Kontakten, die dem Ticket zugeordnet sind. Datentyp: Array "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
zugehörigepartei.@referenztyp	Typ der zugehörigen Partei Gültige Werte: Kunde: Das Unternehmen oder der Account für das Ticket. Customer_Contact: Der Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
relatedParty.id	Sys_id der zugehörigen Partei. Bei Fällen stammt die sys_id aus den Tabellen „Kontakt“ [customer_contact] oder „Account“ [customer_account]. Bei Incidents stammt die sys_id aus den Tabellen „Benutzer“ [sys_user] oder „Unternehmen“ [core_company]. Wenn Sie einen Kontakt oder Benutzer (Anrufer) angeben, wird dessen Account bzw. Unternehmen automatisch im Ticket eingetragen. Datentyp: Zeichenfolge
relatedParty.name	Der Name der zugehörigen Partei Bei Fällen ist dies dem Feld Kontakt oder Account zugeordnet. Bei Incidents wird dem Feld Anrufer oder Unternehmen zugeordnet. Datentyp: Zeichenfolge
Schweregrad	Der Schweregrad des im Problemticket beschriebenen Problems. Wird dem Feld „ Priorität “ zugeordnet. Datentyp: Zeichenfolge
status	Der aktuelle Status des Problemtickets. Wird dem Feld „Status“ zugeordnet. Datentyp: Zeichenfolge
ticketType	Der Typ des Tickets (Fall oder Incident). Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel werden der Name, die Beschreibung, der Schweregrad und der Status eines Falls abgerufen.

curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/troubleticket/case/a78e2c8cdb68b41015364c9b0b96193e?fields=name%2Cdescription%2Cseverity%2Cstatus" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Antworttext.

{
  "name": "Short description of issue",
  "description": "Example description of an issue",
  "severity": "2 - High",
  "status": "Open"
}

Problemticket – PATCH /sn_ind_tsm_sdwan/ticket/troubleTicket/{id}

Aktualisiert einen angegebenen Datensatz in der Tabelle „Fall“ [sn_customerservice_case] oder „Incident“ [incident].

URL-Format

Standard-URL: /api/sn_ind_tsm_sdwan/ticket/troubleTicket/{id}

Unterstützte Anforderungsparameter

Tabelle : 19. Pfadparameter

Name	Beschreibung
id	Sys_id des zu aktualisierenden Fall- oder Incident-Datensatzes. Befindet sich in der Tabelle „Fall“ [sn_customerservice_case] oder „Incident“ [incident]. Datentyp: Zeichenfolge

Tabelle : 20. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 21. Parameter des Anforderungstexts (JSON)

Name	Beschreibung
channel	Die Kontaktmethode, mit der dieses Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
Kanalname	Der Name der Kontaktmethode Wird dem Feld „ Kanal “ [contact_type] für Fälle und dem Feld „ Kontakttyp“ [contact_type] für Incidents zugewiesen. Gültige Werte sind die Auswahlmöglichkeiten für das Feld „contact_type“. Sie können die Bezeichnung oder den Wert der Auswahl angeben. Beispiel: Virtual Agent oder virtual_agent. Datentyp: Zeichenfolge
Beschreibung	Eine Beschreibung des Problems. Wird dem Feld „ Beschreibung “ zugeordnet. Datentyp: Zeichenfolge
name	Der Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Wird dem Feld Kurzbeschreibung zugeordnet. Datentyp: Zeichenfolge
Hinweis	Eine Liste von Arbeitsnotizen und Kommentaren, die dem Ticket hinzugefügt werden sollen. Datentyp: Array "note":[ { "text": "String", "@type": "String" } ]
Anmerkung.@Typ	Der Typ der Notiz. Dieser Wert bestimmt, ob die Notiz im Feld Arbeitsnotizen oder Zusätzliche Kommentare aufgezeichnet wird. Gültige Werte: work_notes comments Datentyp: Zeichenfolge
Anmerkung.Text	Der Hinweistext. Entspricht dem Feld Arbeitsnotizen oder Zusätzliche Kommentare. Datentyp: Zeichenfolge
ZugehörigeEntität	Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselemente oder Services. Datentyp: Array "relatedEntity": [ { "id": "String", "@referredType": "String" } ]
relatedEntity.id	Sys_id des betroffenen Artikels oder Services. Bei Fällen stammt dieser Wert aus einer der folgenden Tabellen: Asset [alm_asset] Produktmodell [cmdb_model] Verkauftes Produkt [sn_install_base_sold_product] „Produktbestand“ [sn_prd_invt_product_inventory], der die Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product] erweitert Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: Konfigurationselement [cmdb_ci] Service [cmdb_ci_service] Datentyp: Zeichenfolge
relatedEntity.@referredType	Typ des Artikels oder Services. Gültige Werte für Falltickets: Asset product product_inventory Gültige Werte für Incident-Tickets: cmdb_ci cmdb_ci_service Datentyp: Zeichenfolge
Zugehörige Partei	Details zu Kontakten für das Ticket. Bei Fällen füllt dieser Parameter das Feld „ Kontakt“ oder „Account“ aus. Bei Incidents füllt dieser Parameter das Feld Anrufer oder Unternehmen aus. Datentyp: Array "relatedParty": [ { "id": "String", "@referredType": "String" } ]
relatedParty.id	Sys_id der zugehörigen Partei. Bei Fällen stammt die sys_id aus den Tabellen „Kontakt“ [customer_contact] oder „Account“ [customer_account]. Bei Incidents stammt die sys_id aus den Tabellen „Benutzer“ [sys_user] oder „Unternehmen“ [core_company]. Wenn Sie einen Kontakt oder Benutzer (Anrufer) angeben, wird dessen Account bzw. Unternehmen automatisch im Ticket eingetragen. Datentyp: Zeichenfolge
zugehörigepartei.@referenztyp	Typ der zugehörigen Partei Gültige Werte: Kunde: Das Unternehmen oder der Account für das Ticket. Customer_Contact: Der Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
Schweregrad	Der Schweregrad des im Problemticket beschriebenen Problems. Wird dem Feld „ Priorität“ zugewiesen. Gültige Werte: 1: Kritisch. 2: Hoch. 3: Mittel. 4: Niedrig. 5: Planung. Nur Incident Gültige Werte sind die Auswahlmöglichkeiten für das Feld Priorität. Sie müssen nur den Auswahlwert angeben. Beispiel: 1. Wenn ein ungültiger Wert angegeben wird, wird der Schweregrad auf „Niedrig“ festgelegt. Datentyp: Zeichenfolge
status	Der aktuelle Status des Problemtickets. Wird dem Feld „Status“ zugeordnet. Gültige Werte sind die Auswahlmöglichkeiten für das Feld „Status“. Sie können die Bezeichnung oder den Wert der Auswahl angeben. Zum Beispiel Neu oder 1. Datentyp: Zeichenfolge

Header

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

Tabelle : 22. Anforderungskopfzeilen

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

Tabelle : 23. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

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

Tabelle : 24. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Aus einem oder mehreren der folgenden Gründe wurde ein ungültiger Anforderungstyp oder eine falsch formatierte Anforderung erkannt. Ungültiger Pfadparameter. Ungültiger URI.
404	Datensatz nicht gefunden Ein Datensatz, der der ID zugeordnet ist, wurde in der Tabelle „Fall“ [sn_customerservice_case] oder „Incident“ [incident] nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
channel	Die Kontaktmethode, mit der dieses Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
Kanalname	Der Name der Kontaktmethode Datentyp: Zeichenfolge
creationDate	Das Datum, an dem der Datensatz erstellt wurde. Datentyp: Zeichenfolge
Beschreibung	Die Beschreibung des Problems aus dem Ticket. Datentyp: Zeichenfolge
href	Relativer Link zum Fall- oder Incident-Datensatz. Datentyp: Zeichenfolge
id	Die sys_id des Fall- oder Incident-Datensatzes. Datentyp: Zeichenfolge
lastUpdate	Das Datum, an dem der Datensatz zuletzt aktualisiert wurde. Datentyp: Zeichenfolge
name	Der Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Datentyp: Zeichenfolge
Hinweis	Eine Liste aller Kommentare zum Ticket. Diese Liste enthält keine Arbeitsnotizen. Datentyp: Array "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
Anmerkung.@Typ	Der Typ der Notiz. Es werden nur Kommentare zurückgegeben (keine Arbeitsnotizen), daher ist dieser Wert immer Kommentare. Datentyp: Zeichenfolge
Anmerkung.Autor	Der Name des Anwenders, der den Kommentar geschrieben hat. Datentyp: Zeichenfolge
Notiz.Datum	Das Datum, an dem der Kommentar in der Instanz ServiceNow erstellt wurde. Datentyp: Zeichenfolge
Anmerkung.Text	Der Kommentartext. Datentyp: Zeichenfolge
ZugehörigeEntität	Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselemente oder Services. Datentyp: Array "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
relatedEntity.id	Sys_id des betroffenen Artikels oder Services. Bei Fällen stammt dieser Wert aus einer der folgenden Tabellen: Asset [alm_asset] Produktmodell [cmdb_model] Verkauftes Produkt [sn_install_base_sold_product] „Produktbestand“ [sn_prd_invt_product_inventory], der die Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product] erweitert Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: Konfigurationselement [cmdb_ci] Service [cmdb_ci_service] Datentyp: Zeichenfolge
relatedEntity.href	Gibt eine leere Zeichenfolge zurück. Datentyp: Zeichenfolge
relatedEntity.name	Name des betroffenen Artikels oder Services. Datentyp: Zeichenfolge
ZugehörigeEntität.Rolle	Beschreibung des betroffenen Artikels oder Services. Datentyp: Zeichenfolge
relatedEntity.@referredType	Typ des Artikels oder Services. Gültige Werte für Falltickets: Asset product product_inventory Gültige Werte für Incident-Tickets: cmdb_ci cmdb_ci_service Datentyp: Zeichenfolge
ZugehörigeEntität.@Typ	Dieser Wert ist immer „relatedEntity“. Datentyp: Zeichenfolge
Zugehörige Partei	Details zu Kontakten für das Ticket. Datentyp: Array "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
Zugehörigepartei.id	Sys_id der zugehörigen Partei. Die sys_id kann je nach Tickettyp und Typ der zugehörigen Partei aus den folgenden Tabellen stammen. Fall: Account [customer_account]: Typ der zugehörigen Partei ist „ Kunde“. Kontakt [customer_contact]: Typ der zugehörigen Partei ist „ customer_contact“. Vorfall: Unternehmen [core_company]: Typ der zugehörigen Partei ist „ Kunde“. Benutzer [sys_user]: Typ der zugehörigen Partei ist „ customer_contact“. Fall oder Incident: Gruppe [sys_user_group]: Typ der zugehörigen Partei ist „ assignment_group“. Anwender [sys_user]: Der zugehörige Parteityp ist assigned_to Datentyp: Zeichenfolge
relatedParty.name	Name der zugehörigen Partei. Datentyp: Zeichenfolge
zugehörigepartei.@referenztyp	Typ der zugehörigen Partei Mögliche Werte: assigned_to: Der Anwender, der für die Bearbeitung des Tickets zugewiesen ist. assignment_group: Die Gruppe, die für die Bearbeitung des Tickets zugewiesen ist. Kunde: Das Unternehmen oder der Account für das Ticket. Customer_contact: Der Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
Schweregrad	Der Schweregrad des im Problemticket beschriebenen Problems. Datentyp: Zeichenfolge
status	Der aktuelle Status des Problemtickets. Datentyp: Zeichenfolge
ticketType	Der Typ des Tickets. Mögliche Werte: Fall Incident Datentyp: Zeichenfolge
@type	Dieser Wert ist immer TroubleTicket. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird ein Falldatensatz aktualisiert.

curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   description: "Updated description",
   "note": [
      {
         "text": "Adding another comment",
         "@type": "comments"
      }
   ]
}" \
--user 'username':'password'

Antworttext.

{
   "id": "6467508d47e345508761b955d36d43f6",
   "href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6",
   "creationDate": "2022-05-16 23:38:55",
   "lastUpdate": "2022-05-16 23:48:42",
   "description": "Updated description",
   "severity": "2 - High",
   "ticketType": "Case",
   "name": "Laptop problem",
   "status": "New",
   "channel": {
      "name": "web"
   },
   "relatedParty": [
      {
         "id": "",
         "name": "",
         "@referredType": "customer"
      },
      {
         "id": "62826bf03710200044e0bfc8bcbe5df1",
         "name": "",
         "@referredType": "customer_contact"
      },
      {
         "id": "",
         "name": "",
         "@referredType": "assignment_group"
      },
      {
         "id": "",
         "name": "",
         "@referredType": "assigned_to"
      }
   ],
   "relatedEntity": [
      {
         "id": "",
         "href": "",
         "name": "",
         "role": "This is the product associated with the case",
         "@type": "relatedEntity",
         "@referredType": "product"
      },
      {
         "id": "74a9ec0d3790200044e0bfc8bcbe5d7f",
         "href": "",
         "name": "P1000597 - Apple MacBook Pro 15\"",
         "role": "This is the asset associated with the case",
         "@type": "relatedEntity",
         "@referredType": "asset"
      }
      {
         "id": "a1913c3577b301108e191e599a5a99e8",
         "href": "",
         "name": "Deduplication and Compression PI0000037",
         "role": "This is the product inventory associated with the case.",
         "@type": "relatedEntity",
         "@referredType": "product_inventory"
      }
   ],
   "note": [
      {
         "text": "Adding another comment",
         "date": "2022-05-16 16:48:42",
         "author": "admin",
         "@type": "comments"
      },
      {
         "text": "Comment about this case",
         "date": "2022-05-16 16:38:55",
         "author": "admin",
         "@type": "comments"
      }
   ],
   "@type": "TroubleTicket"
}

Problemticket – PATCH /sn_ind_tsm_sdwan/troubleticket/{ticketType}/{id}

Aktualisiert einen Datensatz in der Tabelle „Fall“ [sn_customerservice_case] oder „Incident“ [incident].

Wichtig:

Ab Release Tokyo ist dieser Endpunkt veraltet. Die neue Version dieses Endpunkts ist Problemticket – PATCH /sn_ind_tsm_sdwan/ticket/troubleTicket/{id}.

URL-Format

Standard-URL: /api/sn_ind_tsm_sdwan/troubleticket/{ticketType}/{id}

Unterstützte Anforderungsparameter

Tabelle : 25. Pfadparameter

Name	Beschreibung
ticketType	Der Typ des Tickets. Dieser Wert bestimmt, ob ein Datensatz in der Tabelle „Fall“ [sn_customerservice_case] oder „Incident“ [incident] aktualisiert wird. Gültige Werte: Fall Incident Datentyp: Zeichenfolge
id	Die sys_id des zu aktualisierenden Fall- oder Incident-Datensatzes. Datentyp: Zeichenfolge

Tabelle : 26. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 27. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
channel	Die Kontaktmethode, mit der dieses Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
Kanalname	Der Name der Kontaktmethode Wird dem Feld „ Kanal “ [contact_type] für Fälle und dem Feld „ Kontakttyp“ [contact_type] für Incidents zugewiesen. Gültige Werte sind die Auswahlmöglichkeiten für das Feld „contact_type“. Sie können die Bezeichnung oder den Wert der Auswahl angeben. Beispiel: Virtual Agent oder virtual_agent. Datentyp: Zeichenfolge
Beschreibung	Eine Beschreibung des Problems. Wird dem Feld „ Beschreibung “ zugeordnet. Datentyp: Zeichenfolge
name	Der Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Wird dem Feld Kurzbeschreibung zugeordnet. Datentyp: Zeichenfolge
Hinweis	Eine Liste von Arbeitsnotizen und Kommentaren, die dem Ticket hinzugefügt werden sollen. Datentyp: Array "note":[ { "text": "String", "@type": "String" } ]
Anmerkung.@Typ	Der Typ der Notiz. Dieser Wert bestimmt, ob die Notiz im Feld Arbeitsnotizen oder Zusätzliche Kommentare aufgezeichnet wird. Gültige Werte: work_notes comments Datentyp: Zeichenfolge
Anmerkung.Text	Der Hinweistext. Entspricht dem Feld Arbeitsnotizen oder Zusätzliche Kommentare. Datentyp: Zeichenfolge
ZugehörigeEntität	Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselemente oder Services. Datentyp: Array "relatedEntity": [ { "id": "String", "@referredType": "String" } ]
relatedEntity.id	Sys_id des betroffenen Artikels oder Services. Bei Fällen stammt dieser Wert aus einer der folgenden Tabellen: Asset [alm_asset] Produktmodell [cmdb_model] Verkauftes Produkt [sn_install_base_sold_product] „Produktbestand“ [sn_prd_invt_product_inventory], der die Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product] erweitert Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: Konfigurationselement [cmdb_ci] Service [cmdb_ci_service] Datentyp: Zeichenfolge
relatedEntity.@referredType	Typ des Artikels oder Services. Gültige Werte für Falltickets: Asset product product_inventory Gültige Werte für Incident-Tickets: cmdb_ci cmdb_ci_service Datentyp: Zeichenfolge
Zugehörige Partei	Details zu Kontakten für das Ticket. Bei Fällen füllt dieser Parameter das Feld „ Kontakt“ oder „Account“ aus. Bei Incidents füllt dieser Parameter das Feld Anrufer oder Unternehmen aus. Datentyp: Array "relatedParty": [ { "id": "String", "@referredType": "String" } ]
zugehörigepartei.@referenztyp	Typ der zugehörigen Partei Gültige Werte: Kunde: Das Unternehmen oder der Account für das Ticket. Customer_Contact: Der Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
relatedParty.id	Sys_id der zugehörigen Partei. Bei Fällen stammt die sys_id aus den Tabellen „Kontakt“ [customer_contact] oder „Account“ [customer_account]. Bei Incidents stammt die sys_id aus den Tabellen „Benutzer“ [sys_user] oder „Unternehmen“ [core_company]. Wenn Sie einen Kontakt oder Benutzer (Anrufer) angeben, wird dessen Account bzw. Unternehmen automatisch im Ticket eingetragen. Datentyp: Zeichenfolge
Schweregrad	Der Schweregrad des im Problemticket beschriebenen Problems. Wird dem Feld „ Priorität “ zugeordnet. Gültige Werte: 1: Kritisch. 2: Hoch. 3: Mittel. 4: Niedrig. 5: Planung. Nur Incident Gültige Werte sind die Auswahlmöglichkeiten für das Feld Priorität. Sie müssen nur den Auswahlwert angeben. Beispiel: 1. Wenn ein ungültiger Wert angegeben wird, wird der Schweregrad auf „Niedrig“ festgelegt. Datentyp: Zeichenfolge
status	Der aktuelle Status des Problemtickets. Wird dem Feld „Status“ zugeordnet. Gültige Werte sind die Auswahlmöglichkeiten für das Feld „Status“. Sie können die Bezeichnung oder den Wert der Auswahl angeben. Zum Beispiel Neu oder 1. Datentyp: Zeichenfolge

Header

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

Tabelle : 28. Anforderungskopfzeilen

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

Tabelle : 29. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

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

Tabelle : 30. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Aus einem oder mehreren der folgenden Gründe wurde ein ungültiger Anforderungstyp oder eine falsch formatierte Anforderung erkannt. Ungültiger Pfadparameter. Ungültiger URI.
404	Datensatz nicht gefunden Ein Datensatz, der der ID zugeordnet ist, wurde in der Tabelle „Fall“ [sn_customerservice_case] oder „Incident“ [incident] nicht gefunden.

Parameter des Antworttexts (JSON oder XML)

Name	Beschreibung
@type	Dieser Wert ist immer TroubleTicket. Datentyp: Zeichenfolge
channel	Die Kontaktmethode, mit der dieses Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
Kanalname	Der Name der Kontaktmethode Datentyp: Zeichenfolge
creationDate	Das Datum, an dem der Datensatz erstellt wurde. Datentyp: Zeichenfolge
Beschreibung	Die Beschreibung des Problems aus dem Ticket. Datentyp: Zeichenfolge
id	Die sys_id des Fall- oder Incident-Datensatzes. Datentyp: Zeichenfolge
lastUpdate	Das Datum, an dem der Datensatz zuletzt aktualisiert wurde. Datentyp: Zeichenfolge
name	Der Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Datentyp: Zeichenfolge
Hinweis	Eine Liste aller Kommentare zum Ticket. Diese Liste enthält keine Arbeitsnotizen. Datentyp: Array "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
Anmerkung.@Typ	Der Typ der Notiz. Es werden nur Kommentare zurückgegeben (keine Arbeitsnotizen), daher ist dieser Wert immer Kommentare. Datentyp: Zeichenfolge
Anmerkung.Autor	Der Name des ServiceNow-Integrationsanwenders, der die POST- oder PATCH-Anforderung erstellt hat, von der der Kommentar erstellt wurde. Datentyp: Zeichenfolge
Notiz.Datum	Das Datum, an dem der Kommentar in der ServiceNow-Instanz erstellt wurde. Datentyp: Zeichenfolge
Anmerkung.Text	Der Kommentartext. Datentyp: Zeichenfolge
ZugehörigeEntität	Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselemente oder Services. Datentyp: Array "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
relatedEntity.id	Sys_id des betroffenen Artikels oder Services. Bei Fällen stammt dieser Wert aus einer der folgenden Tabellen: Asset [alm_asset] Produktmodell [cmdb_model] Verkauftes Produkt [sn_install_base_sold_product] „Produktbestand“ [sn_prd_invt_product_inventory], der die Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product] erweitert Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: Konfigurationselement [cmdb_ci] Service [cmdb_ci_service] Datentyp: Zeichenfolge
relatedEntity.href	Gibt eine leere Zeichenfolge zurück. Datentyp: Zeichenfolge
relatedEntity.name	Name des betroffenen Artikels oder Services. Datentyp: Zeichenfolge
ZugehörigeEntität.Rolle	Beschreibung des betroffenen Artikels oder Services. Datentyp: Zeichenfolge
relatedEntity.@referredType	Typ des Artikels oder Services. Gültige Werte für Falltickets: Asset product product_inventory Gültige Werte für Incident-Tickets: cmdb_ci cmdb_ci_service Datentyp: Zeichenfolge
ZugehörigeEntität.@Typ	Dieser Wert ist immer „relatedEntity“. Datentyp: Zeichenfolge
Zugehörige Partei	Details zu den Unternehmen und Kontakten, die dem Ticket zugeordnet sind. Datentyp: Array "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
zugehörigepartei.@referenztyp	Typ der zugehörigen Partei Gültige Werte: Kunde: Das Unternehmen oder der Account für das Ticket. Customer_Contact: Der Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
Zugehörigepartei.id	Sys_id der zugehörigen Partei. Bei Fällen stammt die sys_id aus den Tabellen „Kontakt“ [customer_contact] oder „Account“ [customer_account]. Bei Incidents stammt die sys_id aus den Tabellen „Benutzer“ [sys_user] oder „Unternehmen“ [core_company]. Wenn Sie einen Kontakt oder Benutzer (Anrufer) angeben, wird dessen Account bzw. Unternehmen automatisch im Ticket eingetragen. Datentyp: Zeichenfolge
relatedParty.name	Der Name der zugehörigen Partei Datentyp: Zeichenfolge
Schweregrad	Der Schweregrad des im Problemticket beschriebenen Problems. Datentyp: Zeichenfolge
status	Der aktuelle Status des Problemtickets. Datentyp: Zeichenfolge
ticketType	Der Typ des Tickets (Fall oder Incident). Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird ein Falldatensatz aktualisiert.

curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/troubleticket/case/370415f03c20e910f8772f1bc332b31b" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"description\":\"Router is not working, my devices cannot detect any signals from the router. First button from the left is flashing red, all others are black. Resetting the router does not solve the problem, I need urgent assistance.\",
    \"name\":\"My router is not working properly\",
    \"severity\":\"2\",
    \"status\":\"10\",
    \"ticketType\":\"Case\",
    \"channel\":{
        \"id\":\"8774\",
        \"name\":\"eBonding\",
        \"@type\":\"Channel\"
    },
    \"note\":[
        {
            \"id\":\"77456\",
            \"author\":\"Jack Smith\",
            \"date\":\"2019-05-31T07:34:45.968Z\",
            \"text\":\"This is a testing work note<html>hello world</html> and <h1>title</h1>\",
            \"@type\":\"Worknotes\"
        },
        {
            \"id\":\"77457\",
            \"author\":\"Jack Smith\",
            \"date\":\"2019-05-31T07:35:45.968Z\",
            \"text\":\"This is a testing comment<script>gs.info('Hello World')</script>\",
            \"@type\":\"Comment\"
        }
    ],
    \"relatedParty\":[
        {
            \"id\":\"eaf68911c35420105252716b7d40ddde\",
            \"href\":\"https://mycsp.com:8080/tmf-api/partyManagement/v1/individual/9866\",
            \"name\":\"Sally Thomas\",
            \"role\":\"customer\",
            \"@referredType\":\"customer_contact\"
        },
        {
            \"id\":\"ffc68911c35420105252716b7d40dd55\",
            \"href\":\"https://mycsp.com:8080/tmf-api/partyManagement/v4/customer/9176\",
            \"name\":\"Funco Intl\",
            \"role\":\"customer\",
            \"@referredType\":\"customer\"
        }
    ],
    \"relatedEntity\": [
        {
            \"id\": \"b7fa12c7532520103b6bddeeff7b123b\",
            \"href\": \"www.google.com\",
            \"name\": \"Some random name\",
            \"role\": \"I dont know what this is\",
            \"@type\": \"relatedEntity\",
            \"@referredType\": \"product\"
        },
        {
            \"id\": \"71e73d87c3e23010ff00ed23a140dde8\",
            \"href\": \"www.google.com\",
            \"name\": \"Some random name\",
            \"role\": \"I dont know what this is\",
            \"@type\": \"relatedEntity\",
            \"@referredType\": \"asset\"
        },
        {
            \"id\": \"a1913c3577b301108e191e599a5a99e8\",
            \"href\": \"www.google.com\",
            \"name\": \"Some random name\",
            \"role\": \"I dont know what this is\",
            \"@type\": \"relatedEntity\",
            \"@referredType\": \"product_inventory\"
        }
    ]
}" \
--user 'username':'password'

Antworttext.

{
  "id": "370415f03c20e910f8772f1bc332b31b",
  "href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/370415f03c20e910f8772f1bc332b31b",
  "creationDate": "2023-01-19 22:39:28",
  "lastUpdate": "2023-01-19 22:41:39",
  "description": "Router is not working, my devices cannot detect any signals from the router. First button from the left is flashing red, all others are black. Resetting the router does not solve the problem, I need urgent assistance.",
  "severity": "2 - High",
  "ticketType": "Case",
  "name": "My router is not working properly",
  "status": "Open",
  "channel": {
    "name": "e_bonding"
  },
  "relatedParty": [
    {
      "id": "ffc68911c35420105252716b7d40dd55",
      "name": "Funco Intl",
      "@referredType": "customer"
    },
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "@referredType": "customer_contact"
    },
    {
      "id": "",
      "name": "",
      "@referredType": "assignment_group"
    },
    {
      "id": "",
      "name": "",
      "@referredType": "assigned_to"
    }
  ],
  "relatedEntity": [
    {
      "id": "b7fa12c7532520103b6bddeeff7b123b",
      "href": "",
      "name": "Deduplication and Compression PRD00001965",
      "role": "This is the product associated with the case.",
      "@type": "relatedEntity",
      "@referredType": "product"
    },
    {
      "id": "71e73d87c3e23010ff00ed23a140dde8",
      "href": "",
      "name": "",
      "role": "This is the asset associated with the case.",
      "@type": "relatedEntity",
      "@referredType": "asset"
    },
    {
      "id": "a1913c3577b301108e191e599a5a99e8",
      "href": "",
      "name": "Deduplication and Compression PI0000037",
      "role": "This is the product inventory associated with the case.",
      "@type": "relatedEntity",
      "@referredType": "product_inventory"
    }
  ],
  "note": [
    {
      "text": "This is a testing comment<script>gs.info('Hello World')</script>",
      "date": "2023-01-19 14:41:39",
      "author": "System Administrator",
      "@type": "comments"
    },
    {
      "text": "This is a testing comment<script>gs.info('Hello World')</script>",
      "date": "2023-01-19 14:39:28",
      "author": "System Administrator",
      "@type": "comments"
    }
  ],
  "@type": "TroubleTicket"
}

Problemticket – POST /sn_ind_tsm_sdwan/ticket/troubleTicket

Erstellt einen Datensatz in der Tabelle „Fall“ [sn_customerservice_case] oder „Incident“ [incident].

URL-Format

Standard-URL: /api/sn_ind_tsm_sdwan/ticket/troubleTicket

Unterstützte Anforderungsparameter

Tabelle : 31. Pfadparameter

Name	Beschreibung
Keine

Tabelle : 32. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 33. Parameter des Anforderungstexts (JSON)

Name	Beschreibung
channel	Die Kontaktmethode, mit der dieses Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
Kanalname	Der Name der Kontaktmethode Wird dem Feld „ Kanal “ [contact_type] für Fälle und dem Feld „ Kontakttyp“ [contact_type] für Incidents zugewiesen. Gültige Werte sind die Auswahlmöglichkeiten für das Feld „contact_type“. Sie können die Bezeichnung oder den Wert der Auswahl angeben. Beispiel: Virtual Agent oder virtual_agent. Datentyp: Zeichenfolge
Beschreibung	Erforderlich. Eine Beschreibung des Problems. Wird dem Feld „ Beschreibung “ zugeordnet. Datentyp: Zeichenfolge
name	Der Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Wird dem Feld Kurzbeschreibung zugeordnet. Datentyp: Zeichenfolge
Hinweis	Eine Liste von Arbeitsnotizen und Kommentaren, die dem Ticket hinzugefügt werden sollen. Datentyp: Array "note":[ { "text": "String", "@type": "String" } ]
Anmerkung.@Typ	Der Typ der Notiz. Dieser Wert bestimmt, ob die Notiz im Feld Arbeitsnotizen oder Zusätzliche Kommentare aufgezeichnet wird. Gültige Werte: work_notes comments Datentyp: Zeichenfolge
Anmerkung.Text	Der Hinweistext. Entspricht dem Feld Arbeitsnotizen oder Zusätzliche Kommentare. Datentyp: Zeichenfolge
ZugehörigeEntität	Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselemente oder Services. Datentyp: Array "relatedEntity": [ { "id": "String", "@referredType": "String" } ]
relatedEntity.id	Sys_id des betroffenen Artikels oder Services. Bei Fällen stammt dieser Wert aus einer der folgenden Tabellen: Asset [alm_asset] Produktmodell [cmdb_model] Verkauftes Produkt [sn_install_base_sold_product] „Produktbestand“ [sn_prd_invt_product_inventory], der die Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product] erweitert Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: Konfigurationselement [cmdb_ci] Service [cmdb_ci_service] Datentyp: Zeichenfolge
relatedEntity.@referredType	Typ des Artikels oder Services. Gültige Werte für Falltickets: Asset product product_inventory Gültige Werte für Incident-Tickets: cmdb_ci cmdb_ci_service Datentyp: Zeichenfolge
Zugehörige Partei	Details zu Kontakten für das Ticket. Bei Fällen füllt dieser Parameter das Feld „ Kontakt“ oder „Account“ aus. Bei Incidents füllt dieser Parameter das Feld Anrufer oder Unternehmen aus. Datentyp: Array "relatedParty": [ { "id": "String", "@referredType": "String" } ]
relatedParty.id	Sys_id der zugehörigen Partei. Bei Fällen stammt die sys_id aus den Tabellen „Kontakt“ [customer_contact] oder „Account“ [customer_account]. Bei Incidents stammt die sys_id aus den Tabellen „Benutzer“ [sys_user] oder „Unternehmen“ [core_company]. Wenn Sie einen Kontakt oder Benutzer (Anrufer) angeben, wird dessen Account bzw. Unternehmen automatisch im Ticket eingetragen. Datentyp: Zeichenfolge
zugehörigepartei.@referenztyp	Typ der zugehörigen Partei Gültige Werte: Kunde: Das Unternehmen oder der Account für das Ticket. Customer_Contact: Der Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
Schweregrad	Erforderlich. Der Schweregrad des im Problemticket beschriebenen Problems. Wird dem Feld „ Priorität “ zugeordnet. Gültige Werte: 1: Kritisch. 2: Hoch. 3: Mittel. 4: Niedrig. 5: Planung. Nur Incident Gültige Werte sind die Auswahlmöglichkeiten für das Feld Priorität. Sie müssen nur den Auswahlwert angeben. Beispiel: 1. Wenn ein ungültiger Wert angegeben wird, wird der Schweregrad auf „Niedrig“ festgelegt. Datentyp: Zeichenfolge
status	Erforderlich. Der aktuelle Status des Problemtickets. Wird dem Feld „Status“ zugeordnet. Gültige Werte sind die Auswahlmöglichkeiten für das Feld „Status“. Sie können die Bezeichnung oder den Wert der Auswahl angeben. Zum Beispiel Neu oder 1. Wenn Sie einen ungültigen Wertangeben , wird der Status auf Neu festgelegt. Datentyp: Zeichenfolge
ticketType	Der Typ des Tickets. Dieser Wert bestimmt, ob der Datensatz in der Tabelle „Fall“ [sn_customerservice_case] oder „Incident“ [incident] erstellt wird. Gültige Werte: Fall Incident Datentyp: Zeichenfolge Standard: Incident

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.
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

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

Tabelle : 36. Statuscodes

Statuscode	Beschreibung
201	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Aus einem oder mehreren der folgenden Gründe wurde ein ungültiger Anforderungstyp oder eine falsch formatierte Anforderung erkannt. Leere Nutzlast. Ungültige Nutzlast. Pflichtfeld fehlt. Ungültiger ticketType.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
@type	Dieser Wert ist immer TroubleTicket. Datentyp: Zeichenfolge
channel	Die Kontaktmethode, mit der dieses Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
Kanalname	Der Name der Kontaktmethode Datentyp: Zeichenfolge
creationDate	Das Datum, an dem der Fall- oder Incident-Datensatz erstellt wurde. Datentyp: Zeichenfolge
Beschreibung	Die Beschreibung des Problems aus dem Ticket. Datentyp: Zeichenfolge
href	Relativer Link zum Fall- oder Incident-Datensatz. Datentyp: Zeichenfolge
id	Die sys_id des erstellten Fall- oder Incident-Datensatzes. Datentyp: Zeichenfolge
lastUpdate	Das Datum, an dem der Fall- oder Incident-Datensatz zuletzt aktualisiert wurde. Datentyp: Zeichenfolge
name	Der Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Datentyp: Zeichenfolge
Hinweis	Eine Liste aller Kommentare zum Ticket. Diese Liste enthält keine Arbeitsnotizen. Datentyp: Array "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
Anmerkung.@Typ	Der Typ der Notiz. Es werden nur Kommentare zurückgegeben (keine Arbeitsnotizen), daher ist dieser Wert immer Kommentare. Datentyp: Zeichenfolge
Anmerkung.Autor	Der Name des Anwenders, der den Kommentar geschrieben hat. Datentyp: Zeichenfolge
Notiz.Datum	Das Datum, an dem der Kommentar in der Instanz ServiceNow erstellt wurde. Datentyp: Zeichenfolge
Anmerkung.Text	Der Kommentartext. Datentyp: Zeichenfolge
ZugehörigeEntität	Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselemente oder Services. Datentyp: Array "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
relatedEntity.id	Sys_id des betroffenen Artikels oder Services. Bei Fällen stammt dieser Wert aus einer der folgenden Tabellen: Asset [alm_asset] Produktmodell [cmdb_model] Verkauftes Produkt [sn_install_base_sold_product] „Produktbestand“ [sn_prd_invt_product_inventory], der die Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product] erweitert Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: Konfigurationselement [cmdb_ci] Service [cmdb_ci_service] Datentyp: Zeichenfolge
relatedEntity.href	Gibt eine leere Zeichenfolge zurück. Datentyp: Zeichenfolge
relatedEntity.name	Name des betroffenen Artikels oder Services. Datentyp: Zeichenfolge
ZugehörigeEntität.Rolle	Beschreibung des betroffenen Artikels oder Services. Datentyp: Zeichenfolge
relatedEntity.@referredType	Typ des Artikels oder Services. Gültige Werte für Falltickets: Asset product product_inventory Gültige Werte für Incident-Tickets: cmdb_ci cmdb_ci_service Datentyp: Zeichenfolge
ZugehörigeEntität.@Typ	Dieser Wert ist immer „relatedEntity“. Datentyp: Zeichenfolge
Zugehörige Partei	Details zu Kontakten für das Ticket. Datentyp: Array "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
Zugehörigepartei.id	Sys_id der zugehörigen Partei. Die sys_id kann je nach Tickettyp und Typ der zugehörigen Partei aus den folgenden Tabellen stammen. Fall: Account [customer_account]: Typ der zugehörigen Partei ist „ Kunde“. Kontakt [customer_contact]: Typ der zugehörigen Partei ist „ customer_contact“. Vorfall: Unternehmen [core_company]: Typ der zugehörigen Partei ist „ Kunde“. Benutzer [sys_user]: Typ der zugehörigen Partei ist „ customer_contact“. Fall oder Incident: Gruppe [sys_user_group]: Typ der zugehörigen Partei ist „ assignment_group“. Anwender [sys_user]: Der zugehörige Parteityp ist assigned_to Datentyp: Zeichenfolge
relatedParty.name	Name der zugehörigen Partei. Datentyp: Zeichenfolge
zugehörigepartei.@referenztyp	Typ der zugehörigen Partei Mögliche Werte: assigned_to: Der Anwender, der für die Bearbeitung des Tickets zugewiesen ist. assignment_group: Die Gruppe, die für die Bearbeitung des Tickets zugewiesen ist. Kunde: Das Unternehmen oder der Account für das Ticket. Customer_contact: Der Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
Schweregrad	Der Schweregrad des im Problemticket beschriebenen Problems. Datentyp: Zeichenfolge
status	Der aktuelle Status des Problemtickets. Datentyp: Zeichenfolge
ticketType	Der Typ des Tickets. Mögliche Werte: Fall Incident Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird ein Datensatz für einen Problemticket-Fall erstellt.

curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/ticket/troubleTicket" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "name": "Laptop problem",
   "description": "Laptop keeps shutting off unexpectedly",
   "severity": "2",
   "status": "New",
   "ticketType": "Case",
   "channel": {
      "name": "Web"
   },
   "note": [
      {
         "text": "Work note about this case",
         "@type": "work_notes"
      },
      {
         "text": "Comment about this case",
         "@type": "comments"
      }
   ],
   "relatedEntity": [
      {
         "id": "74a9ec0d3790200044e0bfc8bcbe5d7f",
         "@referredType": "asset"
      }
   ],
   "relatedParty": [
      {
         "id": "62826bf03710200044e0bfc8bcbe5df1",
         "@referredType": "customer_contact"
      }
   ]
}" \
--user 'username':'password'

Antworttext.

{
   "id": "6467508d47e345508761b955d36d43f6",
   "href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6",
   "creationDate": "2022-05-16 23:38:55",
   "lastUpdate": "2022-05-16 23:38:55",
   "description": "Laptop keeps shutting off unexpectedly",
   "severity": "2 - High",
   "ticketType": "Case",
   "name": "Laptop problem",
   "status": "New",
   "channel": {
      "name": "web"
   },
   "relatedParty": [
      {
         "id": "",
         "name": "",
         "@referredType": "customer"
      },
      {
         "id": "62826bf03710200044e0bfc8bcbe5df1",
         "name": "",
         "@referredType": "customer_contact"
      },
      {
         "id": "",
         "name": "",
         "@referredType": "assignment_group"
      },
      {
         "id": "",
         "name": "",
         "@referredType": "assigned_to"
      }
   ],
   "relatedEntity": [
      {
         "id": "",
         "href": "",
         "name": "",
         "role": "This is the product associated with the case.",
         "@type": "relatedEntity",
         "@referredType": "product"
      },
      {
         "id": "74a9ec0d3790200044e0bfc8bcbe5d7f",
         "href": "",
         "name": "P1000597 - Apple MacBook Pro 15\"",
         "role": "This is the asset associated with the case.",
         "@type": "relatedEntity",
         "@referredType": "asset"
      }
      {
         "id": "a1913c3577b301108e191e599a5a99e8",
         "href": "",
         "name": "Deduplication and Compression PI0000037",
         "role": "This is the product inventory associated with the case.",
         "@type": "relatedEntity",
         "@referredType": "product_inventory"
      }
   ],
   "note": [
      {
         "text": "Comment about this case",
         "date": "2022-05-16 16:38:55",
         "author": "admin",
         "@type": "comments"
      }
   ],
   "@type": "TroubleTicket"
}

Problemticket – POST /sn_ind_tsm_sdwan/troubleticket/{ticketType}

Erstellt einen Datensatz in der Tabelle „Fall“ [sn_customerservice_case] oder „Incident“ [incident].

Wichtig:

Ab Release Tokyo ist dieser Endpunkt veraltet. Die neue Version dieses Endpunkts ist Problemticket – POST /sn_ind_tsm_sdwan/ticket/troubleTicket.

URL-Format

Standard-URL: /api/sn_ind_tsm_sdwan/troubleticket/{ticketType}

Unterstützte Anforderungsparameter

Tabelle : 37. Pfadparameter

Name	Beschreibung
ticketType	Der Typ des Tickets. Dieser Wert bestimmt, ob der Datensatz in der Tabelle „Fall“ [sn_customerservice_case] oder „Incident“ [incident] erstellt wird. Gültige Werte: Fall Incident Datentyp: Zeichenfolge

Tabelle : 38. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 39. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
channel	Die Kontaktmethode, mit der dieses Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
Kanalname	Der Name der Kontaktmethode Wird dem Feld „ Kanal “ [contact_type] für Fälle und dem Feld „ Kontakttyp“ [contact_type] für Incidents zugewiesen. Gültige Werte sind die Auswahlmöglichkeiten für das Feld „contact_type“. Sie können die Bezeichnung oder den Wert der Auswahl angeben. Beispiel: Virtual Agent oder virtual_agent. Datentyp: Zeichenfolge
Beschreibung	Erforderlich. Eine Beschreibung des Problems. Wird dem Feld „ Beschreibung “ zugeordnet. Datentyp: Zeichenfolge
name	Der Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Wird dem Feld Kurzbeschreibung zugeordnet. Datentyp: Zeichenfolge
Hinweis	Eine Liste von Arbeitsnotizen und Kommentaren, die dem Ticket hinzugefügt werden sollen. Datentyp: Array "note":[ { "text": "String", "@type": "String" } ]
Anmerkung.@Typ	Der Typ der Notiz. Dieser Wert bestimmt, ob die Notiz im Feld Arbeitsnotizen oder Zusätzliche Kommentare aufgezeichnet wird. Gültige Werte: work_notes comments Datentyp: Zeichenfolge
Anmerkung.Text	Der Hinweistext. Entspricht dem Feld Arbeitsnotizen oder Zusätzliche Kommentare. Datentyp: Zeichenfolge
ZugehörigeEntität	Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselemente oder Services. Datentyp: Array "relatedEntity": [ { "id": "String", "@referredType": "String" } ]
relatedEntity.id	Sys_id des betroffenen Artikels oder Services. Bei Fällen stammt dieser Wert aus einer der folgenden Tabellen: Asset [alm_asset] Produktmodell [cmdb_model] Verkauftes Produkt [sn_install_base_sold_product] „Produktbestand“ [sn_prd_invt_product_inventory], der die Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product] erweitert Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: Konfigurationselement [cmdb_ci] Service [cmdb_ci_service] Datentyp: Zeichenfolge
relatedEntity.@referredType	Typ des Artikels oder Services. Gültige Werte für Falltickets: Asset product product_inventory Gültige Werte für Incident-Tickets: cmdb_ci cmdb_ci_service Datentyp: Zeichenfolge
Zugehörige Partei	Details zu Kontakten für das Ticket. Bei Fällen füllt dieser Parameter das Feld „ Kontakt“ oder „Account“ aus. Bei Incidents füllt dieser Parameter das Feld Anrufer oder Unternehmen aus. Datentyp: Array "relatedParty": [ { "id": "String", "@referredType": "String" } ]
zugehörigepartei.@referenztyp	Typ der zugehörigen Partei Gültige Werte: Kunde: Das Unternehmen oder der Account für das Ticket. Customer_Contact: Der Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
relatedParty.id	Sys_id der zugehörigen Partei. Bei Fällen stammt die sys_id aus den Tabellen „Kontakt“ [customer_contact] oder „Account“ [customer_account]. Bei Incidents stammt die sys_id aus den Tabellen „Benutzer“ [sys_user] oder „Unternehmen“ [core_company]. Wenn Sie einen Kontakt oder Benutzer (Anrufer) angeben, wird dessen Account bzw. Unternehmen automatisch im Ticket eingetragen. Datentyp: Zeichenfolge
Schweregrad	Erforderlich. Der Schweregrad des im Problemticket beschriebenen Problems. Wird dem Feld „ Priorität “ zugeordnet. Gültige Werte: 1: Kritisch. 2: Hoch. 3: Mittel. 4: Niedrig. 5: Planung. Nur Incident Gültige Werte sind die Auswahlmöglichkeiten für das Feld Priorität. Sie müssen nur den Auswahlwert angeben. Beispiel: 1. Wenn ein ungültiger Wert angegeben wird, wird der Schweregrad auf „Niedrig“ festgelegt. Datentyp: Zeichenfolge
status	Der aktuelle Status des Problemtickets. Wird dem Feld „Status“ zugeordnet. Gültige Werte sind die Auswahlmöglichkeiten für das Feld „Status“. Sie können die Bezeichnung oder den Wert der Auswahl angeben. Zum Beispiel Neu oder 1. Datentyp: Zeichenfolge Standard: Neu
ticketType	Erforderlich. Der Typ des Tickets. Dieser Wert bestimmt, ob der Datensatz in der Tabelle „Fall“ [sn_customerservice_case] oder „Incident“ [incident] erstellt wird. Gültige Werte: Fall Incident Datentyp: Zeichenfolge

Header

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

Tabelle : 40. Anforderungskopfzeilen

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

Tabelle : 41. 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-Antwortcodesder REST-API.

Tabelle : 42. Statuscodes

Statuscode	Beschreibung
201	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Aus einem oder mehreren der folgenden Gründe wurde ein ungültiger Anforderungstyp oder eine falsch formatierte Anforderung erkannt. Leere Nutzlast. Ungültige Nutzlast. Pflichtfeld fehlt. Ungültiger ticketType oder ticketType stimmt nicht mit dem Pfadparameter „ticketType“ überein. Beispiel: „ticketType“ ist „ Fall “, der Pfadparameter ist jedoch „ Incident“.

Parameter des Antworttexts (JSON oder XML)

Name	Beschreibung
@type	Dieser Wert ist immer TroubleTicket. Datentyp: Zeichenfolge
channel	Die Kontaktmethode, mit der dieses Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
Kanalname	Der Name der Kontaktmethode Datentyp: Zeichenfolge
creationDate	Das Datum, an dem der Fall- oder Incident-Datensatz erstellt wurde. Datentyp: Zeichenfolge
Beschreibung	Die Beschreibung des Problems aus dem Ticket. Datentyp: Zeichenfolge
id	Die sys_id des erstellten Fall- oder Incident-Datensatzes. Datentyp: Zeichenfolge
lastUpdate	Das Datum, an dem der Fall- oder Incident-Datensatz zuletzt aktualisiert wurde. Datentyp: Zeichenfolge
name	Der Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Datentyp: Zeichenfolge
Hinweis	Eine Liste der Kommentare und Arbeitsnotizen, die dem Ticket von der POST-Anforderung hinzugefügt wurden. Datentyp: Array "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
Anmerkung.@Typ	Der Typ der Notiz. Gültige Werte: work_notes comments Datentyp: Zeichenfolge
Anmerkung.Autor	Der Name des ServiceNow-Integrationsanwenders, der die POST-Anforderung zum Erstellen des Hinweises gestellt hat. Datentyp: Zeichenfolge
Notiz.Datum	Das Datum, an dem die Notiz in der ServiceNow-Instanz erstellt wurde. Datentyp: Zeichenfolge
Anmerkung.Text	Der Hinweistext. Datentyp: Zeichenfolge
ZugehörigeEntität	Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselemente oder Services. Datentyp: Array "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
relatedEntity.id	Sys_id des betroffenen Artikels oder Services. Bei Fällen stammt dieser Wert aus einer der folgenden Tabellen: Asset [alm_asset] Produktmodell [cmdb_model] Verkauftes Produkt [sn_install_base_sold_product] „Produktbestand“ [sn_prd_invt_product_inventory], der die Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product] erweitert Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: Konfigurationselement [cmdb_ci] Service [cmdb_ci_service] Datentyp: Zeichenfolge
relatedEntity.href	Gibt eine leere Zeichenfolge zurück. Datentyp: Zeichenfolge
relatedEntity.name	Name des betroffenen Artikels oder Services. Datentyp: Zeichenfolge
ZugehörigeEntität.Rolle	Beschreibung des betroffenen Artikels oder Services. Datentyp: Zeichenfolge
relatedEntity.@referredType	Typ des Artikels oder Services. Gültige Werte für Falltickets: Asset product product_inventory Gültige Werte für Incident-Tickets: cmdb_ci cmdb_ci_service Datentyp: Zeichenfolge
ZugehörigeEntität.@Typ	Dieser Wert ist immer „relatedEntity“. Datentyp: Zeichenfolge
Zugehörige Partei	Details zu den Unternehmen und Kontakten, die dem Ticket zugeordnet sind. Datentyp: Array "relatedParty": [ { "id": "String", "@referredType": "String" } ]
Zugehörigepartei.id	Sys_id der zugehörigen Partei. Bei Fällen stammt die sys_id aus den Tabellen „Kontakt“ [customer_contact] oder „Account“ [customer_account]. Bei Incidents stammt die sys_id aus den Tabellen „Benutzer“ [sys_user] oder „Unternehmen“ [core_company]. Wenn Sie einen Kontakt oder Benutzer (Anrufer) angeben, wird dessen Account bzw. Unternehmen automatisch im Ticket eingetragen. Datentyp: Zeichenfolge
Zugehörigepartei.empfohlenerTyp	Typ der zugehörigen Partei Gültige Werte: Kunde: Das Unternehmen oder der Account für das Ticket. Customer_Contact: Der Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
Schweregrad	Der Schweregrad des im Problemticket beschriebenen Problems. Datentyp: Zeichenfolge
status	Der aktuelle Status des Problemtickets. Datentyp: Zeichenfolge
ticketType	Der Typ des Tickets (Fall oder Incident). Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird ein Fall mit hoher Priorität und dem Status „Offen“ erstellt.

ccurl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/troubleticket/case" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"description\":\"Router is not working, my devices cannot detect any signals from the router. First button from the left is flashing red, all others are black. Resetting the router does not solve the problem, I need urgent assistance.\",
    \"name\":\"My router is not working properly\",
    \"severity\":\"2\",
    \"status\":\"10\",
    \"ticketType\":\"Case\",
    \"channel\":{
        \"id\":\"8774\",
        \"name\":\"eBonding\",
        \"@type\":\"Channel\"
    },
    \"note\":[
        {
            \"id\":\"77456\",
            \"author\":\"Jack Smith\",
            \"date\":\"2019-05-31T07:34:45.968Z\",
            \"text\":\"This is a testing work note<html>hello world</html> and <h1>title</h1>\",
            \"@type\":\"Worknotes\"
        },
        {
            \"id\":\"77457\",
            \"author\":\"Jack Smith\",
            \"date\":\"2019-05-31T07:35:45.968Z\",
            \"text\":\"This is a testing comment<script>gs.info('Hello World')</script>\",
            \"@type\":\"Comment\"
        }
    ],
    \"relatedParty\":[
        {
            \"id\":\"eaf68911c35420105252716b7d40ddde\",
            \"href\":\"https://mycsp.com:8080/tmf-api/partyManagement/v1/individual/9866\",
            \"name\":\"Sally Thomas\",
            \"role\":\"customer\",
            \"@referredType\":\"customer_contact\"
        },
        {
            \"id\":\"ffc68911c35420105252716b7d40dd55\",
            \"href\":\"https://mycsp.com:8080/tmf-api/partyManagement/v4/customer/9176\",
            \"name\":\"Funco Intl\",
            \"role\":\"customer\",
            \"@referredType\":\"customer\"
        }
    ],
    \"relatedEntity\": [
        {
            \"id\": \"b7fa12c7532520103b6bddeeff7b123b\",
            \"href\": \"www.google.com\",
            \"name\": \"Some random name\",
            \"role\": \"I dont know what this is\",
            \"@type\": \"relatedEntity\",
            \"@referredType\": \"product\"
        },
        {
            \"id\": \"71e73d87c3e23010ff00ed23a140dde8\",
            \"href\": \"www.google.com\",
            \"name\": \"Some random name\",
            \"role\": \"I dont know what this is\",
            \"@type\": \"relatedEntity\",
            \"@referredType\": \"asset\"
        },
        {
            \"id\": \"a1913c3577b301108e191e599a5a99e8\",
            \"href\": \"www.google.com\",
            \"name\": \"Some random name\",
            \"role\": \"I dont know what this is\",
            \"@type\": \"relatedEntity\",
            \"@referredType\": \"product_inventory\"
        }
    ]
}" \
--user 'username':'password'

Antworttext.

{
  "id": "5bbb5cbc3c2ca910f8772f1bc332b34d",
  "href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/5bbb5cbc3c2ca910f8772f1bc332b34d",
  "creationDate": "2023-01-19 18:33:24",
  "lastUpdate": "2023-01-19 18:33:24",
  "description": "Router is not working, my devices cannot detect any signals from the router. First button from the left is flashing red, all others are black. Resetting the router does not solve the problem, I need urgent assistance.",
  "severity": "2 - High",
  "ticketType": "Case",
  "name": "My router is not working properly",
  "status": "Open",
  "channel": {
    "name": "e_bonding"
  },
  "relatedParty": [
    {
      "id": "ffc68911c35420105252716b7d40dd55",
      "name": "Funco Intl",
      "@referredType": "customer"
    },
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "@referredType": "customer_contact"
    },
    {
      "id": "",
      "name": "",
      "@referredType": "assignment_group"
    },
    {
      "id": "",
      "name": "",
      "@referredType": "assigned_to"
    }
  ],
  "relatedEntity": [
    {
      "id": "b7fa12c7532520103b6bddeeff7b123b",
      "href": "",
      "name": "Deduplication and Compression PRD00001965",
      "role": "This is the product associated with the case.",
      "@type": "relatedEntity",
      "@referredType": "product"
    },
    {
      "id": "71e73d87c3e23010ff00ed23a140dde8",
      "href": "",
      "name": "",
      "role": "This is the asset associated with the case.",
      "@type": "relatedEntity",
      "@referredType": "asset"
    },
    {
      "id": "a1913c3577b301108e191e599a5a99e8",
      "href": "",
      "name": "Deduplication and Compression PI0000037",
      "role": "This is the product inventory associated with the case.",
      "@type": "relatedEntity",
      "@referredType": "product_inventory"
    }
  ],
  "note": [
    {
      "text": "This is a testing comment<script>gs.info('Hello World')</script>",
      "date": "2023-01-19 10:33:24",
      "author": "System Administrator",
      "@type": "comments"
    }
  ],
  "@type": "TroubleTicket"
}