ProEye-X API

So lesen und schreiben Sie Arbeitsanalysedaten Ihrer Firmeninstanz (https://firma.proeye-x.com) aus externen Systemen wie MES, ERP oder BI. Alle Aufrufe nutzen JSON-RPC 2.0 und gehen per POST an einen Endpunkt: /jsonrpc.

Erste Schritte

Endpunkt

Die Adresse ist für jede Firmeninstanz anders. Der Datenbankname entspricht dem vorderen Teil Ihrer Firmenadresse (firma).

POST https://company.proeye-x.com/jsonrpc

API-Schlüssel erstellen

Bei der Instanz anmelden → Benutzermenü (oben rechts) › Mein Profil (Einstellungen) › Kontosicherheit › „Neuer API-Schlüssel“. Der Schlüssel ersetzt das Passwort und wird nur einmal angezeigt. Bewahren Sie Schlüssel nur in serverseitigen Programmen auf, nie im Browsercode.

Authentifizierung (uid erhalten)

Tauschen Sie Login-E-Mail und API-Schlüssel gegen eine Benutzernummer (uid) und senden Sie Datenbank, uid und API-Schlüssel bei jedem Aufruf mit.

curl
curl -s https://company.proeye-x.com/jsonrpc \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc": "2.0", "method": "call", "params": {
        "service": "common", "method": "authenticate",
        "args": ["company", "you@company.com", "YOUR_API_KEY", {}]}}'

# → {"jsonrpc": "2.0", "id": null, "result": 7}      (7 = uid)

Python-Hilfsfunktion

Die folgenden Beispiele verwenden diese Hilfsfunktion model().

Python
import requests

URL = "https://company.proeye-x.com/jsonrpc"
DB, LOGIN, KEY = "company", "you@company.com", "YOUR_API_KEY"

def call(service, method, *args):
    r = requests.post(URL, json={"jsonrpc": "2.0", "method": "call",
                                 "params": {"service": service, "method": method, "args": args}}, timeout=30)
    r.raise_for_status()
    body = r.json()
    if body.get("error"):
        raise RuntimeError(body["error"]["data"]["message"])
    return body.get("result")          # no "result" key when the method returns nothing

UID = call("common", "authenticate", DB, LOGIN, KEY, {})

def model(name, method, args, kw=None):
    return call("object", "execute_kw", DB, UID, KEY, name, method, args, kw or {})

Sprache

Geben Sie lang im context an, um Arbeits- und Elementnamen in dieser Sprache zu erhalten (sofern übersetzt). Beispiel: {"context": {"lang": "de_DE"}} · en_US · ja_JP · zh_CN · zh_TW · vi_VN · th_TH · id_ID · es_ES · ko_KR.

Fehler

Bei einem Fehler erhalten Sie HTTP 200 mit einem "error"-Objekt; error.data.message nennt den Grund (keine Berechtigung, Pflichtfeld fehlt, …).

API-Liste

element_type ist der Schlüssel eines Arbeitstyp-Feldes (va = Feld 1, nva = Feld 2, wait = Feld 3, eigene Felder c4 …). Die VA/NVA-Zeit ergibt sich aus den segment_data-Intervallen.

1. Analysen auflisten

Modell · wa.sessionMethode · search_read

Liefert Arbeitsanalysen (Sitzungen) mit mittlerer Zykluszeit, VA-Anteil und Anzahl der Elemente.

Python
rows = model("wa.session", "search_read", [[]], {
    "fields": ["o_no", "name", "process_name", "cycle_time_avg", "va_ratio", "element_count"],
    "order": "date desc", "limit": 20,
    "context": {"lang": "en_US"},       # names in English (optional)
})
curl
curl -s https://company.proeye-x.com/jsonrpc -H "Content-Type: application/json" -d '{
  "jsonrpc": "2.0", "method": "call", "params": {"service": "object", "method": "execute_kw",
  "args": ["company", 7, "YOUR_API_KEY", "wa.session", "search_read", [[]],
           {"fields": ["o_no", "name", "cycle_time_avg", "va_ratio"], "limit": 20}]}}'
Beispielantwort
[{"id": 6, "o_no": "O-ENG-NOVICE-01", "name": "Engine Assembly - Novice",
  "process_name": "Engine Assembly Work", "cycle_time_avg": 165.33, "va_ratio": 63.7, "element_count": 14}]

2. Arbeitselemente abrufen

Modell · wa.elementMethode · search_read

Liefert die Arbeitselemente einer Analyse je Zyklus: Start-/Endzeit (s), Standardzeit, VA- und NVA-Zeit. cycle_no gibt den Zyklus an, zu dem das Element gehört (1, 2, 3 …).

