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


---

# Serviceauftrag -- API-Entwicklerleitfaden öffnen

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

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

Verwenden Sie Serviceauftrag -- API öffnen Dient zum Erstellen, Aktualisieren und Abrufen von Serviceauftragsinformationen.

Dieser Entwicklerleitfaden enthält Informationen zur Erweiterung von [Serviceauftrag -- API öffnen](https://servicenow-prod.fluidtopics.net/ofcZoDnxDS_Tci71jf1h7g#service-order-open-api "Die Serviceauftrag Offen Die API stellt einen Endpunkt bereit, der einen standardisierten Mechanismus für die Vergabe von Serviceaufträgen ermöglicht.")Um verschiedene Anpassungen vorzunehmen.

## Erweiterung der offenen API für Serviceaufträge {#ariaid-title2}

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

* TMFServiceOrderAPIUtil : Enthält Funktionen zur Verarbeitung von POST-Anforderungen.
* TMFServiceOrderGetAPIUtil : Enthält Funktionen zur Verarbeitung von GET-Anforderungen.
* ServiceauftragserweiterungOOB : Enthält Hilfsfunktionen, die Funktionen in unterstützen TMFServiceOrderAPIUtil Und TMFServiceOrderGetAPIUtil .
* Serviceauftragsprozessor : Eine leere Skripteinbindungsdatei. Verwenden Sie diese Datei, um alle Funktionen zu definieren, aus denen Sie überschreiben möchten ServiceauftragserweiterungOOB .
{#extend-service-order-api__ul_d5h_lhr_wpb}

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

### Erforderliche Parameter {#extend-service-order-api__section_nmk_lbt_prb}

Um zu ändern, welche Anforderungstext-Parameter zum Erstellen eines Serviceauftrags erforderlich sind oder nicht erforderlich sind, überschreiben Sie die Funktion `GetServiceOrderSchema() `Enthalten in ServiceauftragserweiterungOOB Skripteinbindung.

Die Funktion `GetServiceOrderSchema() `Liest das Schema aus TMFOrderAPIKonstanten Skripteinbindung. TMFOrderAPIKonstanten Ist geschützt und kann nicht bearbeitet werden, daher können Sie das Schema nicht einfach aktualisieren. Stattdessen muss ein neues Schema aus einer anderen Datei gelesen werden. Sie können überschreiben `GetServiceOrderSchema() `Zum Lesen eines neuen Schemas. Zum Überschreiben `GetServiceOrderSchema() `, Schreiben Sie eine Funktion mit demselben Namen in Serviceauftragsprozessor Skripteinbindung. Die neue Funktion in Serviceauftragsprozessor Wird von aufgerufen TMFServiceOrderAPIUtil Um den Standard zu ersetzen `GetServiceOrderSchema() `Funktion in ServiceauftragserweiterungOOB .  
In diesem Beispiel `GetServiceOrderSchema() `Gibt ein anwenderdefiniertes Schema zurück, das in einer neuen Konstantendatei definiert ist.

    // ServiceOrderProcessor

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

       getServiceOrderSchema: function() {
          //Define your own custom schema in a new constant file
          return JSON.parse(Constants.SCHEMA.CREATE_SERVICE_ORDER);
       },

       type: 'ServiceOrderProcessor'
    });

### Validierung des Anforderungstexts {#extend-service-order-api__section_m3r_1hs_nrb}

Überschreiben Sie, um eine zusätzliche Validierung für den Anforderungstext durchzuführen ServiceauftragserweiterungOOB Funktionen. ServiceauftragserweiterungOOB Enthält die folgenden vier Hilfsfunktionen, die zurückgeben `Wahr `Standardmäßig.

* `ValidatePostRequest() `-- Angerufen von `ProcessPostOrder() `In TMFServiceOrderAPIUtil .
* `ValidierenServiceObj() `-- Angerufen von `ProcessPostOrder() `In TMFServiceOrderAPIUtil .
* `ValidateRelatedPartyObj() `-- Angerufen von `ProcessPostOrder() `In TMFServiceOrderAPIUtil .
* `ValidateGetRequest() `-- Angerufen von `ProcessGetOrder() `In TMFServiceOrderGetAPIUtil .

