Versionen im Vergleich

Schlüssel

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

profacto bietet einen token-gesicherten Zugriff auf ausgewählte Tabellen und Felder mit sehr flexibler Architektur. Bei Wünschen für zusätzliche Tabellen, API-Sets oder als externer Entwickler sprich uns gerne an. 

...

API-Basis = http://<Servername im LAN oder WAN | IP im LAN oder| WAN-Domain bzw. IP|>:8080/4DAction/<api-Methode>?token=<Token>

Weil das darunter liegende Framework von Profacto Case-Insensitive ist verhält sich das auch so mit den API-Methoden bzw. Aufrufen.

Folgende API-Methoden stehen zur Verfügung:

api_getapilist (Alle API) - Gibt eine Liste der verfügbaren APIs der profacto Installation zurück

api_getmytokens (Alle API mit persönlichem Token) - Gibt eine List der APIs mit Token der aufrufenden Person (gemäß Token) zurück

api_getzeitmodell  (API Zeiterfassung) - liefert daß Zeitmodell von dem Mitarbeiter der dem Zeiterfassung-Token zugeordnet ist

api_cadtextures - (API Integration) - empfängt Texturnamen vom CAD

api_get (API diverse) - Daten aus der Datenbank lesen.

api_get_doccopybyid (API Projekte) - Gibt eine Datei bestimmt durch die id aus der Tabelle DokumentSeiten

api_get_filebyid - Gibt eine Datei bestimmt durch die id aus der Tabelle Alias

api_get_personaltokens - Liefert für die übergebene Personalnummer und ggf. API das notwendige Token

api_get_project_doccopylist (API Projekte)

api_get_project_filelist - Liefert eine Liste aller Dateien, die einem Projekt zugeordnet sind

api_get_qr - erlaubt URLs mit "/" statt "?", um aus der Tabellenkalkulation Daten abzurufen

api_getkunden -  Holt alle Kundendatensätze ab (veraltet - besser api_get benutzen)

api_getposdelta - Ermittelt die für das übergebene Projekt seit dem als zweiten Parameter gegebenen Zeitstempel erfolgten Änderungen an Projektpositionen

api_getproduction - Gibt eine Projektübersicht im HTML-Format wieder

api_license_redirect - Zeigt den Status der verfügbaren API & OTA Lizenzen an

api_newstockdemand - verarbeitet eine Artikel-UUID in einen Bestellvorschlag

api_partcncqrcode - gibt den QR-Code für ein CNC-Programm aus

api_partdone - Fortschrittsmeldung in einer Stückliste

api_partitem - Liefert eine Stückliste aus (ElementID)

api_partstation - Setzt den Status einer Stückliste und gibt ihn wieder

api_ping - Gibt eine einfache Response zurück, ob eine API verfügbar ist

api_productionposition - Liefert alle zugehörigen Stücklisten zu einem Projekt

api_put_activity (API Aktivitäten) - Schreibt eine Aktivität.

api_put_bestellpos (API Bestellung) - Schreibt eine Bestellposition.

api_put_bestellung (API Bestellung) - Erstellt eine Bestellung

api_put_contact (API Kontakte) - Schreibt einen Kontakt zu einem vorhandenden Kunden oder Lieferanten.

api_put_customer (API Kunden) - Schreibt einen Kundendatensatz.

api_put_employee (API Personal) - Schreibt einen Personaldatensatz.

api_put_item (API Artikel) - Schreibt einen Artikeldatensatz.

api_put_project (Alle API) - Projekt anlegen.

api_put_projectpos - Schreiben einer Projektposition

api_put_supplier (API Lieferanten - Schreibt einen Lieferantendatensatz.

api_put_time (API Zeiterfassung)- Schreibt einen Zeitdatensatz.

api_qasignature - Speichert eine digitale Unterschrift oder liefert sie aus

api_sandbox - Gibt eine HTML-Seite wieder zur Verwendung des Proglove Handschuhs

api_stornostockdemand - Lagerbestellungen stornieren

api_time_getday - Liefert alle gebuchten Zeiten für gegebenen Tag für gegebenen Mitarbeiter aus

api_time_getpositions (API Zeiterfassung) - liefert zu gegebenem Projekt die Positionen

api_time_start (API Zeiterfassung) - Startet einen Zeiterfassungsvorgang im Browser - Kern der WebZE

Info
titleOTA-Integration

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

http://<Servername im LAN oder WAN |LAN oder WAN-IP|>:8080/4DAction/api_get?token=<Token>LAN = Local Area Network - Also über das lokale Netzwerk oder das lokale WLAN

WAN = Wide Area Network - Also über das Internet, öffentliche WLAN HotSpots oder Mobilfunk

Der Port 8080 ist hart vorgegeben und darf nicht geändert werden.

Das 4DAction ist einfach Teil der Struktur und kann nicht geändert werden.

Tabellen und Feld-Namen

...

  • 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 

...