sn_erp_Integration API – Umfang, Global

  • Freigeben Version: Australia
  • Aktualisiert 12. März 2026
  • 13 Minuten Lesedauer
  • Skripteinbindung, die eine verkettbare API für die Interaktion mit bereitstellt Zero-Copy-Connector für ERP(Enterprise Resource Planning)-Modelle.

    Diese Skripteinbindung erfordert Zero-Copy-Connector für ERP(Com.sn_erp_Integration) Store-Anwendung und wird im Namespace „sn_erp_Integration“ bereitgestellt. Weitere Informationen finden Sie unter Zero Copy Connector for ERP.

    Erforderliche Rolle: sn_erp_integration.erp_user

    Metadaten
    Verwenden Sie Metadatenmethoden, um die System-, Modell- und IDoc-Informationen zu erkennen, die in verfügbar sind Zero-Copy-Connector für ERP Umgebung.
    • GetAvailableSystems()
    • GetAvailableModels()
    • GetAvailableOperations()
    • GetAvailableInputs()
    • GetRequiredInputs()
    • GetAvailable-Ausgaben()
    • GetAvailableIdocConfigs()
    Konfiguration
    Verwenden Sie Konfigurationsmethoden, um verfügbare Systeme, Modelle, Vorgänge und IDoc-Konfigurationen für die Verarbeitung auszuwählen. Sie können diese Methoden auch verwenden, um Modellfeld-Rückgabewerte zu filtern.
    • System()
    • Modell ()
    • Vorgang ()
    • IdocConfig()
    • Felder ()
    • Grenzwert ()
    • Offset()
    Abfrageerstellung
    Verwenden Sie Abfrageerstellungsmethoden, um Ergebnisse zu filtern.
    • AddEncodedQuery()
    • AddQuery()
    • AddOrQuery()
    Dateneingabe
    Verwenden Sie die Dateneingabemethoden, um Feldwerte festzulegen. Die WithJSON() Die Methode kann für Eingaben für geschachtelte Objekte und IDoc-Felder verwendet werden. Die Satz() Die Methode wird verwendet, um einen einzelnen Feldwert festzulegen.
    • Satz()
    • WithJSON()
    Vorgangsausführung
    Verwenden Sie Ausführen () Methode bei der Arbeit mit mehreren Datensätzen, und Get() Methode für Ergebnisse eines einzelnen Datensatzes.
    • Ausführen ()
    • Get()

    API: API-Konstruktor

    Initialisiert einen neuen Zero-Copy-Connector für ERP API-Instanz.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Keine

    Die folgenden Beispiele zeigen, wie Sie eine Instanz der API für den Zugriff auf ein ERP-System erstellen.

    // Select the system1 system
    const api = new sn_erp_integration.API().system('system1');

    API – addEncodedQuery(Zeichenfolge encodedQuery)

    Filtert Datensätze mithilfe einer codierten Abfrage.

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    encodedQuery Zeichenfolge Ein Codierte Abfragezeichenfolge .
    Tabelle : 3. Rückgaben
    Typ Beschreibung
    Objekt Gibt diese Instanz für die Verkettung zurück.

    Das folgende Beispiel zeigt, wie eine codierte Abfrage zum Abrufen von Unternehmenscodes in den USA verwendet wird.

    const api = new sn_erp_integration.API()
      .system('system1')
      .model('company_code')
      .operation('read')
      .addEncodedQuery('company_codes_countryregion_key=US')
      .execute();

    API – addOrQuery (Zeichenfolgenfeld, Zeichenfolgenoperator, Zeichenfolgenwert)

    Fügen Sie eine ODER-Abfragebedingung hinzu.

    Tabelle : 4. Parameter
    Name Typ Beschreibung
    Ausstehend Zeichenfolge Der Name des abzufragenden Felds.
    operator Zeichenfolge Optional. Abfrageoperator. Die verwendete Abfrageoption hängt davon ab, ob Daten für bereitgestellt wurden Wert Parameter ist eine Zahl oder Zeichenfolge.

    Standardwert: =

    Nummern:
    • =
    • !=
    • >
    • >=
    • <
    • <=
    Zeichenfolgen (muss in Großbuchstaben angegeben werden):
    • =
    • !=
    • IN
    • NICHT IN
    • BEGINNT MIT
    • ENDSWITH
    • ENTHÄLT
    • ENTHÄLT NICHT
    Hinweis:
    Verwenden Sie „ENTHÄLT“ anstelle des „GEFÄLLT MIR“-Operators.
    Wert Zeichenfolge Wert, für den abgefragt werden soll (Groß-/Kleinschreibung wird nicht beachtet).
    Tabelle : 5. Rückgaben
    Typ Beschreibung
    Objekt Gibt diese Instanz für die Verkettung zurück.

    Das folgende Beispiel zeigt, wie alle Unternehmenscodes in den USA und Kanada zurückgegeben werden.

    const api = new sn_erp_integration.API();
    const companyCodes = api
      .system('system1')
      .model('company_code')
      .operation('read')
      .addQuery('company_codes_countryregion_key', 'US')
      .addOrQuery('company_codes_countryregion_key', 'CA')
      .fields(['company_codes_company_code', 'company_codes_company_name', 'company_codes_countryregion_key', 'company_codes_currency'])
      .execute();
    
    // Process the results
    companyCodes.forEach(companyCode => {
      gs.info('Company Code: ${companyCode.company_codes_company_code}, Name: ${companyCode.company_codes_company_name}, Country: ${companyCode.company_codes_countryregion_key}');
      
      // Do something with each company code
      if (companyCode.company_codes_countryregion_key === 'US') {
        // Process US company codes
      } else {
        // Process Canadian company codes
      }
    });

    API – addQuery (Zeichenfolgenfeld, Zeichenfolgenoperator, Zeichenfolgenwert, Zeichenfolgenverknüpfungstyp)

    Fügen Sie eine Abfragebedingung zum Filtern von Daten hinzu.

    Tabelle : 6. Parameter
    Name Typ Beschreibung
    Ausstehend Zeichenfolge Der Name des abzufragenden Felds.
    operator Zeichenfolge Optional. Abfrageoperator. Die verwendete Abfrageoption hängt davon ab, ob Daten für bereitgestellt wurden Wert Parameter ist eine Zahl oder Zeichenfolge.

    Standardwert: =

    Nummern:
    • =
    • !=
    • >
    • >=
    • <
    • <=
    Zeichenfolgen (muss in Großbuchstaben angegeben werden):
    • =
    • !=
    • IN
    • NICHT IN
    • BEGINNT MIT
    • ENDSWITH
    • ENTHÄLT
    • ENTHÄLT NICHT
    Hinweis:
    Verwenden Sie „ENTHÄLT“ anstelle des „GEFÄLLT MIR“-Operators.
    Wert Zeichenfolge Wert, für den abgefragt werden soll (Groß-/Kleinschreibung wird nicht beachtet).
    JoinType Zeichenfolge Optional. Join-Typ.
    Mögliche Werte:
    • UND
    • ODER
    Standardwert: UND
    Tabelle : 7. Rückgaben
    Typ Beschreibung
    Objekt Gibt diese Instanz für die Verkettung zurück.

    Das folgende Beispiel zeigt, wie Sie den Operator > verwenden, um Ergebnisse zurückzugeben, die Priorität 1 oder eine Priorität größer als 2 haben.

    // Results in: priority=1^ORpriority>2
    const api = new sn_erp_integration.API();
      .system('system1')
      .model('request')
      .operation('read')
      .addQuery('priority', '1)
      .addOrQuery('priority', '>', '2')
      .execute();

    API – execute()

    Führt den konfigurierten Vorgang aus.

    Um einen Vorgang für ein einzelnes Ergebnis auszuführen, verwenden Sie API – get().

    Tabelle : 8. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 9. Rückgaben
    Typ Beschreibung
    Objekt|Array Das Ergebnis des Vorgangs. Fehler, wenn nicht erfolgreich.

    Das folgende Beispiel zeigt, wie ein neuer Unternehmenscode erstellt wird.

    const newCompanyCode = new sn_erp_integration.API()
      .system('system1')
      .model('company_code')
      .operation('create')
      .withJSON({
        company_codes_company_code: '1234',
        company_codes_company_name: 'New York Office',
        company_codes_countryregion_key: 'US',
        company_codes_language_key: 'EN'
      })
      .execute();

    API – Felder (Array-Felder)

    Gibt die zurückzugebenden Modellfelder an. Dies ist die primäre Methode für die Feldauswahl.

    Um eine Liste der für ein Modell verfügbaren Felder abzurufen, verwenden Sie API – getAvailableOutputs().

    Tabelle : 10. Parameter
    Name Typ Beschreibung
    Felder Array Mindestens ein Modellfeldname ist als Zeichenfolgen aufgeführt.
    Tabelle : 11. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie bestimmte Felder für alle Unternehmenscodes in den USA zurückgegeben werden.

    const companyCodes = new API()
      .system('system1')
      .model('company_code')
      .operation('read')
      .addQuery('company_codes_countryregion_key', 'US')
      .fields(['company_codes_company_code', 'company_codes_company_name', 'company_codes_countryregion_key'])
      .execute();

    API – get()

    Alias für die Execute()-Methode zum Abrufen eines einzelnen Datensatzes in den Ergebnissen.

    Siehe auch API – execute().

    Tabelle : 12. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 13. Rückgaben
    Typ Beschreibung
    Objekt Das erste Ergebnis des Vorgangs.

    Das folgende Beispiel zeigt, wie ein bestimmtes Vertriebsdokument abgerufen wird.

    const salesDoc = new sn_erp_integration.API()
      .system('system1')
      .model('sales_document')
      .operation('read')
      .addQuery('document_number', '0000123456')
      .get();

    API – getAvailableIdocConfigs()

    Ruft die verfügbaren IDoc-Konfigurationsdetails für das ausgewählte System ab.

    Tabelle : 14. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 15. Rückgaben
    Typ Beschreibung
    Array von Objekten Liste der verfügbaren IDoc-Konfigurationen. Löst einen Fehler aus, wenn kein System ausgewählt wurde.

    Siehe auch API – System (Zeichenfolge systemId).

    Objekt.ID IDOC-ID. Verwenden Sie diesen Wert, um ein IDoc mit auszuwählen API – idocConfig (Zeichenfolge configId) Methode.

    Datentyp: Zeichenfolge

    object.name IDOC-Anzeigename.

    Datentyp: Zeichenfolge

    object.description Beschreibung des IDoc.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie alle verfügbaren IDoc-Konfigurationen für ein ausgewähltes System abgerufen werden.

    const idocConfigs = new sn_erp_integration.API()
      .system('system1')
      .getAvailableIdocConfigs();
    
    gs.info(JSON.stringify(idocConfigs, null, 2));

    Ausgabe:

    [
      {
        "id": "OBC0001002",
        "name": "Sales Order IDoc",
        "description": "IDoc for sales order processing"
      },
      {
        "id": "OBC0001003",
        "name": "Material IDoc",
        "description": "IDoc for material core data"
      }
    ]

    API – getAvailableInputs()

    Gibt eine Liste aller verfügbaren Eingabefelder für den ausgewählten Vorgang zurück.

    Verwenden Sie für eine Liste nur der erforderlichen Eingabefelder für ein ausgewähltes Modell API – getRequiredInputs() Methode.

    Tabelle : 16. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 17. Rückgaben
    Typ Beschreibung
    Objekt Objekt, das verfügbare Eingaben und ihre Typen beschreibt.

    Siehe auch API – System (Zeichenfolge systemId).

    Object.variable_Name Variablenname des Eingabefelds.

    Datentyp: Zeichenfolge

    Object.label Anzeigename des Eingabefelds.

    Datentyp: Zeichenfolge

    Object.Data_type Datentyp der Vorgangseingabe.

    Datentyp: Zeichenfolge

    Objekt.erforderlich Kennzeichnung, die angibt, ob das Eingabefeld erforderlich ist.
    Gültige Werte:
    • Wahr: Das Eingabefeld ist erforderlich.
    • Falsch: Das Eingabefeld ist nicht erforderlich.

    Datentyp: Boolesch

    Rufen Sie verfügbare Eingaben zum Erstellen eines Unternehmenscodes ab.

    const inputs = new sn_erp_integration.API()
      .system('system1')
      .model('company_code')
      .operation('read')
      .getAvailableInputs();
    
    gs.info(JSON.stringify(operations, null, 2));

    Ausgabe:

    [
      {
        "variable_name": "company_codes_company_code",
        "label": "Company Code",
        "data_type": "string",
        "required": true
      },
      {
        "variable_name": "company_codes_company_name",
        "label": "Company Name",
        "data_type": "string",
        "required": true
      }
    ]

    API – getAvailableModels()

    Gibt eine Liste der verfügbaren Modelle für das ausgewählte System zurück.

    Tabelle : 18. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 19. Rückgaben
    Typ Beschreibung
    Array von Objekten Liste der verfügbaren Modelle, die als JSON-Objekt mit einer ID, einem Namen und einer Beschreibungseigenschaft aufgeführt sind. Löst einen Fehler aus, wenn kein System ausgewählt wurde.

    Siehe auch API – System (Zeichenfolge systemId).

    Objekt.ID Modell-ID. Verwenden Sie diesen Wert, um ein Modell mit auszuwählen API – Modell (Zeichenfolgenmodell-ID) Methode.

    Datentyp: Zeichenfolge

    object.name Modellbezeichnung, d. h. der Anzeigename.

    Datentyp: Zeichenfolge

    object.description Beschreibung des Modells.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie alle verfügbaren Modelle für ein ausgewähltes System abgerufen werden.

    // Get all available models for system1
    const models = new sn_erp_integration.API()
      .system('system1')
      .getAvailableModels();
    
    gs.info(JSON.stringify(models, null, 2));

    Ausgabe:

    [
      {
        "id": "company_code",
        "name": "Company Code",
        "description": "Company Code"
      },
      {
        "id": "country",
        "name": "Country",
        "description": "Country"
      },
      {
        "id": "currency",
        "name": "Currency",
        "description": "Currency"
      },
      {
        "id": "customer_invoice",
        "name": "Customer Invoice",
        "description": "Customer Invoice"
      },
      {
        "id": "language",
        "name": "Language",
        "description": "Language"
      }
    ]

    API – getAvailableOperations()

    Ruft die verfügbaren Vorgänge für das ausgewählte Modell ab.

    Tabelle : 20. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 21. Rückgaben
    Typ Beschreibung
    Array Liste der verfügbaren ERP-Modellvorgänge. Löst einen Fehler aus, wenn kein Modell oder System ausgewählt wurde.
    Objekt.ID Modellvorgang-ID. Verwenden Sie diesen Wert, um einen Modellvorgang mit auszuwählen API – Vorgang (Zeichenfolge operationId) Methode.

    Datentyp: Zeichenfolge

    object.name Bezeichnung des Modellvorgangs, d. h. der Anzeigename.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie alle verfügbaren Vorgänge für abgerufen werden company_codeModell.

    const operations = new sn_erp_integration.API()
      .system('system1')
      .model('company_code')
      .getAvailableOperations();
    
    gs.info(JSON.stringify(operations, null, 2));

    Ausgabe:

    [
      {
        "id": "create",
        "name": "Company Code - Create"
      },
      {
        "id": "read",
        "name": "Company Code - Read"
      }
    ]

    API – getAvailableOutputs()

    Ruft eine Liste aller verfügbaren Ausgabefelder für den ausgewählten Vorgang ab.

    Die von dieser Methode zurückgegebenen Feldnamen können mit verwendet werden API – Felder (Array-Felder) Methode zum Filtern von Feldergebnissen.

    Tabelle : 22. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 23. Rückgaben
    Typ Beschreibung
    Array von Objekten Liste der verfügbaren Ausgabefelder. Löst einen Fehler aus, wenn kein Modell oder System ausgewählt wurde.

    Siehe auch API – System (Zeichenfolge systemId).

    Object.variable_Name Variablenname des Ausgabefelds.

    Datentyp: Zeichenfolge

    Object.label Anzeigename des Ausgabefelds.

    Datentyp: Zeichenfolge

    Object.Data_type Datentyp der Vorgangsausgabe.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie Sie die verfügbare Ausgabe abrufen, die durch Lesen eines aufgerufenen Modellvorgangs bereitgestellt wird vendor.

    // Get available outputs for read operation on a vendor model
    const outputs = new sn_erp_integration.API()
      .system('system1')
      .model('vendor')
      .operation('read')
      .getAvailableOutputs();
    
    gs.info(JSON.stringify(outputs, null, 2));

    Ausgabe:

    [
      {
        "variable_name": "supplier_country",
        "label": "Country",
        "data_type": "string"
      }
      {
        "variable_name": "supplier_city",
        "label": "City",
        "data_type": "string"
      },
      {
        "variable_name": "supplier_location",
        "label": "Location",
        "data_type": "string"
      },
      {
        "variable_name": "supplier_street",
        "label": "Street",
        "data_type": "string"
      },
      {
        "variable_name": "supplier_name",
        "label": "Name",
        "data_type": "string"
      },
      {
        "variable_name": "supplier_postal_code",
        "label": "Postal Code",
        "data_type": "string"
      },
      {
        "variable_name": "supplier_state",
        "label": "State",
        "data_type": "string"
      }
    ]

    API – getAvailableSystems()

    Ruft eine Liste aller verfügbaren ERP-Systeme ab, auf die über die API zugegriffen werden kann.

    Tabelle : 24. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 25. Rückgaben
    Typ Beschreibung
    Array von Objekten Liste der verfügbaren ERP-Systeme.
    Objekt.ID System-ID. Verwenden Sie diesen Wert, um ein System mit auszuwählen API – System (Zeichenfolge systemId) Methode.

    Datentyp: Zeichenfolge

    object.name Systembezeichnung, d. h. der Anzeigename.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie eine Liste aller verfügbaren ERP-Systeme abgerufen wird.

    const systems = new sn_erp_integration.API().getAvailableSystems();
    
    gs.info(JSON.stringify(systems));

    Ausgabe:

    [
      {
        "id": "system1",
        "name": "SAP DEV"
      },
      {
        "id": "system2",
        "name": "SAP PROD"
      }
    ]

    API – getRequiredInputs()

    Gibt eine Liste nur der erforderlichen Eingabefelder für das ausgewählte Modell und den Erstellungsvorgang zurück.

    Erforderliche Eingabefelder werden festgelegt, wenn Modelle erstellt werden.

    Um eine vollständige Liste der Eingabefelder für ein ausgewähltes Modell zu erhalten, verwenden Sie API – getAvailableInputs() Methode.

    Tabelle : 26. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 27. Rückgaben
    Typ Beschreibung
    Array von Objekten Liste der erforderlichen Eingabefeldnamen.
    Object.variable_Name Variablenname des erforderlichen Eingabefelds.

    Datentyp: Zeichenfolge

    Object.label Anzeigename des erforderlichen Eingabefelds.

    Datentyp: Zeichenfolge

    Object.Data_type Datentyp des erforderlichen Vorgangs.

    Datentyp: Zeichenfolge

    Objekt.erforderlich Kennzeichnung, die angibt, ob das Eingabefeld erforderlich ist. Diese Methode gibt nur Ergebnisse zurück, wenn der Wert „wahr“ ist.

    Datentyp: Boolesch

    Das folgende Beispiel zeigt, wie die erforderlichen Eingabefelder zum Erstellen einer Rechnung zurückgegeben werden.

    const requiredInputs = new sn_erp_integration.API()
      .system('system1')
      .model('invoice')
      .operation('create')
      .getRequiredInputs();
    
    gs.info(JSON.stringify(requiredInputs, null, 2));

    Ausgabe:

    {
      "variable_name": "INVOICE01",
      "label": "INVOICE01",
      "data_type": "array",
      "required": true
    }

    API – idocConfig (Zeichenfolge configId)

    Wählt eine IDoc-Konfiguration für den Betrieb aus.

    Tabelle : 28. Parameter
    Name Typ Beschreibung
    Konfig-ID Zeichenfolge ID der ausgehenden IDoc-Konfiguration. Verwenden Sie zum Abrufen einer Liste von IDoc-Konfigurations-IDs API – getAvailableIdocConfigs() Methode.
    Tabelle : 29. Rückgaben
    Typ Beschreibung
    Objekt Gibt diese Instanz für die Verkettung zurück.

    Das folgende Beispiel zeigt, wie eine IDoc-Konfiguration ausgewählt und Werte für die Verarbeitung festgelegt werden.

    const api = new sn_erp_integration.API()
      .system('system1')
      .idocConfig('OBC0001002')
      .withJSON({
        idoc_field1: 'value1',
        idoc_field2: 'value2'
      })
      .execute();

    API – Limit (Anzahl max.)

    Begrenzt die Anzahl der zurückgegebenen Ergebnisse.

    Tabelle : 30. Parameter
    Name Typ Beschreibung
    max. Nummer Maximale Anzahl zurückzugebender Datensätze.
    Tabelle : 31. Rückgaben
    Typ Beschreibung
    Objekt Gibt diese Instanz für die Verkettung zurück.

    Das folgende Beispiel zeigt, wie nur die ersten 10 Unternehmenscode-Datensätze abgerufen werden.

    // Get only the first 10 company codes
    const api = new sn_erp_integration.API()
      .system('system1')
      .model('company_code')
      .fields(['company_codes_company_code', 'company_codes_company_name'])
      .limit(10)
      .execute();

    API – Modell (Zeichenfolgenmodell-ID)

    Wählt ein Modell aus, mit dem gearbeitet werden soll.

    Tabelle : 32. Parameter
    Name Typ Beschreibung
    modelId Zeichenfolge Die ID des Modells.

    Um eine Liste aller Modelle mit ihren IDs abzurufen, verwenden Sie API – getAvailableModels().

    Tabelle : 33. Rückgaben
    Typ Beschreibung
    Objekt Gibt diese Instanz für die Verkettung zurück.

    Das folgende Beispiel zeigt, wie das Modell „Company_Code“ in system1 ausgewählt wird. Sie können zusätzliche Methoden zum Abrufen und Festlegen von Daten für das ausgewählte Modell verketten.

    const api = new sn_erp_integration.API()
      .system('system1')
      .model('company_code')
      .execute();

    API – Offset (Nummernstart)

    Legt den Start-Offset für Ergebnisse fest.

    Tabelle : 34. Parameter
    Name Typ Beschreibung
    start Nummer Ausgangspunkt, an dem mit dem Abrufen der Ergebnisse begonnen werden soll. Wenn Sie diesen Wert beispielsweise auf 10 festlegen, werden die ersten 10 Ergebnisse übersprungen, die in einer Abfrage zurückgegeben werden.
    Tabelle : 35. Rückgaben
    Typ Beschreibung
    Objekt Gibt diese Instanz für die Verkettung zurück.

    Das folgende Beispiel zeigt, wie 10 Unternehmenscode-Datensätze abgerufen werden, wobei die ersten 10 Ergebnisse (11–20) übersprungen werden.

    const api = new sn_erp_integration.API()
      .system('system1')
      .model('company_code')
      .fields(['company_codes_company_code', 'company_codes_company_name'])
      .limit(10)
      .offset(10)
      .execute();

    API – Vorgang (Zeichenfolge operationId)

    Wählt einen Vorgang aus, der für ein ausgewähltes Modell verwendet werden soll.

    Um eine Liste von Modellvorgängen zurückzugeben, verwenden Sie API – getAvailableOperations().

    Tabelle : 36. Parameter
    Name Typ Beschreibung
    OperationId Zeichenfolge Die ID des Modellvorgangs.
    Tabelle : 37. Rückgaben
    Typ Beschreibung
    Objekt Gibt diese Instanz für die Verkettung zurück.

    Das folgende Beispiel zeigt, wie der Lesevorgang für ausgewählt wird company_codeModell.

    const api = new sn_erp_integration.API()
      .system('system1')
      .model('company_code')
      .operation('read')
      .execute();

    API – Set (Zeichenfolgenfeld, Zeichenfolgenwert)

    Legt einen einzelnen Feldwert für Erstellungs- oder Aktualisierungsvorgänge fest.

    Tabelle : 38. Parameter
    Name Typ Beschreibung
    Ausstehend Zeichenfolge Name des Felds, für das ein Wert festgelegt werden soll.
    Wert Zeichenfolge Wert, der für das Feld festgelegt werden soll.
    Tabelle : 39. Rückgaben
    Typ Beschreibung
    Objekt Gibt diese Instanz für die Verkettung zurück.

    Das folgende Beispiel zeigt, wie ein Unternehmenscodeeintrag erstellt und ihm Feldwerte zugewiesen werden.

    const api = new sn_erp_integration.API()
      .system('system1')
      .model('company_code')
      .operation('create')
      .set('company_codes_company_code', '1234')
      .set('company_codes_company_name', 'New York Office')
      .set('company_codes_countryregion_key', 'US')
      .set('company_codes_language_key', 'EN')
      .execute();

    Das folgende Beispiel zeigt, wie ein Vertriebsdokument mit geschachtelten Eigenschaften aktualisiert wird. Verwenden Sie für geschachtelte Datenstrukturen mit zusätzlichen Ebenen API – withJSON (Objektdaten).

    const api = new sn_erp_integration.API()
      .system('system1')
      .model('sales_document')
      .operation('update')
      .set('document_number', '0000123456')
      .set('header.document_type', 'OR')
      .set('header.sales_organization', '1000')
      .execute();

    API – System (Zeichenfolge systemId)

    Wählt ein System für den Betrieb aus.

    Tabelle : 40. Parameter
    Name Typ Beschreibung
    System-ID Zeichenfolge Die System-ID. Sie können die System-ID mit abrufen API – getAvailableSystems() Methode.
    Tabelle : 41. Rückgaben
    Typ Beschreibung
    Objekt Gibt diese Instanz für die Verkettung zurück.

    Das folgende Beispiel zeigt, wie ein System ausgewählt wird. Sie können zusätzliche Methoden zur Auswahl eines Modells im System und zusätzliche Methoden zur Verwendung von Daten im ausgewählten System verketten.

    const api = new sn_erp_integration.API().system('system1');

    API – withJSON (Objektdaten)

    Legt JSON-Daten für den Vorgang fest. Für Lesevorgänge legt diese Methode Filterbedingungen fest. Für Erstellungs- oder Aktualisierungsvorgänge legt diese Methode die Felder mit Daten fest, die erstellt oder aktualisiert werden sollen.

    Siehe auch API – Set (Zeichenfolgenfeld, Zeichenfolgenwert).

    Tabelle : 42. Parameter
    Name Typ Beschreibung
    Daten Objekt JSON-Datenauflistungsfelder und ihre Werte.
    Format:
    {fieldname: 'value'}
    Tabelle : 43. Rückgaben
    Typ Beschreibung
    Objekt Gibt diese Instanz für die Verkettung zurück.

    Das folgende Beispiel zeigt, wie Daten für einen Erstellungsvorgang festgelegt werden.

    const api = new sn_erp_integration.API()
      .system('system1')
      .model('company_code')
      .operation('create')
      .withJSON({
        company_codes_company_code: '1234',
        company_codes_company_name: 'New York Office',
        company_codes_countryregion_key: 'US'
      })
      .execute();

    Das folgende Beispiel zeigt, wie ein geschachtelter Filter für einen Lesevorgang festgelegt wird.

    const api = new sn_erp_integration.API()
      .system('system1')
      .model('sales_document')
      .operation('read')
      .withJSON({
        header: {
          document_type: 'OR',
          sales_organization: '1000'
        }
      })
      .operation('read')
      .execute();