Trouble Ticket Open-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 Ticketerstellungssystemen und Now Platformzu verwalten.

Diese API ist in der Anwendung Telecommunications Assurance Workflows enthalten, die im 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 Falltabelle [sn_customerservice_case] zu verwenden.

Diese API wird innerhalb des Namespace sn_ind_tsm_sdwan bereitgestellt.

Der aufrufende Benutzer muss die Rolle ticket_integrator haben.

Diese API kann erweitert werden, um Anpassungen für erforderliche Parameter, Anforderungstextvalidierung, zusätzliche REST-Vorgänge und Feldzuordnungen vorzunehmen. Weitere Informationen finden Sie unter das Trouble Ticket Open API-Entwicklerleitfaden.

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 konform.

Trouble Ticket – GET /sn_ind_tsm_sdwan/ticket/troubleTicket

Ruft eine Liste aller Problemticketdatensä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: Kanal creationDate Beschreibung href id lastUpdate Name Hinweis relatedEntity relatedPartei 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 Höchstwert: 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, bei 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. Anforderungstextparameter (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. Wenn beispielsweise offset=2 und limit=3festgelegt ist, lautet der Wert der Kopfzeile Content-Rangeitems 3-5.
Content-Type	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	Bei paginierten 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	In Antwort zurückgegebene Teilressource (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
Kanal	Die Kontaktmethode, über die das Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
channel.name	Der Name der Kontaktmethode. Ist 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. Ist dem Feld Erstellt zugeordnet. Datentyp: Zeichenfolge
Beschreibung	Die Beschreibung des Problems aus dem Ticket. Ist 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. Ist dem Feld Aktualisiert zugeordnet. Datentyp: Zeichenfolge
Name	Der Name des Trouble Tickets, in der Regel eine Kurzbeschreibung des Problems. Ist 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" } ]
Hinweis.@Typ	Der Typ der Notiz. Es werden nur Kommentare zurückgegeben (keine Arbeitsnotizen), daher ist dieser Wert immerKommentare. Datentyp: Zeichenfolge
Hinweis.Autor	Der Name des Integrationsbenutzers ServiceNow, der die POST- oder PATCH-Anforderung gestellt hat, die den Kommentar erstellt hat. Datentyp: Zeichenfolge
Hinweis.Datum	Das Datum, an dem der Kommentar in der Instanz ServiceNow erstellt wurde. Datentyp: Zeichenfolge
Hinweis.Text	Der Kommentartext. Datentyp: Zeichenfolge
relatedEntity	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 Elements oder Service. Für Fälle 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 Für 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 Elements oder Service. Datentyp: Zeichenfolge
relatedEntity.role	Beschreibung des betroffenen Elements oder Service. Datentyp: Zeichenfolge
relatedEntity.@referredType	Der Typ des Artikels oder Service. Gültige Werte für Falltickets: Asset Produkt product_inventory Gültige Werte für Incident-Tickets: cmdb_ci cmdb_ci_service Datentyp: Zeichenfolge
relatedEntity.@type	Dieser Wert ist immer relatedEntity. Datentyp: Zeichenfolge
relatedPartei	Details zu Kontakten für das Ticket. Datentyp: Array "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
relatedPartei.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“. Incident: Unternehmen [core_company]: Typ der zugehörigen Partei ist „ Kunde“. Anwender [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]: Typ der zugehörigen Partei ist „ assigned_to“. Datentyp: Zeichenfolge
relatedPartei.name	Name der zugehörigen Partei. Datentyp: Zeichenfolge
relatedPartei.@referenziertTyp	Der Typ der zugehörigen Partei. Mögliche Werte: assigned_to: Der Benutzer, dem die Arbeit an dem Ticket zugewiesen ist. assignment_group: Die Gruppe, der die Arbeit an dem Ticket zugewiesen ist. Kunde: Das Unternehmen oder der Account für das Ticket. customer_contact: Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
Schweregrad	Schweregrad des vom Trouble Ticket beschriebenen Problems. Ist dem Feld Priorität zugeordnet. Datentyp: Zeichenfolge
status	Aktueller Status des Problemtickets. Ist 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"
   }
]

Trouble Ticket – GET /sn_ind_tsm_sdwan/ticket/troubleTicket/{id}

