---
sourceDocument: Xanadu-API-Referenz
sourceDocumentLink: https://www.servicenow.com/docs/r/de-DE/xanadu/api-reference
Release :
- xanadu
ft:locale :
- de-DE
ft:publication_title :
- Xanadu-API-Referenz
ft:clusterId :
- crapiref
bundleId :
- crapiref
workflow :
- Creator
---
# Offene Trouble Ticket-API
# Offene Trouble Ticket-API {#ariaid-title1}
* Freigeben Version: Xanadu
*
* Aktualisiert 1. August 2024
*
*  43 Minuten Lesedauer
Die Trouble Ticket Open API bietet Endpunkte zum Erstellen, Aktualisieren und Abrufen von Daten aus den Tabellen „Fall" \[sn_customerservice_case\] und „Incident" \[incident\].
Verwenden Sie diese API, um Ticketinformationen zwischen externen Ticketsystemen und Now Platformzu verwalten.
Diese API ist in der Anwendung [Telecommunications Assurance Workflows](https://store.servicenow.com/sn_appstore_store.do#!/store/application/9e07323d5b2110100206cb837b81c773) enthalten, die unter ServiceNow Storeverfügbar ist. Die Anwendungen Kundenservice (com.sn_customerservice) und „Customer Service Install Base Management" (com.snc.install_base) sind erforderlich, um diese API mit der Tabelle „Fall" \[sn_customerservice_case\] zu verwenden.
Diese API wird im Namespace `sn_ind_tsm_sdwan` bereitgestellt.
Der anrufende Benutzer muss über die Rolle ticket_integrator verfügen.
Diese API kann erweitert werden, um Anpassungen für erforderliche Parameter, die Validierung des Anforderungstexts, zusätzliche REST-Vorgänge und Feldzuordnungen vorzunehmen. Weitere Informationen finden Sie unter das [Problem Ticket Open API Developer Guide](https://www.servicenow.com/docs/nq22_fBEPvSvP7acrfCy7Q#trouble-ticket_dev-guide "Verwenden Sie die Trouble Ticket Open API, um Ticketinformationen zwischen externen Ticketsystemen und der Now Platform zu verwalten. Diese API erstellt, aktualisiert und ruft Daten aus den Tabellen „Fall“ [sn_customerservice_case] und „Incident“ [incident] ab.").
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](https://www.tmforum.org/resources/specification/tmf621-trouble-ticket-management-api-rest-specification-r19-0-0/), Juni 2019. Die Trouble Ticket Open API ist vom TM Forum zertifiziert.
## Problemticket: GET /sn_ind_tsm_sdwan/ticket/troubleTicket {#ariaid-title2}
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
{#trouble-ticket-GET-ticket-tt__entry__2}
| Name | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 1. Pfadparameter]
{#trouble-ticket-GET-ticket-tt__entry__6}
| Name | Beschreibung |
|-|-|
| Felder | Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Felder: * channel * creationDate * Beschreibung * href * id * lastUpdate * name * Hinweis * ZugehörigeEntität * Zugehörige Partei * Schweregrad * status * ticketType * @type {#trouble-ticket-GET-ticket-tt__ul_n1h_htz_54b} Standard: Gibt alle Felder zurück. Datentyp: Zeichenfolge |
| id | Filtern Sie Problemtickets nach sys_id. In der Antwort werden nur Tickets mit der angegebenen sys_id zurückgegeben. Datentyp: Zeichenfolge |
| limit | Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter offset, um den Datensatzabruf zu paginieren. Standard: 25 Maximum: 100 Sie können die Standard- und Höchstwerte ändern, indem Sie die Systemeigenschaften sn_ind_tsm_sdwan.pagination.set_limit und sn_ind_tsm_sdwan.pagination.max_limit aktualisieren. Datentyp: Zahl |
| Offset | Startindex, ab dem mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Standard: 0 Datentyp: Zahl |
| Schweregrad | Filtern Sie Problemtickets nach Schweregrad. In der Antwort werden nur Tickets mit dem angegebenen Schweregrad zurückgegeben. Datentyp: Zeichenfolge |
| status | Filtern Sie Problemtickets nach Status. In der Antwort werden nur Tickets mit dem angegebenen Status zurückgegeben. Datentyp: Zeichenfolge |
| ticketType | Filtern Sie Problemtickets nach Tickettyp. In der Antwort werden nur Tickets des angegebenen Typs zurückgegeben. Gültige Werte: * Fall * Incident {#trouble-ticket-GET-ticket-tt__ul_pb5_lk3_ktb} Datentyp: Zeichenfolge |
[Tabelle : 2. Abfrageparameter]
{#trouble-ticket-GET-ticket-tt__entry__22}
| Name | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 3. Parameter des Anforderungstexts (JSON)]
### 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](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#trouble-ticket-GET-ticket-tt__entry__26}
| Kopfzeile | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 4. Anforderungskopfzeilen]
{#trouble-ticket-GET-ticket-tt__table_c2r_4gm_lsb__entry__2}{#trouble-ticket-GET-ticket-tt__content-range-row}{#trouble-ticket-GET-ticket-tt__content-type-row}{#trouble-ticket-GET-ticket-tt__links-pagination-row}{#trouble-ticket-GET-ticket-tt__x-total-count-descr}
| Kopfzeile | Beschreibung |
|-|-|
| Inhaltsbereich | Gibt den Inhaltsbereich an, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn `Offset=2` und `Limit=3`, ist der Wert des Content-Range -Headers `Elemente 3-5`. |
| Inhaltstyp | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Verknüpfung | Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse. * zuerst * letzte * Weiter * previous {#trouble-ticket-GET-ticket-tt__ul_zzk_sdm_lsb} |
| X-Gesamtzahl | Für paginierte Abfragen gibt dieser Header die Gesamtzahl der auf dem Server verfügbaren Datensätze an. |
[Tabelle : 5. Antwortkopfzeilen]
{#trouble-ticket-GET-ticket-tt__table_c2r_4gm_lsb}
### Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#trouble-ticket-GET-ticket-tt__table_qbg_4cm_lsb__entry__2}{#trouble-ticket-GET-ticket-tt__tmf-get-status-200-p}{#trouble-ticket-GET-ticket-tt__tmf-get-status-206-entry}{#trouble-ticket-GET-ticket-tt__tmf-get-status-400-entry}{#trouble-ticket-GET-ticket-tt__tmf-get-status-404-entry}
| Statuscode | Beschreibung |
|-|-|
| 200 | Anforderung erfolgreich verarbeitet. Vollständige Ressource, die als Antwort zurückgegeben wird (keine Paginierung). |
| 206 | Teilressource, die als Antwort zurückgegeben wird (mit Paginierung). |
| 400 | Ungültige Anforderung. Mögliche Gründe: * Ungültiger Pfadparameter * Ungültiger URI {#trouble-ticket-GET-ticket-tt__ul_rys_1gy_fsb} |
| 404 | Datensatz nicht gefunden In der Tabelle wurden keine Datensätze gefunden, die den Abfrageparametern entsprechen. |
[Tabelle : 6. Statuscodes]
{#trouble-ticket-GET-ticket-tt__table_qbg_4cm_lsb}
### Parameter des Antwort-Haupttexts (JSON) {#trouble-ticket-GET-ticket-tt__section_mgj_t43_ktb}
{#trouble-ticket-GET-ticket-tt__table_n4d_yvm_5pb__entry__2}
| Name | Beschreibung |
|-|-|
| channel | Die Kontaktmethode, mit der dieses Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" } |
| Kanalname | Der Name der Kontaktmethode Wird dem Feld „ Kanal " \[contact_type\] für Fälle und dem Feld „ Kontakttyp" \[contact_type\] für Incidents zugewiesen. Datentyp: Zeichenfolge |
| creationDate | Das Datum, an dem der Fall- oder Incident-Datensatz erstellt wurde. Wird dem Feld „ Erstellt " zugeordnet. Datentyp: Zeichenfolge |
| Beschreibung | Die Beschreibung des Problems aus dem Ticket. Wird dem Feld „ Beschreibung " zugeordnet. Datentyp: Zeichenfolge |
| href | Relativer Link zum Fall- oder Incident-Datensatz. Datentyp: Zeichenfolge |
| id | Die sys_id des Fall- oder Incident-Datensatzes. Datentyp: Zeichenfolge |
| lastUpdate | Das Datum, an dem der Datensatz zuletzt aktualisiert wurde. Wird dem Feld „ Aktualisiert " zugeordnet. Datentyp: Zeichenfolge |
| name | Der Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Wird dem Feld Kurzbeschreibung zugeordnet. Datentyp: Zeichenfolge |
| Hinweis | Eine Liste aller Kommentare zum Ticket. Diese Liste enthält keine Arbeitsnotizen. Datentyp: Array "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ] |
| Anmerkung.@Typ | Der Typ der Notiz. Es werden nur Kommentare zurückgegeben (keine Arbeitsnotizen), daher ist dieser Wert immer `Kommentare`. Datentyp: Zeichenfolge |
| Anmerkung.Autor | Der Name des ServiceNow -Integrationsanwenders, der die POST- oder PATCH-Anforderung erstellt hat, von der der Kommentar erstellt wurde. Datentyp: Zeichenfolge |
| Notiz.Datum | Das Datum, an dem der Kommentar in der Instanz ServiceNow erstellt wurde. Datentyp: Zeichenfolge |
| Anmerkung.Text | Der Kommentartext. Datentyp: Zeichenfolge |
| ZugehörigeEntität | Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselemente oder Services. Datentyp: Array "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ] |
| relatedEntity.id | Sys_id des betroffenen Artikels oder Services. Bei Fällen stammt dieser Wert aus einer der folgenden Tabellen: * Asset \[alm_asset\] * Produktmodell \[cmdb_model\] * Verkauftes Produkt \[sn_install_base_sold_product\] * „Produktbestand" \[sn_prd_invt_product_inventory\], der die Tabelle „Verkaufte Produkte" \[sn_install_base_sold_product\] erweitert {#trouble-ticket-GET-ticket-tt__ul_en1_3jc_hwb}Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: * Konfigurationselement \[cmdb_ci\] * Service \[cmdb_ci_service\] {#trouble-ticket-GET-ticket-tt__ul_fn1_3jc_hwb} Datentyp: Zeichenfolge |
| relatedEntity.href | Gibt eine leere Zeichenfolge zurück. Datentyp: Zeichenfolge |
| relatedEntity.name | Name des betroffenen Artikels oder Services. Datentyp: Zeichenfolge |
| ZugehörigeEntität.Rolle | Beschreibung des betroffenen Artikels oder Services. Datentyp: Zeichenfolge |
| relatedEntity.@referredType | Typ des Artikels oder Services. Gültige Werte für Falltickets: * Asset * product * product_inventory {#trouble-ticket-GET-ticket-tt__ul_zrm_5jp_mtb} Gültige Werte für Incident-Tickets: * cmdb_ci * cmdb_ci_service {#trouble-ticket-GET-ticket-tt__ul_asm_5jp_mtb} Datentyp: Zeichenfolge |
| ZugehörigeEntität.@Typ | Dieser Wert ist immer `„relatedEntity"`. Datentyp: Zeichenfolge |
| Zugehörige Partei | Details zu Kontakten für das Ticket. Datentyp: Array "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ] |
| Zugehörigepartei.id | Sys_id der zugehörigen Partei. Die sys_id kann je nach Tickettyp und Typ der zugehörigen Partei aus den folgenden Tabellen stammen. Fall: * Account \[customer_account\]: Typ der zugehörigen Partei ist „ Kunde". * Kontakt \[customer_contact\]: Typ der zugehörigen Partei ist „ customer_contact". {#trouble-ticket-GET-ticket-tt__ul_vf5_n3g_4tb} Vorfall: * Unternehmen \[core_company\]: Typ der zugehörigen Partei ist „ Kunde". * Benutzer \[sys_user\]: Typ der zugehörigen Partei ist „ customer_contact". {#trouble-ticket-GET-ticket-tt__ul_ll2_p3g_4tb} Fall oder Incident: * Gruppe \[sys_user_group\]: Typ der zugehörigen Partei ist „ assignment_group". * Anwender \[sys_user\]: Der zugehörige Parteityp ist assigned_to {#trouble-ticket-GET-ticket-tt__ul_umf_r3g_4tb} Datentyp: Zeichenfolge |
| relatedParty.name | Name der zugehörigen Partei. Datentyp: Zeichenfolge |
| zugehörigepartei.@referenztyp | Typ der zugehörigen Partei Mögliche Werte: * assigned_to: Der Anwender, der für die Bearbeitung des Tickets zugewiesen ist. * assignment_group: Die Gruppe, die für die Bearbeitung des Tickets zugewiesen ist. * Kunde: Das Unternehmen oder der Account für das Ticket. * Customer_contact: Der Anrufer oder Kontakt für das Ticket. {#trouble-ticket-GET-ticket-tt__ul_bxv_jgg_4tb} Datentyp: Zeichenfolge |
| Schweregrad | Der Schweregrad des im Problemticket beschriebenen Problems. Wird dem Feld „ Priorität" zugewiesen. Datentyp: Zeichenfolge |
| status | Der aktuelle Status des Problemtickets. Wird dem Feld „Status" zugeordnet. Datentyp: Zeichenfolge |
| ticketType | Der Typ des Tickets. Mögliche Werte: * Fall * Incident {#trouble-ticket-GET-ticket-tt__ul_czp_2mc_ktb} Datentyp: Zeichenfolge |
| @type | Dieser Wert ist immer `TroubleTicket`. Datentyp: Zeichenfolge |
[ ]
{#trouble-ticket-GET-ticket-tt__table_n4d_yvm_5pb}
### cURL-Anforderung
In diesem Beispiel werden die angegebenen Felder für die ersten fünf Problemticket-Falldatensätze zurückgegeben.
curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/ticket/troubleTicket?limit=5&fields=id%2Cname%2Cdescription%2Cstatus%2Cseverity%2CticketType&ticketType=case" \
--request GET \
--user 'username':'password'
Antworttext.
[
{
"id": "0004609eb9830110f877b3758cd21d37",
"name": "Compliant Over 2796",
"description": "checkNo2796",
"status": "New",
"severity": "3 - Moderate",
"ticketType": "Case"
},
{
"id": "000560d2b9c30110f877b3758cd21d36",
"name": "Compliant Over 4696",
"description": "checkNo4696",
"status": "New",
"severity": "3 - Moderate",
"ticketType": "Case"
},
{
"id": "0007ac5eb9c30110f877b3758cd21d34",
"name": "Compliant Over 8817",
"description": "checkNo8817",
"status": "New",
"severity": "3 - Moderate",
"ticketType": "Case"
},
{
"id": "0007ac5eb9c30110f877b3758cd21d39",
"name": "Compliant Over 8819",
"description": "checkNo8819",
"status": "New",
"severity": "3 - Moderate",
"ticketType": "Case"
},
{
"id": "0007ac5eb9c30110f877b3758cd21d3e",
"name": "Compliant Over 8821",
"description": "checkNo8821",
"status": "New",
"severity": "3 - Moderate",
"ticketType": "Case"
}
]
## Problemticket -- GET /sn_ind_tsm_sdwan/ticket/troubleTicket/{id} {#ariaid-title3}
Ruft einen angegebenen Datensatz aus der Tabelle „Fall" \[sn_customerservice_case\] oder „Incident" \[incident\] ab.
### URL-Format {#trouble-ticket-GET-ticket-tt-id__section_fcs_wqm_5pb}
Standard-URL: /api/sn_ind_tsm_sdwan/ticket/troubleTicket/{id}
### Unterstützte Anforderungsparameter
{#trouble-ticket-GET-ticket-tt-id__table_ufw_yqm_5pb__entry__2}
| Name | Beschreibung |
|-|-|
| id | Sys_id des abzurufenden Fall- oder Incident-Datensatzes. Befindet sich in der Tabelle „Fall" \[sn_customerservice_case\] oder „Incident" \[incident\]. Datentyp: Zeichenfolge |
[Tabelle : 7. Pfadparameter]
{#trouble-ticket-GET-ticket-tt-id__table_ufw_yqm_5pb} {#trouble-ticket-GET-ticket-tt-id__table_cn5_zqm_5pb__entry__2}
| Name | Beschreibung |
|-|-|
| Felder | Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Werte: * channel * creationDate * Beschreibung * href * id * lastUpdate * name * Hinweis * ZugehörigeEntität * Zugehörige Partei * Schweregrad * status * ticketType * @type {#trouble-ticket-GET-ticket-tt-id__ul_n1h_htz_54b} Standard: Gibt alle Felder zurück. Datentyp: Zeichenfolge |
[Tabelle : 8. Abfrageparameter]
{#trouble-ticket-GET-ticket-tt-id__table_cn5_zqm_5pb} {#trouble-ticket-GET-ticket-tt-id__entry__10}
| Name | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 9. Parameter des Anforderungstexts (JSON)]
### 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](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#trouble-ticket-GET-ticket-tt-id__entry__14}{#trouble-ticket-GET-ticket-tt-id__accept-JSON-only-entry-RESTAPI}
| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
[Tabelle : 10. Anforderungskopfzeilen]
{#trouble-ticket-GET-ticket-tt-id__entry__18}
| Kopfzeile | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 11. Antwortkopfzeilen]
### Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#trouble-ticket-GET-ticket-tt-id__entry__22}{#trouble-ticket-GET-ticket-tt-id__entry-200-status-code}
| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Aus einem oder mehreren der folgenden Gründe wurde ein ungültiger Anforderungstyp oder eine falsch formatierte Anforderung erkannt. * Ungültiger Pfadparameter. * Ungültiger URI. {#trouble-ticket-GET-ticket-tt-id__ul_rjf_fqw_rpb} |
| 404 | Datensatz nicht gefunden Ein Datensatz, der der ID zugeordnet ist, wurde in der Tabelle „Fall" \[sn_customerservice_case\] oder „Incident" \[incident\] nicht gefunden. |
[Tabelle : 12. Statuscodes]
### Parameter des Antwort-Haupttexts (JSON)
{#trouble-ticket-GET-ticket-tt-id__table_n4d_yvm_5pb__entry__2}
| Name | Beschreibung |
|-|-|
| channel | Die Kontaktmethode, mit der dieses Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" } |
| Kanalname | Der Name der Kontaktmethode Wird dem Feld „ Kanal " \[contact_type\] für Fälle und dem Feld „ Kontakttyp" \[contact_type\] für Incidents zugeordnet. Datentyp: Zeichenfolge |
| creationDate | Das Datum, an dem der Fall- oder Incident-Datensatz erstellt wurde. Wird dem Feld „ Erstellt " zugeordnet. Datentyp: Zeichenfolge |
| Beschreibung | Die Beschreibung des Problems aus dem Ticket. Wird dem Feld „ Beschreibung " zugeordnet. Datentyp: Zeichenfolge |
| href | Relativer Link zum Fall- oder Incident-Datensatz. Datentyp: Zeichenfolge |
| id | Die sys_id des Fall- oder Incident-Datensatzes. Datentyp: Zeichenfolge |
| lastUpdate | Das Datum, an dem der Datensatz zuletzt aktualisiert wurde. Wird dem Feld „ Aktualisiert " zugeordnet. Datentyp: Zeichenfolge |
| name | Der Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Wird dem Feld Kurzbeschreibung zugeordnet. Datentyp: Zeichenfolge |
| Hinweis | Eine Liste aller Kommentare zum Ticket. Diese Liste enthält keine Arbeitsnotizen. Datentyp: Array "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ] |
| Anmerkung.@Typ | Der Typ der Notiz. Es werden nur Kommentare zurückgegeben (keine Arbeitsnotizen), daher ist dieser Wert immer `Kommentare`. Datentyp: Zeichenfolge |
| Anmerkung.Autor | Der Name des Anwenders, der den Kommentar geschrieben hat. Datentyp: Zeichenfolge |
| Notiz.Datum | Das Datum, an dem der Kommentar in der Instanz ServiceNow erstellt wurde. Datentyp: Zeichenfolge |
| Anmerkung.Text | Der Kommentartext. Datentyp: Zeichenfolge |
| ZugehörigeEntität | Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselemente oder Services. Datentyp: Array "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ] |
| relatedEntity.id | Sys_id des betroffenen Artikels oder Services. Bei Fällen stammt dieser Wert aus einer der folgenden Tabellen: * Asset \[alm_asset\] * Produktmodell \[cmdb_model\] * Verkauftes Produkt \[sn_install_base_sold_product\] * „Produktbestand" \[sn_prd_invt_product_inventory\], der die Tabelle „Verkaufte Produkte" \[sn_install_base_sold_product\] erweitert {#trouble-ticket-GET-ticket-tt-id__ul_en1_3jc_hwb}Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: * Konfigurationselement \[cmdb_ci\] * Service \[cmdb_ci_service\] {#trouble-ticket-GET-ticket-tt-id__ul_fn1_3jc_hwb} Datentyp: Zeichenfolge |
| relatedEntity.href | Gibt eine leere Zeichenfolge zurück. Datentyp: Zeichenfolge |
| relatedEntity.name | Name des betroffenen Artikels oder Services. Datentyp: Zeichenfolge |
| ZugehörigeEntität.Rolle | Beschreibung des betroffenen Artikels oder Services. Datentyp: Zeichenfolge |
| relatedEntity.@referredType | Typ des Artikels oder Services. Gültige Werte für Falltickets: * Asset * product * product_inventory {#trouble-ticket-GET-ticket-tt-id__ul_zrm_5jp_mtb} Gültige Werte für Incident-Tickets: * cmdb_ci * cmdb_ci_service {#trouble-ticket-GET-ticket-tt-id__ul_asm_5jp_mtb} Datentyp: Zeichenfolge |
| ZugehörigeEntität.@Typ | Dieser Wert ist immer `„relatedEntity"`. Datentyp: Zeichenfolge |
| Zugehörige Partei | Details zu Kontakten für das Ticket. Datentyp: Array "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ] |
| Zugehörigepartei.id | Sys_id der zugehörigen Partei. Die sys_id kann je nach Tickettyp und Typ der zugehörigen Partei aus den folgenden Tabellen stammen. Fall: * Account \[customer_account\]: Typ der zugehörigen Partei ist „ Kunde". * Kontakt \[customer_contact\]: Typ der zugehörigen Partei ist „ customer_contact". {#trouble-ticket-GET-ticket-tt-id__ul_vf5_n3g_4tb} Vorfall: * Unternehmen \[core_company\]: Typ der zugehörigen Partei ist „ Kunde". * Benutzer \[sys_user\]: Typ der zugehörigen Partei ist „ customer_contact". {#trouble-ticket-GET-ticket-tt-id__ul_ll2_p3g_4tb} Fall oder Incident: * Gruppe \[sys_user_group\]: Typ der zugehörigen Partei ist „ assignment_group". * Anwender \[sys_user\]: Der zugehörige Parteityp ist assigned_to {#trouble-ticket-GET-ticket-tt-id__ul_umf_r3g_4tb} Datentyp: Zeichenfolge |
| relatedParty.name | Name der zugehörigen Partei. Datentyp: Zeichenfolge |
| zugehörigepartei.@referenztyp | Typ der zugehörigen Partei Mögliche Werte: * assigned_to: Der Anwender, der für die Bearbeitung des Tickets zugewiesen ist. * assignment_group: Die Gruppe, die für die Bearbeitung des Tickets zugewiesen ist. * Kunde: Das Unternehmen oder der Account für das Ticket. * Customer_contact: Der Anrufer oder Kontakt für das Ticket. {#trouble-ticket-GET-ticket-tt-id__ul_bxv_jgg_4tb} Datentyp: Zeichenfolge |
| Schweregrad | Der Schweregrad des im Problemticket beschriebenen Problems. Wird dem Feld „ Priorität" zugewiesen. Datentyp: Zeichenfolge |
| status | Der aktuelle Status des Problemtickets. Wird dem Feld „Status" zugeordnet. Datentyp: Zeichenfolge |
| ticketType | Der Typ des Tickets. Mögliche Werte: * Fall * Incident {#trouble-ticket-GET-ticket-tt-id__ul_czp_2mc_ktb} Datentyp: Zeichenfolge |
| @type | Dieser Wert ist immer `TroubleTicket`. Datentyp: Zeichenfolge |
[ ]
{#trouble-ticket-GET-ticket-tt-id__table_n4d_yvm_5pb}
### cURL-Anforderung
In diesem Beispiel wird ein Problemticketdatensatz aus der Tabelle „Fall" \[sn_customerservice_case\] abgerufen.
curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Antworttext.
{
"id": "370415f03c20e910f8772f1bc332b31b",
"href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/370415f03c20e910f8772f1bc332b31b",
"creationDate": "2023-01-19 22:39:28",
"lastUpdate": "2023-01-19 22:41:39",
"description": "Router is not working, my devices cannot detect any signals from the router. First button from the left is flashing red, all others are black. Resetting the router does not solve the problem, I need urgent assistance.",
"severity": "2 - High",
"ticketType": "Case",
"name": "My router is not working properly",
"status": "Open",
"channel": {
"name": "e_bonding"
},
"relatedParty": [
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@referredType": "customer"
},
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@referredType": "customer_contact"
},
{
"id": "",
"name": "",
"@referredType": "assignment_group"
},
{
"id": "",
"name": "",
"@referredType": "assigned_to"
}
],
"relatedEntity": [
{
"id": "b7fa12c7532520103b6bddeeff7b123b",
"href": "",
"name": "Deduplication and Compression PRD00001965",
"role": "This is the product associated with the case.",
"@type": "relatedEntity",
"@referredType": "product"
},
{
"id": "71e73d87c3e23010ff00ed23a140dde8",
"href": "",
"name": "",
"role": "This is the asset associated with the case.",
"@type": "relatedEntity",
"@referredType": "asset"
},
{
"id": "a1913c3577b301108e191e599a5a99e8",
"href": "",
"name": "Deduplication and Compression PI0000037",
"role": "This is the product inventory associated with the case.",
"@type": "relatedEntity",
"@referredType": "product_inventory"
}
],
"note": [
{
"text": "This is a testing comment",
"date": "2023-01-19 14:41:39",
"author": "System Administrator",
"@type": "comments"
},
{
"text": "This is a testing comment",
"date": "2023-01-19 14:39:28",
"author": "System Administrator",
"@type": "comments"
}
],
"@type": "TroubleTicket"
}
## Problemticket -- GET /sn_ind_tsm_sdwan/troubleticket/{ticketType}/{id} {#ariaid-title4}
Ruft einen angegebenen Datensatz aus der Tabelle „Fall" \[sn_customerservice_case\] oder „Incident" \[incident\] ab.
Wichtig:
Ab Release Tokyo ist dieser Endpunkt veraltet. Die neue Version dieses Endpunkts ist [Problemticket -- GET /sn_ind_tsm_sdwan/ticket/troubleTicket/{id}](https://www.servicenow.com/docs/dqWk457tZAW6X2t6eynssA#trouble-ticket-GET-ticket-tt-id "Ruft einen angegebenen Datensatz aus der Tabelle „Fall“ [sn_customerservice_case] oder „Incident“ [incident] ab.").
### URL-Format {#trouble-ticket-GET-trouble_ticket__section_fcs_wqm_5pb}
Standard-URL: /api/sn_ind_tsm_sdwan/troubleticket/{ticketType}/{id}
### Unterstützte Anforderungsparameter
{#trouble-ticket-GET-trouble_ticket__table_ufw_yqm_5pb__entry__2}
| Name | Beschreibung |
|-|-|
| ticketType | Der Typ des Tickets. Dieser Wert bestimmt, ob ein Datensatz aus der Tabelle „Fall" \[sn_customerservice_case\] oder „Incident" \[incident\] abgerufen wird. Gültige Werte: * Fall * Incident {#trouble-ticket-GET-trouble_ticket__ul_k1m_qvs_qpb} Datentyp: Zeichenfolge |
| id | Sys_id des abzurufenden Fall- oder Incident-Datensatzes. Datentyp: Zeichenfolge |
[Tabelle : 13. Pfadparameter]
{#trouble-ticket-GET-trouble_ticket__table_ufw_yqm_5pb} {#trouble-ticket-GET-trouble_ticket__table_cn5_zqm_5pb__entry__2}
| Name | Beschreibung |
|-|-|
| Felder | Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Wenn dieser Wert nicht übergeben wird, werden alle Felder zurückgegeben. Gültige Felder: * channel * creationDate * Beschreibung * id * lastUpdate * name * Hinweis * ZugehörigeEntität * Zugehörige Partei * Schweregrad * status * ticketType * @type {#trouble-ticket-GET-trouble_ticket__ul_n1h_htz_54b} Datentyp: Zeichenfolge |
[Tabelle : 14. Abfrageparameter]
{#trouble-ticket-GET-trouble_ticket__table_cn5_zqm_5pb} {#trouble-ticket-GET-trouble_ticket__entry__12}
| Name | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 15. Anforderungstextparameter (XML oder JSON)]
### 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](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#trouble-ticket-GET-trouble_ticket__entry__16}{#trouble-ticket-GET-trouble_ticket__accept-JSON-only-entry-RESTAPI}
| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
[Tabelle : 16. Anforderungskopfzeilen]
{#trouble-ticket-GET-trouble_ticket__entry__20}
| Kopfzeile | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 17. Antwortkopfzeilen]
### Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#trouble-ticket-GET-trouble_ticket__entry__24}{#trouble-ticket-GET-trouble_ticket__entry-200-status-code}
| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Aus einem oder mehreren der folgenden Gründe wurde ein ungültiger Anforderungstyp oder eine falsch formatierte Anforderung erkannt. * Ungültiger Pfadparameter. * Ungültiger URI. {#trouble-ticket-GET-trouble_ticket__ul_rjf_fqw_rpb} |
| 404 | Datensatz nicht gefunden Ein Datensatz, der der ID zugeordnet ist, wurde in der Tabelle „Fall" \[sn_customerservice_case\] oder „Incident" \[incident\] nicht gefunden. |
[Tabelle : 18. Statuscodes]
### Parameter des Antworttexts (JSON oder XML)
{#trouble-ticket-GET-trouble_ticket__table_n4d_yvm_5pb__entry__2}
| Name | Beschreibung |
|-|-|
| @type | Dieser Wert ist immer `TroubleTicket`. Datentyp: Zeichenfolge |
| channel | Die Kontaktmethode, mit der dieses Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" } |
| Kanalname | Der Name der Kontaktmethode Wird dem Feld „ Kanal " \[contact_type\] für Fälle und dem Feld „ Kontakttyp" \[contact_type\] für Incidents zugewiesen. Datentyp: Zeichenfolge |
| creationDate | Das Datum, an dem der Fall- oder Incident-Datensatz erstellt wurde. Wird dem Feld „ Erstellt " zugeordnet. Datentyp: Zeichenfolge |
| Beschreibung | Die Beschreibung des Problems aus dem Ticket. Wird dem Feld „ Beschreibung " zugeordnet. Datentyp: Zeichenfolge |
| id | Die sys_id des Fall- oder Incident-Datensatzes. Datentyp: Zeichenfolge |
| lastUpdate | Das Datum, an dem der Datensatz zuletzt aktualisiert wurde. Wird dem Feld „ Aktualisiert " zugeordnet. Datentyp: Zeichenfolge |
| name | Der Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Wird dem Feld Kurzbeschreibung zugeordnet. Datentyp: Zeichenfolge |
| Hinweis | Eine Liste aller Kommentare zum Ticket. Diese Liste enthält keine Arbeitsnotizen. Datentyp: Array "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ] |
| Anmerkung.@Typ | Der Typ der Notiz. Es werden nur Kommentare zurückgegeben (keine Arbeitsnotizen), daher ist dieser Wert immer `Kommentare`. Datentyp: Zeichenfolge |
| Anmerkung.Autor | Der Name des ServiceNow-Integrationsanwenders, der die POST- oder PATCH-Anforderung erstellt hat, von der der Kommentar erstellt wurde. Datentyp: Zeichenfolge |
| Notiz.Datum | Das Datum, an dem der Kommentar in der ServiceNow-Instanz erstellt wurde. Datentyp: Zeichenfolge |
| Anmerkung.Text | Der Kommentartext. Datentyp: Zeichenfolge |
| ZugehörigeEntität | Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselemente oder Services. Datentyp: Array "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ] |
| relatedEntity.id | Sys_id des betroffenen Artikels oder Services. Bei Fällen stammt dieser Wert aus einer der folgenden Tabellen: * Asset \[alm_asset\] * Produktmodell \[cmdb_model\] * Verkauftes Produkt \[sn_install_base_sold_product\] * „Produktbestand" \[sn_prd_invt_product_inventory\], der die Tabelle „Verkaufte Produkte" \[sn_install_base_sold_product\] erweitert {#trouble-ticket-GET-trouble_ticket__ul_en1_3jc_hwb}Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: * Konfigurationselement \[cmdb_ci\] * Service \[cmdb_ci_service\] {#trouble-ticket-GET-trouble_ticket__ul_fn1_3jc_hwb} Datentyp: Zeichenfolge |
| relatedEntity.href | Gibt eine leere Zeichenfolge zurück. Datentyp: Zeichenfolge |
| relatedEntity.name | Name des betroffenen Artikels oder Services. Datentyp: Zeichenfolge |
| ZugehörigeEntität.Rolle | Beschreibung des betroffenen Artikels oder Services. Datentyp: Zeichenfolge |
| relatedEntity.@referredType | Typ des Artikels oder Services. Gültige Werte für Falltickets: * Asset * product * product_inventory {#trouble-ticket-GET-trouble_ticket__ul_zrm_5jp_mtb} Gültige Werte für Incident-Tickets: * cmdb_ci * cmdb_ci_service {#trouble-ticket-GET-trouble_ticket__ul_asm_5jp_mtb} Datentyp: Zeichenfolge |
| ZugehörigeEntität.@Typ | Dieser Wert ist immer `„relatedEntity"`. Datentyp: Zeichenfolge |
| Zugehörige Partei | Details zu den Unternehmen und Kontakten, die dem Ticket zugeordnet sind. Datentyp: Array "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ] |
| zugehörigepartei.@referenztyp | Typ der zugehörigen Partei Gültige Werte: * Kunde: Das Unternehmen oder der Account für das Ticket. * Customer_Contact: Der Anrufer oder Kontakt für das Ticket. {#trouble-ticket-GET-trouble_ticket__ul_sfh_g3j_5pb} Datentyp: Zeichenfolge |
| relatedParty.id | Sys_id der zugehörigen Partei. Bei Fällen stammt die sys_id aus den Tabellen „Kontakt" \[customer_contact\] oder „Account" \[customer_account\]. Bei Incidents stammt die sys_id aus den Tabellen „Benutzer" \[sys_user\] oder „Unternehmen" \[core_company\]. Wenn Sie einen Kontakt oder Benutzer (Anrufer) angeben, wird dessen Account bzw. Unternehmen automatisch im Ticket eingetragen. Datentyp: Zeichenfolge |
| relatedParty.name | Der Name der zugehörigen Partei Bei Fällen ist dies dem Feld Kontakt oder Account zugeordnet. Bei Incidents wird dem Feld Anrufer oder Unternehmen zugeordnet. Datentyp: Zeichenfolge |
| Schweregrad | Der Schweregrad des im Problemticket beschriebenen Problems. Wird dem Feld „ Priorität " zugeordnet. Datentyp: Zeichenfolge |
| status | Der aktuelle Status des Problemtickets. Wird dem Feld „Status" zugeordnet. Datentyp: Zeichenfolge |
| ticketType | Der Typ des Tickets (Fall oder Incident). Datentyp: Zeichenfolge |
[ ]
{#trouble-ticket-GET-trouble_ticket__table_n4d_yvm_5pb}
### cURL-Anforderung
In diesem Beispiel werden der Name, die Beschreibung, der Schweregrad und der Status eines Falls abgerufen.
curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/troubleticket/case/a78e2c8cdb68b41015364c9b0b96193e?fields=name%2Cdescription%2Cseverity%2Cstatus" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Antworttext.
{
"name": "Short description of issue",
"description": "Example description of an issue",
"severity": "2 - High",
"status": "Open"
}
## Problemticket -- PATCH /sn_ind_tsm_sdwan/ticket/troubleTicket/{id} {#ariaid-title5}
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
{#trouble-ticket-PATCH-ticket-tt__entry__2}
| Name | Beschreibung |
|-|-|
| id | Sys_id des zu aktualisierenden Fall- oder Incident-Datensatzes. Befindet sich in der Tabelle „Fall" \[sn_customerservice_case\] oder „Incident" \[incident\]. Datentyp: Zeichenfolge |
[Tabelle : 19. Pfadparameter]
{#trouble-ticket-PATCH-ticket-tt__entry__6}
| Name | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 20. Abfrageparameter]
{#trouble-ticket-PATCH-ticket-tt__entry__10}
| Name | Beschreibung |
|-|-|
| channel | Die Kontaktmethode, mit der dieses Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" } |
| Kanalname | Der Name der Kontaktmethode Wird dem Feld „ Kanal " \[contact_type\] für Fälle und dem Feld „ Kontakttyp" \[contact_type\] für Incidents zugewiesen. Gültige Werte sind die Auswahlmöglichkeiten für das Feld „contact_type". Sie können die Bezeichnung oder den Wert der Auswahl angeben. Beispiel: `Virtual Agent` oder `virtual_agent`. Datentyp: Zeichenfolge |
| Beschreibung | Eine Beschreibung des Problems. Wird dem Feld „ Beschreibung " zugeordnet. Datentyp: Zeichenfolge |
| name | Der Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Wird dem Feld Kurzbeschreibung zugeordnet. Datentyp: Zeichenfolge |
| Hinweis | Eine Liste von Arbeitsnotizen und Kommentaren, die dem Ticket hinzugefügt werden sollen. Datentyp: Array "note":[ { "text": "String", "@type": "String" } ] |
| Anmerkung.@Typ | Der Typ der Notiz. Dieser Wert bestimmt, ob die Notiz im Feld Arbeitsnotizen oder Zusätzliche Kommentare aufgezeichnet wird. Gültige Werte: * work_notes * comments {#trouble-ticket-PATCH-ticket-tt__ul_vtx_hmz_rpb} Datentyp: Zeichenfolge |
| Anmerkung.Text | Der Hinweistext. Entspricht dem Feld Arbeitsnotizen oder Zusätzliche Kommentare. Datentyp: Zeichenfolge |
| ZugehörigeEntität | Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselemente oder Services. Datentyp: Array "relatedEntity": [ { "id": "String", "@referredType": "String" } ] |
| relatedEntity.id | Sys_id des betroffenen Artikels oder Services. Bei Fällen stammt dieser Wert aus einer der folgenden Tabellen: * Asset \[alm_asset\] * Produktmodell \[cmdb_model\] * Verkauftes Produkt \[sn_install_base_sold_product\] * „Produktbestand" \[sn_prd_invt_product_inventory\], der die Tabelle „Verkaufte Produkte" \[sn_install_base_sold_product\] erweitert {#trouble-ticket-PATCH-ticket-tt__ul_vl4_13c_hwb}Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: * Konfigurationselement \[cmdb_ci\] * Service \[cmdb_ci_service\] {#trouble-ticket-PATCH-ticket-tt__ul_lbg_b3c_hwb} Datentyp: Zeichenfolge |
| relatedEntity.@referredType | Typ des Artikels oder Services. Gültige Werte für Falltickets: * Asset * product * product_inventory {#trouble-ticket-PATCH-ticket-tt__ul_bjm_lfy_wsb} Gültige Werte für Incident-Tickets: * cmdb_ci * cmdb_ci_service {#trouble-ticket-PATCH-ticket-tt__ul_sfh_g3j_5pa} Datentyp: Zeichenfolge |
| Zugehörige Partei | Details zu Kontakten für das Ticket. Bei Fällen füllt dieser Parameter das Feld „ Kontakt" oder „Account" aus. Bei Incidents füllt dieser Parameter das Feld Anrufer oder Unternehmen aus. Datentyp: Array "relatedParty": [ { "id": "String", "@referredType": "String" } ] |
| relatedParty.id | Sys_id der zugehörigen Partei. Bei Fällen stammt die sys_id aus den Tabellen „Kontakt" \[customer_contact\] oder „Account" \[customer_account\]. Bei Incidents stammt die sys_id aus den Tabellen „Benutzer" \[sys_user\] oder „Unternehmen" \[core_company\]. Wenn Sie einen Kontakt oder Benutzer (Anrufer) angeben, wird dessen Account bzw. Unternehmen automatisch im Ticket eingetragen. Datentyp: Zeichenfolge |
| zugehörigepartei.@referenztyp | Typ der zugehörigen Partei Gültige Werte: * Kunde: Das Unternehmen oder der Account für das Ticket. * Customer_Contact: Der Anrufer oder Kontakt für das Ticket. {#trouble-ticket-PATCH-ticket-tt__ul_sfh_g3j_5pb} Datentyp: Zeichenfolge |
| Schweregrad | Der Schweregrad des im Problemticket beschriebenen Problems. Wird dem Feld „ Priorität" zugewiesen. Gültige Werte: * 1: Kritisch. * 2: Hoch. * 3: Mittel. * 4: Niedrig. * 5: Planung. Nur Incident {#trouble-ticket-PATCH-ticket-tt__ul_xhd_24p_rpb}Gültige Werte sind die Auswahlmöglichkeiten für das Feld Priorität. Sie müssen nur den Auswahlwert angeben. Beispiel: `1`. Wenn ein ungültiger Wert angegeben wird, wird der Schweregrad auf „Niedrig" festgelegt. Datentyp: Zeichenfolge |
| status | Der aktuelle Status des Problemtickets. Wird dem Feld „Status" zugeordnet. Gültige Werte sind die Auswahlmöglichkeiten für das Feld „Status". Sie können die Bezeichnung oder den Wert der Auswahl angeben. Zum Beispiel `Neu` oder `1`. Datentyp: Zeichenfolge |
[Tabelle : 21. Parameter des Anforderungstexts (JSON)]
### Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#trouble-ticket-PATCH-ticket-tt__entry__42}{#trouble-ticket-PATCH-ticket-tt__accept-JSON-only-entry-RESTAPI}{#trouble-ticket-PATCH-ticket-tt__content_type-JSON-only-entry-RESTAPI}
| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
[Tabelle : 22. Anforderungskopfzeilen]
{#trouble-ticket-PATCH-ticket-tt__entry__48}
| Kopfzeile | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 23. Antwortkopfzeilen]
### Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#trouble-ticket-PATCH-ticket-tt__entry__52}{#trouble-ticket-PATCH-ticket-tt__entry-200-status-code}
| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Aus einem oder mehreren der folgenden Gründe wurde ein ungültiger Anforderungstyp oder eine falsch formatierte Anforderung erkannt. * Ungültiger Pfadparameter. * Ungültiger URI. {#trouble-ticket-PATCH-ticket-tt__ul_rjf_fqw_rpb} |
| 404 | Datensatz nicht gefunden Ein Datensatz, der der ID zugeordnet ist, wurde in der Tabelle „Fall" \[sn_customerservice_case\] oder „Incident" \[incident\] nicht gefunden. |
[Tabelle : 24. Statuscodes]
### Parameter des Antwort-Haupttexts (JSON)
{#trouble-ticket-PATCH-ticket-tt__entry__60}
| Name | Beschreibung |
|-|-|
| channel | Die Kontaktmethode, mit der dieses Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" } |
| Kanalname | Der Name der Kontaktmethode Datentyp: Zeichenfolge |
| creationDate | Das Datum, an dem der Datensatz erstellt wurde. Datentyp: Zeichenfolge |
| Beschreibung | Die Beschreibung des Problems aus dem Ticket. Datentyp: Zeichenfolge |
| href | Relativer Link zum Fall- oder Incident-Datensatz. Datentyp: Zeichenfolge |
| id | Die sys_id des Fall- oder Incident-Datensatzes. Datentyp: Zeichenfolge |
| lastUpdate | Das Datum, an dem der Datensatz zuletzt aktualisiert wurde. Datentyp: Zeichenfolge |
| name | Der Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Datentyp: Zeichenfolge |
| Hinweis | Eine Liste aller Kommentare zum Ticket. Diese Liste enthält keine Arbeitsnotizen. Datentyp: Array "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ] |
| Anmerkung.@Typ | Der Typ der Notiz. Es werden nur Kommentare zurückgegeben (keine Arbeitsnotizen), daher ist dieser Wert immer `Kommentare`. Datentyp: Zeichenfolge |
| Anmerkung.Autor | Der Name des Anwenders, der den Kommentar geschrieben hat. Datentyp: Zeichenfolge |
| Notiz.Datum | Das Datum, an dem der Kommentar in der Instanz ServiceNow erstellt wurde. Datentyp: Zeichenfolge |
| Anmerkung.Text | Der Kommentartext. Datentyp: Zeichenfolge |
| ZugehörigeEntität | Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselemente oder Services. Datentyp: Array "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ] |
| relatedEntity.id | Sys_id des betroffenen Artikels oder Services. Bei Fällen stammt dieser Wert aus einer der folgenden Tabellen: * Asset \[alm_asset\] * Produktmodell \[cmdb_model\] * Verkauftes Produkt \[sn_install_base_sold_product\] * „Produktbestand" \[sn_prd_invt_product_inventory\], der die Tabelle „Verkaufte Produkte" \[sn_install_base_sold_product\] erweitert {#trouble-ticket-PATCH-ticket-tt__ul_en1_3jc_hwb}Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: * Konfigurationselement \[cmdb_ci\] * Service \[cmdb_ci_service\] {#trouble-ticket-PATCH-ticket-tt__ul_fn1_3jc_hwb} Datentyp: Zeichenfolge |
| relatedEntity.href | Gibt eine leere Zeichenfolge zurück. Datentyp: Zeichenfolge |
| relatedEntity.name | Name des betroffenen Artikels oder Services. Datentyp: Zeichenfolge |
| ZugehörigeEntität.Rolle | Beschreibung des betroffenen Artikels oder Services. Datentyp: Zeichenfolge |
| relatedEntity.@referredType | Typ des Artikels oder Services. Gültige Werte für Falltickets: * Asset * product * product_inventory {#trouble-ticket-PATCH-ticket-tt__ul_zrm_5jp_mtb} Gültige Werte für Incident-Tickets: * cmdb_ci * cmdb_ci_service {#trouble-ticket-PATCH-ticket-tt__ul_asm_5jp_mtb} Datentyp: Zeichenfolge |
| ZugehörigeEntität.@Typ | Dieser Wert ist immer `„relatedEntity"`. Datentyp: Zeichenfolge |
| Zugehörige Partei | Details zu Kontakten für das Ticket. Datentyp: Array "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ] |
| Zugehörigepartei.id | Sys_id der zugehörigen Partei. Die sys_id kann je nach Tickettyp und Typ der zugehörigen Partei aus den folgenden Tabellen stammen. Fall: * Account \[customer_account\]: Typ der zugehörigen Partei ist „ Kunde". * Kontakt \[customer_contact\]: Typ der zugehörigen Partei ist „ customer_contact". {#trouble-ticket-PATCH-ticket-tt__ul_vf5_n3g_4tb} Vorfall: * Unternehmen \[core_company\]: Typ der zugehörigen Partei ist „ Kunde". * Benutzer \[sys_user\]: Typ der zugehörigen Partei ist „ customer_contact". {#trouble-ticket-PATCH-ticket-tt__ul_ll2_p3g_4tb} Fall oder Incident: * Gruppe \[sys_user_group\]: Typ der zugehörigen Partei ist „ assignment_group". * Anwender \[sys_user\]: Der zugehörige Parteityp ist assigned_to {#trouble-ticket-PATCH-ticket-tt__ul_umf_r3g_4tb} Datentyp: Zeichenfolge |
| relatedParty.name | Name der zugehörigen Partei. Datentyp: Zeichenfolge |
| zugehörigepartei.@referenztyp | Typ der zugehörigen Partei Mögliche Werte: * assigned_to: Der Anwender, der für die Bearbeitung des Tickets zugewiesen ist. * assignment_group: Die Gruppe, die für die Bearbeitung des Tickets zugewiesen ist. * Kunde: Das Unternehmen oder der Account für das Ticket. * Customer_contact: Der Anrufer oder Kontakt für das Ticket. {#trouble-ticket-PATCH-ticket-tt__ul_bxv_jgg_4tb} Datentyp: Zeichenfolge |
| Schweregrad | Der Schweregrad des im Problemticket beschriebenen Problems. Datentyp: Zeichenfolge |
| status | Der aktuelle Status des Problemtickets. Datentyp: Zeichenfolge |
| ticketType | Der Typ des Tickets. Mögliche Werte: * Fall * Incident {#trouble-ticket-PATCH-ticket-tt__ul_czp_2mc_ktb} Datentyp: Zeichenfolge |
| @type | Dieser Wert ist immer `TroubleTicket`. Datentyp: Zeichenfolge |
[ ]
### cURL-Anforderung
In diesem Beispiel wird ein Falldatensatz aktualisiert.
curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
description: "Updated description",
"note": [
{
"text": "Adding another comment",
"@type": "comments"
}
]
}" \
--user 'username':'password'
Antworttext.
{
"id": "6467508d47e345508761b955d36d43f6",
"href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6",
"creationDate": "2022-05-16 23:38:55",
"lastUpdate": "2022-05-16 23:48:42",
"description": "Updated description",
"severity": "2 - High",
"ticketType": "Case",
"name": "Laptop problem",
"status": "New",
"channel": {
"name": "web"
},
"relatedParty": [
{
"id": "",
"name": "",
"@referredType": "customer"
},
{
"id": "62826bf03710200044e0bfc8bcbe5df1",
"name": "",
"@referredType": "customer_contact"
},
{
"id": "",
"name": "",
"@referredType": "assignment_group"
},
{
"id": "",
"name": "",
"@referredType": "assigned_to"
}
],
"relatedEntity": [
{
"id": "",
"href": "",
"name": "",
"role": "This is the product associated with the case",
"@type": "relatedEntity",
"@referredType": "product"
},
{
"id": "74a9ec0d3790200044e0bfc8bcbe5d7f",
"href": "",
"name": "P1000597 - Apple MacBook Pro 15\"",
"role": "This is the asset associated with the case",
"@type": "relatedEntity",
"@referredType": "asset"
}
{
"id": "a1913c3577b301108e191e599a5a99e8",
"href": "",
"name": "Deduplication and Compression PI0000037",
"role": "This is the product inventory associated with the case.",
"@type": "relatedEntity",
"@referredType": "product_inventory"
}
],
"note": [
{
"text": "Adding another comment",
"date": "2022-05-16 16:48:42",
"author": "admin",
"@type": "comments"
},
{
"text": "Comment about this case",
"date": "2022-05-16 16:38:55",
"author": "admin",
"@type": "comments"
}
],
"@type": "TroubleTicket"
}
## Problemticket -- PATCH /sn_ind_tsm_sdwan/troubleticket/{ticketType}/{id} {#ariaid-title6}
Aktualisiert einen Datensatz in der Tabelle „Fall" \[sn_customerservice_case\] oder „Incident" \[incident\].
Wichtig:
Ab Release Tokyo ist dieser Endpunkt veraltet. Die neue Version dieses Endpunkts ist [Problemticket -- PATCH /sn_ind_tsm_sdwan/ticket/troubleTicket/{id}](https://www.servicenow.com/docs/dqWk457tZAW6X2t6eynssA#trouble-ticket-PATCH-ticket-tt "Aktualisiert einen angegebenen Datensatz in der Tabelle „Fall“ [sn_customerservice_case] oder „Incident“ [incident].").
### URL-Format
Standard-URL: /api/sn_ind_tsm_sdwan/troubleticket/{ticketType}/{id}
### Unterstützte Anforderungsparameter
{#trouble-ticket-PATCH-trouble_ticket__entry__2}
| Name | Beschreibung |
|-|-|
| ticketType | Der Typ des Tickets. Dieser Wert bestimmt, ob ein Datensatz in der Tabelle „Fall" \[sn_customerservice_case\] oder „Incident" \[incident\] aktualisiert wird. Gültige Werte: * Fall * Incident {#trouble-ticket-PATCH-trouble_ticket__ul_k1m_qvs_qpb} Datentyp: Zeichenfolge |
| id | Die sys_id des zu aktualisierenden Fall- oder Incident-Datensatzes. Datentyp: Zeichenfolge |
[Tabelle : 25. Pfadparameter]
{#trouble-ticket-PATCH-trouble_ticket__entry__8}
| Name | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 26. Abfrageparameter]
{#trouble-ticket-PATCH-trouble_ticket__entry__12}
| Name | Beschreibung |
|-|-|
| channel | Die Kontaktmethode, mit der dieses Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" } |
| Kanalname | Der Name der Kontaktmethode Wird dem Feld „ Kanal " \[contact_type\] für Fälle und dem Feld „ Kontakttyp" \[contact_type\] für Incidents zugewiesen. Gültige Werte sind die Auswahlmöglichkeiten für das Feld „contact_type". Sie können die Bezeichnung oder den Wert der Auswahl angeben. Beispiel: `Virtual Agent` oder `virtual_agent`. Datentyp: Zeichenfolge |
| Beschreibung | Eine Beschreibung des Problems. Wird dem Feld „ Beschreibung " zugeordnet. Datentyp: Zeichenfolge |
| name | Der Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Wird dem Feld Kurzbeschreibung zugeordnet. Datentyp: Zeichenfolge |
| Hinweis | Eine Liste von Arbeitsnotizen und Kommentaren, die dem Ticket hinzugefügt werden sollen. Datentyp: Array "note":[ { "text": "String", "@type": "String" } ] |
| Anmerkung.@Typ | Der Typ der Notiz. Dieser Wert bestimmt, ob die Notiz im Feld Arbeitsnotizen oder Zusätzliche Kommentare aufgezeichnet wird. Gültige Werte: * work_notes * comments {#trouble-ticket-PATCH-trouble_ticket__ul_vtx_hmz_rpb} Datentyp: Zeichenfolge |
| Anmerkung.Text | Der Hinweistext. Entspricht dem Feld Arbeitsnotizen oder Zusätzliche Kommentare. Datentyp: Zeichenfolge |
| ZugehörigeEntität | Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselemente oder Services. Datentyp: Array "relatedEntity": [ { "id": "String", "@referredType": "String" } ] |
| relatedEntity.id | Sys_id des betroffenen Artikels oder Services. Bei Fällen stammt dieser Wert aus einer der folgenden Tabellen: * Asset \[alm_asset\] * Produktmodell \[cmdb_model\] * Verkauftes Produkt \[sn_install_base_sold_product\] * „Produktbestand" \[sn_prd_invt_product_inventory\], der die Tabelle „Verkaufte Produkte" \[sn_install_base_sold_product\] erweitert {#trouble-ticket-PATCH-trouble_ticket__ul_vl4_13c_hwb}Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: * Konfigurationselement \[cmdb_ci\] * Service \[cmdb_ci_service\] {#trouble-ticket-PATCH-trouble_ticket__ul_lbg_b3c_hwb} Datentyp: Zeichenfolge |
| relatedEntity.@referredType | Typ des Artikels oder Services. Gültige Werte für Falltickets: * Asset * product * product_inventory {#trouble-ticket-PATCH-trouble_ticket__ul_bjm_lfy_wsb} Gültige Werte für Incident-Tickets: * cmdb_ci * cmdb_ci_service {#trouble-ticket-PATCH-trouble_ticket__ul_sfh_g3j_5pa} Datentyp: Zeichenfolge |
| Zugehörige Partei | Details zu Kontakten für das Ticket. Bei Fällen füllt dieser Parameter das Feld „ Kontakt" oder „Account" aus. Bei Incidents füllt dieser Parameter das Feld Anrufer oder Unternehmen aus. Datentyp: Array "relatedParty": [ { "id": "String", "@referredType": "String" } ] |
| zugehörigepartei.@referenztyp | Typ der zugehörigen Partei Gültige Werte: * Kunde: Das Unternehmen oder der Account für das Ticket. * Customer_Contact: Der Anrufer oder Kontakt für das Ticket. {#trouble-ticket-PATCH-trouble_ticket__ul_sfh_g3j_5pb} Datentyp: Zeichenfolge |
| relatedParty.id | Sys_id der zugehörigen Partei. Bei Fällen stammt die sys_id aus den Tabellen „Kontakt" \[customer_contact\] oder „Account" \[customer_account\]. Bei Incidents stammt die sys_id aus den Tabellen „Benutzer" \[sys_user\] oder „Unternehmen" \[core_company\]. Wenn Sie einen Kontakt oder Benutzer (Anrufer) angeben, wird dessen Account bzw. Unternehmen automatisch im Ticket eingetragen. Datentyp: Zeichenfolge |
| Schweregrad | Der Schweregrad des im Problemticket beschriebenen Problems. Wird dem Feld „ Priorität " zugeordnet. Gültige Werte: * 1: Kritisch. * 2: Hoch. * 3: Mittel. * 4: Niedrig. * 5: Planung. Nur Incident {#trouble-ticket-PATCH-trouble_ticket__ul_xhd_24p_rpb}Gültige Werte sind die Auswahlmöglichkeiten für das Feld Priorität. Sie müssen nur den Auswahlwert angeben. Beispiel: `1`. Wenn ein ungültiger Wert angegeben wird, wird der Schweregrad auf „Niedrig" festgelegt. Datentyp: Zeichenfolge |
| status | Der aktuelle Status des Problemtickets. Wird dem Feld „Status" zugeordnet. Gültige Werte sind die Auswahlmöglichkeiten für das Feld „Status". Sie können die Bezeichnung oder den Wert der Auswahl angeben. Zum Beispiel `Neu` oder `1`. Datentyp: Zeichenfolge |
[Tabelle : 27. Anforderungstextparameter (XML oder JSON)]
### Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#trouble-ticket-PATCH-trouble_ticket__entry__44}{#trouble-ticket-PATCH-trouble_ticket__accept-JSON-only-entry-RESTAPI}{#trouble-ticket-PATCH-trouble_ticket__content_type-JSON-only-entry-RESTAPI}
| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
[Tabelle : 28. Anforderungskopfzeilen]
{#trouble-ticket-PATCH-trouble_ticket__entry__50}
| Kopfzeile | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 29. Antwortkopfzeilen]
### Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#trouble-ticket-PATCH-trouble_ticket__entry__54}{#trouble-ticket-PATCH-trouble_ticket__entry-200-status-code}
| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Aus einem oder mehreren der folgenden Gründe wurde ein ungültiger Anforderungstyp oder eine falsch formatierte Anforderung erkannt. * Ungültiger Pfadparameter. * Ungültiger URI. {#trouble-ticket-PATCH-trouble_ticket__ul_rjf_fqw_rpb} |
| 404 | Datensatz nicht gefunden Ein Datensatz, der der ID zugeordnet ist, wurde in der Tabelle „Fall" \[sn_customerservice_case\] oder „Incident" \[incident\] nicht gefunden. |
[Tabelle : 30. Statuscodes]
### Parameter des Antworttexts (JSON oder XML)
{#trouble-ticket-PATCH-trouble_ticket__entry__62}
| Name | Beschreibung |
|-|-|
| @type | Dieser Wert ist immer `TroubleTicket`. Datentyp: Zeichenfolge |
| channel | Die Kontaktmethode, mit der dieses Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" } |
| Kanalname | Der Name der Kontaktmethode Datentyp: Zeichenfolge |
| creationDate | Das Datum, an dem der Datensatz erstellt wurde. Datentyp: Zeichenfolge |
| Beschreibung | Die Beschreibung des Problems aus dem Ticket. Datentyp: Zeichenfolge |
| id | Die sys_id des Fall- oder Incident-Datensatzes. Datentyp: Zeichenfolge |
| lastUpdate | Das Datum, an dem der Datensatz zuletzt aktualisiert wurde. Datentyp: Zeichenfolge |
| name | Der Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Datentyp: Zeichenfolge |
| Hinweis | Eine Liste aller Kommentare zum Ticket. Diese Liste enthält keine Arbeitsnotizen. Datentyp: Array "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ] |
| Anmerkung.@Typ | Der Typ der Notiz. Es werden nur Kommentare zurückgegeben (keine Arbeitsnotizen), daher ist dieser Wert immer `Kommentare`. Datentyp: Zeichenfolge |
| Anmerkung.Autor | Der Name des ServiceNow-Integrationsanwenders, der die POST- oder PATCH-Anforderung erstellt hat, von der der Kommentar erstellt wurde. Datentyp: Zeichenfolge |
| Notiz.Datum | Das Datum, an dem der Kommentar in der ServiceNow-Instanz erstellt wurde. Datentyp: Zeichenfolge |
| Anmerkung.Text | Der Kommentartext. Datentyp: Zeichenfolge |
| ZugehörigeEntität | Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselemente oder Services. Datentyp: Array "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ] |
| relatedEntity.id | Sys_id des betroffenen Artikels oder Services. Bei Fällen stammt dieser Wert aus einer der folgenden Tabellen: * Asset \[alm_asset\] * Produktmodell \[cmdb_model\] * Verkauftes Produkt \[sn_install_base_sold_product\] * „Produktbestand" \[sn_prd_invt_product_inventory\], der die Tabelle „Verkaufte Produkte" \[sn_install_base_sold_product\] erweitert {#trouble-ticket-PATCH-trouble_ticket__ul_en1_3jc_hwb}Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: * Konfigurationselement \[cmdb_ci\] * Service \[cmdb_ci_service\] {#trouble-ticket-PATCH-trouble_ticket__ul_fn1_3jc_hwb} Datentyp: Zeichenfolge |
| relatedEntity.href | Gibt eine leere Zeichenfolge zurück. Datentyp: Zeichenfolge |
| relatedEntity.name | Name des betroffenen Artikels oder Services. Datentyp: Zeichenfolge |
| ZugehörigeEntität.Rolle | Beschreibung des betroffenen Artikels oder Services. Datentyp: Zeichenfolge |
| relatedEntity.@referredType | Typ des Artikels oder Services. Gültige Werte für Falltickets: * Asset * product * product_inventory {#trouble-ticket-PATCH-trouble_ticket__ul_zrm_5jp_mtb} Gültige Werte für Incident-Tickets: * cmdb_ci * cmdb_ci_service {#trouble-ticket-PATCH-trouble_ticket__ul_asm_5jp_mtb} Datentyp: Zeichenfolge |
| ZugehörigeEntität.@Typ | Dieser Wert ist immer `„relatedEntity"`. Datentyp: Zeichenfolge |
| Zugehörige Partei | Details zu den Unternehmen und Kontakten, die dem Ticket zugeordnet sind. Datentyp: Array "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ] |
| zugehörigepartei.@referenztyp | Typ der zugehörigen Partei Gültige Werte: * Kunde: Das Unternehmen oder der Account für das Ticket. * Customer_Contact: Der Anrufer oder Kontakt für das Ticket. {#trouble-ticket-PATCH-trouble_ticket__d4359e333} Datentyp: Zeichenfolge |
| Zugehörigepartei.id | Sys_id der zugehörigen Partei. Bei Fällen stammt die sys_id aus den Tabellen „Kontakt" \[customer_contact\] oder „Account" \[customer_account\]. Bei Incidents stammt die sys_id aus den Tabellen „Benutzer" \[sys_user\] oder „Unternehmen" \[core_company\]. Wenn Sie einen Kontakt oder Benutzer (Anrufer) angeben, wird dessen Account bzw. Unternehmen automatisch im Ticket eingetragen. Datentyp: Zeichenfolge |
| relatedParty.name | Der Name der zugehörigen Partei Datentyp: Zeichenfolge |
| Schweregrad | Der Schweregrad des im Problemticket beschriebenen Problems. Datentyp: Zeichenfolge |
| status | Der aktuelle Status des Problemtickets. Datentyp: Zeichenfolge |
| ticketType | Der Typ des Tickets (Fall oder Incident). Datentyp: Zeichenfolge |
[ ]
### cURL-Anforderung
In diesem Beispiel wird ein Falldatensatz aktualisiert.
curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/troubleticket/case/370415f03c20e910f8772f1bc332b31b" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"description\":\"Router is not working, my devices cannot detect any signals from the router. First button from the left is flashing red, all others are black. Resetting the router does not solve the problem, I need urgent assistance.\",
\"name\":\"My router is not working properly\",
\"severity\":\"2\",
\"status\":\"10\",
\"ticketType\":\"Case\",
\"channel\":{
\"id\":\"8774\",
\"name\":\"eBonding\",
\"@type\":\"Channel\"
},
\"note\":[
{
\"id\":\"77456\",
\"author\":\"Jack Smith\",
\"date\":\"2019-05-31T07:34:45.968Z\",
\"text\":\"This is a testing work notehello world and title
\",
\"@type\":\"Worknotes\"
},
{
\"id\":\"77457\",
\"author\":\"Jack Smith\",
\"date\":\"2019-05-31T07:35:45.968Z\",
\"text\":\"This is a testing comment\",
\"@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",
"date": "2023-01-19 14:41:39",
"author": "System Administrator",
"@type": "comments"
},
{
"text": "This is a testing comment",
"date": "2023-01-19 14:39:28",
"author": "System Administrator",
"@type": "comments"
}
],
"@type": "TroubleTicket"
}
## Problemticket -- POST /sn_ind_tsm_sdwan/ticket/troubleTicket {#ariaid-title7}
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
{#trouble-ticket-POST-ticket-tt__entry__2}
| Name | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 31. Pfadparameter]
{#trouble-ticket-POST-ticket-tt__entry__6}
| Name | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 32. Abfrageparameter]
{#trouble-ticket-POST-ticket-tt__entry__10}
| Name | Beschreibung |
|-|-|
| channel | Die Kontaktmethode, mit der dieses Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" } |
| Kanalname | Der Name der Kontaktmethode Wird dem Feld „ Kanal " \[contact_type\] für Fälle und dem Feld „ Kontakttyp" \[contact_type\] für Incidents zugewiesen. Gültige Werte sind die Auswahlmöglichkeiten für das Feld „contact_type". Sie können die Bezeichnung oder den Wert der Auswahl angeben. Beispiel: `Virtual Agent` oder `virtual_agent`. Datentyp: Zeichenfolge |
| Beschreibung | Erforderlich. Eine Beschreibung des Problems. Wird dem Feld „ Beschreibung " zugeordnet. Datentyp: Zeichenfolge |
| name | Der Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Wird dem Feld Kurzbeschreibung zugeordnet. Datentyp: Zeichenfolge |
| Hinweis | Eine Liste von Arbeitsnotizen und Kommentaren, die dem Ticket hinzugefügt werden sollen. Datentyp: Array "note":[ { "text": "String", "@type": "String" } ] |
| Anmerkung.@Typ | Der Typ der Notiz. Dieser Wert bestimmt, ob die Notiz im Feld Arbeitsnotizen oder Zusätzliche Kommentare aufgezeichnet wird. Gültige Werte: * work_notes * comments {#trouble-ticket-POST-ticket-tt__ul_vtx_hmz_rpb} Datentyp: Zeichenfolge |
| Anmerkung.Text | Der Hinweistext. Entspricht dem Feld Arbeitsnotizen oder Zusätzliche Kommentare. Datentyp: Zeichenfolge |
| ZugehörigeEntität | Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselemente oder Services. Datentyp: Array "relatedEntity": [ { "id": "String", "@referredType": "String" } ] |
| relatedEntity.id | Sys_id des betroffenen Artikels oder Services. Bei Fällen stammt dieser Wert aus einer der folgenden Tabellen: * Asset \[alm_asset\] * Produktmodell \[cmdb_model\] * Verkauftes Produkt \[sn_install_base_sold_product\] * „Produktbestand" \[sn_prd_invt_product_inventory\], der die Tabelle „Verkaufte Produkte" \[sn_install_base_sold_product\] erweitert {#trouble-ticket-POST-ticket-tt__ul_vl4_13c_hwb}Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: * Konfigurationselement \[cmdb_ci\] * Service \[cmdb_ci_service\] {#trouble-ticket-POST-ticket-tt__ul_lbg_b3c_hwb} Datentyp: Zeichenfolge |
| relatedEntity.@referredType | Typ des Artikels oder Services. Gültige Werte für Falltickets: * Asset * product * product_inventory {#trouble-ticket-POST-ticket-tt__ul_bjm_lfy_wsb} Gültige Werte für Incident-Tickets: * cmdb_ci * cmdb_ci_service {#trouble-ticket-POST-ticket-tt__ul_sfh_g3j_5pa} Datentyp: Zeichenfolge |
| Zugehörige Partei | Details zu Kontakten für das Ticket. Bei Fällen füllt dieser Parameter das Feld „ Kontakt" oder „Account" aus. Bei Incidents füllt dieser Parameter das Feld Anrufer oder Unternehmen aus. Datentyp: Array "relatedParty": [ { "id": "String", "@referredType": "String" } ] |
| relatedParty.id | Sys_id der zugehörigen Partei. Bei Fällen stammt die sys_id aus den Tabellen „Kontakt" \[customer_contact\] oder „Account" \[customer_account\]. Bei Incidents stammt die sys_id aus den Tabellen „Benutzer" \[sys_user\] oder „Unternehmen" \[core_company\]. Wenn Sie einen Kontakt oder Benutzer (Anrufer) angeben, wird dessen Account bzw. Unternehmen automatisch im Ticket eingetragen. Datentyp: Zeichenfolge |
| zugehörigepartei.@referenztyp | Typ der zugehörigen Partei Gültige Werte: * Kunde: Das Unternehmen oder der Account für das Ticket. * Customer_Contact: Der Anrufer oder Kontakt für das Ticket. {#trouble-ticket-POST-ticket-tt__ul_sfh_g3j_5pb} Datentyp: Zeichenfolge |
| Schweregrad | Erforderlich. Der Schweregrad des im Problemticket beschriebenen Problems. Wird dem Feld „ Priorität " zugeordnet. Gültige Werte: * 1: Kritisch. * 2: Hoch. * 3: Mittel. * 4: Niedrig. * 5: Planung. Nur Incident {#trouble-ticket-POST-ticket-tt__ul_xhd_24p_rpb}Gültige Werte sind die Auswahlmöglichkeiten für das Feld Priorität. Sie müssen nur den Auswahlwert angeben. Beispiel: `1`. Wenn ein ungültiger Wert angegeben wird, wird der Schweregrad auf „Niedrig" festgelegt. Datentyp: Zeichenfolge |
| status | Erforderlich. Der aktuelle Status des Problemtickets. Wird dem Feld „Status" zugeordnet. Gültige Werte sind die Auswahlmöglichkeiten für das Feld „Status". Sie können die Bezeichnung oder den Wert der Auswahl angeben. Zum Beispiel `Neu` oder `1`. Wenn Sie einen ungültigen Wertangeben , wird der Status auf Neu festgelegt. Datentyp: Zeichenfolge |
| ticketType | Der Typ des Tickets. Dieser Wert bestimmt, ob der Datensatz in der Tabelle „Fall" \[sn_customerservice_case\] oder „Incident" \[incident\] erstellt wird. Gültige Werte: * Fall * Incident {#trouble-ticket-POST-ticket-tt__ul_p44_tjp_rpb} Datentyp: Zeichenfolge Standard: Incident |
[Tabelle : 33. Parameter des Anforderungstexts (JSON)]
### Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#trouble-ticket-POST-ticket-tt__entry__44}{#trouble-ticket-POST-ticket-tt__accept-JSON-only-entry-RESTAPI}{#trouble-ticket-POST-ticket-tt__content_type-JSON-only-entry-RESTAPI}
| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
[Tabelle : 34. Anforderungskopfzeilen]
{#trouble-ticket-POST-ticket-tt__entry__50}
| Kopfzeile | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 35. Antwortkopfzeilen]
### Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#trouble-ticket-POST-ticket-tt__entry__54}
| Statuscode | Beschreibung |
|-|-|
| 201 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Aus einem oder mehreren der folgenden Gründe wurde ein ungültiger Anforderungstyp oder eine falsch formatierte Anforderung erkannt. * Leere Nutzlast. * Ungültige Nutzlast. Pflichtfeld fehlt. * Ungültiger ticketType. {#trouble-ticket-POST-ticket-tt__ul_rjf_fqw_rpb} |
[Tabelle : 36. Statuscodes]
### Parameter des Antwort-Haupttexts (JSON)
{#trouble-ticket-POST-ticket-tt__entry__60}
| Name | Beschreibung |
|-|-|
| @type | Dieser Wert ist immer `TroubleTicket`. Datentyp: Zeichenfolge |
| channel | Die Kontaktmethode, mit der dieses Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" } |
| Kanalname | Der Name der Kontaktmethode Datentyp: Zeichenfolge |
| creationDate | Das Datum, an dem der Fall- oder Incident-Datensatz erstellt wurde. Datentyp: Zeichenfolge |
| Beschreibung | Die Beschreibung des Problems aus dem Ticket. Datentyp: Zeichenfolge |
| href | Relativer Link zum Fall- oder Incident-Datensatz. Datentyp: Zeichenfolge |
| id | Die sys_id des erstellten Fall- oder Incident-Datensatzes. Datentyp: Zeichenfolge |
| lastUpdate | Das Datum, an dem der Fall- oder Incident-Datensatz zuletzt aktualisiert wurde. Datentyp: Zeichenfolge |
| name | Der Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Datentyp: Zeichenfolge |
| Hinweis | Eine Liste aller Kommentare zum Ticket. Diese Liste enthält keine Arbeitsnotizen. Datentyp: Array "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ] |
| Anmerkung.@Typ | Der Typ der Notiz. Es werden nur Kommentare zurückgegeben (keine Arbeitsnotizen), daher ist dieser Wert immer `Kommentare`. Datentyp: Zeichenfolge |
| Anmerkung.Autor | Der Name des Anwenders, der den Kommentar geschrieben hat. Datentyp: Zeichenfolge |
| Notiz.Datum | Das Datum, an dem der Kommentar in der Instanz ServiceNow erstellt wurde. Datentyp: Zeichenfolge |
| Anmerkung.Text | Der Kommentartext. Datentyp: Zeichenfolge |
| ZugehörigeEntität | Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselemente oder Services. Datentyp: Array "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ] |
| relatedEntity.id | Sys_id des betroffenen Artikels oder Services. Bei Fällen stammt dieser Wert aus einer der folgenden Tabellen: * Asset \[alm_asset\] * Produktmodell \[cmdb_model\] * Verkauftes Produkt \[sn_install_base_sold_product\] * „Produktbestand" \[sn_prd_invt_product_inventory\], der die Tabelle „Verkaufte Produkte" \[sn_install_base_sold_product\] erweitert {#trouble-ticket-POST-ticket-tt__ul_en1_3jc_hwb}Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: * Konfigurationselement \[cmdb_ci\] * Service \[cmdb_ci_service\] {#trouble-ticket-POST-ticket-tt__ul_fn1_3jc_hwb} Datentyp: Zeichenfolge |
| relatedEntity.href | Gibt eine leere Zeichenfolge zurück. Datentyp: Zeichenfolge |
| relatedEntity.name | Name des betroffenen Artikels oder Services. Datentyp: Zeichenfolge |
| ZugehörigeEntität.Rolle | Beschreibung des betroffenen Artikels oder Services. Datentyp: Zeichenfolge |
| relatedEntity.@referredType | Typ des Artikels oder Services. Gültige Werte für Falltickets: * Asset * product * product_inventory {#trouble-ticket-POST-ticket-tt__ul_zrm_5jp_mtb} Gültige Werte für Incident-Tickets: * cmdb_ci * cmdb_ci_service {#trouble-ticket-POST-ticket-tt__ul_asm_5jp_mtb} Datentyp: Zeichenfolge |
| ZugehörigeEntität.@Typ | Dieser Wert ist immer `„relatedEntity"`. Datentyp: Zeichenfolge |
| Zugehörige Partei | Details zu Kontakten für das Ticket. Datentyp: Array "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ] |
| Zugehörigepartei.id | Sys_id der zugehörigen Partei. Die sys_id kann je nach Tickettyp und Typ der zugehörigen Partei aus den folgenden Tabellen stammen. Fall: * Account \[customer_account\]: Typ der zugehörigen Partei ist „ Kunde". * Kontakt \[customer_contact\]: Typ der zugehörigen Partei ist „ customer_contact". {#trouble-ticket-POST-ticket-tt__ul_vf5_n3g_4tb} Vorfall: * Unternehmen \[core_company\]: Typ der zugehörigen Partei ist „ Kunde". * Benutzer \[sys_user\]: Typ der zugehörigen Partei ist „ customer_contact". {#trouble-ticket-POST-ticket-tt__ul_ll2_p3g_4tb} Fall oder Incident: * Gruppe \[sys_user_group\]: Typ der zugehörigen Partei ist „ assignment_group". * Anwender \[sys_user\]: Der zugehörige Parteityp ist assigned_to {#trouble-ticket-POST-ticket-tt__ul_umf_r3g_4tb} Datentyp: Zeichenfolge |
| relatedParty.name | Name der zugehörigen Partei. Datentyp: Zeichenfolge |
| zugehörigepartei.@referenztyp | Typ der zugehörigen Partei Mögliche Werte: * assigned_to: Der Anwender, der für die Bearbeitung des Tickets zugewiesen ist. * assignment_group: Die Gruppe, die für die Bearbeitung des Tickets zugewiesen ist. * Kunde: Das Unternehmen oder der Account für das Ticket. * Customer_contact: Der Anrufer oder Kontakt für das Ticket. {#trouble-ticket-POST-ticket-tt__ul_bxv_jgg_4tb} Datentyp: Zeichenfolge |
| Schweregrad | Der Schweregrad des im Problemticket beschriebenen Problems. Datentyp: Zeichenfolge |
| status | Der aktuelle Status des Problemtickets. Datentyp: Zeichenfolge |
| ticketType | Der Typ des Tickets. Mögliche Werte: * Fall * Incident {#trouble-ticket-POST-ticket-tt__ul_czp_2mc_ktb} Datentyp: Zeichenfolge |
[ ]
### cURL-Anforderung
In diesem Beispiel wird ein Datensatz für einen Problemticket-Fall erstellt.
curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/ticket/troubleTicket" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
"name": "Laptop problem",
"description": "Laptop keeps shutting off unexpectedly",
"severity": "2",
"status": "New",
"ticketType": "Case",
"channel": {
"name": "Web"
},
"note": [
{
"text": "Work note about this case",
"@type": "work_notes"
},
{
"text": "Comment about this case",
"@type": "comments"
}
],
"relatedEntity": [
{
"id": "74a9ec0d3790200044e0bfc8bcbe5d7f",
"@referredType": "asset"
}
],
"relatedParty": [
{
"id": "62826bf03710200044e0bfc8bcbe5df1",
"@referredType": "customer_contact"
}
]
}" \
--user 'username':'password'
Antworttext.
{
"id": "6467508d47e345508761b955d36d43f6",
"href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6",
"creationDate": "2022-05-16 23:38:55",
"lastUpdate": "2022-05-16 23:38:55",
"description": "Laptop keeps shutting off unexpectedly",
"severity": "2 - High",
"ticketType": "Case",
"name": "Laptop problem",
"status": "New",
"channel": {
"name": "web"
},
"relatedParty": [
{
"id": "",
"name": "",
"@referredType": "customer"
},
{
"id": "62826bf03710200044e0bfc8bcbe5df1",
"name": "",
"@referredType": "customer_contact"
},
{
"id": "",
"name": "",
"@referredType": "assignment_group"
},
{
"id": "",
"name": "",
"@referredType": "assigned_to"
}
],
"relatedEntity": [
{
"id": "",
"href": "",
"name": "",
"role": "This is the product associated with the case.",
"@type": "relatedEntity",
"@referredType": "product"
},
{
"id": "74a9ec0d3790200044e0bfc8bcbe5d7f",
"href": "",
"name": "P1000597 - Apple MacBook Pro 15\"",
"role": "This is the asset associated with the case.",
"@type": "relatedEntity",
"@referredType": "asset"
}
{
"id": "a1913c3577b301108e191e599a5a99e8",
"href": "",
"name": "Deduplication and Compression PI0000037",
"role": "This is the product inventory associated with the case.",
"@type": "relatedEntity",
"@referredType": "product_inventory"
}
],
"note": [
{
"text": "Comment about this case",
"date": "2022-05-16 16:38:55",
"author": "admin",
"@type": "comments"
}
],
"@type": "TroubleTicket"
}
## Problemticket -- POST /sn_ind_tsm_sdwan/troubleticket/{ticketType} {#ariaid-title8}
Erstellt einen Datensatz in der Tabelle „Fall" \[sn_customerservice_case\] oder „Incident" \[incident\].
Wichtig:
Ab Release Tokyo ist dieser Endpunkt veraltet. Die neue Version dieses Endpunkts ist [Problemticket -- POST /sn_ind_tsm_sdwan/ticket/troubleTicket](https://www.servicenow.com/docs/dqWk457tZAW6X2t6eynssA#trouble-ticket-POST-ticket-tt "Erstellt einen Datensatz in der Tabelle „Fall“ [sn_customerservice_case] oder „Incident“ [incident].").
### URL-Format
Standard-URL: /api/sn_ind_tsm_sdwan/troubleticket/{ticketType}
### Unterstützte Anforderungsparameter
{#trouble-ticket-POST-trouble_ticket__entry__2}
| 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 {#trouble-ticket-POST-trouble_ticket__ul_k1m_qvs_qpb} Datentyp: Zeichenfolge |
[Tabelle : 37. Pfadparameter]
{#trouble-ticket-POST-trouble_ticket__entry__6}
| Name | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 38. Abfrageparameter]
{#trouble-ticket-POST-trouble_ticket__entry__10}
| Name | Beschreibung |
|-|-|
| channel | Die Kontaktmethode, mit der dieses Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" } |
| Kanalname | Der Name der Kontaktmethode Wird dem Feld „ Kanal " \[contact_type\] für Fälle und dem Feld „ Kontakttyp" \[contact_type\] für Incidents zugewiesen. Gültige Werte sind die Auswahlmöglichkeiten für das Feld „contact_type". Sie können die Bezeichnung oder den Wert der Auswahl angeben. Beispiel: `Virtual Agent` oder `virtual_agent`. Datentyp: Zeichenfolge |
| Beschreibung | Erforderlich. Eine Beschreibung des Problems. Wird dem Feld „ Beschreibung " zugeordnet. Datentyp: Zeichenfolge |
| name | Der Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Wird dem Feld Kurzbeschreibung zugeordnet. Datentyp: Zeichenfolge |
| Hinweis | Eine Liste von Arbeitsnotizen und Kommentaren, die dem Ticket hinzugefügt werden sollen. Datentyp: Array "note":[ { "text": "String", "@type": "String" } ] |
| Anmerkung.@Typ | Der Typ der Notiz. Dieser Wert bestimmt, ob die Notiz im Feld Arbeitsnotizen oder Zusätzliche Kommentare aufgezeichnet wird. Gültige Werte: * work_notes * comments {#trouble-ticket-POST-trouble_ticket__ul_vtx_hmz_rpb} Datentyp: Zeichenfolge |
| Anmerkung.Text | Der Hinweistext. Entspricht dem Feld Arbeitsnotizen oder Zusätzliche Kommentare. Datentyp: Zeichenfolge |
| ZugehörigeEntität | Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselemente oder Services. Datentyp: Array "relatedEntity": [ { "id": "String", "@referredType": "String" } ] |
| relatedEntity.id | Sys_id des betroffenen Artikels oder Services. Bei Fällen stammt dieser Wert aus einer der folgenden Tabellen: * Asset \[alm_asset\] * Produktmodell \[cmdb_model\] * Verkauftes Produkt \[sn_install_base_sold_product\] * „Produktbestand" \[sn_prd_invt_product_inventory\], der die Tabelle „Verkaufte Produkte" \[sn_install_base_sold_product\] erweitert {#trouble-ticket-POST-trouble_ticket__ul_vl4_13c_hwb}Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: * Konfigurationselement \[cmdb_ci\] * Service \[cmdb_ci_service\] {#trouble-ticket-POST-trouble_ticket__ul_lbg_b3c_hwb} Datentyp: Zeichenfolge |
| relatedEntity.@referredType | Typ des Artikels oder Services. Gültige Werte für Falltickets: * Asset * product * product_inventory {#trouble-ticket-POST-trouble_ticket__ul_bjm_lfy_wsb} Gültige Werte für Incident-Tickets: * cmdb_ci * cmdb_ci_service {#trouble-ticket-POST-trouble_ticket__ul_sfh_g3j_5pa} Datentyp: Zeichenfolge |
| Zugehörige Partei | Details zu Kontakten für das Ticket. Bei Fällen füllt dieser Parameter das Feld „ Kontakt" oder „Account" aus. Bei Incidents füllt dieser Parameter das Feld Anrufer oder Unternehmen aus. Datentyp: Array "relatedParty": [ { "id": "String", "@referredType": "String" } ] |
| zugehörigepartei.@referenztyp | Typ der zugehörigen Partei Gültige Werte: * Kunde: Das Unternehmen oder der Account für das Ticket. * Customer_Contact: Der Anrufer oder Kontakt für das Ticket. {#trouble-ticket-POST-trouble_ticket__ul_sfh_g3j_5pb} Datentyp: Zeichenfolge |
| relatedParty.id | Sys_id der zugehörigen Partei. Bei Fällen stammt die sys_id aus den Tabellen „Kontakt" \[customer_contact\] oder „Account" \[customer_account\]. Bei Incidents stammt die sys_id aus den Tabellen „Benutzer" \[sys_user\] oder „Unternehmen" \[core_company\]. Wenn Sie einen Kontakt oder Benutzer (Anrufer) angeben, wird dessen Account bzw. Unternehmen automatisch im Ticket eingetragen. Datentyp: Zeichenfolge |
| Schweregrad | Erforderlich. Der Schweregrad des im Problemticket beschriebenen Problems. Wird dem Feld „ Priorität " zugeordnet. Gültige Werte: * 1: Kritisch. * 2: Hoch. * 3: Mittel. * 4: Niedrig. * 5: Planung. Nur Incident {#trouble-ticket-POST-trouble_ticket__ul_xhd_24p_rpb}Gültige Werte sind die Auswahlmöglichkeiten für das Feld Priorität. Sie müssen nur den Auswahlwert angeben. Beispiel: `1`. Wenn ein ungültiger Wert angegeben wird, wird der Schweregrad auf „Niedrig" festgelegt. Datentyp: Zeichenfolge |
| status | Der aktuelle Status des Problemtickets. Wird dem Feld „Status" zugeordnet. Gültige Werte sind die Auswahlmöglichkeiten für das Feld „Status". Sie können die Bezeichnung oder den Wert der Auswahl angeben. Zum Beispiel `Neu` oder `1`. Datentyp: Zeichenfolge Standard: Neu |
| ticketType | Erforderlich. Der Typ des Tickets. Dieser Wert bestimmt, ob der Datensatz in der Tabelle „Fall" \[sn_customerservice_case\] oder „Incident" \[incident\] erstellt wird. Gültige Werte: * Fall * Incident {#trouble-ticket-POST-trouble_ticket__ul_p44_tjp_rpb} Datentyp: Zeichenfolge |
[Tabelle : 39. Anforderungstextparameter (XML oder JSON)]
### Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#trouble-ticket-POST-trouble_ticket__entry__44}{#trouble-ticket-POST-trouble_ticket__accept-JSON-only-entry-RESTAPI}{#trouble-ticket-POST-trouble_ticket__content_type-JSON-only-entry-RESTAPI}
| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
[Tabelle : 40. Anforderungskopfzeilen]
{#trouble-ticket-POST-trouble_ticket__entry__50}
| Kopfzeile | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 41. Antwortkopfzeilen]
### Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#trouble-ticket-POST-trouble_ticket__entry__54}
| Statuscode | Beschreibung |
|-|-|
| 201 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Aus einem oder mehreren der folgenden Gründe wurde ein ungültiger Anforderungstyp oder eine falsch formatierte Anforderung erkannt. * Leere Nutzlast. * Ungültige Nutzlast. Pflichtfeld fehlt. * Ungültiger ticketType oder ticketType stimmt nicht mit dem Pfadparameter „ticketType" überein. Beispiel: „ticketType" ist „ `Fall` ", der Pfadparameter ist jedoch „ `Incident`". {#trouble-ticket-POST-trouble_ticket__ul_rjf_fqw_rpb} |
[Tabelle : 42. Statuscodes]
### Parameter des Antworttexts (JSON oder XML)
{#trouble-ticket-POST-trouble_ticket__entry__60}
| Name | Beschreibung |
|-|-|
| @type | Dieser Wert ist immer `TroubleTicket`. Datentyp: Zeichenfolge |
| channel | Die Kontaktmethode, mit der dieses Ticket erstellt wurde. Datentyp: Objekt "channel":{ "name": "String" } |
| Kanalname | Der Name der Kontaktmethode Datentyp: Zeichenfolge |
| creationDate | Das Datum, an dem der Fall- oder Incident-Datensatz erstellt wurde. Datentyp: Zeichenfolge |
| Beschreibung | Die Beschreibung des Problems aus dem Ticket. Datentyp: Zeichenfolge |
| id | Die sys_id des erstellten Fall- oder Incident-Datensatzes. Datentyp: Zeichenfolge |
| lastUpdate | Das Datum, an dem der Fall- oder Incident-Datensatz zuletzt aktualisiert wurde. Datentyp: Zeichenfolge |
| name | Der Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Datentyp: Zeichenfolge |
| Hinweis | Eine Liste der Kommentare und Arbeitsnotizen, die dem Ticket von der POST-Anforderung hinzugefügt wurden. Datentyp: Array "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ] |
| Anmerkung.@Typ | Der Typ der Notiz. Gültige Werte: * work_notes * comments {#trouble-ticket-POST-trouble_ticket__ul_zmv_ybd_5pb} Datentyp: Zeichenfolge |
| Anmerkung.Autor | Der Name des ServiceNow-Integrationsanwenders, der die POST-Anforderung zum Erstellen des Hinweises gestellt hat. Datentyp: Zeichenfolge |
| Notiz.Datum | Das Datum, an dem die Notiz in der ServiceNow-Instanz erstellt wurde. Datentyp: Zeichenfolge |
| Anmerkung.Text | Der Hinweistext. Datentyp: Zeichenfolge |
| ZugehörigeEntität | Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselemente oder Services. Datentyp: Array "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ] |
| relatedEntity.id | Sys_id des betroffenen Artikels oder Services. Bei Fällen stammt dieser Wert aus einer der folgenden Tabellen: * Asset \[alm_asset\] * Produktmodell \[cmdb_model\] * Verkauftes Produkt \[sn_install_base_sold_product\] * „Produktbestand" \[sn_prd_invt_product_inventory\], der die Tabelle „Verkaufte Produkte" \[sn_install_base_sold_product\] erweitert {#trouble-ticket-POST-trouble_ticket__ul_en1_3jc_hwb}Bei Incidents stammt dieser Wert aus einer der folgenden Tabellen: * Konfigurationselement \[cmdb_ci\] * Service \[cmdb_ci_service\] {#trouble-ticket-POST-trouble_ticket__ul_fn1_3jc_hwb} Datentyp: Zeichenfolge |
| relatedEntity.href | Gibt eine leere Zeichenfolge zurück. Datentyp: Zeichenfolge |
| relatedEntity.name | Name des betroffenen Artikels oder Services. Datentyp: Zeichenfolge |
| ZugehörigeEntität.Rolle | Beschreibung des betroffenen Artikels oder Services. Datentyp: Zeichenfolge |
| relatedEntity.@referredType | Typ des Artikels oder Services. Gültige Werte für Falltickets: * Asset * product * product_inventory {#trouble-ticket-POST-trouble_ticket__ul_zrm_5jp_mtb} Gültige Werte für Incident-Tickets: * cmdb_ci * cmdb_ci_service {#trouble-ticket-POST-trouble_ticket__ul_asm_5jp_mtb} Datentyp: Zeichenfolge |
| ZugehörigeEntität.@Typ | Dieser Wert ist immer `„relatedEntity"`. Datentyp: Zeichenfolge |
| Zugehörige Partei | Details zu den Unternehmen und Kontakten, die dem Ticket zugeordnet sind. Datentyp: Array "relatedParty": [ { "id": "String", "@referredType": "String" } ] |
| Zugehörigepartei.id | Sys_id der zugehörigen Partei. Bei Fällen stammt die sys_id aus den Tabellen „Kontakt" \[customer_contact\] oder „Account" \[customer_account\]. Bei Incidents stammt die sys_id aus den Tabellen „Benutzer" \[sys_user\] oder „Unternehmen" \[core_company\]. Wenn Sie einen Kontakt oder Benutzer (Anrufer) angeben, wird dessen Account bzw. Unternehmen automatisch im Ticket eingetragen. Datentyp: Zeichenfolge |
| Zugehörigepartei.empfohlenerTyp | Typ der zugehörigen Partei Gültige Werte: * Kunde: Das Unternehmen oder der Account für das Ticket. * Customer_Contact: Der Anrufer oder Kontakt für das Ticket. {#trouble-ticket-POST-trouble_ticket__d4359e333} Datentyp: Zeichenfolge |
| Schweregrad | Der Schweregrad des im Problemticket beschriebenen Problems. Datentyp: Zeichenfolge |
| status | Der aktuelle Status des Problemtickets. Datentyp: Zeichenfolge |
| ticketType | Der Typ des Tickets (Fall oder Incident). Datentyp: Zeichenfolge |
[ ]
### cURL-Anforderung
In diesem Beispiel wird ein Fall mit hoher Priorität und dem Status „Offen" erstellt.
ccurl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/troubleticket/case" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"description\":\"Router is not working, my devices cannot detect any signals from the router. First button from the left is flashing red, all others are black. Resetting the router does not solve the problem, I need urgent assistance.\",
\"name\":\"My router is not working properly\",
\"severity\":\"2\",
\"status\":\"10\",
\"ticketType\":\"Case\",
\"channel\":{
\"id\":\"8774\",
\"name\":\"eBonding\",
\"@type\":\"Channel\"
},
\"note\":[
{
\"id\":\"77456\",
\"author\":\"Jack Smith\",
\"date\":\"2019-05-31T07:34:45.968Z\",
\"text\":\"This is a testing work notehello world and title
\",
\"@type\":\"Worknotes\"
},
{
\"id\":\"77457\",
\"author\":\"Jack Smith\",
\"date\":\"2019-05-31T07:35:45.968Z\",
\"text\":\"This is a testing comment\",
\"@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",
"date": "2023-01-19 10:33:24",
"author": "System Administrator",
"@type": "comments"
}
],
"@type": "TroubleTicket"
}