---
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


---

# Problemticket -- API-Entwicklerleitfaden öffnen

# Problemticket -- API-Entwicklerleitfaden öffnen {#ariaid-title1}

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

Verwenden Sie Problemticket -- API öffnen Dient zum Verwalten von Ticketinformationen zwischen externen Ticketsystemen und der Now Platform. Diese API erstellt, aktualisiert und ruft Daten aus den Tabellen „Fall" \[sn_customerservice_Case\] und „Incident" \[Incident\] ab.

Dieser Entwicklerleitfaden enthält Informationen zur Erweiterung von [Problemticket -- API öffnen](https://servicenow-prod.fluidtopics.net/9K9kxelhRxZjI6zhti8G_A#trouble-ticket-open-api "Die Problemticket Offen Die API stellt Endpunkte zum Erstellen, Aktualisieren und Abrufen von Daten aus den Tabellen „Fall“ [sn_customerservice_Case] und „Incident“ [Incident] bereit.")Um verschiedene Anpassungen vorzunehmen.

## Erweitern der API „Trouble Ticket öffnen" {#ariaid-title2}

Die Problemticket -- API öffnen Kann durch Bearbeitung von Skripteinbindungen erweitert werden.  
Diese Skripteinbindungen sollten nur bearbeitet werden, wenn die Konsequenzen der Änderungen verstanden werden.

* `TMFTroubleTicketAPIKonstanten `: Enthält Konstanten und erforderliche Parameterinformationen.
* `TMFTroubleTicketAPIUtil `: Enthält Funktionen zur Verarbeitung von POST-, GET- und PATCH-Anforderungen.
* `ProblemTicketProcessorOOB `: Enthält Hilfsfunktionen, die Funktionen in TMFTroubleTicketAPIUtil unterstützen.
* `ProblemticketProcessor `: Eine leere Skripteinbindungsdatei. Verwenden Sie diese Datei, um alle Funktionen zu definieren, die Sie über „TroubleTicketProcessorOOB" überschreiben möchten.
{#extend-trouble-ticket-api__ul_d5h_lhr_wpb}

Erweitern Sie Problemticket -- API öffnen Um die folgenden Anpassungen vorzunehmen.

### Erforderliche Parameter {#extend-trouble-ticket-api__section_kcp_rw2_2rb}

Um zu ändern, welche Anforderungstext-Parameter erforderlich oder nicht erforderlich sind, aktualisieren Sie die Skripteinbindung „TMFTroubleTicketAPIConstants". Standardmäßig erfordert der Anforderungstext zum Erstellen eines Tickets (POST) die Parameter description, severity, Und ticketType. Standardmäßig weist der Anforderungstext zum Aktualisieren eines Tickets (PATCH) keine erforderlichen Parameter auf.

* `TMFTroubleTicketAPIConstants.TROUBLE_TICKET_CREATION_SCHEMA `: Legt die erforderlichen Anforderungstext-Parameter fest, um ein Ticket zu erstellen.
* `TMFTroubleTicketAPIConstants.TROUBLE_TICKET_UPDATE_SCHEMA `: Legt die erforderlichen Anforderungstext-Parameter fest, um ein Ticket zu aktualisieren.
{#extend-trouble-ticket-api__ul_nsx_yps_wpb}  
In diesem Beispiel ist description, severity, status, Und ticketTypeParameter sind zum Erstellen eines Tickets erforderlich.

    // TMFTroubleTicketAPIConstants
    TMFTroubleTicketAPIConstants.TROUBLE_TICKET_CREATION_SCHEMA = {
        "title": "CreateTroubleTicket",
        "type": "object",
        "properties": {
            "description": {
                "type": "string"
            },
            "severity": {
                "type": "string"
            },
            "status": {
                "type": "string"
            },
            "ticketType": {
                "type": "string"
            }
        },
        "required": [
            "description",
            "severity",
            "status",
            "ticketType"
        ]
    };

### Validierung des Anforderungstexts {#extend-trouble-ticket-api__section_byb_ww2_2rb}

Um eine zusätzliche Validierung für den Anforderungstext durchzuführen, überschreiben Sie die Funktionen „TroubleTicketProcessorOB". TroubleTicketProcessorOB enthält die folgenden sechs Hilfsfunktionen, die zurückgeben `Wahr `Standardmäßig. Diese Funktionen werden in TMFTroubleTicketAPIUtil aufgerufen.

* `VerifyGetRequestForCase() `-- Angerufen von `ProcessGetRequestForCase() `.
* `VerifyPatchRequestForCase() `-- Angerufen von `ProcessPatchRequestForCase() `.
* `VerifyPostRequestForCase() `-- Angerufen von `ProcessPostRequestForCase() `.
* `VerifyGetRequestForIncident() `-- Angerufen von `ProcessGetRequestForIncident() `.
* `VerifyPatchRequestForIncident() `-- Angerufen von `ProcessPatchRequestForIncident() `.
* `VerifyPostRequestForIncident() `-- Angerufen von `ProcessPostRequestForIncident() `.

{#extend-trouble-ticket-api__ul_khg_llx_wpb}Wenn eine Hilfsfunktion zurückgegeben wird `Falsch `, Stoppt den API-Vorgang. Um eine anwenderdefinierte Validierung anzuwenden, überschreiben Sie die Hilfsfunktionen „TroubleTicketProcessorOOB", indem Sie Funktionen mit identischen Namen und Parametern in „TroubleTicketProcessor" erstellen. Diese neuen TroubleTicketProcessor-Funktionen werden von TMFTroubleTicketAPIUtil aufgerufen, um die standardmäßigen TroubleTicketProcessorOOB-Hilfsfunktionen zu ersetzen.  
In diesem Beispiel überschreibt eine Funktion in TroubleTicketProcessor eine Standardfunktion in TroubleTicketProcessorOOB, um eine Validierung des Namensattributs durchzuführen.

    // TroubleTicketProcessor
    var TroubleTicketProcessor = Class.create();
    TroubleTicketProcessor.prototype = Object.extendsObject(TroubleTicketProcessorOOB, {
        // Define overriding functions here
        // Function name and parameters must be identical to the function it overrides

        verifyPostRequestForCase: function(caseObject, apiResponseProcessor){
            // Returning false terminates the POST request
            // Make sure to assign error message and reason
            if (caseObject.name != "Hello world") {
                apiResponseProcessor.setMessage(TMFTroubleTicketAPIConstants.MESSAGES.CASE_CREATION_FAILURE);
                apiResponseProcessor.setReason("No reason needed");
                return false;
            }
        },

        type: 'TroubleTicketProcessor'
    });

### Zusätzliche REST-Vorgänge {#extend-trouble-ticket-api__section_x2z_zw2_2rb}

Um zusätzliche Vorgänge zu erstellen, die über die vorhandenen GET-, PATCH- und POST-Vorgänge hinausgehen, [Erstellen Sie zusätzliche geskriptete REST-Ressourcen](https://servicenow-prod.fluidtopics.net/J9poRY8S~x2OKdHpaThv6Q "Erstellen Sie eine geskriptete REST-API-Ressource, um die HTTP-Methode und das Verarbeitungsskript zu definieren und Einstellungen aus dem übergeordneten Service zu überschreiben.")Für die API „Trouble Ticket öffnen". Die Logik der neuen geskripteten REST-Ressourcen muss mit den vorhandenen Vorgängen übereinstimmen. Definieren Sie Funktionen für die neuen Vorgänge in TMFTroubleTicketAPIUtil.

### Feldzuordnung {#extend-trouble-ticket-api__section_oxc_cx2_2rb}

Beim Erstellen oder Aktualisieren von Datensätzen ordnet die API Anforderungstext-Parameter Fall- und Incident-Datensatzfeldern zu. Beim Abrufen von Datensätzen ordnet die API Datensatzfelder Antwortobjektattributen zu.  
TroubleTicketProcessorOOB enthält die folgenden Funktionen zum Zuordnen eines PATCH- oder POST-Anforderungstexts zu einem Fall oder Incident-GlideRecord.

* `MapPatchRequestToCase()`
* `MapPostRequestToCase()`
* `ZuordnungsPatchRequestToIncident()`
* `ZuordnungspostRequestToIncident()`
{#extend-trouble-ticket-api__ul_krb_r4x_wpb}  
TroubleTicketProcessorOOB enthält die folgenden Funktionen zum Zuordnen eines Falls oder Incident-GlideRecord zu einem JSON-Antwortobjekt für GET-, PATCH- oder POST-Anforderungen.

* `CreateGetResponseForCase()`
* `CreatePatchResponseForCase()`
* `CreatePostResponseForCase()`
* `CreateGetResponseForIncident()`
* `CreatePatchResponseForIncident()`
* `CreatePostResponseForIncident()`
{#extend-trouble-ticket-api__ul_qqk_zfz_wpb}

Passen Sie Feldzuordnungen an, um Daten für zusätzliche Fall- und Incident-Felder hinzuzufügen und abzurufen oder die Standardzuordnungen für Felder zu ändern. Um die Feldzuordnungen anzupassen, überschreiben Sie die Zuordnungsfunktionen „TroubleTicketProcessor OOB", indem Sie Funktionen mit identischen Namen und Parametern in „TroubleTicketProcessor" erstellen. Diese neuen TroubleTicketProcessor-Funktionen werden von TMFTroubleTicketAPIUtil verwendet, um die standardmäßigen TroubleTicketProcessorOOB-Zuordnungsfunktionen zu ersetzen.  
In diesem Beispiel überschreiben zwei Funktionen in TroubleTicketProcessor die Standardfunktionen in TroubleTicketProcessorOOB, um die Zuordnung des Beschreibungsfelds zu ändern und eine Zuordnung für das Feld „Vertrag" hinzuzufügen.

    // TroubleTicketProcessor
    var TroubleTicketProcessor = Class.create();
    TroubleTicketProcessor.prototype = Object.extendsObject(TroubleTicketProcessorOOB, {
        // Define overriding functions here
        // Function name and parameters must be identical to the function it overrides

        mapPostRequestToCase: function(caseGr, caseObject){
            // Override default mapping for the Description field
            caseGr.description = "All cases will be created with this description";
            // Add new mapping to the Contract field
            caseGr.contract = caseObject.contract;
         },

        createPostResponseForCase: function(caseGr, caseObject){
            // Override default mapping for the description attribute
            caseObject.description = "This will always be the retrieved description";
            // Add new contract attribute to the response object
            caseObject.contract = caseGr.contract;    
        },

        type: 'TroubleTicketProcessor'
    });

### Zuordnungslogik für Auswahlfelder {#extend-trouble-ticket-api__section_kdd_gx2_2rb}

Die Status , Priorität , Und Contact_type Felder sind Auswahlfelder, bei denen jede Auswahl aus einer Bezeichnung und einem entsprechenden Wert besteht. Beispiel: Wenn Status Feld ist auf festgelegt Neu , Die Bezeichnung ist Neu Und der Wert ist 1 . Die Zuordnung zwischen Auswahlbezeichnungen und -Werten kann geändert werden, indem die Auswahlfeldzuordnungsfunktionen überschrieben werden.  
TroubleTicketProcessorOB enthält die folgenden Auswahlfeldzuordnungsfunktionen.

* `TransformFallschweregrad()`
* `TransformCaseChannel()`
* `TransformFallstatus()`
* `TransformIncidentSchweregrad ToUrgency()`
* `TransformIncidentSchweregrad ToImpact()`
* `TransformIncidentChannel()`
* `TransformIncidentStatus()`
{#extend-trouble-ticket-api__ul_jzp_kfz_wpb}Überschreiben Sie die Zuordnungsfunktionen des ProblemTicketProcessorOOB-Auswahlfelds, indem Sie Funktionen mit identischen Namen und Parametern in TroubleTicketProcessor erstellen. Diese neuen TroubleTicketProcessor-Funktionen werden von TMFTroubleTicketAPIUtil verwendet, um die standardmäßigen Zuordnungsfunktionen für TroubleTicketProcessorOOB-Auswahlfeld zu ersetzen.  
In diesem Beispiel überschreibt eine Funktion in TroubleTicketProcessor eine Standardfunktion in TroubleTicketProcessorOOB, um die Auswahlzuordnung für zu ändern Status Feld.

    // TroubleTicketProcessor
    var TroubleTicketProcessor = Class.create();
    TroubleTicketProcessor.prototype = Object.extendsObject(TroubleTicketProcessorOOB, {
        // Define overriding functions here
        // Function name and parameters must be identical to the function it overrides

        transformCaseStatus: function(status){
            if (status == "Draft")
                return 1;
            else return 10;
        },

        type: 'TroubleTicketProcessor'
    });


