Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

Stand 23.09.2019 - Feature ist im  Beta-Modus und kann noch jederzeit geändert werden, oder Fehler haben.

...

api_new - Daten schreiben, nur für bestimmte APIs verfügbar

api_put_customer - Schreibt einen Kundendatensatz.

api_put_supplier - Schreibt einen Lieferantendatensatz.

api_put_contact - Schreibt einen Kontakt zu einem vorhandenden Kunden oder Lieferanten.

api_put_item - Schreibt einen Artikeldatensatz.

api_put_employee - Schreibt einen Personaldatensatz.

api_put_activity - Schreibt eine Aktivität.

api_put_time - Schreibt einen Zeitdatensatz.

api_time_start - Startet einen Zeiterfassungsvorgang im Browser, vergleichbar mit der WebZE.


Info
titleOTA-Integration

Für die OTA-Integration bitte die Integrations-Dokumentation nach öffentlichem Release lesen.

...

  • Symbole zum Vergleichen von Attribut und Value. Es gibt folgende Symbole:

    VergleichSymbol(e)Kommentar
    Ist gleich=, ==Erhält passende Daten, unterstützt den Joker @, berücksichtigt weder Groß- und Kleinschreibung noch diakritische Zeichen.

    ===, ISErhält passende Daten, bewertet @ als Standardzeichen und nicht als Joker, berücksichtigt weder Groß- und Kleinschreibung noch diakritische Zeichen.
    Ungleich zu#, !=unterstützt den Joker (@)

    !==, IS NOTbewertet @ als Standardzeichen und nicht als Joker
    Kleiner als<
    Größer als>
    Kleiner als oder gleich<=
    Größer als oder gleich>=
    Enthalten inINErhält Daten, die mit mindestens einem Wert in einer Collection bzw. einem Satz Werte übereinstimmt
    Nicht enthalten in einer AnweisungNOTKlammern sind zwingend, wenn NOT vor einer Anweisung mit mehreren Operatoren verwendet wird
    Enthält Schlüsselwort%Schlüsselwörter lassen sich in Attributen vom Typ String oder Bild verwenden


  • Value: Wert zum Vergleichen mit dem aktuellen Wert der Eigenschaft. 
    Für eine Suche nach einem String innerhalb eines anderen String (eine Suche "Enthalten in") verwenden Sie den Joker (@) in value, um den zu suchenden String zu isolieren, zum Beispiel: "@Smith@".
    Für numerische Werte dient Punkt als Dezimaltrenner. Datumsangeben müssen im Format "YYYY-MM-DD" sein.
    Bei einer Suche mit einem IN Vergleichsoperator muss value eine Collection sein bzw. Werte, die zum Typ des Attributspfads zwischen eckigen Klammern [] passen, getrennt durch Kommas (bei Strings müssen Anführungszeichen " mit "\" abschließen).
  • LogicalOperator: verbindet mehrere Bedingungen in der Suche (optional). Es gibt folgende logische Operatoren (Sie können Name oder Symbol übergeben):

    KonjunktionSymbol(e)
    AND&, &&, and
    OR|, ||, or


  • order by Attribut: Sie können eine Anweisung order by Attribute in der Suche hinzufügen, so dass die Ergebniswerte sortiert werden. Sie können mehrere Sortieranweisungen, durch Komma getrennt, verwenden, (z.B. order by Attribut1 desc, Attribut2 asc). Die Sortierung ist standardmäßig aufsteigend. Übergeben Sie 'desc' für absteigende Reihenfolge und 'asc' für aufsteigende Reihenfolge 

...

Man sieht, daß trotzdem alle zulässigen Felder unterstützt werden, die Abfrage deswegen nicht komplett scheitert.

Neue Daten schreiben

...

mit api_put_*

API-Basis = http://<Servername im LAN oder WAN |LAN oder WAN-IP|>:8080/4DAction/api_put_<areaname>

weitere Parameter:

update - Werte: True oder False. Regelt, ob ein vorhandener Datensatz aktualisiert werden soll oder nicht. Bei Neuanlage kann dieses Flag weggelassen werden.

response - Werte: HTML oder JSON. Regelt, ob die Rückmeldung als HTML-Seite oder als JSON-Objekt erfolgen soll. Lassen Sie dieses Flag weg, wird JSON rückgeliefert.

Ausgeschlossene Parameter:

host - Dieser Parameter wird intern verwendet und kann nicht übergeben werden

Die obigen Angaben gelten für alle api_put_*-Aufrufe bis auf api_put_time, das einen Sonderstatus einnimmt.

Die Namen aller Tabellen  und Felder in profacto können hier eingesehen werden. Für die verschiedenen put-Befehle wird auf jeweils eine Tabelle schreibend zugriffen. Bestimmte Felder dürfen nicht geschrieben werden, dies ist unten in der Dokumentation jeweils aufgeführt.

Link: Datenbankstruktur

api_put_customer - Kundenanlage

Erforderliche Parameter: 

Name1, PLZ

Ausgeschlossene Parameter:

PKUUID_12

Konkretes Beispiel:

http://meinServer:8080/4DAction/api_put_customer?token=5E05A427CD134432A28F2DAF11EC500E&Name1=Schreinerei%20Meier&PLZ=48149&Strasse=Hauptstr.%201


In der JSON-Rückmeldung wird auch die neue vergebene Kundennummer rückgeliefert:


{"success":true,"wasUpdate":false,"mainKey":"n20-01170","processingTime":54,"errorMsg":""}

Zeiten erfassen mit api_time_start

Lagerbedarfsmeldung

api_newstockdemand?ArtikelID=ABC123 - die ArtikelID wird parallel zur ArtikelTypenNr erstellt.

...