Python
elements = model("wa.element", "search_read",
    [[["session_id", "=", 6], ["cycle_no", "=", 1]]],
    {"fields": ["cycle_no", "sequence", "name", "element_type", "video_start_time", "video_end_time",
                "standard_time", "va_time", "nva_time"], "order": "cycle_no, sequence"})
# every cycle: drop the ["cycle_no", "=", 1] condition — cycle_no tells which cycle each element belongs to
Beispielantwort
[{"id": 70, "cycle_no": 1, "sequence": 1, "name": "Fetch the tools and prepare.", "element_type": "wait",
  "video_start_time": 189.656, "video_end_time": 198.398, "standard_time": 8.742,
  "va_time": 4.104, "nva_time": 4.638}, ...]

3. LOSS abrufen

Modell · wa.elementMethode · search_read (LOSS)

Liefert die im Reiter LOSS erfassten Inhalte. Für jedes NVA-Segment eines Elements (segment_data-Einträge mit type = nva) sind LOSS-Text (loss_data) und Verschwendungsart-Code (loss_type_data) als JSON-Arrays in gleicher Reihenfolge gespeichert – wie unten zusammenführen, um Zeilen aus Zyklus · Element · Segmentzeit · Verschwendungsart · LOSS-Text zu erhalten.

Python
import json

rows = model("wa.element", "search_read", [[["session_id", "=", session_id]]],
             {"fields": ["cycle_no", "sequence", "name", "segment_data", "loss_data", "loss_type_data"],
              "order": "cycle_no, sequence"})
losses = []
for e in rows:
    nva = [s for s in json.loads(e["segment_data"] or "[]") if s["type"] == "nva"]
    notes = json.loads(e["loss_data"] or "[]")          # LOSS text, one per NVA segment
    types = json.loads(e["loss_type_data"] or "[]")     # waste type code, one per NVA segment
    for i, seg in enumerate(nva):
        losses.append({"cycle_no": e["cycle_no"], "element": e["name"],
                       "start": seg["start"], "end": seg["end"], "dur": seg["dur"],
                       "loss_type": types[i] if i < len(types) else "",
                       "loss": notes[i] if i < len(notes) else ""})
Beispielantwort
# rows (raw)
[{"id": 207, "cycle_no": 1, "sequence": 1, "name": "Fasten bolt",
  "segment_data": "[{\"type\": \"va\", \"start\": 4.2, \"end\": 7.0, \"dur\": 2.8}, {\"type\": \"nva\", \"start\": 7.0, ...}]",
  "loss_data": "[\"Searching for the wrench\", \"Waiting for the jig\"]",
  "loss_type_data": "[\"w6\", \"w2\"]"}]

# losses
[{"cycle_no": 1, "element": "Fasten bolt", "start": 7.0, "end": 9.1, "dur": 2.1, "loss_type": "w6", "loss": "Searching for the wrench"},
 {"cycle_no": 1, "element": "Fasten bolt", "start": 11.0, "end": 12.6, "dur": 1.6, "loss_type": "w2", "loss": "Waiting for the jig"}]

# loss_type: w1 overproduction · w2 waiting · w3 transport · w4 over-processing · w5 inventory · w6 motion · w7 defects

4. Analyse anlegen

Modell · wa.sessionMethode · create

Legt eine neue Arbeitsanalyse an. O-No (eindeutige Nummer) ist Pflicht und darf sich nicht wiederholen. Liefert die neue ID.

Python
session_id = model("wa.session", "create", [{
    "o_no": "O-2026-LINE3-01",          # required, unique
    "name": "Line 3 sub-assembly",
    "process_name": "Sub-assembly",
}])
Beispielantwort
21

5. Arbeitselemente hinzufügen

Modell · wa.elementMethode · create

Fügt mehrere Elemente auf einmal nach Videozeitbereich hinzu. Summen wie Zykluszeit und VA-Anteil werden automatisch neu berechnet.

Python
ids = model("wa.element", "create", [[
    {"session_id": session_id, "cycle_no": 1, "sequence": 1, "name": "Pick part",
     "element_type": "va", "video_start_time": 0.0, "video_end_time": 4.2},
    {"session_id": session_id, "cycle_no": 1, "sequence": 2, "name": "Fasten bolt",
     "element_type": "va", "video_start_time": 4.2, "video_end_time": 9.8},
]])
summary = model("wa.session", "read", [[session_id]],
                {"fields": ["element_count", "cycle_time_avg", "va_ratio"]})
Beispielantwort
[205, 206]
[{"id": 18, "element_count": 2, "cycle_time_avg": 9.8, "va_ratio": 100.0}]

6. Element ändern / löschen

Modell · wa.elementMethode · write / unlink

Name, Zeiten oder Arbeitstyp ändern (write) oder löschen (unlink).

Python
model("wa.element", "write", [[205], {"name": "Pick and place", "video_end_time": 4.6}])
model("wa.element", "unlink", [[206]])
Beispielantwort
true
true

