Product Order Open API-Entwicklerleitfaden

Verwenden Sie die Product Order Open-API, um Produktbestellinformationen zu erstellen, zu aktualisieren und abzurufen.

Dieser Entwicklerleitfaden enthält Informationen zum Erweitern von Produktbestellung offene API, um verschiedene Anpassungen vorzunehmen.

Erweitern der API „Product Order Open“.

Die Product Order Open API kann durch Bearbeiten von Skripteinbindungen erweitert werden.

Diese Skripteinbindungen sollten nur bearbeitet werden, wenn die Konsequenzen der Änderungen bekannt sind.

• TMFProductOrderAPIUtil: Enthält Funktionen zur Verarbeitung von POST-Anforderungen.
• TMFProductOrderGetAPIUtil: Enthält Funktionen zur Verarbeitung von GET-Anforderungen.
• ProductOrderExtensionOOB: Enthält Hilfsfunktionen, die Funktionen in TMFProductOrderAPIUtil und TMFProductOrderGetAPIUtil unterstützen.
• ProductOrderProcessor: Eine leere Skripteinbindungsdatei. Verwenden Sie diese Datei, um alle Funktionen zu definieren, die Sie von ProductOrderExtensionOOBüberschreiben möchten.

Erweitern Sie die API „Product Order Open“, um die folgenden Anpassungen vorzunehmen.

Erforderliche Parameter

Um zu ändern, welche Anforderungstextparameter zum Erstellen einer Produktbestellung erforderlich sind oder nicht, überschreiben Sie die Funktion getProductOrderSchema(), die in der Skripteinbindung ProductOrderExtensionOOB enthalten ist.

Die Funktion getProductOrderSchema() liest das Schema aus der Skripteinbindung TMFOrderAPIConstants. TMFOrderAPIConstants ist geschützt und kann nicht bearbeitet werden, daher können Sie nicht nur das Schema aktualisieren. Stattdessen muss ein neues Schema aus einer anderen Datei gelesen werden. Sie können getProductOrderSchema() überschreiben, um ein neues Schema zu lesen. Um getProductOrderSchema()zu überschreiben, schreiben Sie eine Funktion mit demselben Namen in die Skripteinbindung ProductOrderProcessor. Die neue Funktion in ProductOrderProcessor wird von TMFProductOrderAPIUtil aufgerufen, um die Standardfunktion getProductOrderSchema() in ProductOrderExtensionOOBzu ersetzen.

In diesem Beispiel gibt getProductOrderSchema() ein benutzerdefiniertes Schema zurück, das in einer neuen Konstantendatei definiert ist.

// ProductOrderProcessor

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

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

   type: 'ProductOrderProcessor'
});

Validierung des Anforderungstexts

Um eine zusätzliche Validierung für den Anforderungstext durchzuführen, überschreiben Sie die ProductOrderExtensionOOB- Funktionen. ProductOrderExtensionOOB enthält die folgenden vier Hilfsfunktionen, die standardmäßig „ true “ zurückgeben.

• validePostRequest() – Wird von processCreateOrder() in TMFProductOrderAPIUtil aufgerufen.
• valideProductObj() – Wird von processCreateOrder() in TMFProductOrderAPIUtil aufgerufen.
• valideRelatedParteiObj() – Wird von processCreateOrder() in TMFProductOrderAPIUtil aufgerufen.
• valideGetRequest() – Wird von processGetOrder() in TMFProductOrderGetAPIUtil aufgerufen.

Wenn eine Hilfsfunktion falsezurückgibt, wird der API-Vorgang angehalten. Um eine benutzerdefinierte Validierung anzuwenden, überschreiben Sie die Hilfsfunktionen ProductOrderExtensionOOB, indem Sie Funktionen mit identischen Namen und Parametern in ProductOrderProcessor erstellen. Diese neuen ProductOrderProcessor- Funktionen werden von TMFProductOrderAPIUtil und TMFProductOrderGetAPIUtil aufgerufen, um die Standardhilfsfunktionen ProductOrderExtensionOOB zu ersetzen.

In diesem Beispiel überschreibt eine Funktion in ProductOrderProcessor eine Standardfunktion in ProductOrderExtensionOOB, um eine Validierung für das Attribut productOrderItem durchzuführen.

// ProductOrderProcessor

var ProductOrderProcessor = Class.create();
ProductOrderProcessor.prototype = Object.extendsObject(ProductOrderExtensionOOB, {
    // 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.productOrderItem)) {
            details.push(new TMFCommonOrderAPIUtil().getErrorDetailsObj(TMFOrderAPIConstants.MESSAGES.MISSING_ORDER_ITEM, '/'));
            return false;
        }
        return true;
    },

    type: 'ProductOrderProcessor'
});

Zusätzliche REST-Vorgänge

Um zusätzliche Vorgänge zu erstellen, die über die vorhandenen GET- und POST-Vorgänge hinausgehen, erstellen Sie zusätzliche geskriptete REST-Ressourcen für die Product Order Open API. Die Logik der neuen geskripteten REST-Ressourcen sollte mit den vorhandenen Vorgängen übereinstimmen. Definieren Sie Funktionen für die neuen Vorgänge in einer neuen Skripteinbindung.

Feldzuordnung

Beim Erstellen von Datensätzen ordnet die API Anforderungstextparameter Datensatzfeldern zu. Beim Abrufen von Datensätzen ordnet die API Datensatzfelder Antwortobjektattributen zu.

ProductOrderExtensionOOB enthält die folgenden Funktionen, um einen POST-Anforderungstext einem GlideRecord zuzuordnen.

• transformOrderGr()
• transformOrdLineItemGr()
• getLineItemPrice()
• transformPriceOrderTypeAndState()
• transformCustLineItmContact()
• transformOrderItemChar()

ProductOrderExtensionOOB enthält die folgenden Funktionen, um einen GlideRecord einem Antwortobjekt für GET- oder POST-Anforderungen zuzuordnen.

• transformPostOrderResponse()
• transformGetOrderResponse()
• transformProductObj ()
• transformRelatedParteiCustomerLineItem()
• transformOrderItemRelationship()
• transformGetOrdLineItmResponse()
• transformProductCharacteristics()
• transformProductSpecification()

Passen Sie die Feldzuordnungen an, um Daten für zusätzliche Felder hinzuzufügen und abzurufen oder um die Standardzuordnungen für Felder zu ändern. Um die Feldzuordnungen anzupassen, überschreiben Sie die Zuordnungsfunktionen ProductOrderExtensionOOB, indem Sie Funktionen mit identischen Namen und Parametern in ProductOrderProcessor erstellen. Diese neuen ProductOrderProcessor- Funktionen werden von TMFProductOrderAPIUtil und TMFProductOrderGetAPIUtil verwendet, um die standardmäßigen ProductOrderExtensionOOB -Zuordnungsfunktionen zu ersetzen.

In diesem Beispiel überschreiben zwei Funktionen in ProductOrderProcessor die Standardfunktionen in ProductOrderExtensionOOB, um Zuordnungen für die Felder external_id und sys_id zu erstellen.

// ProductOrderProcessor

var ProductOrderProcessor = Class.create();
ProductOrderProcessor.prototype = Object.extendsObject(ProductOrderExtensionOOB, {
    // 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: 'ProductOrderProcessor'
});