Ereignismanagement-Thema – API öffnen

Die Ereignismanagement-Thema Offen Die API stellt einen Endpunkt bereit, mit dem Sie ein Thema über Ihren Nachrichten-Broker senden und in einem speichern können ServiceNow Instanz.

Mit dieser API können Sie Themen speichern, die über Ihren Nachrichten-Broker in erstellt wurden ServiceNow Thementabelle [Thema].

Diese API wird in ausgeführt sn-api-notif-mgmt Namespace und erfordert die Rolle sn_api_notif_mgmt.event_mgmt_Integration.

Ereignismanagement-Thema offen – POST /sn_api_notif_mgmt/topic

Erstellt einen neuen Datensatz in der Tabelle „Thema“ [sn_api_notif_mgmt_topic] und speichert die übergebenen Themeninformationen in diesem Datensatz.

Verwenden Sie diesen Endpunkt, um Themen, die in Ihrer Nachrichtenbus-Middleware erstellt wurden, mit denen in zu synchronisieren ServiceNow Instanz.

Wenn Themen mit diesem Endpunkt erstellt werden, wird das Feld user_created im zugehörigen Themendatensatz auf festgelegt Falsch Und das Feld Typ ist auf festgelegt Ausgang .

URL-Format

Versionierte URL: /api/sn_api_notif_mgmt/{api_Version}/topic

Standard-URL: /api/sn_api_notif_mgmt/topic

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 2. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 3. Anforderungstextparameter

Name	Beschreibung
ContentQuery	Filter, der auf die Nutzlast des Ereignisses angewendet werden soll. Diese Abfrage ist ein tieferer Ereignisfilter, der verwendet wird, um Informationen wie Ereignisschweregrad oder Tickettyp zu finden. Sie können diesen Parameter als geschachtelte Abfrage übergeben. Für die folgende Nutzlast des Problemticket-Ereignisses gilt diese Abfrage beispielsweise für die Attribute, die sich in befinden „Ereignis“ Objekt der Nutzlast: { "eventId":"dc2003c2c3bb3550054e20bdc0013136", "@type":"Troubleticket", "eventType":"TroubleTicketCreateEvent", "event":{ "troubleTicket":{ "short_description":"Test payload", "severity":3, "ticketType":"incident" } } } Dieser Parameter unterstützt die folgenden Bedingungen: UND: Z. B. variable1=value1&variable2=value2&variable3=value3 ODER: Z. B. variable1=value1,value2,value3 Hierarchische Variablen: Z. B. variable1.variable2.variable3=value1 Beispiel: „ContentQuery“: „TroubleTicket.ticketType=Incident&troubleTicket.severity=1", Dieses Feld wird dem Feld content_query im zugehörigen Themendatensatz zugeordnet. Weitere Informationen finden Sie unter TMF688 Ereignismanagement-API – Anwenderhandbuch . Datentyp: Zeichenfolge
externalId	Eindeutiger externer Bezeichner für das Thema, z. B. eine GUID. Dieses Feld wird dem Feld topic_ID im zugehörigen Themendatensatz zugeordnet. Datentyp: Zeichenfolge
HeaderQuery	Filter, der auf die Eigenschaften des Ereignis-Headers angewendet werden soll. Diese Abfrage definiert den Typ der Ereignisse, die für das zugehörige Thema abgehört werden sollen. Sie können diesen Parameter als geschachtelte Abfrage übergeben. Dieser Parameter unterstützt die folgenden Bedingungen: UND: Z. B. variable1=value1&variable2=value2&variable3=value3 ODER: Z. B. variable1=value1,value2,value3 Hierarchische Variablen: Z. B. variable1.variable2.variable3=value1 Beispiel: „HeaderQuery“: „EventType=TroubleTicketStatusChangeEvent,TroubleTicketAttributeChangeEvent“ Dieses Feld wird dem Feld „Header_query“ im zugehörigen Themendatensatz zugeordnet. Weitere Informationen finden Sie unter TMF688 Ereignismanagement-API – Anwenderhandbuch . Datentyp: Zeichenfolge
name	Der Name des Themas. Dieses Feld wird dem Feld topic_Name im zugehörigen Themendatensatz zugeordnet. Datentyp: Zeichenfolge
namespace	Namespace für das Thema. Leer, wenn kein Namespace zugeordnet ist. Dieses Feld wird dem Namespace-Feld im zugehörigen Themendatensatz zugeordnet. Datentyp: Zeichenfolge

Header

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

Tabelle : 4. Anforderungskopfzeilen

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

Tabelle : 5. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

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

Tabelle : 6. Statuscodes

Statuscode	Beschreibung
201	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Übergebene externe Thema-ID ist bereits vorhanden. Übergeben Sie die eindeutige externe Thema-ID : Gibt an, dass die übergebene externe ID bereits in der Thementabelle vorhanden ist. Übergeben Sie die eindeutige Kombination aus Themenname, Headerabfrage, Inhaltsabfrage und Namespace : Gibt an, dass die Kombination aus Themenname, Namespace, Headerabfrage und Inhaltsabfrage bereits vorhanden ist.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antwort-Haupttexts

Name	Beschreibung
ContentQuery	Wert des Felds „content_query“ im erstellten Themendatensatz. Datentyp: Zeichenfolge
externalId	Wert des Felds topic_ID im erstellten Themendatensatz. Datentyp: Zeichenfolge
HeaderQuery	Wert des Felds „Header_query“ im erstellten Themendatensatz. Dieses Feld wird vom Themenauswahl-Framework verwendet, um zu bestimmen, welche Ereignisnachrichten an ein Thema gesendet werden sollen. Datentyp: Zeichenfolge
id	SYS_ID des erstellten Themendatensatzes. Datentyp: Zeichenfolge
name	Der Name des Themas. Datentyp: Zeichenfolge
namespace	Wert des Namespace-Felds im erstellten Themendatensatz. Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird.

curl "http://instance.servicenow.com/api/sn_api_notif_mgmt/topic" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'
--data
{
  "name": "HighPriorityTroubleTicket",
  "headerQuery": "eventType=TroubleTicketStatusChangeEvent,TroubleTicketAttributeChangeEvent",
  "contentQuery": "troubleTicket.ticketType=incident&troubleTicket.severity=1",
  "externalId": "ext001",
  "namespace": "telecomEvents"
}

Antwort:

{
  "externalId": "ext001",
  "name": "HighPriorityTroubleTicket",
  "headerQuery": "eventType=TroubleTicketStatusChangeEvent,TroubleTicketAttributeChangeEvent",
  "contentQuery": "troubleTicket.ticketType=incident&troubleTicket.severity=1",
  "namespace": "telecomEvents",
  "id": "7ee9850443c3f550461f99612bb8f223"
}