---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# ThemenAPIUtilsOOB -- Umfang

# ThemenAPIUtilsOOB -- Umfang {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 10 Minuten Lesedauer

Die ThemenAPIUtilsOOB Die Skripteinbindung stellt Methoden bereit, die bei der Verarbeitung von verwendet werden Ereignismanagement-Thema -- API öffnen Endpunkt.

Wenn Sie die Standardfunktionalität von ändern möchten Ereignismanagement-Thema -- API öffnen , Sie müssen die Funktionen in dieser Skripteinbindung in überschreiben `Themen-APIUtils `Skripteinbindung.

Diese Skripteinbindung wird in ausgeführt `sn_api_notif_mgmt `Namespace und erfordert die sn_api_notif_mgmt.event_mgmt_integration-Rolle.

## TopicAPIUtilsOOB -- createTopicHelper(ObjekttopicObject, Array-Warnungen) {#ariaid-title2}

Fügt die in übergebenen Informationen ein Ereignismanagement-Thema -- offene API -- POST /sn_api_notif_mgmt/topic Endpunkt in der Thementabelle \[sn_api_notif_mgmt_topic\].
Wenn Sie diesen Einfügeprozess ändern möchten, müssen Sie diese Methode in überschreiben Themen-APIUtils Skripteinbindung.
{#TopAPIUtilOOB-createTopHelp_O_A__table_jkr_mjr_tzb__entry__3}{#TopAPIUtilOOB-createTopHelp_O_A__TopicAPIUtilsOOB-topicObject-entry}{#TopAPIUtilOOB-createTopHelp_O_A__TopicAPIUtilsOOB-warnings-entry}

| Name | Typ | Beschreibung |
|-|-|-|
| TopicObject | Objekt | Nutzlastobjekt des Themas an übergeben [Ereignismanagement-Thema -- API öffnen](https://servicenow-prod.fluidtopics.net/cwBhdHWeDnAJYBKlVVQh2w#event_management_topic-api "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.")Endpunkt. Zum Beispiel: { "name": "HighPriorityTroubleTicket", "headerQuery": "eventType=TroubleTicketStatusChangeEvent,TroubleTicketAttributeChangeEvent", "contentQuery": "troubleTicket.ticketType=incident&troubleTicket.severity=1", "externalId": "ext001", "namespace": "telecomEvents" } Das Schema dieses Objekts muss dem entsprechen, was in definiert ist <var class="keyword varname">CONSTANTS.SCHEMA.CREATE_TOPIC_SCHEMA </var>Befindet sich in sn_api_notif_mgmt.Constants Skripteinbindung. |
| Warnungen | Array | Warnmeldungen, die in zurückgegeben werden sollen [Ereignismanagement-Thema -- API öffnen](https://servicenow-prod.fluidtopics.net/cwBhdHWeDnAJYBKlVVQh2w#event_management_topic-api "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.")Endpunktantwort, wenn bei der Methode ein Problem auf der Ebene „Warnung" auftritt. Mit diesem Parameter können Sie Ihrer Implementierung dieses Endpunkts anwenderdefinierte Warnmeldungen hinzufügen. Wenn keine zusätzlichen Warnmeldungen vorhanden sind, müssen Sie ein leeres Array übergeben. |
[Tabelle : 1. Parameter]

{#TopAPIUtilOOB-createTopHelp_O_A__table_jkr_mjr_tzb} {#TopAPIUtilOOB-createTopHelp_O_A__table_kkr_mjr_tzb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Antwortobjekt. { "contentQuery": "String", "eventType": "String", "externalId": "String", "headerQuery": "String", "id": "String", "name": "String" } Details zu diesen Parametern finden Sie in den Rückgabeergebnissen für [Ereignismanagement-Thema offen -- POST /sn_api_notif_mgmt/topic](https://servicenow-prod.fluidtopics.net/cwBhdHWeDnAJYBKlVVQh2w#evt_man_top-POST-topic "Erstellt einen neuen Datensatz in der Thementabelle [sn_api_notif_mgmt_topic] und speichert die übergebenen Themeninformationen in diesem Datensatz."). |
[Tabelle : 2. Rückgaben]

{#TopAPIUtilOOB-createTopHelp_O_A__table_kkr_mjr_tzb}  
Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    processTopicCreation: function(topicObject) {
      try {
        var warnings = [];

        var schema = this.getCreateTopicSchema();
        if (!this.isValidCreateTopicPayload(topicObject, schema, warnings)) {
          this._logger.logDebug("Create Topic : validation failed");
          return this.response;
        }
        this.createTopicHelper(topicObject, warnings);
        this._logger.logDebug("Create Topic: Topic created succesfully");
      } catch (ex) {
        this._logger.logErr("Create Topic : Process aborted, error is: " + ex);
        var errorObj = this.apiCoreUtil.getErrorObj(sn_tmt_core.Constants.ERROR_CODES.INTERNAL_ERROR, Constants.MESSAGES.TOPIC_CREATE_ERROR, Constants.MESSAGES.TOPIC_CREATE_ERROR);
        var details = [];
        details.push(this.apiCoreUtil.getErrorDetailsObj(ex.message + '', ''));
        errorObj.details = details;
        this.response.details = errorObj;
      }

      return this.response;
    },

## TopicAPIUtilsOOB -- getCreateTopicSchema() {#ariaid-title3}

Gibt das definierte Schema für die Nutzlast zurück, die von verwendet wird Ereignismanagement-Thema -- offene API -- POST /sn_api_notif_mgmt/topic Endpunkt zum Validieren der Themennutzlast.
Wenn Sie das Schema für die Themennutzlast anpassen möchten, müssen Sie das Standardnutzlastschema überschreiben. <var class="keyword varname">Constants.SCHEMA </var>, Befindet sich in sn_api_notif_mgmt.Constants Skripteinbindung. Dieser Standardwert dieses Schemas ist:

    CREATE_TOPIC_SCHEMA: "{
      \"title\":\"Topic\",
      \"type\":\"object\",
      \"properties\":{
        \"name\":{
          \"type\":\"string\"
        },
        \"contentQuery\":{
          \"type\":\"string\"
        },
        \"headerQuery\":{
          \"type\":\"string\"
        },
        \"namespace\":{
          \"type\":\"string\"
        }
      },
      \"required\":[\"name\"]
    }"