{#extend-service-order-api__ul_khg_llx_wpb}Wenn eine Hilfsfunktion zurückgegeben wird `Falsch `, Stoppt den API-Vorgang. Überschreiben Sie, um eine anwenderdefinierte Validierung anzuwenden ServiceauftragserweiterungOOB Hilfsfunktionen durch Erstellen von Funktionen mit identischen Namen und Parametern in Serviceauftragsprozessor . Diese neu Serviceauftragsprozessor Funktionen werden von aufgerufen TMFServiceOrderAPIUtil Und TMFServiceOrderGetAPIUtil Um den Standard zu ersetzen ServiceauftragserweiterungOOB Hilfsfunktionen.  
In diesem Beispiel eine Funktion in Serviceauftragsprozessor Überschreibt eine Standardfunktion in ServiceauftragserweiterungOOB Dient zum Durchführen der Validierung für serviceOrderItemAttribut.

    // ServiceOrderProcessor

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

        validatePostRequest: function(orderObject, details) {
            // Returning false terminates the POST request
            // Make sure to push error message in details array in case of error
            if (gs.nil(orderObject.serviceOrderItem)) {
                details.push(new TMFCommonOrderAPIUtil().getErrorDetailsObj(TMFOrderAPIConstants.MESSAGES.MISSING_ORDER_ITEM, '/'));
                return false;
            }
            return true;
        },

        type: 'ServiceOrderProcessor'
    });

### Zusätzliche REST-Vorgänge {#extend-service-order-api__section_sy1_2hs_nrb}

Um zusätzliche Vorgänge zu erstellen, die über die vorhandenen GET- 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 Serviceauftrag -- API ö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 einer neuen Skripteinbindung.

### Feldzuordnung {#extend-service-order-api__section_ywk_rhs_nrb}

Beim Erstellen von Datensätzen ordnet die API Anforderungstext-Parameter Datensatzfeldern zu. Beim Abrufen von Datensätzen ordnet die API Datensatzfelder Antwortobjektattributen zu.  
ServiceauftragserweiterungOOB Enthält die folgenden Funktionen zum Zuordnen eines POST-Anforderungstexts zu einem GlideRecord.

* `TransformOrderGr()`
* `TransformOrdnerLineItemGr()`
* `TransformCustLineItmContact()`
* `TransformOrderItemChar()`
{#extend-service-order-api__ul_krb_r4x_wpb}  
ServiceauftragserweiterungOOB Enthält die folgenden Funktionen zum Zuordnen eines GlideRecord zu einem Antwortobjekt für GET- oder POST-Anforderungen.

* `TransformPostOrderResponse()`
* `TransformGetOrderResponse()`
* `TransformServiceObj()`
* `TransformRelatedPartyCustomerLineItem()`
* `TransformOrderItemRelationship()`
* `TransformGetOrdLineItmResponse()`
* `TransformServicemerkmale ()`
* `TransformationsServiceSpezifikation ()`
{#extend-service-order-api__ul_qqk_zfz_wpb}

Passen Sie Feldzuordnungen an, um Daten für zusätzliche Felder hinzuzufügen und abzurufen oder die Standardzuordnungen für Felder zu ändern. Überschreiben Sie, um die Feldzuordnungen anzupassen ServiceauftragserweiterungOOB Ordnen Sie Funktionen zu, indem Sie Funktionen mit identischen Namen und Parametern in erstellen Serviceauftragsprozessor . Diese neu Serviceauftragsprozessor Funktionen werden von verwendet TMFServiceOrderAPIUtil Und TMFServiceOrderGetAPIUtil Um den Standard zu ersetzen ServiceauftragserweiterungOOB Zuordnungsfunktionen.  
In diesem Beispiel zwei Funktionen in Serviceauftragsprozessor Überschreiben Sie die Standardfunktionen in ServiceauftragserweiterungOOB Um Zuordnungen für zu erstellen external_idUnd sys_idFelder.

    // ServiceOrderProcessor

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

        transformOrderGr: function(requestObject, orderGr) {
            orderGr.external_id = requestObject.externalId;
            return orderGr;
        },

        transformPostOrderResponse: function(orderObject, orderGr) {
            orderObject.id = orderGr.getValue('sys_id');
            return orderObject;
        },

        type: 'ServiceOrderProcessor'
    });