Ruft einen angegebenen Datensatz aus der Falltabelle [sn_customerservice_case] oder der Incident-Tabelle [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 Falltabelle [sn_customerservice_case] oder der Incident-Tabelle [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: Kanal creationDate Beschreibung href id lastUpdate Name Hinweis relatedEntity relatedPartei Schweregrad status ticketType @type Standard: Gibt alle Felder zurück. Datentyp: Zeichenfolge

Tabelle : 9. Anforderungstextparameter (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. Ein ungültiger Anforderungstyp oder eine falsch formatierte Anforderung wurde aus einem oder mehreren der folgenden Gründe erkannt. Ungültiger Pfadparameter. Ungültiger URI.
404	Datensatz nicht gefunden Ein mit der ID verknüpfter Datensatz wurde in der Falltabelle [sn_customerservice_case] oder der Incident-Tabelle [incident] nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
Kanal	Die Kontaktmethode, über die das Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
channel.name	Der Name der Kontaktmethode. Ist 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. Ist dem Feld Erstellt zugeordnet. Datentyp: Zeichenfolge
Beschreibung	Die Beschreibung des Problems aus dem Ticket. Ist 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. Ist dem Feld Aktualisiert zugeordnet. Datentyp: Zeichenfolge
Name	Der Name des Trouble Tickets, in der Regel eine Kurzbeschreibung des Problems. Ist 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" } ]
Hinweis.@Typ	Der Typ der Notiz. Es werden nur Kommentare zurückgegeben (keine Arbeitsnotizen), daher ist dieser Wert immerKommentare. Datentyp: Zeichenfolge
Hinweis.Autor	Der Name des Benutzers, der den Kommentar geschrieben hat. Datentyp: Zeichenfolge
Hinweis.Datum	Das Datum, an dem der Kommentar in der Instanz ServiceNow erstellt wurde. Datentyp: Zeichenfolge
Hinweis.Text	Der Kommentartext. Datentyp: Zeichenfolge
relatedEntity	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 Elements oder Service. Für Fälle 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 Für 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 Elements oder Service. Datentyp: Zeichenfolge
relatedEntity.role	Beschreibung des betroffenen Elements oder Service. Datentyp: Zeichenfolge
relatedEntity.@referredType	Der Typ des Artikels oder Service. Gültige Werte für Falltickets: Asset Produkt product_inventory Gültige Werte für Incident-Tickets: cmdb_ci cmdb_ci_service Datentyp: Zeichenfolge
relatedEntity.@type	Dieser Wert ist immer relatedEntity. Datentyp: Zeichenfolge
relatedPartei	Details zu Kontakten für das Ticket. Datentyp: Array "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
relatedPartei.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“. Incident: Unternehmen [core_company]: Typ der zugehörigen Partei ist „ Kunde“. Anwender [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]: Typ der zugehörigen Partei ist „ assigned_to“. Datentyp: Zeichenfolge
relatedPartei.name	Name der zugehörigen Partei. Datentyp: Zeichenfolge
relatedPartei.@referenziertTyp	Der Typ der zugehörigen Partei. Mögliche Werte: assigned_to: Der Benutzer, dem die Arbeit an dem Ticket zugewiesen ist. assignment_group: Die Gruppe, der die Arbeit an dem Ticket zugewiesen ist. Kunde: Das Unternehmen oder der Account für das Ticket. customer_contact: Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
Schweregrad	Schweregrad des vom Trouble Ticket beschriebenen Problems. Ist dem Feld Priorität zugeordnet. Datentyp: Zeichenfolge
status	Aktueller Status des Problemtickets. Ist 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 Falltabelle [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"
}

Trouble Ticket – GET /sn_ind_tsm_sdwan/troubleticket/{ticketType}/{id}

Ruft einen angegebenen Datensatz aus der Falltabelle [sn_customerservice_case] oder der Incident-Tabelle [incident] ab.

Wichtig:

Ab Release Tokyo ist dieser Endpunkt veraltet. Die neue Version dieses Endpunkts ist Trouble Ticket – 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 Falltabelle [sn_customerservice_case] oder der Incident-Tabelle [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: Kanal creationDate Beschreibung id lastUpdate Name Hinweis relatedEntity relatedPartei 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. Ein ungültiger Anforderungstyp oder eine falsch formatierte Anforderung wurde aus einem oder mehreren der folgenden Gründe erkannt. Ungültiger Pfadparameter. Ungültiger URI.
404	Datensatz nicht gefunden Ein mit der ID verknüpfter Datensatz wurde in der Falltabelle [sn_customerservice_case] oder der Incident-Tabelle [incident] nicht gefunden.

Antworttextparameter (JSON oder XML)

Name	Beschreibung
@type	Dieser Wert ist immer TroubleTicket. Datentyp: Zeichenfolge
Kanal	Die Kontaktmethode, über die das Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
channel.name	Der Name der Kontaktmethode. Ist 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. Ist dem Feld Erstellt zugeordnet. Datentyp: Zeichenfolge
Beschreibung	Die Beschreibung des Problems aus dem Ticket. Ist 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. Ist dem Feld Aktualisiert zugeordnet. Datentyp: Zeichenfolge
Name	Der Name des Trouble Tickets, in der Regel eine Kurzbeschreibung des Problems. Ist 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" } ]
Hinweis.@Typ	Der Typ der Notiz. Es werden nur Kommentare zurückgegeben (keine Arbeitsnotizen), daher ist dieser Wert immerKommentare. Datentyp: Zeichenfolge
Hinweis.Autor	Der Name des ServiceNow-Integrationsbenutzers, der die POST- oder PATCH-Anforderung gestellt hat, die den Kommentar erstellt hat. Datentyp: Zeichenfolge
Hinweis.Datum	Das Datum, an dem der Kommentar in der ServiceNow-Instanz erstellt wurde. Datentyp: Zeichenfolge
Hinweis.Text	Der Kommentartext. Datentyp: Zeichenfolge
relatedEntity	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 Elements oder Service. Für Fälle 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 Für 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 Elements oder Service. Datentyp: Zeichenfolge
relatedEntity.role	Beschreibung des betroffenen Elements oder Service. Datentyp: Zeichenfolge
relatedEntity.@referredType	Der Typ des Artikels oder Service. Gültige Werte für Falltickets: Asset Produkt product_inventory Gültige Werte für Incident-Tickets: cmdb_ci cmdb_ci_service Datentyp: Zeichenfolge
relatedEntity.@type	Dieser Wert ist immer relatedEntity. Datentyp: Zeichenfolge
relatedPartei	Details zu den Unternehmen und Kontakten, die dem Ticket zugeordnet sind. Datentyp: Array "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
relatedPartei.@referenziertTyp	Der Typ der zugehörigen Partei. Gültige Werte: Kunde: Das Unternehmen oder der Account für das Ticket. customer_contact: Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
relatedPartei.id	Sys_id der zugehörigen Partei. In 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 oder Unternehmen automatisch in das Ticket eingetragen. Datentyp: Zeichenfolge
relatedPartei.name	Der Name der zugehörigen Partei. Ist für Fälle dem Feld Kontakt oder Account zugeordnet. Wird für Incidents dem Feld Anrufer oder Unternehmen zugeordnet. Datentyp: Zeichenfolge
Schweregrad	Schweregrad des vom Trouble Ticket beschriebenen Problems. Ist dem Feld Priorität zugeordnet. Datentyp: Zeichenfolge
status	Aktueller Status des Problemtickets. Ist dem Feld Status zugeordnet. Datentyp: Zeichenfolge
ticketType	Der Typ des Tickets (Fall oder Incident). Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel werden Name, Beschreibung, Schweregrad und 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"
}

Trouble Ticket – PATCH /sn_ind_tsm_sdwan/ticket/troubleTicket/{id}

Aktualisiert einen angegebenen Datensatz in der Falltabelle [sn_customerservice_case] oder der Incident-Tabelle [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 Falltabelle [sn_customerservice_case] oder der Incident-Tabelle [incident]. Datentyp: Zeichenfolge

Tabelle : 20. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 21. Anforderungstextparameter (JSON)

Name	Beschreibung
Kanal	Die Kontaktmethode, über die das Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
channel.name	Der Name der Kontaktmethode. Ist dem Feld Kanal [contact_type] für Fälle und dem Feld Kontakttyp [contact_type] für Incidents zugeordnet. Gültige Werte sind die Auswahlmöglichkeiten für das Feld „contact_type“. Sie können die Auswahlbezeichnung oder den Wert angeben. Zum Beispiel Virtual Agent oder virtual_agent. Datentyp: Zeichenfolge
Beschreibung	Eine Beschreibung des Problems. Ist dem Feld Beschreibung zugeordnet. Datentyp: Zeichenfolge
Name	Der Name des Trouble Tickets, in der Regel eine Kurzbeschreibung des Problems. Ist dem Feld Kurzbeschreibung zugeordnet. Datentyp: Zeichenfolge
Hinweis	Eine Liste der Arbeitsnotizen und Kommentare, die dem Ticket hinzugefügt werden sollen. Datentyp: Array "note":[ { "text": "String", "@type": "String" } ]
Hinweis.@Typ	Der Typ der Notiz. Dieser Wert bestimmt, ob die Notiz im Feld Arbeitsnotizen oder Zusätzliche Anmerkungen aufgezeichnet wird. Gültige Werte: work_notes Kommentare Datentyp: Zeichenfolge
Hinweis.Text	Der Hinweistext. Ist dem Feld „Arbeitsnotizen“ oder „ Zusätzliche Anmerkungen “ zugeordnet. Datentyp: Zeichenfolge
relatedEntity	Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselemente oder Services. Datentyp: Array "relatedEntity": [ { "id": "String", "@referredType": "String" } ]
relatedEntity.id	Sys_id des betroffenen Elements oder Service. Für Fälle 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 Für Incidents stammt dieser Wert aus einer der folgenden Tabellen: Konfigurationselement [cmdb_ci] Service [cmdb_ci_service] Datentyp: Zeichenfolge
relatedEntity.@referredType	Der Typ des Artikels oder Service. Gültige Werte für Falltickets: Asset Produkt product_inventory Gültige Werte für Incident-Tickets: cmdb_ci cmdb_ci_service Datentyp: Zeichenfolge
relatedPartei	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" } ]
relatedPartei.id	Sys_id der zugehörigen Partei. In 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 oder Unternehmen automatisch in das Ticket eingetragen. Datentyp: Zeichenfolge
relatedPartei.@referenziertTyp	Der Typ der zugehörigen Partei. Gültige Werte: Kunde: Das Unternehmen oder der Account für das Ticket. customer_contact: Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
Schweregrad	Schweregrad des vom Trouble Ticket beschriebenen Problems. Ist 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	Aktueller Status des Problemtickets. Ist dem Feld Status zugeordnet. Gültige Werte sind die Auswahlmöglichkeiten für das Feld Status. Sie können die Auswahlbezeichnung oder den Wert angeben. 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. Ein ungültiger Anforderungstyp oder eine falsch formatierte Anforderung wurde aus einem oder mehreren der folgenden Gründe erkannt. Ungültiger Pfadparameter. Ungültiger URI.
404	Datensatz nicht gefunden Ein mit der ID verknüpfter Datensatz wurde in der Falltabelle [sn_customerservice_case] oder der Incident-Tabelle [incident] nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
Kanal	Die Kontaktmethode, über die das Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
channel.name	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 Trouble Tickets, in der Regel eine Kurzbeschreibung 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" } ]
Hinweis.@Typ	Der Typ der Notiz. Es werden nur Kommentare zurückgegeben (keine Arbeitsnotizen), daher ist dieser Wert immerKommentare. Datentyp: Zeichenfolge
Hinweis.Autor	Der Name des Benutzers, der den Kommentar geschrieben hat. Datentyp: Zeichenfolge
Hinweis.Datum	Das Datum, an dem der Kommentar in der Instanz ServiceNow erstellt wurde. Datentyp: Zeichenfolge
Hinweis.Text	Der Kommentartext. Datentyp: Zeichenfolge
relatedEntity	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 Elements oder Service. Für Fälle 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 Für 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 Elements oder Service. Datentyp: Zeichenfolge
relatedEntity.role	Beschreibung des betroffenen Elements oder Service. Datentyp: Zeichenfolge
relatedEntity.@referredType	Der Typ des Artikels oder Service. Gültige Werte für Falltickets: Asset Produkt product_inventory Gültige Werte für Incident-Tickets: cmdb_ci cmdb_ci_service Datentyp: Zeichenfolge
relatedEntity.@type	Dieser Wert ist immer relatedEntity. Datentyp: Zeichenfolge
relatedPartei	Details zu Kontakten für das Ticket. Datentyp: Array "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
relatedPartei.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“. Incident: Unternehmen [core_company]: Typ der zugehörigen Partei ist „ Kunde“. Anwender [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]: Typ der zugehörigen Partei ist „ assigned_to“. Datentyp: Zeichenfolge
relatedPartei.name	Name der zugehörigen Partei. Datentyp: Zeichenfolge
relatedPartei.@referenziertTyp	Der Typ der zugehörigen Partei. Mögliche Werte: assigned_to: Der Benutzer, dem die Arbeit an dem Ticket zugewiesen ist. assignment_group: Die Gruppe, der die Arbeit an dem Ticket zugewiesen ist. Kunde: Das Unternehmen oder der Account für das Ticket. customer_contact: Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
Schweregrad	Schweregrad des vom Trouble Ticket beschriebenen Problems. Datentyp: Zeichenfolge
status	Aktueller 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"
}

Trouble Ticket – PATCH /sn_ind_tsm_sdwan/troubleticket/{ticketType}/{id}

Aktualisiert einen Datensatz in der Falltabelle [sn_customerservice_case] oder der Incident-Tabelle [incident].

Wichtig:

Ab Release Tokyo ist dieser Endpunkt veraltet. Die neue Version dieses Endpunkts ist Trouble Ticket – 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 Falltabelle [sn_customerservice_case] oder der Incident-Tabelle [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
Kanal	Die Kontaktmethode, über die das Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
channel.name	Der Name der Kontaktmethode. Ist dem Feld Kanal [contact_type] für Fälle und dem Feld Kontakttyp [contact_type] für Incidents zugeordnet. Gültige Werte sind die Auswahlmöglichkeiten für das Feld „contact_type“. Sie können die Auswahlbezeichnung oder den Wert angeben. Zum Beispiel Virtual Agent oder virtual_agent. Datentyp: Zeichenfolge
Beschreibung	Eine Beschreibung des Problems. Ist dem Feld Beschreibung zugeordnet. Datentyp: Zeichenfolge
Name	Der Name des Trouble Tickets, in der Regel eine Kurzbeschreibung des Problems. Ist dem Feld Kurzbeschreibung zugeordnet. Datentyp: Zeichenfolge
Hinweis	Eine Liste der Arbeitsnotizen und Kommentare, die dem Ticket hinzugefügt werden sollen. Datentyp: Array "note":[ { "text": "String", "@type": "String" } ]
Hinweis.@Typ	Der Typ der Notiz. Dieser Wert bestimmt, ob die Notiz im Feld Arbeitsnotizen oder Zusätzliche Anmerkungen aufgezeichnet wird. Gültige Werte: work_notes Kommentare Datentyp: Zeichenfolge
Hinweis.Text	Der Hinweistext. Ist dem Feld „Arbeitsnotizen“ oder „ Zusätzliche Anmerkungen “ zugeordnet. Datentyp: Zeichenfolge
relatedEntity	Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselemente oder Services. Datentyp: Array "relatedEntity": [ { "id": "String", "@referredType": "String" } ]
relatedEntity.id	Sys_id des betroffenen Elements oder Service. Für Fälle 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 Für Incidents stammt dieser Wert aus einer der folgenden Tabellen: Konfigurationselement [cmdb_ci] Service [cmdb_ci_service] Datentyp: Zeichenfolge
relatedEntity.@referredType	Der Typ des Artikels oder Service. Gültige Werte für Falltickets: Asset Produkt product_inventory Gültige Werte für Incident-Tickets: cmdb_ci cmdb_ci_service Datentyp: Zeichenfolge
relatedPartei	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" } ]
relatedPartei.@referenziertTyp	Der Typ der zugehörigen Partei. Gültige Werte: Kunde: Das Unternehmen oder der Account für das Ticket. customer_contact: Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
relatedPartei.id	Sys_id der zugehörigen Partei. In 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 oder Unternehmen automatisch in das Ticket eingetragen. Datentyp: Zeichenfolge
Schweregrad	Schweregrad des vom Trouble Ticket beschriebenen Problems. Ist 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	Aktueller Status des Problemtickets. Ist dem Feld Status zugeordnet. Gültige Werte sind die Auswahlmöglichkeiten für das Feld Status. Sie können die Auswahlbezeichnung oder den Wert angeben. 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. Ein ungültiger Anforderungstyp oder eine falsch formatierte Anforderung wurde aus einem oder mehreren der folgenden Gründe erkannt. Ungültiger Pfadparameter. Ungültiger URI.
404	Datensatz nicht gefunden Ein mit der ID verknüpfter Datensatz wurde in der Falltabelle [sn_customerservice_case] oder der Incident-Tabelle [incident] nicht gefunden.

Antworttextparameter (JSON oder XML)

Name	Beschreibung
@type	Dieser Wert ist immer TroubleTicket. Datentyp: Zeichenfolge
Kanal	Die Kontaktmethode, über die das Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
channel.name	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 Trouble Tickets, in der Regel eine Kurzbeschreibung 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" } ]
Hinweis.@Typ	Der Typ der Notiz. Es werden nur Kommentare zurückgegeben (keine Arbeitsnotizen), daher ist dieser Wert immerKommentare. Datentyp: Zeichenfolge
Hinweis.Autor	Der Name des ServiceNow-Integrationsbenutzers, der die POST- oder PATCH-Anforderung gestellt hat, die den Kommentar erstellt hat. Datentyp: Zeichenfolge
Hinweis.Datum	Das Datum, an dem der Kommentar in der ServiceNow-Instanz erstellt wurde. Datentyp: Zeichenfolge
Hinweis.Text	Der Kommentartext. Datentyp: Zeichenfolge
relatedEntity	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 Elements oder Service. Für Fälle 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 Für 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 Elements oder Service. Datentyp: Zeichenfolge
relatedEntity.role	Beschreibung des betroffenen Elements oder Service. Datentyp: Zeichenfolge
relatedEntity.@referredType	Der Typ des Artikels oder Service. Gültige Werte für Falltickets: Asset Produkt product_inventory Gültige Werte für Incident-Tickets: cmdb_ci cmdb_ci_service Datentyp: Zeichenfolge
relatedEntity.@type	Dieser Wert ist immer relatedEntity. Datentyp: Zeichenfolge
relatedPartei	Details zu den Unternehmen und Kontakten, die dem Ticket zugeordnet sind. Datentyp: Array "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
relatedPartei.@referenziertTyp	Der Typ der zugehörigen Partei. Gültige Werte: Kunde: Das Unternehmen oder der Account für das Ticket. customer_contact: Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
relatedPartei.id	Sys_id der zugehörigen Partei. In 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 oder Unternehmen automatisch in das Ticket eingetragen. Datentyp: Zeichenfolge
relatedPartei.name	Der Name der zugehörigen Partei. Datentyp: Zeichenfolge
Schweregrad	Schweregrad des vom Trouble Ticket beschriebenen Problems. Datentyp: Zeichenfolge
status	Aktueller 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"
}

Trouble Ticket – POST /sn_ind_tsm_sdwan/ticket/troubleTicket

Erstellt einen Datensatz in der Falltabelle [sn_customerservice_case] oder der Incident-Tabelle [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. Anforderungstextparameter (JSON)

Name	Beschreibung
Kanal	Die Kontaktmethode, über die das Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
channel.name	Der Name der Kontaktmethode. Ist dem Feld Kanal [contact_type] für Fälle und dem Feld Kontakttyp [contact_type] für Incidents zugeordnet. Gültige Werte sind die Auswahlmöglichkeiten für das Feld „contact_type“. Sie können die Auswahlbezeichnung oder den Wert angeben. Zum Beispiel Virtual Agent oder virtual_agent. Datentyp: Zeichenfolge
Beschreibung	Erforderlich. Eine Beschreibung des Problems. Ist dem Feld Beschreibung zugeordnet. Datentyp: Zeichenfolge
Name	Der Name des Trouble Tickets, in der Regel eine Kurzbeschreibung des Problems. Ist dem Feld Kurzbeschreibung zugeordnet. Datentyp: Zeichenfolge
Hinweis	Eine Liste der Arbeitsnotizen und Kommentare, die dem Ticket hinzugefügt werden sollen. Datentyp: Array "note":[ { "text": "String", "@type": "String" } ]
Hinweis.@Typ	Der Typ der Notiz. Dieser Wert bestimmt, ob die Notiz im Feld Arbeitsnotizen oder Zusätzliche Anmerkungen aufgezeichnet wird. Gültige Werte: work_notes Kommentare Datentyp: Zeichenfolge
Hinweis.Text	Der Hinweistext. Ist dem Feld „Arbeitsnotizen“ oder „ Zusätzliche Anmerkungen “ zugeordnet. Datentyp: Zeichenfolge
relatedEntity	Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselemente oder Services. Datentyp: Array "relatedEntity": [ { "id": "String", "@referredType": "String" } ]
relatedEntity.id	Sys_id des betroffenen Elements oder Service. Für Fälle 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 Für Incidents stammt dieser Wert aus einer der folgenden Tabellen: Konfigurationselement [cmdb_ci] Service [cmdb_ci_service] Datentyp: Zeichenfolge
relatedEntity.@referredType	Der Typ des Artikels oder Service. Gültige Werte für Falltickets: Asset Produkt product_inventory Gültige Werte für Incident-Tickets: cmdb_ci cmdb_ci_service Datentyp: Zeichenfolge
relatedPartei	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" } ]
relatedPartei.id	Sys_id der zugehörigen Partei. In 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 oder Unternehmen automatisch in das Ticket eingetragen. Datentyp: Zeichenfolge
relatedPartei.@referenziertTyp	Der Typ der zugehörigen Partei. Gültige Werte: Kunde: Das Unternehmen oder der Account für das Ticket. customer_contact: Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
Schweregrad	Erforderlich. Schweregrad des vom Trouble Ticket beschriebenen Problems. Ist 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. Aktueller Status des Problemtickets. Ist dem Feld Status zugeordnet. Gültige Werte sind die Auswahlmöglichkeiten für das Feld Status. Sie können die Auswahlbezeichnung oder den Wert angeben. 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 Falltabelle [sn_customerservice_case] oder der Incident-Tabelle [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. Ein ungültiger Anforderungstyp oder eine falsch formatierte Anforderung wurde aus einem oder mehreren der folgenden Gründe 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
Kanal	Die Kontaktmethode, über die das Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
channel.name	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 Trouble Tickets, in der Regel eine Kurzbeschreibung 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" } ]
Hinweis.@Typ	Der Typ der Notiz. Es werden nur Kommentare zurückgegeben (keine Arbeitsnotizen), daher ist dieser Wert immerKommentare. Datentyp: Zeichenfolge
Hinweis.Autor	Der Name des Benutzers, der den Kommentar geschrieben hat. Datentyp: Zeichenfolge
Hinweis.Datum	Das Datum, an dem der Kommentar in der Instanz ServiceNow erstellt wurde. Datentyp: Zeichenfolge
Hinweis.Text	Der Kommentartext. Datentyp: Zeichenfolge
relatedEntity	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 Elements oder Service. Für Fälle 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 Für 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 Elements oder Service. Datentyp: Zeichenfolge
relatedEntity.role	Beschreibung des betroffenen Elements oder Service. Datentyp: Zeichenfolge
relatedEntity.@referredType	Der Typ des Artikels oder Service. Gültige Werte für Falltickets: Asset Produkt product_inventory Gültige Werte für Incident-Tickets: cmdb_ci cmdb_ci_service Datentyp: Zeichenfolge
relatedEntity.@type	Dieser Wert ist immer relatedEntity. Datentyp: Zeichenfolge
relatedPartei	Details zu Kontakten für das Ticket. Datentyp: Array "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
relatedPartei.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“. Incident: Unternehmen [core_company]: Typ der zugehörigen Partei ist „ Kunde“. Anwender [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]: Typ der zugehörigen Partei ist „ assigned_to“. Datentyp: Zeichenfolge
relatedPartei.name	Name der zugehörigen Partei. Datentyp: Zeichenfolge
relatedPartei.@referenziertTyp	Der Typ der zugehörigen Partei. Mögliche Werte: assigned_to: Der Benutzer, dem die Arbeit an dem Ticket zugewiesen ist. assignment_group: Die Gruppe, der die Arbeit an dem Ticket zugewiesen ist. Kunde: Das Unternehmen oder der Account für das Ticket. customer_contact: Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
Schweregrad	Schweregrad des vom Trouble Ticket beschriebenen Problems. Datentyp: Zeichenfolge
status	Aktueller Status des Problemtickets. Datentyp: Zeichenfolge
ticketType	Der Typ des Tickets. Mögliche Werte: Fall Incident Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird ein Problemticket-Falldatensatz 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"
}

Trouble Ticket – POST /sn_ind_tsm_sdwan/troubleticket/{ticketType}

Erstellt einen Datensatz in der Falltabelle [sn_customerservice_case] oder der Incident-Tabelle[incident] .

Wichtig:

Ab Release Tokyo ist dieser Endpunkt veraltet. Die neue Version dieses Endpunkts ist Trouble Ticket – 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 Falltabelle [sn_customerservice_case] oder der Incident-Tabelle [incident] erstellt wird. Gültige Werte: Fall Incident Datentyp: Zeichenfolge

Tabelle : 38. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 39. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
Kanal	Die Kontaktmethode, über die das Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
channel.name	Der Name der Kontaktmethode. Ist dem Feld Kanal [contact_type] für Fälle und dem Feld Kontakttyp [contact_type] für Incidents zugeordnet. Gültige Werte sind die Auswahlmöglichkeiten für das Feld „contact_type“. Sie können die Auswahlbezeichnung oder den Wert angeben. Zum Beispiel Virtual Agent oder virtual_agent. Datentyp: Zeichenfolge
Beschreibung	Erforderlich. Eine Beschreibung des Problems. Ist dem Feld Beschreibung zugeordnet. Datentyp: Zeichenfolge
Name	Der Name des Trouble Tickets, in der Regel eine Kurzbeschreibung des Problems. Ist dem Feld Kurzbeschreibung zugeordnet. Datentyp: Zeichenfolge
Hinweis	Eine Liste der Arbeitsnotizen und Kommentare, die dem Ticket hinzugefügt werden sollen. Datentyp: Array "note":[ { "text": "String", "@type": "String" } ]
Hinweis.@Typ	Der Typ der Notiz. Dieser Wert bestimmt, ob die Notiz im Feld Arbeitsnotizen oder Zusätzliche Anmerkungen aufgezeichnet wird. Gültige Werte: work_notes Kommentare Datentyp: Zeichenfolge
Hinweis.Text	Der Hinweistext. Ist dem Feld „Arbeitsnotizen“ oder „ Zusätzliche Anmerkungen “ zugeordnet. Datentyp: Zeichenfolge
relatedEntity	Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselemente oder Services. Datentyp: Array "relatedEntity": [ { "id": "String", "@referredType": "String" } ]
relatedEntity.id	Sys_id des betroffenen Elements oder Service. Für Fälle 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 Für Incidents stammt dieser Wert aus einer der folgenden Tabellen: Konfigurationselement [cmdb_ci] Service [cmdb_ci_service] Datentyp: Zeichenfolge
relatedEntity.@referredType	Der Typ des Artikels oder Service. Gültige Werte für Falltickets: Asset Produkt product_inventory Gültige Werte für Incident-Tickets: cmdb_ci cmdb_ci_service Datentyp: Zeichenfolge
relatedPartei	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" } ]
relatedPartei.@referenziertTyp	Der Typ der zugehörigen Partei. Gültige Werte: Kunde: Das Unternehmen oder der Account für das Ticket. customer_contact: Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
relatedPartei.id	Sys_id der zugehörigen Partei. In 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 oder Unternehmen automatisch in das Ticket eingetragen. Datentyp: Zeichenfolge
Schweregrad	Erforderlich. Schweregrad des vom Trouble Ticket beschriebenen Problems. Ist 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	Aktueller Status des Problemtickets. Ist dem Feld Status zugeordnet. Gültige Werte sind die Auswahlmöglichkeiten für das Feld Status. Sie können die Auswahlbezeichnung oder den Wert angeben. Beispiel: Neu oder 1. Datentyp: Zeichenfolge Standard: Neu
ticketType	Erforderlich. Der Typ des Tickets. Dieser Wert bestimmt, ob der Datensatz in der Falltabelle [sn_customerservice_case] oder der Incident-Tabelle [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. Ein ungültiger Anforderungstyp oder eine falsch formatierte Anforderung wurde aus einem oder mehreren der folgenden Gründe erkannt. Leere Nutzlast. Ungültige Nutzlast. Pflichtfeld fehlt. Ungültiger ticketType oder ticketType stimmt nicht mit dem Pfadparameter ticketType überein. Beispiel: ticketType ist „ case “, der Pfadparameter ist jedoch incident.

Antworttextparameter (JSON oder XML)

Name	Beschreibung
@type	Dieser Wert ist immer TroubleTicket. Datentyp: Zeichenfolge
Kanal	Die Kontaktmethode, über die das Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
channel.name	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 Trouble Tickets, in der Regel eine Kurzbeschreibung 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" } ]
Hinweis.@Typ	Der Typ der Notiz. Gültige Werte: work_notes Kommentare Datentyp: Zeichenfolge
Hinweis.Autor	Der Name des ServiceNow-Integrationsbenutzers, der die POST-Anforderung gestellt hat, die die Notiz erstellt hat. Datentyp: Zeichenfolge
Hinweis.Datum	Das Datum, an dem die Notiz in der ServiceNow-Instanz erstellt wurde Datentyp: Zeichenfolge
Hinweis.Text	Der Hinweistext. Datentyp: Zeichenfolge
relatedEntity	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 Elements oder Service. Für Fälle 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 Für 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 Elements oder Service. Datentyp: Zeichenfolge
relatedEntity.role	Beschreibung des betroffenen Elements oder Service. Datentyp: Zeichenfolge
relatedEntity.@referredType	Der Typ des Artikels oder Service. Gültige Werte für Falltickets: Asset Produkt product_inventory Gültige Werte für Incident-Tickets: cmdb_ci cmdb_ci_service Datentyp: Zeichenfolge
relatedEntity.@type	Dieser Wert ist immer relatedEntity. Datentyp: Zeichenfolge
relatedPartei	Details zu den Unternehmen und Kontakten, die dem Ticket zugeordnet sind. Datentyp: Array "relatedParty": [ { "id": "String", "@referredType": "String" } ]
relatedPartei.id	Sys_id der zugehörigen Partei. In 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 oder Unternehmen automatisch in das Ticket eingetragen. Datentyp: Zeichenfolge
relatedPartei.referenziertTyp	Der Typ der zugehörigen Partei. Gültige Werte: Kunde: Das Unternehmen oder der Account für das Ticket. customer_contact: Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
Schweregrad	Schweregrad des vom Trouble Ticket beschriebenen Problems. Datentyp: Zeichenfolge
status	Aktueller 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 offenem Status 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"
}