7. LOSS schreiben

Modell · wa.elementMethode · write (LOSS)

Schreibt LOSS-Text und Verschwendungsart-Code je NVA-Segment als JSON-Arrays in zeitlicher Reihenfolge. Der n-te Wert gehört zum n-ten NVA-Segment. Codes: w1 Überproduktion · w2 Warten · w3 Transport · w4 Überbearbeitung · w5 Bestände · w6 Bewegung · w7 Fehler.

Python
import json

# element with NVA segments 7.0–9.1 s and 11.0–12.6 s → one entry per NVA segment, in time order
model("wa.element", "write", [[207], {
    "loss_data": json.dumps(["Searching for the wrench", "Waiting for the jig"]),
    "loss_type_data": json.dumps(["w6", "w2"]),
}])
Beispielantwort
true

8. Zyklen abrufen

Modell · wa.cycleMethode · search_read

Liefert die gemessenen Zyklen mit Start, Ende und Zykluszeit.

Python
cycles = model("wa.cycle", "search_read", [[["session_id", "=", 4]]],
               {"fields": ["sequence", "video_start", "video_end", "cycle_time"], "order": "sequence"})
Beispielantwort
[{"id": 4, "sequence": 1, "video_start": 0.767, "video_end": 17.15, "cycle_time": 16.383}, ...]

9. Vergleich (vorher / nachher)

Modell · wa.comparisonMethode · create · action_build_lines · read

Verbindet zwei Analysen zu einem Vergleich, erzeugt die Vergleichszeilen und liefert Zykluszeitreduktion, VA-Verbesserung und Unterschiede je Element.

Python
cid = model("wa.comparison", "create", [{
    "name": "Line 1 before / after", "session_a_id": 7, "session_b_id": 11}])
model("wa.comparison", "action_build_lines", [[cid]])
result = model("wa.comparison", "read", [[cid]],
               {"fields": ["ct_a", "ct_b", "ct_reduction", "ct_reduction_pct", "va_improvement"]})
lines = model("wa.comparison.line", "search_read", [[["comparison_id", "=", cid]]],
              {"fields": ["sequence", "step_name", "time_a", "time_b", "time_diff"], "order": "sequence"})
Beispielantwort
[{"id": 3, "ct_a": 22.72, "ct_b": 23.39, "ct_reduction": -0.67, "ct_reduction_pct": -2.9, "va_improvement": -6.4}]
[{"id": 49, "sequence": 1, "step_name": "UP", "time_a": 2.85, "time_b": 2.723, "time_diff": -0.127}, ...]

10. Linienabgleich

Modell · wa.linebalance · wa.lb.processMethode · search_read

Liefert Taktzeit, Linieneffizienz, den Engpassprozess sowie Zykluszeit und Auslastung je Prozess.

Python
lines = model("wa.linebalance", "search_read", [[]],
              {"fields": ["name", "takt_time", "lb_efficiency", "bottleneck_name", "max_ct"]})
processes = model("wa.lb.process", "search_read", [[["lb_id", "=", lines[0]["id"]]]],
                  {"fields": ["sequence", "process_name", "cycle_time", "load_ratio", "over_takt"],
                   "order": "sequence"})
Beispielantwort
[{"id": 1, "name": "LB_Robot Assembly Line MAC Analysis", "takt_time": 27.74,
  "lb_efficiency": 90.0, "bottleneck_name": "Robot Assembly Line (After Improvement)", "max_ct": 27.74}]
[{"id": 1, "sequence": 10, "process_name": "Robot Assembly Line (After Improvement)",
  "cycle_time": 23.39, "load_ratio": 84.3, "over_takt": false}, ...]

11. MMC · MAC

Modell · wa.mmc · wa.macMethode · search_read

Liefert Mensch-Maschine-Diagramme (MMC) und Mehrfachtätigkeitsdiagramme (MAC) mit Zeitaufteilung und Auslastung.

Python
mmc = model("wa.mmc", "search_read", [[]],
            {"fields": ["name", "total_time", "machine_time", "walk_time", "wait_time", "load_ratio"]})
mac = model("wa.mac", "search_read", [[]],
            {"fields": ["name", "process_count", "takt_time", "avg_ct", "utilization", "balance_eff"]})
Beispielantwort
[{"id": 1, "name": "Engine Assembly Line", "total_time": 165.33, "machine_time": 0.0,
  "walk_time": 0.0, "wait_time": 0.0, "load_ratio": 100.0}]
[{"id": 1, "name": "Robot Assembly Line MAC Analysis", "process_count": 4, "takt_time": 0.0,
  "avg_ct": 24.97, "utilization": 0.0, "balance_eff": 90.0}]

Alle Felder mit fields_get anzeigen: model("wa.session", "fields_get", [], {"attributes": ["string", "type"]})