{#TopAPIUtilOOB-getCreTopSchema__table_tqw_tnw_tzb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 3. Parameter]

{#TopAPIUtilOOB-getCreTopSchema__table_tqw_tnw_tzb} {#TopAPIUtilOOB-getCreTopSchema__table_uqw_tnw_tzb__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Schema für Ereignismanagement-Thema -- offene API -- POST /sn_api_notif_mgmt/topic Endpunkt-Nutzlast. Verwenden Sie dieses Schema, um das an den Endpunkt übergebene Schema mit zu validieren [TopicAPIUtilsOOB -- isValidCreateTopicPayload(ObjekttopicObject, Zeichenfolgenschema, Array-Warnungen)](https://servicenow-prod.fluidtopics.net/MBdUqOrSYhpxf5whCqNeCg#TopAPIUtilOOB-isValCreTopPay_O "Validiert die Nutzlast, die an übergeben wurde Ereignismanagement-Thema – offene API – POST /sn_api_notif_mgmt/topic Endpunkt. Diese Validierung wird für den Anforderungstext und das Schema durchgeführt.")Methode. |
[Tabelle : 4. Rückgaben]

{#TopAPIUtilOOB-getCreTopSchema__table_uqw_tnw_tzb}  
Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    processTopicCreation: function(topicObject) {
      try {
        var warnings = [];

        var schema = this.getCreateTopicSchema();
        if (!this.isValidCreateTopicPayload(topicObject, schema, warnings)) {
          this._logger.logDebug("Create Topic : validation failed");
          return this.response;
        }
        this.createTopicHelper(topicObject, warnings);
        this._logger.logDebug("Create Topic: Topic created succesfully");
      } catch (ex) {
        this._logger.logErr("Create Topic : Process aborted, error is: " + ex);
        var errorObj = this.apiCoreUtil.getErrorObj(sn_tmt_core.Constants.ERROR_CODES.INTERNAL_ERROR, Constants.MESSAGES.TOPIC_CREATE_ERROR, Constants.MESSAGES.TOPIC_CREATE_ERROR);
        var details = [];
        details.push(this.apiCoreUtil.getErrorDetailsObj(ex.message + '', ''));
        errorObj.details = details;
        this.response.details = errorObj;
      }

      return this.response;
    },

## TopicAPIUtilsOOB -- isValidCreateTopicPayload(ObjekttopicObject, Zeichenfolgenschema, Array-Warnungen) {#ariaid-title4}

Validiert die Nutzlast, die an übergeben wurde Ereignismanagement-Thema -- offene API -- POST /sn_api_notif_mgmt/topic Endpunkt. Diese Validierung wird für den Anforderungstext und das Schema durchgeführt.
Wenn Sie den Validierungsprozess für die Nutzlast ändern möchten, müssen Sie diese Methode in überschreiben Themen-APIUtils Skripteinbindung.
{#TopAPIUtilOOB-isValCreTopPay_O__table_jkr_mjr_tzb__entry__3}{#TopAPIUtilOOB-isValCreTopPay_O__TopicAPIUtilsOOB-topicObject-entry}

| Name | Typ | Beschreibung |
|-|-|-|
| TopicObject | Objekt | Nutzlastobjekt des Themas an übergeben [Ereignismanagement-Thema -- API öffnen](https://servicenow-prod.fluidtopics.net/cwBhdHWeDnAJYBKlVVQh2w#event_management_topic-api "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.")Endpunkt. Zum Beispiel: { "name": "HighPriorityTroubleTicket", "headerQuery": "eventType=TroubleTicketStatusChangeEvent,TroubleTicketAttributeChangeEvent", "contentQuery": "troubleTicket.ticketType=incident&troubleTicket.severity=1", "externalId": "ext001", "namespace": "telecomEvents" } Das Schema dieses Objekts muss dem entsprechen, was in definiert ist <var class="keyword varname">CONSTANTS.SCHEMA.CREATE_TOPIC_SCHEMA </var>Befindet sich in sn_api_notif_mgmt.Constants Skripteinbindung. |
| Schema | Zeichenfolge | Schema, das zum Validieren der Themennutzlast verwendet werden soll. Verwenden Sie [TopicAPIUtilsOOB -- getCreateTopicSchema()](https://servicenow-prod.fluidtopics.net/MBdUqOrSYhpxf5whCqNeCg#TopAPIUtilOOB-getCreTopSchema "Gibt das definierte Schema für die Nutzlast zurück, die von verwendet wird Ereignismanagement-Thema – offene API – POST /sn_api_notif_mgmt/topic Endpunkt zum Validieren der Themennutzlast.")Methode zum Abrufen dieses Schemas. |
| Warnungen | Array | Warnmeldungen, die in zurückgegeben werden sollen [Ereignismanagement-Thema -- API öffnen](https://servicenow-prod.fluidtopics.net/cwBhdHWeDnAJYBKlVVQh2w#event_management_topic-api "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.")Endpunktantwort, wenn bei der Methode ein Problem auf der Ebene „Warnung" auftritt. Mit diesem Parameter können Sie Ihrer Implementierung dieses Endpunkts anwenderdefinierte Warnmeldungen hinzufügen. Wenn keine zusätzlichen Warnmeldungen vorhanden sind, müssen Sie ein leeres Array übergeben. |
[Tabelle : 5. Parameter]

{#TopAPIUtilOOB-isValCreTopPay_O__table_jkr_mjr_tzb} {#TopAPIUtilOOB-isValCreTopPay_O__table_kkr_mjr_tzb__entry__2}

| Typ | Beschreibung |
|-|-|
| Boolean | Kennzeichnung, die angibt, ob die Nutzlast in übergeben wurde topicObjectParameter hat die Validierungen von Schema und Anforderungstext übergeben. Gültige Werte: * Wahr: Nutzlast ist gültig. * Falsch: Nutzlast ist ungültig. |
[Tabelle : 6. Rückgaben]

{#TopAPIUtilOOB-isValCreTopPay_O__table_kkr_mjr_tzb}  
Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    processTopicCreation: function(topicObject) {
      try {
        var warnings = [];

        var schema = this.getCreateTopicSchema();
        if (!this.isValidCreateTopicPayload(topicObject, schema, warnings)) {
          this._logger.logDebug("Create Topic : validation failed");
          return this.response;
        }
        this.createTopicHelper(topicObject, warnings);
        this._logger.logDebug("Create Topic: Topic created succesfully");
      } catch (ex) {
        this._logger.logErr("Create Topic : Process aborted, error is: " + ex);
        var errorObj = this.apiCoreUtil.getErrorObj(sn_tmt_core.Constants.ERROR_CODES.INTERNAL_ERROR, Constants.MESSAGES.TOPIC_CREATE_ERROR, Constants.MESSAGES.TOPIC_CREATE_ERROR);
        var details = [];
        details.push(this.apiCoreUtil.getErrorDetailsObj(ex.message + '', ''));
        errorObj.details = details;
        this.response.details = errorObj;
      }

      return this.response;
    },

## TopicAPIUtilsOOB -- prepareCreateTopicResponse(ObjekttopicObject, ZeichenfolgentopicSysId, Array-Warnungen) {#ariaid-title5}

Generiert die Antwort und gibt sie an zurück Ereignismanagement-Thema -- offene API -- POST /sn_api_notif_mgmt/topic Endpunkt-Aufruf.
Wenn Sie das von zurückgegebene Antwortobjekt anpassen möchten Ereignismanagement-Thema -- offene API -- POST /sn_api_notif_mgmt/topic Endpunkt, Sie müssen diese Methode in überschreiben Themen-APIUtils Skripteinbindung.
{#TopAPIUtilOOB-prepCreTopResp_OSA__table_jkr_mjr_tzb__entry__3}{#TopAPIUtilOOB-prepCreTopResp_OSA__TopicAPIUtilsOOB-topicObject-entry}

| Name | Typ | Beschreibung |
|-|-|-|
| TopicObject | Objekt | Nutzlastobjekt des Themas an übergeben [Ereignismanagement-Thema -- API öffnen](https://servicenow-prod.fluidtopics.net/cwBhdHWeDnAJYBKlVVQh2w#event_management_topic-api "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.")Endpunkt. Zum Beispiel: { "name": "HighPriorityTroubleTicket", "headerQuery": "eventType=TroubleTicketStatusChangeEvent,TroubleTicketAttributeChangeEvent", "contentQuery": "troubleTicket.ticketType=incident&troubleTicket.severity=1", "externalId": "ext001", "namespace": "telecomEvents" } Das Schema dieses Objekts muss dem entsprechen, was in definiert ist <var class="keyword varname">CONSTANTS.SCHEMA.CREATE_TOPIC_SCHEMA </var>Befindet sich in sn_api_notif_mgmt.Constants Skripteinbindung. |
| topicSysId | Zeichenfolge | SYS_ID des Themas, das als Teil von erstellt wurde Ereignismanagement-Thema -- offene API -- POST /sn_api_notif_mgmt/topic Rufen Sie an. Tabelle: Thema \[sn_api_notif_mgmt_topic\] |
| Warnungen | Array | Warnmeldungen, die in zurückgegeben werden sollen [Ereignismanagement-Thema -- API öffnen](https://servicenow-prod.fluidtopics.net/cwBhdHWeDnAJYBKlVVQh2w#event_management_topic-api "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.")Endpunktantwort, wenn bei der Methode ein Problem auf der Ebene „Warnung" auftritt. Mit diesem Parameter können Sie Ihrer Implementierung dieses Endpunkts anwenderdefinierte Warnmeldungen hinzufügen. Wenn keine zusätzlichen Warnmeldungen vorhanden sind, müssen Sie ein leeres Array übergeben. |
[Tabelle : 7. Parameter]

{#TopAPIUtilOOB-prepCreTopResp_OSA__table_jkr_mjr_tzb} {#TopAPIUtilOOB-prepCreTopResp_OSA__table_kkr_mjr_tzb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Endpunkt-Antwortobjekt. Zum Beispiel: { "externalId": "ext001", "name": "HighPriorityTroubleTicket", "headerQuery": "eventType=TroubleTicketStatusChangeEvent,TroubleTicketAttributeChangeEvent", "contentQuery": "troubleTicket.ticketType=incident&troubleTicket.severity=1", "namespace": "telecomEvents", "id": "7ee9850443c3f550461f99612bb8f223" } |
[Tabelle : 8. Rückgaben]

{#TopAPIUtilOOB-prepCreTopResp_OSA__table_kkr_mjr_tzb}  
Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

     createTopicHelper: function(topicObject, warnings) {
      var topicObj = new sn_tmt_core.BaseObject();
      topicObj.setValue('topic_name', topicObject.name);
      if (!gs.nil(topicObject.headerQuery))
        topicObj.setValue('header_query', topicObject.headerQuery);
      if (!gs.nil(topicObject.contentQuery))
        topicObj.setValue('content_query', topicObject.contentQuery);
      if (!gs.nil(topicObject.namespace))
        topicObj.setValue('namespace', topicObject.namespace);
      if (!gs.nil(topicObject.externalId))
        topicObj.setValue('topic_id', topicObject.externalId);
      topicObj.setValue('type', "egress");
      topicObj.setValue('user_created', false);

      new TopicUtil().createTopic(topicObj);

      // If topic external id is passed by external system, add it in topic id field. This will act as an external id for us.

      var topicGr = TopicDAO.getTopicByNameHeaderContentNamespace(topicObject.name, topicObject.headerQuery, topicObject.contentQuery, topicObject.namespace, '');

      if (topicGr && topicGr.next())
        var newTopicSysId = topicGr.getValue('sys_id');

        this.prepareCreateTopicResponse(topicObject, newTopicSysId, warnings);
        return this.response;

    },

## TopicAPIUtilsOOB -- processTopicCreation(Object topicObject) {#ariaid-title6}

Verarbeitet die Anforderung von Ereignismanagement-Thema -- API öffnen Endpunkt.
Diese Methode ruft die Hilfsmethoden auf, die für die Dateneinfügung, die Schemavalidierung, die Validierung des Anforderungstexts und die Antwort-Orchestration erforderlich sind. Überschreiben Sie diese Methode, wenn Sie die grundlegende Verarbeitung von anpassen müssen [Ereignismanagement-Thema offen -- POST /sn_api_notif_mgmt/topic](https://servicenow-prod.fluidtopics.net/cwBhdHWeDnAJYBKlVVQh2w#evt_man_top-POST-topic "Erstellt einen neuen Datensatz in der Thementabelle [sn_api_notif_mgmt_topic] und speichert die übergebenen Themeninformationen in diesem Datensatz.")Anforderung. Andernfalls überschreiben Sie die einzelnen Hilfsmethoden.
{#TopAPIUtilOOB-processTopicCreation_O__table_s2k_n3k_tzb__entry__3}{#TopAPIUtilOOB-processTopicCreation_O__TopicAPIUtilsOOB-topicObject-entry}

| Name | Typ | Beschreibung |
|-|-|-|
| TopicObject | Objekt | Nutzlastobjekt des Themas an übergeben [Ereignismanagement-Thema -- API öffnen](https://servicenow-prod.fluidtopics.net/cwBhdHWeDnAJYBKlVVQh2w#event_management_topic-api "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.")Endpunkt. Zum Beispiel: { "name": "HighPriorityTroubleTicket", "headerQuery": "eventType=TroubleTicketStatusChangeEvent,TroubleTicketAttributeChangeEvent", "contentQuery": "troubleTicket.ticketType=incident&troubleTicket.severity=1", "externalId": "ext001", "namespace": "telecomEvents" } Das Schema dieses Objekts muss dem entsprechen, was in definiert ist <var class="keyword varname">CONSTANTS.SCHEMA.CREATE_TOPIC_SCHEMA </var>Befindet sich in sn_api_notif_mgmt.Constants Skripteinbindung. |
[Tabelle : 9. Parameter]

{#TopAPIUtilOOB-processTopicCreation_O__table_s2k_n3k_tzb} {#TopAPIUtilOOB-processTopicCreation_O__table_t2k_n3k_tzb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Endpunkt-Antwortobjekt. Zum Beispiel: { "externalId": "ext001", "name": "HighPriorityTroubleTicket", "headerQuery": "eventType=TroubleTicketStatusChangeEvent,TroubleTicketAttributeChangeEvent", "contentQuery": "troubleTicket.ticketType=incident&troubleTicket.severity=1", "namespace": "telecomEvents", "id": "7ee9850443c3f550461f99612bb8f223" } |
[Tabelle : 10. Rückgaben]

{#TopAPIUtilOOB-processTopicCreation_O__table_t2k_n3k_tzb}  
Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    try {
      var topicAPIUtils = new TopicAPIUtils();
      var apiResponse = topicAPIUtils.processTopicCreation(request.body.data);
      response.setStatus(apiResponse.status);
      return tsmOpenAPIUtil.responseBuilder(response, apiResponse.details);
    } 

## TopicAPIUtilsOOB -- transformCreateTopicResponse(ObjekttopicObject, ZeichenfolgentopicSysId) {#ariaid-title7}

Bietet die Möglichkeit, anwenderdefinierte Daten zum Antwortobjekt hinzuzufügen, das an zurückgegeben wird Ereignismanagement-Thema -- offene API -- POST /sn_api_notif_mgmt/topic Endpunkt.
Um dieses Antwortobjekt anzupassen, überschreiben Sie diese Methode in Themen-APIUtils Skripteinbindung.
{#TopAPIUtilOOB-tranCreTopResp_OS__table_jkr_mjr_tzb__entry__3}{#TopAPIUtilOOB-tranCreTopResp_OS__TopicAPIUtilsOOB-topicObject-entry}

| Name | Typ | Beschreibung |
|-|-|-|
| TopicObject | Objekt | Nutzlastobjekt des Themas an übergeben [Ereignismanagement-Thema -- API öffnen](https://servicenow-prod.fluidtopics.net/cwBhdHWeDnAJYBKlVVQh2w#event_management_topic-api "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.")Endpunkt. Zum Beispiel: { "name": "HighPriorityTroubleTicket", "headerQuery": "eventType=TroubleTicketStatusChangeEvent,TroubleTicketAttributeChangeEvent", "contentQuery": "troubleTicket.ticketType=incident&troubleTicket.severity=1", "externalId": "ext001", "namespace": "telecomEvents" } Das Schema dieses Objekts muss dem entsprechen, was in definiert ist <var class="keyword varname">CONSTANTS.SCHEMA.CREATE_TOPIC_SCHEMA </var>Befindet sich in sn_api_notif_mgmt.Constants Skripteinbindung. |
| topicSysId | Zeichenfolge | SYS_ID des Themas, das als Teil von erstellt wurde Ereignismanagement-Thema -- offene API -- POST /sn_api_notif_mgmt/topic Rufen Sie an. Sie können dem Themenantwortobjekt Informationen aus diesem Datensatz hinzufügen. Tabelle: Thema \[sn_api_notif_mgmt_topic\] |
[Tabelle : 11. Parameter]

{#TopAPIUtilOOB-tranCreTopResp_OS__table_jkr_mjr_tzb} {#TopAPIUtilOOB-tranCreTopResp_OS__table_kkr_mjr_tzb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Transformiertes Endpunkt-Antwortobjekt. Dieses Objekt muss TMF688-konform sein. Zum Beispiel: { "externalId": "ext001", "name": "HighPriorityTroubleTicket", "headerQuery": "eventType=TroubleTicketStatusChangeEvent,TroubleTicketAttributeChangeEvent", "contentQuery": "troubleTicket.ticketType=incident&troubleTicket.severity=1", "namespace": "telecomEvents", "id": "7ee9850443c3f550461f99612bb8f223" } |
[Tabelle : 12. Rückgaben]

{#TopAPIUtilOOB-tranCreTopResp_OS__table_kkr_mjr_tzb}  
Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    prepareCreateTopicResponse: function(topicObject, topicSysId, warnings) {
      if (!gs.nil(topicSysId)) {
        topicObject.id = topicSysId;
        this.response.status = sn_tmt_core.Constants.STATUS_CODES.CREATED;
        topicObject = this.transformCreateTopicResponse(topicObject, topicSysId); // Customize response payload as per requirement.
        this.response.details = topicObject;
        if (!gs.nil(warnings) && warnings.length > 0) {
          this.response.details.warnings = warnings;
        }
      } else {
        var errorObj = this.apiCoreUtil.getErrorObj(sn_tmt_core.Constants.ERROR_CODES.INTERNAL_ERROR, Constants.MESSAGES.CREATE_TOPIC_ERROR, Constants.MESSAGES.CREATE_TOPIC_ERROR);
        var details = [];
        details.push(this.apiCoreUtil.getErrorDetailsObj(Constants.MESSAGES.CREATE_TOPIC_ERROR, ''));
        errorObj.details = details;
        this.response.details = errorObj;
      }
    },

Das folgende Codebeispiel zeigt Code zum Überschreiben der Standardfunktionalität dieser Methode.

    transformCreateTopicResponse: function(topicObject, topicSysId) {
      new sn_tmt_core.BaseAPIUtil().removeNulls(topicObject);

      // Add custom attributes to the topicObject
      topicObject.origin = "ServiceNow",
      topicObject.ServiceId= "service001",
      return topicObject;
    },

## TopicAPIUtilsOOB -- validateTopicAttributes (ObjekttopicObject, Arraydetails) {#ariaid-title8}

Validiert, ob die Kombination aus Themenname, Header-Abfrage, Content-Abfrage und Namespace in übergeben wurde Ereignismanagement-Thema -- API öffnen Endpunkt-Nutzlast ist eindeutig.
Der Endpunkt verwendet diese Attributkombinationen, um zu bestimmen, ob das Thema derzeit in der Thementabelle \[sn_api_notif_mgmt_topic\] vorhanden ist.

Wenn Sie den Validierungsprozess ändern möchten, müssen Sie diese Methode in überschreiben Themen-APIUtils Skripteinbindung.
{#TopAPIUtilOOB-valTopAtts_O_A__table_i1s_zqr_tzb__entry__3}{#TopAPIUtilOOB-valTopAtts_O_A__TopicAPIUtilsOOB-topicObject-entry}

| Name | Typ | Beschreibung |
|-|-|-|
| TopicObject | Objekt | Nutzlastobjekt des Themas an übergeben [Ereignismanagement-Thema -- API öffnen](https://servicenow-prod.fluidtopics.net/cwBhdHWeDnAJYBKlVVQh2w#event_management_topic-api "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.")Endpunkt. Zum Beispiel: { "name": "HighPriorityTroubleTicket", "headerQuery": "eventType=TroubleTicketStatusChangeEvent,TroubleTicketAttributeChangeEvent", "contentQuery": "troubleTicket.ticketType=incident&troubleTicket.severity=1", "externalId": "ext001", "namespace": "telecomEvents" } Das Schema dieses Objekts muss dem entsprechen, was in definiert ist <var class="keyword varname">CONSTANTS.SCHEMA.CREATE_TOPIC_SCHEMA </var>Befindet sich in sn_api_notif_mgmt.Constants Skripteinbindung. |
| details | Array | Warnmeldungen, die in zurückgegeben werden sollen [Ereignismanagement-Thema -- API öffnen](https://servicenow-prod.fluidtopics.net/cwBhdHWeDnAJYBKlVVQh2w#event_management_topic-api "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.")Endpunktantwort, wenn bei der Methode ein Problem auf der Ebene „Warnung" auftritt. Mit diesem Parameter können Sie Ihrer Implementierung dieses Endpunkts anwenderdefinierte Warnmeldungen hinzufügen. Wenn keine zusätzlichen Warnmeldungen vorhanden sind, müssen Sie ein leeres Array übergeben. |
[Tabelle : 13. Parameter]

{#TopAPIUtilOOB-valTopAtts_O_A__table_i1s_zqr_tzb} {#TopAPIUtilOOB-valTopAtts_O_A__table_j1s_zqr_tzb__entry__2}

| Typ | Beschreibung |
|-|-|
| Boolean | Kennzeichnung, die angibt, ob die Kombination aus Themenname, Header-Abfrage, Content-Abfrage und Namespace in übergeben wurde topicObjectParameter ist eindeutig. Gültige Werte: * Wahr: Parameterkombination ist eindeutig. * Falsch: Parameterkombination ist nicht eindeutig. |
[Tabelle : 14. Rückgaben]

{#TopAPIUtilOOB-valTopAtts_O_A__table_j1s_zqr_tzb}  
Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    isValidCreateTopicPayload: function(topicObject, schema, warnings) {
      var isValidPayload = true;
      var details = [];
      var validationResults = this.jsonSchemaValidation.validateJSON(topicObject, schema, ''); // Schema validation
      var errorObj = this.apiCoreUtil.getErrorObj(sn_tmt_core.Constants.ERROR_CODES.MISSING_BODY_FIELD, sn_tmt_core.Constants.MESSAGES.MISSING_BODY_FIELD, sn_tmt_core.Constants.MESSAGES.MISSING_BODY_FIELD);

      if (validationResults.length > 0) {
        if (validationResults[0].message == Constants.PAYLOAD_MISSING) {
          this._logger.logDebug("isValidCreateTopicPayload: Missing request body, invalid payload");
          errorObj = this.apiCoreUtil.getErrorObj(sn_tmt_core.Constants.ERROR_CODES.MISSING_BODY, sn_tmt_core.Constants.MESSAGES.MISSING_BODY, sn_tmt_core.Constants.MESSAGES.MISSING_BODY);
          details.push(this.apiCoreUtil.getErrorDetailsObj(sn_tmt_core.Constants.MESSAGES.MISSING_BODY, ''));
          errorObj.details = details;
          this.response.details = errorObj;
          return false;
        } else {
          for (var i = 0; i < validationResults.length; i++) {
            var missingFieldMsg = sn_tmt_core.Constants.MESSAGES.MISSING_FIELD_KEY;
            var message = validationResults[i].message;
            var errorMessage = '';
            if (message.indexOf('missing') != -1) {
              var newMessage = this.apiCoreUtil.constructErrorMsg(message, validationResults[i].dataPath);
              errorMessage = missingFieldMsg.replace(/\$key/g, newMessage);
            } else {
              errorMessage = message;
            }
            details.push(this.apiCoreUtil.getErrorDetailsObj(errorMessage, validationResults[i].dataPath));
          }
        }
        isValidPayload = false;
      }
      var isValidTopicExternalId = this.validateTopicExternalId(topicObject, details);
      var isValidTopicAttributes = this.validatateTopicAttributes(topicObject, details);

      isValidPayload = isValidPayload && isValidTopicExternalId && isValidTopicAttributes;
        if (!isValidPayload) {
          errorObj.details = details;
          this.response.details = errorObj;
        }
        return isValidPayload;
      },

## TopicAPIUtilsOOB -- validateTopicExternalId (ObjekttopicObject, Arraydetails) {#ariaid-title9}

Validiert die externe Thema-ID, die im Anforderungstext von übergeben wurde Ereignismanagement-Thema -- API öffnen Endpunkt.
In der Basisimplementierung validiert dies nur, dass die externe ID nicht leer ist. Wenn Sie den Validierungsprozess für die externe ID des Themas ändern möchten, müssen Sie diese Methode in überschreiben Themen-APIUtils Skripteinbindung. Die übergebene externe ID wird dem Feld „topic_ID" in der Tabelle „Thema" \[sn_api_notif_mgmt_topic\] zugeordnet.
{#TopAPIUtilOOB-valTopExtId_O_A__table_dyg_5mr_tzb__entry__3}{#TopAPIUtilOOB-valTopExtId_O_A__TopicAPIUtilsOOB-topicObject-entry}

| Name | Typ | Beschreibung |
|-|-|-|
| TopicObject | Objekt | Nutzlastobjekt des Themas an übergeben [Ereignismanagement-Thema -- API öffnen](https://servicenow-prod.fluidtopics.net/cwBhdHWeDnAJYBKlVVQh2w#event_management_topic-api "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.")Endpunkt. Zum Beispiel: { "name": "HighPriorityTroubleTicket", "headerQuery": "eventType=TroubleTicketStatusChangeEvent,TroubleTicketAttributeChangeEvent", "contentQuery": "troubleTicket.ticketType=incident&troubleTicket.severity=1", "externalId": "ext001", "namespace": "telecomEvents" } Das Schema dieses Objekts muss dem entsprechen, was in definiert ist <var class="keyword varname">CONSTANTS.SCHEMA.CREATE_TOPIC_SCHEMA </var>Befindet sich in sn_api_notif_mgmt.Constants Skripteinbindung. |
| details | Array | Fehler-/Detailmeldungen, die in zurückgegeben werden sollen [Ereignismanagement-Thema -- API öffnen](https://servicenow-prod.fluidtopics.net/cwBhdHWeDnAJYBKlVVQh2w#event_management_topic-api "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.")Endpunktantwort, wenn bei der Methode ein Problem auf der Ebene „Fehler" auftritt. Mit diesem Parameter können Sie Ihrer Implementierung dieses Endpunkts anwenderdefinierte Fehlermeldungen hinzufügen. Wenn keine zusätzlichen Fehlermeldungen vorhanden sind, müssen Sie ein leeres Array übergeben. |
[Tabelle : 15. Parameter]

{#TopAPIUtilOOB-valTopExtId_O_A__table_dyg_5mr_tzb} {#TopAPIUtilOOB-valTopExtId_O_A__table_eyg_5mr_tzb__entry__2}

| Typ | Beschreibung |
|-|-|
| Boolean | Kennzeichnung, die angibt, ob die externe ID in übergeben wurde topicObjectParameter ist gültig. Gültige Werte: * Wahr: Externe ID ist gültig. * Falsch: Externe ID ist ungültig. |
[Tabelle : 16. Rückgaben]

{#TopAPIUtilOOB-valTopExtId_O_A__table_eyg_5mr_tzb}  
Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    isValidCreateTopicPayload: function(topicObject, schema, warnings) {
      var isValidPayload = true;
      var details = [];
      var validationResults = this.jsonSchemaValidation.validateJSON(topicObject, schema, ''); // Schema validation
      var errorObj = this.apiCoreUtil.getErrorObj(sn_tmt_core.Constants.ERROR_CODES.MISSING_BODY_FIELD, sn_tmt_core.Constants.MESSAGES.MISSING_BODY_FIELD, sn_tmt_core.Constants.MESSAGES.MISSING_BODY_FIELD);

      if (validationResults.length > 0) {
        if (validationResults[0].message == Constants.PAYLOAD_MISSING) {
          this._logger.logDebug("isValidCreateTopicPayload: Missing request body, invalid payload");
          errorObj = this.apiCoreUtil.getErrorObj(sn_tmt_core.Constants.ERROR_CODES.MISSING_BODY, sn_tmt_core.Constants.MESSAGES.MISSING_BODY, sn_tmt_core.Constants.MESSAGES.MISSING_BODY);
          details.push(this.apiCoreUtil.getErrorDetailsObj(sn_tmt_core.Constants.MESSAGES.MISSING_BODY, ''));
          errorObj.details = details;
          this.response.details = errorObj;
          return false;
        } else {
          for (var i = 0; i < validationResults.length; i++) {
            var missingFieldMsg = sn_tmt_core.Constants.MESSAGES.MISSING_FIELD_KEY;
            var message = validationResults[i].message;
            var errorMessage = '';
            if (message.indexOf('missing') != -1) {
              var newMessage = this.apiCoreUtil.constructErrorMsg(message, validationResults[i].dataPath);
              errorMessage = missingFieldMsg.replace(/\$key/g, newMessage);
            } else {
              errorMessage = message;
            }
            details.push(this.apiCoreUtil.getErrorDetailsObj(errorMessage, validationResults[i].dataPath));
          }
        }
        isValidPayload = false;
      }
      var isValidTopicExternalId = this.validateTopicExternalId(topicObject, details);
      var isValidTopicAttributes = this.validatateTopicAttributes(topicObject, details);

      isValidPayload = isValidPayload && isValidTopicExternalId && isValidTopicAttributes;
        if (!isValidPayload) {
          errorObj.details = details;
          this.response.details = errorObj;
        }
        return isValidPayload;
      },


