Problemticket – API öffnen
Die Problemticket Offen Die API stellt Endpunkte zum Erstellen, Aktualisieren und Abrufen von Daten aus den Tabellen „Fall“ [sn_customerservice_Case], „Incident“ [Incident] und „Serviceproblemfall“ [sn_sprb_mgmt_case] bereit.
Verwenden Sie diese API, um Ticketinformationen zwischen externen Ticketsystemen und zu verwalten ServiceNow AI Platform.
Diese API ist in enthalten Proactive Service Experience Workflows Anwendung, die auf verfügbar ist ServiceNow Store. Die Kundenservice(Com.sn_customerservice) und Kundenservice-Installationsbasisverwaltung (com.snc.install_base) sind zur Verwendung dieser API mit der Falltabelle [sn_customerservice_Case] erforderlich.
Diese API wird in bereitgestellt sn_ind_tsm_sdwan Namespace.
Der aufrufende Anwender muss über die Rolle „Ticket_Integrator“ verfügen.
Diese API kann erweitert werden, um Anpassungen an erforderlichen Parametern, die Validierung des Anforderungstexts, zusätzliche REST-Vorgänge und Feldzuordnungen vorzunehmen. Weitere Informationen finden Sie unter Die Problemticket – API-Entwicklerleitfaden öffnen .
Die Problemticket Offen API ist ein ServiceNow® Implementierung der REST-Spezifikation der TM-Forum-Trouble-Ticket-Verwaltung. Diese Implementierung basiert auf TMF621 API-Anwenderhandbuch für Problemticketmanagement v5.0.0 , September 2024. Die Problemticket Offen API ist vom TM-Forum zertifiziert.
Problemticket: RUFT /sn_ind_tsm_sdwan/Ticket/troubleTicket AB
Ruft eine Liste aller Problemticket-Datensätze aus den Tabellen „Fall“ [sn_customerservice_Case], „Incident“ [Incident] und „Serviceproblemfall“ [sn_sprb_mgmt_case] ab.
URL-Format
Standard-URL: /api/sn_ind_tsm_sdwan/Ticket/troubleTicket
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Felder | Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Felder:
Standard: Gibt alle Felder zurück. Datentyp: Zeichenfolge |
| ID | Problemtickets nach sys_ID filtern Nur Tickets mit der angegebenen sys_ID werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge |
| limit | Maximale Anzahl zurückzugebender Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie offsetParameter zum Paginieren des Datensatzabrufs. Standard: 25 Maximum: 100 Sie können die Standard- und Höchstwerte ändern, indem Sie aktualisieren sn_ind_tsm_sdwan.pagination.set_limitUnd sn_ind_tsm_sdwan.pagination.max_limitSystemeigenschaften. Datentyp: Zahl |
| Offset | Startindex, bei dem mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktionalität ermöglicht den Abruf aller Datensätze, unabhängig von der Anzahl der Datensätze, in kleinen verwaltbaren Blöcken. Datentyp: Zahl Standard: 0 |
| Schweregrad | Filtern Sie Problemtickets nach Schweregrad. Nur Tickets mit dem angegebenen Schweregrad werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge |
| Status | Filtern Sie Problemtickets nach Status. Nur Tickets mit dem angegebenen Status werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge |
| TicketType | Filtern Sie Problemtickets nach Tickettyp. Nur Tickets des angegebenen Typs werden in der Antwort zurückgegeben. Gültige Werte:
Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Keine |
| Header | Beschreibung |
|---|---|
| Inhaltsbereich | Inhaltsbereich, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn |
| Inhaltstyp | Datenformat des Antworttexts. Nur unterstützt application/json. |
| Verknüpfen | Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse.
|
| X-Gesamtzahl | Für paginierte Abfragen gibt dieser Header die Gesamtzahl der auf dem Server verfügbaren Datensätze an. |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich verarbeitet. Vollständige Ressource in Antwort zurückgegeben (keine Paginierung). |
| 206 | In Antwort zurückgegebene Teilressource (mit Paginierung). |
| 400 | Ungültige Anforderung. Mögliche Gründe:
|
| 404 | Datensatz nicht gefunden In der Tabelle wurden keine Datensätze gefunden, die den Abfrageparametern entsprechen. |
Parameter des Antwort-Haupttexts (JSON)
| Name | Beschreibung |
|---|---|
| Kanal | Kontaktmethode, über die das Ticket erstellt wurde. Datentyp: Objekt |
| channel.name | Der Name der Kontaktmethode. Ordnet zu zu Kanal [Contact_type] Feld für Fälle und Kontakttyp Feld [contact_type] für Incidents. Datentyp: Zeichenfolge |
| creationDate | Das Datum, an dem der Fall oder Incident-Datensatz erstellt wurde. Ordnet zu zu Erstellt Feld. Datentyp: Zeichenfolge |
| Beschreibung | Die Beschreibung des Problems aus dem Ticket. Ordnet zu zu Beschreibung Feld. Datentyp: Zeichenfolge |
| href | Relativer Link zum Fall- oder Incident-Datensatz. Datentyp: Zeichenfolge |
| ID | Die sys_ID des Fall- oder Incident-Datensatzes. Datentyp: Zeichenfolge |
| Letztes Update | Das Datum, an dem der Datensatz zuletzt aktualisiert wurde. Ordnet zu zu Aktualisiert Feld. Datentyp: Zeichenfolge |
| Name | Der Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Ordnet zu zu Kurzbeschreibung Feld. Datentyp: Zeichenfolge |
| note | Eine Liste aller Kommentare zum Ticket. Diese Liste enthält keine Arbeitsnotizen. Datentyp: Array |
| Hinweis.@type | Der Typ der Notiz. Es werden nur Kommentare (keine Arbeitsnotizen) zurückgegeben, daher ist dieser Wert immer Kommentare .Datentyp: Zeichenfolge |
| note.author | Der Name von ServiceNow Integrationsanwender, der die POST- oder PATCH-Anforderung gestellt hat, die den Kommentar erstellt hat. Datentyp: Zeichenfolge |
| Hinweis.Datum | Das Datum, an dem der Kommentar in erstellt wurde ServiceNow Instanz. Datentyp: Zeichenfolge |
| Hinweis.Text | Der Kommentartext. Datentyp: Zeichenfolge |
| ZugehörigEntität | Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselementen oder Services. Datentyp: Array von Objekten |
| RelatedEntity.ID | SYS_ID des betroffenen Elements oder Service. In Fällen stammt dieser Wert aus einer der folgenden Tabellen:
Datentyp: Zeichenfolge |
| RelatedEntity.href | Gibt eine leere Zeichenfolge zurück. Datentyp: Zeichenfolge |
| relatedEntity.name | Name des betroffenen Elements oder Service. Datentyp: Zeichenfolge |
| RelatedEntity.role | Beschreibung des betroffenen Elements oder Service. Datentyp: Zeichenfolge |
| RelatedEntity.@referredType | Typ des Artikels oder Service. Gültige Werte für Falltickets:
Gültige Werte für Incident-Tickets:
Datentyp: Zeichenfolge |
| RelatedEntity.@type | Dieser Wert ist immer ZugehörigEntität .Datentyp: Zeichenfolge |
| Zugehörige Partei | Details zu Kontakten für das Ticket. Datentyp: Array von Objekten |
| ZugehörigPartei.ID | SYS_ID der zugehörigen Partei. Die sys_ID kann je nach Tickettyp und Typ der zugehörigen Partei aus den folgenden Tabellen stammen. Fall:
Incident:
Fall oder Incident:
Datentyp: Zeichenfolge |
| relatedParty.name | Name der zugehörigen Partei. Datentyp: Zeichenfolge |
| RelatedParty.@referredType | Typ der zugehörigen Partei. Mögliche Werte:
Datentyp: Zeichenfolge |
| Schweregrad | Der Schweregrad des im Problemticket beschriebenen Problems. Ordnet zu zu Priorität Feld. Datentyp: Zeichenfolge |
| Status | Der aktuelle Status des Problemtickets. Ordnet zu zu Status Feld. Datentyp: Zeichenfolge |
| TicketType | Der Typ des Tickets. Mögliche Werte:
Datentyp: Zeichenfolge |
| @TYPE | Dieser Wert ist immer Problemticket .Datentyp: Zeichenfolge |
cURL-Anforderung
Dieses Beispiel gibt angegebene Felder für die ersten fünf Problemticketfalldatensätze zurück.
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 – RUFT /sn_ind_tsm_sdwan/Ticket/troubleTicket/{ID} AB
Ruft einen angegebenen Datensatz aus der Tabelle „Fall“ [sn_customerservice_Case], „Incident“ [Incident] oder „Serviceproblemfall“ [sn_sprb_mgmt_case] ab.
URL-Format
Standard-URL: /api/sn_ind_tsm_sdwan/Ticket/troubleTicket/{ID}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| ID | SYS_ID des abzurufenden Fall- oder Incident-Datensatzes. Datentyp: Zeichenfolge Tabelle: Fall [sn_customerservice_Case] oder Incident [Incident] |
| Name | Beschreibung |
|---|---|
| Felder | Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Werte:
Datentyp: Zeichenfolge Standard: Gibt alle Felder zurück. |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde aus mindestens einem der folgenden Gründe erkannt.
|
| 404 | Datensatz nicht gefunden Ein Datensatz, der der ID zugeordnet ist, wurde in der Tabelle „Fall“ [sn_customerservice_Case] oder „Incident“ [Incident] nicht gefunden. |
Parameter des Antwort-Haupttexts (JSON)
| Name | Beschreibung |
|---|---|
| Kanal | Kontaktmethode, über die das Ticket erstellt wurde. Datentyp: Objekt |
| channel.name | Name der Kontaktmethode. Ordnet das Feld „Kanal [contact_type]“ für Fälle und das Feld „Kontakttyp“ [contact_type] für Incidents zu. Datentyp: Zeichenfolge |
| creationDate | Datum, an dem der Fall oder Incident-Datensatz erstellt wurde. Ordnet dem erstellten Feld zu. Datentyp: Zeichenfolge |
| Beschreibung | Beschreibung des Problems aus dem Ticket. Ordnet dem Beschreibungsfeld zu. Datentyp: Zeichenfolge |
| href | Relativer Link zum Fall- oder Incident-Datensatz. Datentyp: Zeichenfolge |
| ID | SYS_ID des Fall- oder Incident-Datensatzes. Datentyp: Zeichenfolge |
| Letztes Update | Datum, an dem der Datensatz zuletzt aktualisiert wurde. Ordnet dem aktualisierten Feld zu. Datentyp: Zeichenfolge |
| Name | Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Ordnet dem Feld „Kurzbeschreibung“ zu. Datentyp: Zeichenfolge |
| note | Liste aller Kommentare zum Ticket. Diese Liste enthält keine Arbeitsnotizen. Datentyp: Array von Objekten |
| Hinweis.@type | Typ der Notiz. Es werden nur Kommentare (keine Arbeitsnotizen) zurückgegeben, daher ist dieser Wert immer Kommentare .Datentyp: Zeichenfolge |
| note.author | Name des Anwenders, der den Kommentar geschrieben hat. Datentyp: Zeichenfolge |
| Hinweis.Datum | Datum, an dem der Kommentar in erstellt wurde ServiceNow Instanz. Datentyp: Zeichenfolge |
| Hinweis.Text | Kommentartext. Datentyp: Zeichenfolge |
| ZugehörigEntität | Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselementen oder Services. Datentyp: Array von Objekten |
| RelatedEntity.ID | SYS_ID des betroffenen Elements oder Service. In Fällen stammt dieser Wert aus einer der folgenden Tabellen:
Datentyp: Zeichenfolge |
| RelatedEntity.href | Gibt eine leere Zeichenfolge zurück. Datentyp: Zeichenfolge |
| relatedEntity.name | Name des betroffenen Elements oder Service. Datentyp: Zeichenfolge |
| RelatedEntity.role | Beschreibung des betroffenen Elements oder Service. Datentyp: Zeichenfolge |
| RelatedEntity.@referredType | Typ des Artikels oder Service. Gültige Werte für Falltickets:
Gültige Werte für Incident-Tickets:
Datentyp: Zeichenfolge |
| RelatedEntity.@type | Dieser Wert ist immer ZugehörigEntität .Datentyp: Zeichenfolge |
| Zugehörige Partei | Details zu Kontakten für das Ticket. Datentyp: Array von Objekten |
| ZugehörigPartei.ID | SYS_ID der zugehörigen Partei. Die sys_ID kann je nach Tickettyp und Typ der zugehörigen Partei aus den folgenden Tabellen stammen. Fall:
Incident:
Fall oder Incident:
Datentyp: Zeichenfolge |
| relatedParty.name | Name der zugehörigen Partei. Datentyp: Zeichenfolge |
| RelatedParty.@referredType | Typ der zugehörigen Partei. Mögliche Werte:
Datentyp: Zeichenfolge |
| Schweregrad | Schweregrad des im Problemticket beschriebenen Problems. Ordnet dem Prioritätsfeld zu. Datentyp: Zeichenfolge |
| Status | Aktueller Status des Problemtickets. Ordnet dem Feld Status zu. Datentyp: Zeichenfolge |
| TicketType | Typ des Tickets. Mögliche Werte:
Datentyp: Zeichenfolge |
| @TYPE | Dieser Wert ist immer Problemticket .Datentyp: Zeichenfolge |
cURL-Anforderung
Dieses Beispiel ruft einen Problemticket-Datensatz aus der Tabelle „Fall“ [sn_customerservice_Case] ab.
curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Antworttext.
{
"id": "370415f03c20e910f8772f1bc332b31b",
"href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/370415f03c20e910f8772f1bc332b31b",
"creationDate": "2023-01-19 22:39:28",
"lastUpdate": "2023-01-19 22:41:39",
"description": "Router is not working, my devices cannot detect any signals from the router. First button from the left is flashing red, all others are black. Resetting the router does not solve the problem, I need urgent assistance.",
"severity": "2 - High",
"ticketType": "Case",
"name": "My router is not working properly",
"status": "Open",
"channel": {
"name": "e_bonding"
},
"relatedParty": [
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@referredType": "customer"
},
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@referredType": "customer_contact"
},
{
"id": "",
"name": "",
"@referredType": "assignment_group"
},
{
"id": "",
"name": "",
"@referredType": "assigned_to"
}
],
"relatedEntity": [
{
"id": "b7fa12c7532520103b6bddeeff7b123b",
"href": "",
"name": "Deduplication and Compression PRD00001965",
"role": "This is the product associated with the case.",
"@type": "relatedEntity",
"@referredType": "product"
},
{
"id": "71e73d87c3e23010ff00ed23a140dde8",
"href": "",
"name": "",
"role": "This is the asset associated with the case.",
"@type": "relatedEntity",
"@referredType": "asset"
},
{
"id": "a1913c3577b301108e191e599a5a99e8",
"href": "",
"name": "Deduplication and Compression PI0000037",
"role": "This is the product inventory associated with the case.",
"@type": "relatedEntity",
"@referredType": "product_inventory"
}
],
"note": [
{
"text": "This is a testing comment<script>gs.info('Hello World')</script>",
"date": "2023-01-19 14:41:39",
"author": "System Administrator",
"@type": "comments"
},
{
"text": "This is a testing comment<script>gs.info('Hello World')</script>",
"date": "2023-01-19 14:39:28",
"author": "System Administrator",
"@type": "comments"
}
],
"@type": "TroubleTicket"
}
Problemticket: PATCH /sn_ind_tsm_sdwan/Ticket/troubleTicket/{ID}
Aktualisiert einen angegebenen Datensatz in der Tabelle „Fall“ [sn_customerservice_Case], „Incident“ [Incident] oder „Serviceproblemfall“ [sn_sprb_mgmt_case].
URL-Format
Standard-URL: /api/sn_ind_tsm_sdwan/Ticket/troubleTicket/{ID}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| ID | SYS_ID des zu aktualisierenden Fall- oder Incident-Datensatzes. Datentyp: Zeichenfolge Tabelle: Fall [sn_customerservice_Case] oder Incident [Incident] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Kanal | Kontaktmethode, über die das Ticket erstellt wurde. Datentyp: Objekt |
| channel.name | Name der Kontaktmethode. Ordnet das Feld „Kanal [contact_type]“ für Fälle und das Feld „Kontakttyp“ [contact_type] für Incidents zu. Gültige Werte sind die Auswahlmöglichkeiten für das Feld contact_type. Sie können die Bezeichnung oder den Wert der Auswahl angeben. Beispiel: Datentyp: Zeichenfolge |
| Beschreibung | Beschreibung des Problems. Ordnet zu zu Beschreibung Feld. Datentyp: Zeichenfolge |
| Name | Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Ordnet dem Feld „Kurzbeschreibung“ zu. Datentyp: Zeichenfolge |
| note | Liste der Arbeitsnotizen und Kommentare, die dem Ticket hinzugefügt werden sollen. Datentyp: Array von Objekten |
| Hinweis.@type | Typ der Notiz. Dieser Wert bestimmt, ob die Notiz im Feld „Arbeitsnotizen“ oder „zusätzliche Kommentare“ aufgezeichnet wird. Gültige Werte:
Datentyp: Zeichenfolge |
| Hinweis.Text | Hinweistext. Ordnet dem Feld „Arbeitsnotizen“ oder „zusätzliche Kommentare“ zu. Datentyp: Zeichenfolge |
| ZugehörigEntität | Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselementen oder Services. Datentyp: Array von Objekten |
| relatedEntity.id | SYS_ID des betroffenen Elements oder Service. In Fällen stammt dieser Wert aus einer der folgenden Tabellen:
Datentyp: Zeichenfolge |
| RelatedEntity.@referredType | Typ des Artikels oder Service. Gültige Werte für Falltickets:
Gültige Werte für Incident-Tickets:
Datentyp: Zeichenfolge |
| Zugehörige Partei | Details zu Kontakten für das Ticket. In Fällen füllt dieser Parameter das Feld „Kontakt“ oder „Account“ aus. Bei Incidents füllt dieser Parameter das Feld „Anrufer“ oder „Unternehmen“ aus. Datentyp: Array von Objekten |
| ZugehörigPartei.ID | SYS_ID der zugehörigen Partei. Wenn Sie einen Kontakt oder einen Anwender (Anrufer) angeben, wird sein Account oder Unternehmen automatisch im Ticket ausgefüllt. Datentyp: Zeichenfolge Tabelle: Für Fälle stammt die sys_ID aus den Tabellen „Kontakt“ [Customer_contact] oder „Account“ [Customer_Account]. Bei Incidents stammt die sys_ID aus den Tabellen Anwender [sys_user] oder Unternehmen [Core_Company]. |
| RelatedParty.@referredType | Typ der zugehörigen Partei. Gültige Werte:
Datentyp: Zeichenfolge |
| Schweregrad | Schweregrad des im Problemticket beschriebenen Problems. Ordnet zu zu Priorität Feld. Gültige Werte:
1 . Wenn ein ungültiger Wert angegeben wird, wird der Schweregrad auf „Niedrig“ festgelegt.Datentyp: Zeichenfolge |
| Status | Aktueller Status des Problemtickets. Ordnet zu zu Status Feld. Gültige Werte sind die Auswahlmöglichkeiten für Status Feld. Sie können die Bezeichnung oder den Wert der Auswahl angeben. Beispiel: Datentyp: Zeichenfolge |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Inhaltstyp | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde aus mindestens einem der folgenden Gründe erkannt.
|
| 404 | Datensatz nicht gefunden Ein Datensatz, der der ID zugeordnet ist, wurde in der Tabelle „Fall“ [sn_customerservice_Case] oder „Incident“ [Incident] nicht gefunden. |
Parameter des Antwort-Haupttexts (JSON)
| Name | Beschreibung |
|---|---|
| Kanal | Kontaktmethode, über die das Ticket erstellt wurde. Datentyp: Objekt |
| channel.name | Name der Kontaktmethode. Datentyp: Zeichenfolge |
| creationDate | Datum, an dem der Datensatz erstellt wurde. Datentyp: Zeichenfolge |
| Beschreibung | Beschreibung des Problems aus dem Ticket. Datentyp: Zeichenfolge |
| href | Relativer Link zum Fall- oder Incident-Datensatz. Datentyp: Zeichenfolge |
| ID | SYS_ID des Fall- oder Incident-Datensatzes. Datentyp: Zeichenfolge |
| Letztes Update | Datum, an dem der Datensatz zuletzt aktualisiert wurde. Datentyp: Zeichenfolge |
| Name | Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Datentyp: Zeichenfolge |
| note | Liste aller Kommentare zum Ticket. Diese Liste enthält keine Arbeitsnotizen. Datentyp: Array von Objekten |
| Hinweis.@type | Typ der Notiz. Es werden nur Kommentare (keine Arbeitsnotizen) zurückgegeben, daher ist dieser Wert immer Kommentare .Datentyp: Zeichenfolge |
| note.author | Name des Anwenders, der den Kommentar geschrieben hat. Datentyp: Zeichenfolge |
| Hinweis.Datum | Datum, an dem der Kommentar in erstellt wurde ServiceNow Instanz. Datentyp: Zeichenfolge |
| Hinweis.Text | Kommentartext. Datentyp: Zeichenfolge |
| ZugehörigEntität | Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselementen oder Services. Datentyp: Array von Objekten |
| RelatedEntity.ID | SYS_ID des betroffenen Elements oder Service. In Fällen stammt dieser Wert aus einer der folgenden Tabellen:
Datentyp: Zeichenfolge |
| RelatedEntity.href | Gibt eine leere Zeichenfolge zurück. Datentyp: Zeichenfolge |
| relatedEntity.name | Name des betroffenen Elements oder Service. Datentyp: Zeichenfolge |
| RelatedEntity.role | Beschreibung des betroffenen Elements oder Service. Datentyp: Zeichenfolge |
| RelatedEntity.@referredType | Typ des Artikels oder Service. Gültige Werte für Falltickets:
Gültige Werte für Incident-Tickets:
Datentyp: Zeichenfolge |
| RelatedEntity.@type | Dieser Wert ist immer ZugehörigEntität .Datentyp: Zeichenfolge |
| Zugehörige Partei | Details zu Kontakten für das Ticket. Datentyp: Array von Objekten |
| ZugehörigPartei.ID | SYS_ID der zugehörigen Partei. Die sys_ID kann je nach Tickettyp und Typ der zugehörigen Partei aus den folgenden Tabellen stammen. Fall:
Incident:
Fall oder Incident:
Datentyp: Zeichenfolge |
| relatedParty.name | Name der zugehörigen Partei. Datentyp: Zeichenfolge |
| RelatedParty.@referredType | Typ der zugehörigen Partei. Mögliche Werte:
Datentyp: Zeichenfolge |
| Schweregrad | Schweregrad des im Problemticket beschriebenen Problems. Datentyp: Zeichenfolge |
| Status | Aktueller Status des Problemtickets. Datentyp: Zeichenfolge |
| TicketType | Typ des Tickets. Mögliche Werte:
Datentyp: Zeichenfolge |
| @TYPE | Dieser Wert ist immer Problemticket .Datentyp: Zeichenfolge |
cURL-Anforderung
Dieses Beispiel aktualisiert einen Falldatensatz.
curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
description: "Updated description",
"note": [
{
"text": "Adding another comment",
"@type": "comments"
}
]
}" \
--user 'username':'password'
Antworttext.
{
"id": "6467508d47e345508761b955d36d43f6",
"href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6",
"creationDate": "2022-05-16 23:38:55",
"lastUpdate": "2022-05-16 23:48:42",
"description": "Updated description",
"severity": "2 - High",
"ticketType": "Case",
"name": "Laptop problem",
"status": "New",
"channel": {
"name": "web"
},
"relatedParty": [
{
"id": "",
"name": "",
"@referredType": "customer"
},
{
"id": "62826bf03710200044e0bfc8bcbe5df1",
"name": "",
"@referredType": "customer_contact"
},
{
"id": "",
"name": "",
"@referredType": "assignment_group"
},
{
"id": "",
"name": "",
"@referredType": "assigned_to"
}
],
"relatedEntity": [
{
"id": "",
"href": "",
"name": "",
"role": "This is the product associated with the case",
"@type": "relatedEntity",
"@referredType": "product"
},
{
"id": "74a9ec0d3790200044e0bfc8bcbe5d7f",
"href": "",
"name": "P1000597 - Apple MacBook Pro 15\"",
"role": "This is the asset associated with the case",
"@type": "relatedEntity",
"@referredType": "asset"
}
{
"id": "a1913c3577b301108e191e599a5a99e8",
"href": "",
"name": "Deduplication and Compression PI0000037",
"role": "This is the product inventory associated with the case.",
"@type": "relatedEntity",
"@referredType": "product_inventory"
}
],
"note": [
{
"text": "Adding another comment",
"date": "2022-05-16 16:48:42",
"author": "admin",
"@type": "comments"
},
{
"text": "Comment about this case",
"date": "2022-05-16 16:38:55",
"author": "admin",
"@type": "comments"
}
],
"@type": "TroubleTicket"
}
Problemticket: VERÖFFENTLICHEN/sn_ind_tsm_sdwan/Ticket/troubleTicket
Erstellt einen Datensatz in der Tabelle „Fall“ [sn_customerservice_Case], „Incident“ [Incident] oder „Serviceproblemfall“ [sn_sprb_mgmt_case].
URL-Format
Standard-URL: /api/sn_ind_tsm_sdwan/Ticket/troubleTicket
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Kanal | Kontaktmethode, über die das Ticket erstellt wurde. Datentyp: Objekt |
| channel.name | Name der Kontaktmethode. Ordnet das Feld „Kanal [contact_type]“ für Fälle und das Feld „Kontakttyp“ [contact_type] für Incidents zu. Gültige Werte sind die Auswahlmöglichkeiten für das Feld contact_type. Sie können die Bezeichnung oder den Wert der Auswahl angeben. Beispiel: Datentyp: Zeichenfolge |
| Beschreibung | Erforderlich. Eine Beschreibung des Problems. Ordnet zu zu Beschreibung Feld. Datentyp: Zeichenfolge |
| Name | Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Ordnet dem Feld „Kurzbeschreibung“ zu. Datentyp: Zeichenfolge |
| note | Liste der Arbeitsnotizen und Kommentare, die dem Ticket hinzugefügt werden sollen. Datentyp: Array von Objekten |
| Hinweis.@type | Typ der Notiz. Dieser Wert bestimmt, ob die Notiz im Feld „Arbeitsnotizen“ oder „zusätzliche Kommentare“ aufgezeichnet wird. Gültige Werte:
Datentyp: Zeichenfolge |
| Hinweis.Text | Hinweistext. Ordnet dem Feld „Arbeitsnotizen“ oder „zusätzliche Kommentare“ zu. Datentyp: Zeichenfolge |
| ZugehörigEntität | Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselementen oder Services. Datentyp: Array von Objekten |
| relatedEntity.id | SYS_ID des betroffenen Elements oder Service. In Fällen stammt dieser Wert aus einer der folgenden Tabellen:
Datentyp: Zeichenfolge |
| RelatedEntity.@referredType | Typ des Artikels oder Service. Gültige Werte für Falltickets:
Gültige Werte für Incident-Tickets:
Datentyp: Zeichenfolge |
| Zugehörige Partei | Details zu Kontakten für das Ticket. In Fällen füllt dieser Parameter das Feld „Kontakt“ oder „Account“ aus. Bei Incidents füllt dieser Parameter das Feld „Anrufer“ oder „Unternehmen“ aus. Datentyp: Array von Objekten |
| ZugehörigPartei.ID | SYS_ID der zugehörigen Partei. Wenn Sie einen Kontakt oder einen Anwender (Anrufer) angeben, wird sein Account oder Unternehmen automatisch im Ticket ausgefüllt. Datentyp: Zeichenfolge Tabelle: Für Fälle stammt die sys_ID aus den Tabellen „Kontakt“ [Customer_contact] oder „Account“ [Customer_Account]. Bei Incidents stammt die sys_ID aus den Tabellen Anwender [sys_user] oder Unternehmen [Core_Company]. |
| RelatedParty.@referredType | Typ der zugehörigen Partei. Gültige Werte:
Datentyp: Zeichenfolge |
| Schweregrad | Erforderlich. Der Schweregrad des im Problemticket beschriebenen Problems. Ordnet zu zu Priorität Feld. Gültige Werte:
1 . Wenn ein ungültiger Wert angegeben wird, wird der Schweregrad auf „Niedrig“ festgelegt.Datentyp: Zeichenfolge |
| Status | Erforderlich. Der aktuelle Status des Problemtickets. Ordnet zu zu Status Feld. Gültige Werte sind die Auswahlmöglichkeiten für Status Feld. Sie können die Bezeichnung oder den Wert der Auswahl angeben. Beispiel: Datentyp: Zeichenfolge |
| TicketType | Der Typ des Tickets. Dieser Wert bestimmt, ob der Datensatz in der Tabelle „Fall“ [sn_customerservice_Case], „Incident“ [Incident] oder „Serviceproblemfall“ [sn_sprb_mgmt_case] erstellt wird. Gültige Werte:
Datentyp: Zeichenfolge Standard: Incident |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Inhaltstyp | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 201 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde aus mindestens einem der folgenden Gründe erkannt.
|
Parameter des Antwort-Haupttexts (JSON)
| Name | Beschreibung |
|---|---|
| @TYPE | Dieser Wert ist immer Problemticket .Datentyp: Zeichenfolge |
| Kanal | Kontaktmethode, über die das Ticket erstellt wurde. Datentyp: Objekt |
| channel.name | 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 |
| Letztes Update | Das Datum, an dem der Fall oder Incident-Datensatz zuletzt aktualisiert wurde. Datentyp: Zeichenfolge |
| Name | Der Name des Problemtickets, normalerweise eine kurze Beschreibung des Problems. Datentyp: Zeichenfolge |
| note | Eine Liste aller Kommentare zum Ticket. Diese Liste enthält keine Arbeitsnotizen. Datentyp: Array |
| Hinweis.@type | Der Typ der Notiz. Es werden nur Kommentare (keine Arbeitsnotizen) zurückgegeben, daher ist dieser Wert immer Kommentare .Datentyp: Zeichenfolge |
| note.author | Der Name des Anwenders, der den Kommentar geschrieben hat. Datentyp: Zeichenfolge |
| Hinweis.Datum | Das Datum, an dem der Kommentar in erstellt wurde ServiceNow Instanz. Datentyp: Zeichenfolge |
| Hinweis.Text | Der Kommentartext. Datentyp: Zeichenfolge |
| ZugehörigEntität | Liste der betroffenen Assets, Produkte, verkauften Produkte (Produktbestand), Konfigurationselementen oder Services. Datentyp: Array von Objekten |
| RelatedEntity.ID | SYS_ID des betroffenen Elements oder Service. In Fällen stammt dieser Wert aus einer der folgenden Tabellen:
Datentyp: Zeichenfolge |
| RelatedEntity.href | Gibt eine leere Zeichenfolge zurück. Datentyp: Zeichenfolge |
| relatedEntity.name | Name des betroffenen Elements oder Service. Datentyp: Zeichenfolge |
| RelatedEntity.role | Beschreibung des betroffenen Elements oder Service. Datentyp: Zeichenfolge |
| RelatedEntity.@referredType | Typ des Artikels oder Service. Gültige Werte für Falltickets:
Gültige Werte für Incident-Tickets:
Datentyp: Zeichenfolge |
| RelatedEntity.@type | Dieser Wert ist immer ZugehörigEntität .Datentyp: Zeichenfolge |
| Zugehörige Partei | Details zu Kontakten für das Ticket. Datentyp: Array von Objekten |
| ZugehörigPartei.ID | SYS_ID der zugehörigen Partei. Die sys_ID kann je nach Tickettyp und Typ der zugehörigen Partei aus den folgenden Tabellen stammen. Fall:
Incident:
Fall oder Incident:
Datentyp: Zeichenfolge |
| relatedParty.name | Name der zugehörigen Partei. Datentyp: Zeichenfolge |
| RelatedParty.@referredType | Typ der zugehörigen Partei. Mögliche Werte:
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:
Datentyp: Zeichenfolge |
cURL-Anforderung
In diesem Beispiel wird ein Problemticket-Falldatensatz erstellt.
curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/ticket/troubleTicket" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
"name": "Laptop problem",
"description": "Laptop keeps shutting off unexpectedly",
"severity": "2",
"status": "New",
"ticketType": "Case",
"channel": {
"name": "Web"
},
"note": [
{
"text": "Work note about this case",
"@type": "work_notes"
},
{
"text": "Comment about this case",
"@type": "comments"
}
],
"relatedEntity": [
{
"id": "74a9ec0d3790200044e0bfc8bcbe5d7f",
"@referredType": "asset"
}
],
"relatedParty": [
{
"id": "62826bf03710200044e0bfc8bcbe5df1",
"@referredType": "customer_contact"
}
]
}" \
--user 'username':'password'
Antworttext.
{
"id": "6467508d47e345508761b955d36d43f6",
"href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6",
"creationDate": "2022-05-16 23:38:55",
"lastUpdate": "2022-05-16 23:38:55",
"description": "Laptop keeps shutting off unexpectedly",
"severity": "2 - High",
"ticketType": "Case",
"name": "Laptop problem",
"status": "New",
"channel": {
"name": "web"
},
"relatedParty": [
{
"id": "",
"name": "",
"@referredType": "customer"
},
{
"id": "62826bf03710200044e0bfc8bcbe5df1",
"name": "",
"@referredType": "customer_contact"
},
{
"id": "",
"name": "",
"@referredType": "assignment_group"
},
{
"id": "",
"name": "",
"@referredType": "assigned_to"
}
],
"relatedEntity": [
{
"id": "",
"href": "",
"name": "",
"role": "This is the product associated with the case.",
"@type": "relatedEntity",
"@referredType": "product"
},
{
"id": "74a9ec0d3790200044e0bfc8bcbe5d7f",
"href": "",
"name": "P1000597 - Apple MacBook Pro 15\"",
"role": "This is the asset associated with the case.",
"@type": "relatedEntity",
"@referredType": "asset"
}
{
"id": "a1913c3577b301108e191e599a5a99e8",
"href": "",
"name": "Deduplication and Compression PI0000037",
"role": "This is the product inventory associated with the case.",
"@type": "relatedEntity",
"@referredType": "product_inventory"
}
],
"note": [
{
"text": "Comment about this case",
"date": "2022-05-16 16:38:55",
"author": "admin",
"@type": "comments"
}
],
"@type": "TroubleTicket"
}