Problemticket – API öffnen

Die Problemticket Offen Die API stellt Endpunkte zum Erstellen, Aktualisieren und Abrufen von Daten aus den Tabellen „Fall“ [sn_customerservice_Case] und „Incident“ [Incident] bereit.

Verwenden Sie diese API, um Ticketinformationen zwischen externen Ticketsystemen und zu verwalten ServiceNow AI Platform.

Diese API ist in enthalten Workflows Für Telekommunikationssicherheit -Anwendung, die auf verfügbar ist ServiceNow Store. Die Kundenservice Anwendungen (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 in bereitgestellt sn_ind_tsm_sdwan Namespace.

Der aufrufende Anwender muss über die Rolle Ticket_Integrator verfügen.

Diese API kann erweitert werden, um Anpassungen an erforderlichen Parametern, die Validierung des Anforderungstexts, zusätzliche REST-Vorgänge und Feldzuordnungen vorzunehmen. Weitere Informationen finden Sie unterDie Trouble Ticket Open API Developer Guide .

Die Problemticket Offen API ist ein ServiceNow® Implementierung der REST-Spezifikation der TM Forum Trouble Ticket Management API. Diese Implementierung basiert auf TMF621 Trouble Ticket Management API REST-Spezifikation Release 19 , Juni 2019. Die Problemticket Offen 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: Kanal creationDate Beschreibung href id Letztes Update name note Zugehörige Entität Zugehörige Partei severity status ticketType @TYPE Standard: Gibt alle Felder zurück. Datentyp: Zeichenfolge
id	Problemtickets nach sys_ID filtern Nur Tickets mit der angegebenen sys_ID werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge
limit	Maximale Anzahl der zurückzugebenden Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie offsetParameter zum Paginieren des Datensatzabrufs. Standard: 25 Maximum: 100 Sie können die Standard- und Höchstwerte ändern, indem Sie aktualisieren sn_ind_tsm_sdwan.pagination.set_limitUnd sn_ind_tsm_sdwan.pagination.max_limitSystemeigenschaften. 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. Datentyp: Zahl Standard: 0
severity	Filtern Sie Problemtickets nach Schweregrad. Nur Tickets mit dem angegebenen Schweregrad werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge
status	Filtern Sie Problemtickets nach Status. Nur Tickets mit dem angegebenen Status werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge
ticketType	Filtern Sie Problemtickets nach Tickettyp. Nur Tickets des angegebenen Typs werden in der Antwort zurückgegeben. Gültige Werte: Fall Incident Datentyp: Zeichenfolge

Tabelle : 3. Anforderungstext-Parameter (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	Inhaltsbereich, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn Offset=2 Und Grenzwert = 3 , Der Wert von Content-RangeHeader ist Elemente 3-5 .
Inhaltstyp	Datenformat des Antworttexts. Nur unterstützt 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 REST API-HTTP-Antwortcodes .

Tabelle : 6. Statuscodes

Statuscode	Beschreibung
200	Anforderung erfolgreich verarbeitet. Vollständige Ressource als Antwort zurückgegeben (keine Paginierung).
206	Teilressource als Antwort zurückgegeben (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	Kontaktmethode, über die das Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
channel.name	Der Name der Kontaktmethode. Ordnet zu Kanal Feld [Contact_type] für Fälle und Kontakttyp Feld [Contact_type] für Incidents. Datentyp: Zeichenfolge
creationDate	Das Datum, an dem der Fall oder Incident-Datensatz erstellt wurde. Ordnet zu Erstellt Feld. Datentyp: Zeichenfolge
Beschreibung	Die Beschreibung des Problems aus dem Ticket. Ordnet zu Beschreibung Feld. Datentyp: Zeichenfolge
href	Relativer Link zum Fall- oder Incident-Datensatz. Datentyp: Zeichenfolge
id	Die sys_ID des Fall- oder Incident-Datensatzes. Datentyp: Zeichenfolge
Letztes Update	Das Datum, an dem der Datensatz zuletzt aktualisiert wurde. Ordnet zu Aktualisiert Feld. Datentyp: Zeichenfolge
name	Der Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Ordnet zu Kurzbeschreibung Feld. Datentyp: Zeichenfolge
note	Eine Liste aller Kommentare zum Ticket. Diese Liste enthält keine Arbeitsnotizen. Datentyp: Array "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
Hinweis.@type	Der Typ der Notiz. Es werden nur Kommentare (keine Arbeitsnotizen) zurückgegeben, daher ist dieser Wert immer Kommentare . Datentyp: Zeichenfolge
note.author	Der Name des ServiceNow Integrationsanwender, der die POST- oder PATCH-Anforderung gestellt hat, mit der der Kommentar erstellt wurde. Datentyp: Zeichenfolge
Hinweis.Datum	Das Datum, an dem der Kommentar in erstellt wurde ServiceNow Instanz. Datentyp: Zeichenfolge
Hinweis.Text	Der Kommentartext. Datentyp: Zeichenfolge
Zugehörige Entität	Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselementen oder Services. Datentyp: Array von Objekten "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
Zugehörige Entität.ID	SYS_ID des betroffenen Elements oder Service. In Fällen stammt dieser Wert aus einer der folgenden Tabellen: Asset [alm_asset] Produktbestand [sn_prd_invt_Product_Inventory], der die Tabelle „verkauftes Produkt“ [sn_install_Base_sold_Product] erweitert Produktmodell [cmdb_model] Verkauftes Produkt [sn_install_Base_sold_Product] Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: Konfigurationselement [cmdb_ci] Service [cmdb_ci_service] Datentyp: Zeichenfolge
ZugehörigEntity.href	Gibt eine leere Zeichenfolge zurück. Datentyp: Zeichenfolge
relatedEntity.name	Name des betroffenen Elements oder Service. Datentyp: Zeichenfolge
Zugehörige Entität.Rolle	Beschreibung des betroffenen Elements oder Service. Datentyp: Zeichenfolge
RelatedEntity.@referredType	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
ZugehörigEntity.@type	Dieser Wert ist immer Zugehörige Entität . Datentyp: Zeichenfolge
Zugehörige Partei	Details zu Kontakten für das Ticket. Datentyp: Array von Objekten "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
ZugehörigPartei.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 Zuweisungsgruppe Anwender [sys_user]; Typ der zugehörigen Partei ist Assigned_to Datentyp: Zeichenfolge
relatedParty.name	Name der zugehörigen Partei. Datentyp: Zeichenfolge
RelatedParty.@referredType	Typ der zugehörigen Partei. Mögliche Werte: Assigned_to : Anwender, der der Arbeit am Ticket zugewiesen ist. Zuweisungsgruppe : Gruppe, die der Arbeit am Ticket zugewiesen ist. Kunde : Unternehmen oder Account für das Ticket. Customer_contact : Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
severity	Der Schweregrad des Problems, der im Trouble-Ticket beschrieben wird. Ordnet zu Priorität Feld. Datentyp: Zeichenfolge
status	Der aktuelle Status des Problemtickets. Ordnet zu Status Feld. Datentyp: Zeichenfolge
ticketType	Der Typ des Tickets. Mögliche Werte: Fall Incident Datentyp: Zeichenfolge
@TYPE	Dieser Wert ist immer Problemticket . Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel werden angegebene 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. Datentyp: Zeichenfolge Tabelle: Fall [sn_customerservice_Case] oder Incident [Incident]

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 Letztes Update name note Zugehörige Entität Zugehörige Partei severity status ticketType @TYPE Datentyp: Zeichenfolge Standard: Gibt alle Felder zurück.

Tabelle : 9. Anforderungstext-Parameter (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 REST API-HTTP-Antwortcodes .

Tabelle : 12. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine fehlerhafte Anforderung wurde aus mindestens einem der folgenden Gründe 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
Kanal	Kontaktmethode, über die das Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
channel.name	Name der Kontaktmethode. Ordnet das Feld Kanal [Contact_type] für Fälle und das Feld Kontakttyp [contact_type] für Incidents zu. Datentyp: Zeichenfolge
creationDate	Datum, an dem der Fall oder Incident-Datensatz erstellt wurde. Wird dem Feld erstellt zugeordnet. Datentyp: Zeichenfolge
Beschreibung	Beschreibung des Problems aus dem Ticket. Ordnet dem Beschreibungsfeld zu. Datentyp: Zeichenfolge
href	Relativer Link zum Fall- oder Incident-Datensatz. Datentyp: Zeichenfolge
id	SYS_ID des Fall- oder Incident-Datensatzes. Datentyp: Zeichenfolge
Letztes Update	Datum, an dem der Datensatz zuletzt aktualisiert wurde. Ordnet dem aktualisierten Feld zu. Datentyp: Zeichenfolge
name	Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Ordnet dem Feld „Kurzbeschreibung“ zu. Datentyp: Zeichenfolge
note	Liste aller Kommentare zum Ticket. Diese Liste enthält keine Arbeitsnotizen. Datentyp: Array von Objekten "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
Hinweis.@type	Typ der Notiz. Es werden nur Kommentare (keine Arbeitsnotizen) zurückgegeben, daher ist dieser Wert immer Kommentare . Datentyp: Zeichenfolge
note.author	Name des Anwenders, der den Kommentar geschrieben hat. Datentyp: Zeichenfolge
Hinweis.Datum	Datum, an dem der Kommentar in erstellt wurde ServiceNow Instanz. Datentyp: Zeichenfolge
Hinweis.Text	Kommentartext. Datentyp: Zeichenfolge
Zugehörige Entität	Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselementen oder Services. Datentyp: Array von Objekten "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
Zugehörige Entität.ID	SYS_ID des betroffenen Elements oder Service. In Fällen stammt dieser Wert aus einer der folgenden Tabellen: Asset [alm_asset] Produktbestand [sn_prd_invt_Product_Inventory], der die Tabelle „verkauftes Produkt“ [sn_install_Base_sold_Product] erweitert Produktmodell [cmdb_model] Verkauftes Produkt [sn_install_Base_sold_Product] Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: Konfigurationselement [cmdb_ci] Service [cmdb_ci_service] Datentyp: Zeichenfolge
ZugehörigEntity.href	Gibt eine leere Zeichenfolge zurück. Datentyp: Zeichenfolge
relatedEntity.name	Name des betroffenen Elements oder Service. Datentyp: Zeichenfolge
Zugehörige Entität.Rolle	Beschreibung des betroffenen Elements oder Service. Datentyp: Zeichenfolge
RelatedEntity.@referredType	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
ZugehörigEntity.@type	Dieser Wert ist immer Zugehörige Entität . Datentyp: Zeichenfolge
Zugehörige Partei	Details zu Kontakten für das Ticket. Datentyp: Array von Objekten "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
ZugehörigPartei.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 Zuweisungsgruppe Anwender [sys_user]; Typ der zugehörigen Partei ist Assigned_to Datentyp: Zeichenfolge
relatedParty.name	Name der zugehörigen Partei. Datentyp: Zeichenfolge
RelatedParty.@referredType	Typ der zugehörigen Partei. Mögliche Werte: Assigned_to : Anwender, der der Arbeit am Ticket zugewiesen ist. Zuweisungsgruppe : Gruppe, die der Arbeit am Ticket zugewiesen ist. Kunde : Unternehmen oder Account für das Ticket. Customer_contact : Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
severity	Schweregrad des vom Problemticket beschriebenen Problems. Wird dem Feld Priorität zugeordnet. Datentyp: Zeichenfolge
status	Aktueller Status des Problemtickets. Wird dem Feld Status zugeordnet. Datentyp: Zeichenfolge
ticketType	Typ des Tickets. Mögliche Werte: Fall Incident Datentyp: Zeichenfolge
@TYPE	Dieser Wert ist immer Problemticket . Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird ein Problemticket-Datensatz 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:

Beginnend mit Tokyo Release, dieser Endpunkt ist 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	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: Kanal creationDate Beschreibung id Letztes Update name note Zugehörige Entität Zugehörige Partei severity 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 REST API-HTTP-Antwortcodes .

Tabelle : 18. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine fehlerhafte Anforderung wurde aus mindestens einem der folgenden Gründe 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.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
@TYPE	Dieser Wert ist immer Problemticket . Datentyp: Zeichenfolge
Kanal	Kontaktmethode, über die das Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
channel.name	Name der Kontaktmethode. Ordnet das Feld Kanal [Contact_type] für Fälle und das Feld Kontakttyp [contact_type] für Incidents zu. Datentyp: Zeichenfolge
creationDate	Datum, an dem der Fall oder Incident-Datensatz erstellt wurde. Wird dem Feld erstellt zugeordnet. Datentyp: Zeichenfolge
Beschreibung	Beschreibung des Problems aus dem Ticket. Ordnet dem Beschreibungsfeld zu. Datentyp: Zeichenfolge
id	SYS_ID des Fall- oder Incident-Datensatzes. Datentyp: Zeichenfolge
Letztes Update	Datum, an dem der Datensatz zuletzt aktualisiert wurde. Ordnet dem aktualisierten Feld zu. Datentyp: Zeichenfolge
name	Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Ordnet dem Feld „Kurzbeschreibung“ zu. Datentyp: Zeichenfolge
note	Liste aller Kommentare zum Ticket. Diese Liste enthält keine Arbeitsnotizen. Datentyp: Array von Objekten "note": [ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
Hinweis.@type	Typ der Notiz. Es werden nur Kommentare (keine Arbeitsnotizen) zurückgegeben, daher ist dieser Wert immer Kommentare . Datentyp: Zeichenfolge
note.author	Name des ServiceNow Integrationsanwender, der die POST- oder PATCH-Anforderung gestellt hat, mit der der Kommentar erstellt wurde. Datentyp: Zeichenfolge
Hinweis.Datum	Datum, an dem der Kommentar in erstellt wurde ServiceNow Instanz. Datentyp: Zeichenfolge
Hinweis.Text	Kommentartext. Datentyp: Zeichenfolge
Zugehörige Entität	Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselementen oder Services. Datentyp: Array von Objekten "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
Zugehörige Entität.ID	SYS_ID des betroffenen Elements oder Service. In Fällen stammt dieser Wert aus einer der folgenden Tabellen: Asset [alm_asset] Produktbestand [sn_prd_invt_Product_Inventory], der die Tabelle „verkauftes Produkt“ [sn_install_Base_sold_Product] erweitert Produktmodell [cmdb_model] Verkauftes Produkt [sn_install_Base_sold_Product] Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: Konfigurationselement [cmdb_ci] Service [cmdb_ci_service] Datentyp: Zeichenfolge
ZugehörigEntity.href	Gibt eine leere Zeichenfolge zurück. Datentyp: Zeichenfolge
relatedEntity.name	Name des betroffenen Elements oder Service. Datentyp: Zeichenfolge
Zugehörige Entität.Rolle	Beschreibung des betroffenen Elements oder Service. Datentyp: Zeichenfolge
RelatedEntity.@referredType	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
ZugehörigEntity.@type	Dieser Wert ist immer Zugehörige Entität . Datentyp: Zeichenfolge
Zugehörige Partei	Details zu den Unternehmen und Kontakten, die dem Ticket zugeordnet sind. Datentyp: Array von Objekten "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
RelatedParty.@referredType	Typ der zugehörigen Partei. Gültige Werte: Kunde: Unternehmen oder Account für das Ticket. Customer_contact: Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
relatedParty.id	SYS_ID der zugehörigen Partei. Wenn Sie einen Kontakt oder einen Anwender (Anrufer) angeben, wird sein Account oder Unternehmen automatisch im Ticket ausgefüllt. Datentyp: Zeichenfolge Tabelle: Für Fälle stammt die sys_ID aus den Tabellen „Kontakt“ [Customer_contact] oder „Account“ [Customer_Account]. Bei Incidents stammt die sys_ID aus den Tabellen „Anwender“ [sys_user] oder „Unternehmen“ [Core_Company].
relatedParty.name	Name der zugehörigen Partei. Ordnet für Fälle dem Feld „Kontakt“ oder „Account“ zu. Ordnet für Incidents dem Feld Anrufer oder Unternehmen zu. Datentyp: Zeichenfolge
severity	Schweregrad des vom Problemticket beschriebenen Problems. Wird dem Feld Priorität zugeordnet. Datentyp: Zeichenfolge
status	Aktueller Status des Problemtickets. Ordnet dem Feld zu. Datentyp: Zeichenfolge
ticketType	Typ des Tickets (Fall oder Incident). Datentyp: Zeichenfolge

cURL-Anforderung

Dieses Beispiel ruft den Namen, die Beschreibung, den Schweregrad und den Status eines Falls ab.

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. Datentyp: Zeichenfolge Tabelle: Fall [sn_customerservice_Case] oder Incident [Incident]

Tabelle : 20. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 21. Anforderungstext-Parameter (JSON)

Name	Beschreibung
Kanal	Kontaktmethode, über die das Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
channel.name	Name der Kontaktmethode. Ordnet das Feld Kanal [Contact_type] für Fälle und das Feld Kontakttyp [contact_type] für Incidents zu. 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	Beschreibung des Problems. Ordnet zu Beschreibung Feld. Datentyp: Zeichenfolge
name	Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Ordnet dem Feld „Kurzbeschreibung“ zu. Datentyp: Zeichenfolge
note	Liste der Arbeitsnotizen und Kommentare, die dem Ticket hinzugefügt werden sollen. Datentyp: Array von Objekten "note":[ { "text": "String", "@type": "String" } ]
Hinweis.@type	Typ der Notiz. Dieser Wert bestimmt, ob die Notiz im Feld „Arbeitsnotizen“ oder „zusätzliche Kommentare“ aufgezeichnet wird. Gültige Werte: Kommentare work_notes Datentyp: Zeichenfolge
Hinweis.Text	Hinweistext. Ordnet dem Feld „Arbeitsnotizen“ oder „zusätzliche Kommentare“ zu. Datentyp: Zeichenfolge
Zugehörige Entität	Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselementen oder Services. Datentyp: Array von Objekten "relatedEntity": [ { "id": "String", "@referredType": "String" } ]
relatedEntity.id	SYS_ID des betroffenen Elements oder Service. In Fällen stammt dieser Wert aus einer der folgenden Tabellen: Asset [alm_asset] Produktbestand [sn_prd_invt_Product_Inventory], der die Tabelle „verkauftes Produkt“ [sn_install_Base_sold_Product] erweitert Produktmodell [cmdb_model] Verkauftes Produkt [sn_install_Base_sold_Product] 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 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
Zugehörige Partei	Details zu Kontakten für das Ticket. In 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 von Objekten "relatedParty": [ { "id": "String", "@referredType": "String" } ]
relatedParty.id	SYS_ID der zugehörigen Partei. Wenn Sie einen Kontakt oder einen Anwender (Anrufer) angeben, wird sein Account oder Unternehmen automatisch im Ticket ausgefüllt. Datentyp: Zeichenfolge Tabelle: Für Fälle stammt die sys_ID aus den Tabellen „Kontakt“ [Customer_contact] oder „Account“ [Customer_Account]. Bei Incidents stammt die sys_ID aus den Tabellen „Anwender“ [sys_user] oder „Unternehmen“ [Core_Company].
RelatedParty.@referredType	Typ der zugehörigen Partei. Gültige Werte: Kunde: Unternehmen oder Account für das Ticket. Customer_contact: Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
severity	Schweregrad des vom Problemticket beschriebenen Problems. Ordnet zu Priorität Feld. 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. Ordnet zu Status Feld. Gültige Werte sind die Auswahlmöglichkeiten für Status Feld. Sie können die Bezeichnung oder den Wert der Auswahl 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 REST API-HTTP-Antwortcodes .

Tabelle : 24. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine fehlerhafte Anforderung wurde aus mindestens einem der folgenden Gründe 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
Kanal	Kontaktmethode, über die das Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
channel.name	Name der Kontaktmethode. Datentyp: Zeichenfolge
creationDate	Datum, an dem der Datensatz erstellt wurde. Datentyp: Zeichenfolge
Beschreibung	Beschreibung des Problems aus dem Ticket. Datentyp: Zeichenfolge
href	Relativer Link zum Fall- oder Incident-Datensatz. Datentyp: Zeichenfolge
id	SYS_ID des Fall- oder Incident-Datensatzes. Datentyp: Zeichenfolge
Letztes Update	Datum, an dem der Datensatz zuletzt aktualisiert wurde. Datentyp: Zeichenfolge
name	Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Datentyp: Zeichenfolge
note	Liste aller Kommentare zum Ticket. Diese Liste enthält keine Arbeitsnotizen. Datentyp: Array von Objekten "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
Hinweis.@type	Typ der Notiz. Es werden nur Kommentare (keine Arbeitsnotizen) zurückgegeben, daher ist dieser Wert immer Kommentare . Datentyp: Zeichenfolge
note.author	Name des Anwenders, der den Kommentar geschrieben hat. Datentyp: Zeichenfolge
Hinweis.Datum	Datum, an dem der Kommentar in erstellt wurde ServiceNow Instanz. Datentyp: Zeichenfolge
Hinweis.Text	Kommentartext. Datentyp: Zeichenfolge
Zugehörige Entität	Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselementen oder Services. Datentyp: Array von Objekten "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
Zugehörige Entität.ID	SYS_ID des betroffenen Elements oder Service. In Fällen stammt dieser Wert aus einer der folgenden Tabellen: Asset [alm_asset] Produktbestand [sn_prd_invt_Product_Inventory], der die Tabelle „verkauftes Produkt“ [sn_install_Base_sold_Product] erweitert Produktmodell [cmdb_model] Verkauftes Produkt [sn_install_Base_sold_Product] Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: Konfigurationselement [cmdb_ci] Service [cmdb_ci_service] Datentyp: Zeichenfolge
ZugehörigEntity.href	Gibt eine leere Zeichenfolge zurück. Datentyp: Zeichenfolge
relatedEntity.name	Name des betroffenen Elements oder Service. Datentyp: Zeichenfolge
Zugehörige Entität.Rolle	Beschreibung des betroffenen Elements oder Service. Datentyp: Zeichenfolge
RelatedEntity.@referredType	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
ZugehörigEntity.@type	Dieser Wert ist immer Zugehörige Entität . Datentyp: Zeichenfolge
Zugehörige Partei	Details zu Kontakten für das Ticket. Datentyp: Array von Objekten "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
ZugehörigPartei.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 Zuweisungsgruppe Anwender [sys_user]; Typ der zugehörigen Partei ist Assigned_to Datentyp: Zeichenfolge
relatedParty.name	Name der zugehörigen Partei. Datentyp: Zeichenfolge
RelatedParty.@referredType	Typ der zugehörigen Partei. Mögliche Werte: Assigned_to : Anwender, der der Arbeit am Ticket zugewiesen ist. Zuweisungsgruppe : Gruppe, die der Arbeit am Ticket zugewiesen ist. Kunde : Unternehmen oder Account für das Ticket. Customer_contact : Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
severity	Schweregrad des vom Problemticket beschriebenen Problems. Datentyp: Zeichenfolge
status	Aktueller Status des Problemtickets. Datentyp: Zeichenfolge
ticketType	Typ des Tickets. Mögliche Werte: Fall Incident Datentyp: Zeichenfolge
@TYPE	Dieser Wert ist immer Problemticket . Datentyp: Zeichenfolge

cURL-Anforderung

Dieses Beispiel aktualisiert einen Falldatensatz.

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:

Beginnend mit Tokyo Release, dieser Endpunkt ist 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	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	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	Kontaktmethode, über die das Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
channel.name	Name der Kontaktmethode. Ordnet das Feld Kanal [Contact_type] für Fälle und das Feld Kontakttyp [contact_type] für Incidents zu. 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	Beschreibung des Problems. Ordnet zu Beschreibung Feld. Datentyp: Zeichenfolge
name	Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Ordnet dem Feld „Kurzbeschreibung“ zu. Datentyp: Zeichenfolge
note	Liste der Arbeitsnotizen und Kommentare, die dem Ticket hinzugefügt werden sollen. Datentyp: Array von Objekten "note":[ { "text": "String", "@type": "String" } ]
Hinweis.@type	Typ der Notiz. Dieser Wert bestimmt, ob die Notiz im Feld „Arbeitsnotizen“ oder „zusätzliche Kommentare“ aufgezeichnet wird. Gültige Werte: Kommentare work_notes Datentyp: Zeichenfolge
Hinweis.Text	Hinweistext. Ordnet dem Feld „Arbeitsnotizen“ oder „zusätzliche Kommentare“ zu. Datentyp: Zeichenfolge
Zugehörige Entität	Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselementen oder Services. Datentyp: Array von Objekten "relatedEntity": [ { "id": "String", "@referredType": "String" } ]
relatedEntity.id	SYS_ID des betroffenen Elements oder Service. In Fällen stammt dieser Wert aus einer der folgenden Tabellen: Asset [alm_asset] Produktbestand [sn_prd_invt_Product_Inventory], der die Tabelle „verkauftes Produkt“ [sn_install_Base_sold_Product] erweitert Produktmodell [cmdb_model] Verkauftes Produkt [sn_install_Base_sold_Product] 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 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
Zugehörige Partei	Details zu Kontakten für das Ticket. In 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 von Objekten "relatedParty": [ { "id": "String", "@referredType": "String" } ]
RelatedParty.@referredType	Typ der zugehörigen Partei. Gültige Werte: Kunde: Unternehmen oder Account für das Ticket. Customer_contact: Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
relatedParty.id	SYS_ID der zugehörigen Partei. Wenn Sie einen Kontakt oder einen Anwender (Anrufer) angeben, wird sein Account oder Unternehmen automatisch im Ticket ausgefüllt. Datentyp: Zeichenfolge Tabelle: Für Fälle stammt die sys_ID aus den Tabellen „Kontakt“ [Customer_contact] oder „Account“ [Customer_Account]. Bei Incidents stammt die sys_ID aus den Tabellen „Anwender“ [sys_user] oder „Unternehmen“ [Core_Company].
severity	Schweregrad des vom Problemticket beschriebenen Problems. Ordnet zu Priorität Feld. 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. 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. 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 REST API-HTTP-Antwortcodes .

Tabelle : 30. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine fehlerhafte Anforderung wurde aus mindestens einem der folgenden Gründe 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.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
@TYPE	Dieser Wert ist immer Problemticket . Datentyp: Zeichenfolge
Kanal	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
Letztes Update	Das Datum, an dem der Datensatz zuletzt aktualisiert wurde. Datentyp: Zeichenfolge
name	Der Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Datentyp: Zeichenfolge
note	Eine Liste aller Kommentare zum Ticket. Diese Liste enthält keine Arbeitsnotizen. Datentyp: Array "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
Hinweis.@type	Der Typ der Notiz. Es werden nur Kommentare (keine Arbeitsnotizen) zurückgegeben, daher ist dieser Wert immer Kommentare . Datentyp: Zeichenfolge
note.author	Der Name des ServiceNow-Integrationsanwenders, der die POST- oder PATCH-Anforderung gestellt hat, mit der der Kommentar erstellt wurde. Datentyp: Zeichenfolge
Hinweis.Datum	Das Datum, an dem der Kommentar in der ServiceNow-Instanz erstellt wurde. Datentyp: Zeichenfolge
Hinweis.Text	Der Kommentartext. Datentyp: Zeichenfolge
Zugehörige Entität	Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselementen oder Services. Datentyp: Array von Objekten "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
Zugehörige Entität.ID	SYS_ID des betroffenen Elements oder Service. In Fällen stammt dieser Wert aus einer der folgenden Tabellen: Asset [alm_asset] Produktbestand [sn_prd_invt_Product_Inventory], der die Tabelle „verkauftes Produkt“ [sn_install_Base_sold_Product] erweitert Produktmodell [cmdb_model] Verkauftes Produkt [sn_install_Base_sold_Product] Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: Konfigurationselement [cmdb_ci] Service [cmdb_ci_service] Datentyp: Zeichenfolge
ZugehörigEntity.href	Gibt eine leere Zeichenfolge zurück. Datentyp: Zeichenfolge
relatedEntity.name	Name des betroffenen Elements oder Service. Datentyp: Zeichenfolge
Zugehörige Entität.Rolle	Beschreibung des betroffenen Elements oder Service. Datentyp: Zeichenfolge
RelatedEntity.@referredType	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
ZugehörigEntity.@type	Dieser Wert ist immer Zugehörige Entität . 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" } ]
RelatedParty.@referredType	Typ der zugehörigen Partei. Gültige Werte: Kunde: Unternehmen oder Account für das Ticket. Customer_contact: Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
ZugehörigPartei.ID	SYS_ID der zugehörigen Partei. Wenn Sie einen Kontakt oder einen Anwender (Anrufer) angeben, wird sein Account oder Unternehmen automatisch im Ticket ausgefüllt. Datentyp: Zeichenfolge Tabelle: Für Fälle stammt die sys_ID aus den Tabellen „Kontakt“ [Customer_contact] oder „Account“ [Customer_Account]. Bei Incidents stammt die sys_ID aus den Tabellen „Anwender“ [sys_user] oder „Unternehmen“ [Core_Company].
relatedParty.name	Der Name der zugehörigen Partei. Datentyp: Zeichenfolge
severity	Der Schweregrad des Problems, der im Trouble-Ticket beschrieben wird. Datentyp: Zeichenfolge
status	Der aktuelle Status des Problemtickets. Datentyp: Zeichenfolge
ticketType	Der Typ des Tickets (Fall oder Incident). Datentyp: Zeichenfolge

cURL-Anforderung

Dieses Beispiel aktualisiert einen Falldatensatz.

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. Anforderungstext-Parameter (JSON)

Name	Beschreibung
Kanal	Kontaktmethode, über die das Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
channel.name	Name der Kontaktmethode. Ordnet das Feld Kanal [Contact_type] für Fälle und das Feld Kontakttyp [contact_type] für Incidents zu. 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. Ordnet zu Beschreibung Feld. Datentyp: Zeichenfolge
name	Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Ordnet dem Feld „Kurzbeschreibung“ zu. Datentyp: Zeichenfolge
note	Liste der Arbeitsnotizen und Kommentare, die dem Ticket hinzugefügt werden sollen. Datentyp: Array von Objekten "note":[ { "text": "String", "@type": "String" } ]
Hinweis.@type	Typ der Notiz. Dieser Wert bestimmt, ob die Notiz im Feld „Arbeitsnotizen“ oder „zusätzliche Kommentare“ aufgezeichnet wird. Gültige Werte: Kommentare work_notes Datentyp: Zeichenfolge
Hinweis.Text	Hinweistext. Ordnet dem Feld „Arbeitsnotizen“ oder „zusätzliche Kommentare“ zu. Datentyp: Zeichenfolge
Zugehörige Entität	Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselementen oder Services. Datentyp: Array von Objekten "relatedEntity": [ { "id": "String", "@referredType": "String" } ]
relatedEntity.id	SYS_ID des betroffenen Elements oder Service. In Fällen stammt dieser Wert aus einer der folgenden Tabellen: Asset [alm_asset] Produktbestand [sn_prd_invt_Product_Inventory], der die Tabelle „verkauftes Produkt“ [sn_install_Base_sold_Product] erweitert Produktmodell [cmdb_model] Verkauftes Produkt [sn_install_Base_sold_Product] 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 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
Zugehörige Partei	Details zu Kontakten für das Ticket. In 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 von Objekten "relatedParty": [ { "id": "String", "@referredType": "String" } ]
relatedParty.id	SYS_ID der zugehörigen Partei. Wenn Sie einen Kontakt oder einen Anwender (Anrufer) angeben, wird sein Account oder Unternehmen automatisch im Ticket ausgefüllt. Datentyp: Zeichenfolge Tabelle: Für Fälle stammt die sys_ID aus den Tabellen „Kontakt“ [Customer_contact] oder „Account“ [Customer_Account]. Bei Incidents stammt die sys_ID aus den Tabellen „Anwender“ [sys_user] oder „Unternehmen“ [Core_Company].
RelatedParty.@referredType	Typ der zugehörigen Partei. Gültige Werte: Kunde: Unternehmen oder Account für das Ticket. Customer_contact: Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
severity	Erforderlich. Der Schweregrad des Problems, der im Trouble-Ticket beschrieben wird. Ordnet zu Priorität Feld. 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. Ordnet zu Status Feld. Gültige Werte sind die Auswahlmöglichkeiten für Status Feld. Sie können die Bezeichnung oder den Wert der Auswahl angeben. Beispiel: Neu Oder 1 . Wenn Sie einen ungültigen Wert angeben , Der Status wird 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 REST API-HTTP-Antwortcodes .

Tabelle : 36. Statuscodes

Statuscode	Beschreibung
201	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine fehlerhafte Anforderung wurde aus mindestens einem 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 Problemticket . Datentyp: Zeichenfolge
Kanal	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 Falls oder Incident-Datensatzes, der erstellt wurde. Datentyp: Zeichenfolge
Letztes Update	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
note	Eine Liste aller Kommentare zum Ticket. Diese Liste enthält keine Arbeitsnotizen. Datentyp: Array "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
Hinweis.@type	Der Typ der Notiz. Es werden nur Kommentare (keine Arbeitsnotizen) zurückgegeben, daher ist dieser Wert immer Kommentare . Datentyp: Zeichenfolge
note.author	Der Name des Anwenders, der den Kommentar geschrieben hat. Datentyp: Zeichenfolge
Hinweis.Datum	Das Datum, an dem der Kommentar in erstellt wurde ServiceNow Instanz. Datentyp: Zeichenfolge
Hinweis.Text	Der Kommentartext. Datentyp: Zeichenfolge
Zugehörige Entität	Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselementen oder Services. Datentyp: Array von Objekten "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
Zugehörige Entität.ID	SYS_ID des betroffenen Elements oder Service. In Fällen stammt dieser Wert aus einer der folgenden Tabellen: Asset [alm_asset] Produktbestand [sn_prd_invt_Product_Inventory], der die Tabelle „verkauftes Produkt“ [sn_install_Base_sold_Product] erweitert Produktmodell [cmdb_model] Verkauftes Produkt [sn_install_Base_sold_Product] Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: Konfigurationselement [cmdb_ci] Service [cmdb_ci_service] Datentyp: Zeichenfolge
ZugehörigEntity.href	Gibt eine leere Zeichenfolge zurück. Datentyp: Zeichenfolge
relatedEntity.name	Name des betroffenen Elements oder Service. Datentyp: Zeichenfolge
Zugehörige Entität.Rolle	Beschreibung des betroffenen Elements oder Service. Datentyp: Zeichenfolge
RelatedEntity.@referredType	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
ZugehörigEntity.@type	Dieser Wert ist immer Zugehörige Entität . Datentyp: Zeichenfolge
Zugehörige Partei	Details zu Kontakten für das Ticket. Datentyp: Array von Objekten "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
ZugehörigPartei.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 Zuweisungsgruppe Anwender [sys_user]; Typ der zugehörigen Partei ist Assigned_to Datentyp: Zeichenfolge
relatedParty.name	Name der zugehörigen Partei. Datentyp: Zeichenfolge
RelatedParty.@referredType	Typ der zugehörigen Partei. Mögliche Werte: Assigned_to : Anwender, der der Arbeit am Ticket zugewiesen ist. Zuweisungsgruppe : Gruppe, die der Arbeit am Ticket zugewiesen ist. Kunde : Unternehmen oder Account für das Ticket. Customer_contact : Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
severity	Der Schweregrad des Problems, der im Trouble-Ticket beschrieben wird. 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 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"
}

Problemticket – POST /sn_ind_tsm_sdwan/troubleticket/{ticketType}

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

Wichtig:

Beginnend mit Tokyo Release, dieser Endpunkt ist 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
Kanal	Kontaktmethode, über die das Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
channel.name	Name der Kontaktmethode. Ordnet das Feld Kanal [Contact_type] für Fälle und das Feld Kontakttyp [contact_type] für Incidents zu. 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. Ordnet zu Beschreibung Feld. Datentyp: Zeichenfolge
name	Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Ordnet dem Feld „Kurzbeschreibung“ zu. Datentyp: Zeichenfolge
note	Liste der Arbeitsnotizen und Kommentare, die dem Ticket hinzugefügt werden sollen. Datentyp: Array von Objekten "note":[ { "text": "String", "@type": "String" } ]
Hinweis.@type	Typ der Notiz. Dieser Wert bestimmt, ob die Notiz im Feld „Arbeitsnotizen“ oder „zusätzliche Kommentare“ aufgezeichnet wird. Gültige Werte: Kommentare work_notes Datentyp: Zeichenfolge
Hinweis.Text	Hinweistext. Ordnet dem Feld „Arbeitsnotizen“ oder „zusätzliche Kommentare“ zu. Datentyp: Zeichenfolge
Zugehörige Entität	Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselementen oder Services. Datentyp: Array von Objekten "relatedEntity": [ { "id": "String", "@referredType": "String" } ]
relatedEntity.id	SYS_ID des betroffenen Elements oder Service. In Fällen stammt dieser Wert aus einer der folgenden Tabellen: Asset [alm_asset] Produktbestand [sn_prd_invt_Product_Inventory], der die Tabelle „verkauftes Produkt“ [sn_install_Base_sold_Product] erweitert Produktmodell [cmdb_model] Verkauftes Produkt [sn_install_Base_sold_Product] 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 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
Zugehörige Partei	Details zu Kontakten für das Ticket. In 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 von Objekten "relatedParty": [ { "id": "String", "@referredType": "String" } ]
RelatedParty.@referredType	Typ der zugehörigen Partei. Gültige Werte: Kunde: Unternehmen oder Account für das Ticket. Customer_contact: Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
relatedParty.id	SYS_ID der zugehörigen Partei. Wenn Sie einen Kontakt oder einen Anwender (Anrufer) angeben, wird sein Account oder Unternehmen automatisch im Ticket ausgefüllt. Datentyp: Zeichenfolge Tabelle: Für Fälle stammt die sys_ID aus den Tabellen „Kontakt“ [Customer_contact] oder „Account“ [Customer_Account]. Bei Incidents stammt die sys_ID aus den Tabellen „Anwender“ [sys_user] oder „Unternehmen“ [Core_Company].
severity	Erforderlich. Schweregrad des vom Problemticket beschriebenen Problems. Ordnet zu Priorität Feld. 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. Ordnet zu Status Feld. Gültige Werte sind die Auswahlmöglichkeiten für Status Feld. Sie können die Bezeichnung oder den Wert der Auswahl angeben. Beispiel: Neu Oder 1 . Datentyp: Zeichenfolge Standard: Neu
ticketType	Erforderlich. 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 REST API-HTTP-Antwortcodes .

Tabelle : 42. Statuscodes

Statuscode	Beschreibung
201	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine fehlerhafte Anforderung wurde aus mindestens einem der folgenden Gründe erkannt. Leere Nutzlast. Ungültige Nutzlast. Pflichtfeld fehlt. Ungültiger ticketType oder ticketType stimmt nicht mit Pfadparameter ticketType überein. TicketType ist beispielsweise Fall Der Pfadparameter ist jedoch Incident .

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
@TYPE	Dieser Wert ist immer Problemticket . Datentyp: Zeichenfolge
Kanal	Kontaktmethode, über die das Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" }
channel.name	Name der Kontaktmethode. Datentyp: Zeichenfolge
creationDate	Datum, an dem der Fall oder Incident-Datensatz erstellt wurde. Datentyp: Zeichenfolge
Beschreibung	Beschreibung des Problems aus dem Ticket. Datentyp: Zeichenfolge
id	SYS_ID des Falls oder Incident-Datensatzes, der erstellt wurde. Datentyp: Zeichenfolge
Letztes Update	Datum, an dem der Fall oder Incident-Datensatz zuletzt aktualisiert wurde. Datentyp: Zeichenfolge
name	Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Datentyp: Zeichenfolge
note	Liste der Kommentare und Arbeitsnotizen, die dem Ticket durch die POST-Anforderung hinzugefügt wurden. Datentyp: Array von Objekten "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
Hinweis.@type	Typ der Notiz. Gültige Werte: Kommentare work_notes Datentyp: Zeichenfolge
note.author	Name des ServiceNow Integrationsanwender, der die POST-Anforderung gestellt hat, mit der die Notiz erstellt wurde. Datentyp: Zeichenfolge
Hinweis.Datum	Datum, an dem die Notiz in erstellt wurde ServiceNow Instanz. Datentyp: Zeichenfolge
Hinweis.Text	Hinweistext. Datentyp: Zeichenfolge
Zugehörige Entität	Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselementen oder Services. Datentyp: Array von Objekten "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
Zugehörige Entität.ID	SYS_ID des betroffenen Elements oder Service. In Fällen stammt dieser Wert aus einer der folgenden Tabellen: Asset [alm_asset] Produktbestand [sn_prd_invt_Product_Inventory], der die Tabelle „verkauftes Produkt“ [sn_install_Base_sold_Product] erweitert Produktmodell [cmdb_model] Verkauftes Produkt [sn_install_Base_sold_Product] Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: Konfigurationselement [cmdb_ci] Service [cmdb_ci_service] Datentyp: Zeichenfolge
ZugehörigEntity.href	Gibt eine leere Zeichenfolge zurück. Datentyp: Zeichenfolge
relatedEntity.name	Name des betroffenen Elements oder Service. Datentyp: Zeichenfolge
Zugehörige Entität.Rolle	Beschreibung des betroffenen Elements oder Service. Datentyp: Zeichenfolge
RelatedEntity.@referredType	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
ZugehörigEntity.@type	Dieser Wert ist immer Zugehörige Entität . Datentyp: Zeichenfolge
Zugehörige Partei	Details zu den Unternehmen und Kontakten, die dem Ticket zugeordnet sind. Datentyp: Array von Objekten "relatedParty": [ { "id": "String", "@referredType": "String" } ]
ZugehörigPartei.ID	SYS_ID der zugehörigen Partei. Wenn Sie einen Kontakt oder einen Anwender (Anrufer) angeben, wird sein Account oder Unternehmen automatisch im Ticket ausgefüllt. Datentyp: Zeichenfolge Tabelle: Für Fälle stammt die sys_ID aus den Tabellen „Kontakt“ [Customer_contact] oder „Account“ [Customer_Account]. Bei Incidents stammt die sys_ID aus den Tabellen „Anwender“ [sys_user] oder „Unternehmen“ [Core_Company].
ZugehörigPartei.ReferredType	Typ der zugehörigen Partei. Gültige Werte: Kunde: Unternehmen oder Account für das Ticket. Customer_contact: Anrufer oder Kontakt für das Ticket. Datentyp: Zeichenfolge
severity	Schweregrad des vom Problemticket beschriebenen Problems. Datentyp: Zeichenfolge
status	Aktueller Status des Problemtickets. Datentyp: Zeichenfolge
ticketType	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"
}