Ereignismanagement-Thema – API öffnen

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 3 Minuten Lesedauer

    • Die Ereignismanagement-Thema Offen Die API stellt einen Endpunkt bereit, mit dem Sie ein Thema über Ihren Nachrichten-Broker senden und auf speichern können ServiceNowInstanz.

    Mit dieser API können Sie über Ihren Nachrichten-Broker erstellte Themen in speichern ServiceNowThementabelle [Thema].

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

    Ereignismanagement-Thema offen – POST /sn_api_notif_mgmt/topic

    Erstellt einen neuen Datensatz in der Thementabelle [sn_api_notif_mgmt_topic] und speichert die übergebenen Themeninformationen in diesem Datensatz.

    Verwenden Sie diesen Endpunkt, um Themen, die in Ihrer Message-Bus-Middleware erstellt wurden, mit denen in zu synchronisieren ServiceNowInstanz.

    Wenn Themen mit diesem Endpunkt erstellt werden, wird das Feld user_created im zugehörigen Themendatensatz auf festgelegt Falsch Und das Typfeld 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 Geskriptetes REST-Service-Formular .

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfad-Parameter
    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. Anforderungstext-Parameter
    Name Beschreibung
    Inhaltsabfrage 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=Wert1,Wert2,Wert3
    • Hierarchische Variablen: Z. B. variable1.variable2.variable3=Wert1

    Beispiel: „ContentQuery“: „TroubleTicket.ticketType=Incident&troubleTicket.severity=1",

    Dieses Feld ist 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 ist 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=Wert1,Wert2,Wert3
    • Hierarchische Variablen: Z. B. variable1.variable2.variable3=Wert1

    Beispiel: „HeaderQuery“: „EventType=TroubleTicketStatusChangeEvent,TroubleTicketAttributeChangeEvent“

    Dieses Feld ist dem Feld „Header_query“ im zugehörigen Themendatensatz zugeordnet.

    Weitere Informationen finden Sie unter TMF688 Ereignismanagement-API-Anwenderhandbuch .

    Datentyp: Zeichenfolge
    name Name des Themas.

    Dieses Feld ist 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 ist dem Namespace-Feld im zugehörigen Themendatensatz zugeordnet.

    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 .

    Tabelle : 4. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Nur unterstützt application/json.
    Inhaltstyp Datenformat des Anforderungstexts. Nur unterstützt application/json.
    Tabelle : 5. Antwort-Header
    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 .

    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. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter

    Name Beschreibung
    Inhaltsabfrage 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 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"
}