API Reference

OpenLabelEngine Center API v0.1.0 (sprint 2) — OpenAPI 3.1. Generated from the checked-in openapi.json, never hand-written. 96 endpoints in 14 groups.

Quick API Call

Print a label via REST · copy-paste-ready
# 1. Get a token (once)
curl -X POST https://your-center:8090/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username":"admin","password":"..."}'

# 2. Print a label
curl -X POST https://your-center:8090/api/v1/print \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "label_id": "lbl_8f2k3a",
    "printer": "PAL-2",
    "copies": 24,
    "variables": {
      "sscc": "00340123452311160029",
      "charge": "CH-2231"
    },
    "idempotency_key": "order-4711-label-1"
  }'

SDKs are on the v1.x roadmap. Until then: every endpoint is plain REST + JSON.

Audit-Log

MethodEndpointBeschreibung
GET/api/v1/audit-logAudit-Log lesen
GET/api/v1/audit-log/{entryId}Einzelner Audit-Log-Eintrag

Authentication

MethodEndpointBeschreibung
POST/api/v1/auth/loginSign in
POST/api/v1/auth/logoutSign out
GET/api/v1/auth/setupErstzugangs-Probe
POST/api/v1/auth/setupErst-Setup
POST/api/v1/auth/tokensService-Account-Token ausstellen
GET/api/v1/auth/tokensService-Account-Tokens auflisten
DELETE/api/v1/auth/tokens/{id}Service-Account-Revoke token
GET/api/v1/auth/whoamiWho am I?
POST/api/v1/auth/passwordEigenes Change password

Sonstige

MethodEndpointBeschreibung
POST/api/v1/cel/evaluateCEL-Ausdruck gegen Beispieldaten auswerten (Variablen-Editor, AB#721)
GET/api/v1/versionAPI surface version
GET/api/v1/jobs/{jobId}Auftrag mit Meldungshistorie
POST/api/v1/jobs/{jobId}/cancelAuftrag abbrechen

Credentials

MethodEndpointBeschreibung
GET/api/v1/credentialsCredentials auflisten
POST/api/v1/credentialsCreate credential
DELETE/api/v1/credentials/{ref}Delete credential
POST/api/v1/credentials/{ref}/testGespeicherten Zugang pruefen

Deployments

MethodEndpointBeschreibung
GET/api/v1/deploymentsVerteilungsstand aller Gruppen
POST/api/v1/deploymentsFlow ausrollen
POST/api/v1/deployments/{deploymentId}/approvalStufe freigeben
POST/api/v1/deployments/{deploymentId}/rollbackRollout zuruecknehmen
GET/api/v1/deployments/{deploymentId}/contextRead deployment-level context parameters
PUT/api/v1/deployments/{deploymentId}/context/{name}Set deployment-level context parameters
DELETE/api/v1/deployments/{deploymentId}/context/{name}Remove deployment-level context parameters

Flows

MethodEndpointBeschreibung
GET/api/v1/flowsFlow-Liste
POST/api/v1/flowsFlow anlegen
GET/api/v1/flows/registryNodekatalog lesen
GET/api/v1/flows/{flowId}Flow-Metadaten
PATCH/api/v1/flows/{flowId}Flow-Metadaten aendern
DELETE/api/v1/flows/{flowId}Flow loeschen
GET/api/v1/flows/{flowId}/documentflow.json lesen
PATCH/api/v1/flows/{flowId}/documentPatches auf flow.json anwenden
GET/api/v1/flows/{flowId}/versionsVersionshistorie
GET/api/v1/flows/{flowId}/versions/{version}Flow-Dokument einer Version

Labels

MethodEndpointBeschreibung
GET/api/v1/labelsLabels auflisten
POST/api/v1/labelsLabel anlegen
POST/api/v1/labels/{labelId}/statusFreigabestatus eines Labels wechseln
POST/api/v1/labels/from-presetLabel aus Medien-Preset anlegen
POST/api/v1/labels/from-dimensionsLabel aus freien Massen anlegen
PATCH/api/v1/labels/{labelId}Label umbenennen
DELETE/api/v1/labels/{labelId}Label loeschen
POST/api/v1/labels/{labelId}/archiveLabel archivieren
POST/api/v1/labels/{labelId}/duplicateLabel duplizieren
POST/api/v1/labels/{labelId}/save-copyLabel als Save copy
GET/api/v1/labels/{labelId}/documentLabel-Dokument lesen
PATCH/api/v1/labels/{labelId}/documentLabel-Dokument patchen
POST/api/v1/labels/{labelId}/previewEditor preview: label as print raster (PNG)
GET/api/v1/labels/{labelId}/copy-infoMetadata for the copy dialog
GET/api/v1/labels/{labelId}/formDruckformular eines Labels
GET/api/v1/labels/{labelId}/versionsVersionshistorie eines Labels

Drucken

MethodEndpointBeschreibung
POST/api/v1/printPrint job: labelRef@version + Strom oder Variablen + target (AB#418, AB#1250) — the reference case for invariant 10
GET/api/v1/print-archiveDruckarchiv lesen
GET/api/v1/print-archive/{entryId}Einzelner Druckarchiv-Eintrag

Printers

MethodEndpointBeschreibung
GET/api/v1/printersBekannte Druckziele (Wizard, AB#1254)
POST/api/v1/printersErkennungsfund als Druckziel uebernehmen (AB#1829)
POST/api/v1/printers/discoverPrinterssuche im Netz (Wizard Screen 2, AB#717)
GET/api/v1/deployments/{deploymentId}/printersPrinterszuordnung eines Deployments lesen
PUT/api/v1/deployments/{deploymentId}/printers/{name}Printerszuordnung setzen
DELETE/api/v1/deployments/{deploymentId}/printers/{name}Printerszuordnung entfernen
DELETE/api/v1/printers/{printerId}Uebernommenes Druckziel entfernen (AB#1829)

Runner & Enrollment

MethodEndpointBeschreibung
POST/api/v1/runner-enrollmentsRunner-Bootstrap: Enrollment-Token gegen Client-Zertifikat (AB#383)
GET/api/v1/runner-enrollmentsWartende Enrollment-Vorgaenge (AB#1080)
GET/api/v1/runner-enrollments/{id}Stand eines Enrollment-Vorgangs (AB#383)
POST/api/v1/runner-enrollments/{id}/approvalEinen wartenden Enrollment-Vorgang freigeben (AB#1080)
GET/api/v1/runner-groupsRunner groupn auflisten
POST/api/v1/runner-groupsRunner group anlegen
GET/api/v1/runner-groups/{groupId}/deploymentsVerteilungsstand einer Gruppe
POST/api/v1/runner-groups/{groupId}/enrollment-tokensEnrollment-Token ausstellen
POST/api/v1/runner-groups/{groupId}/installerGenerate installer package for a runner group
GET/api/v1/runnersRunner-Liste
GET/api/v1/runners/{runnerId}Runner-Detail
POST/api/v1/runners/{runnerId}/discoveryPrinterssuche an einem Runner anfordern
POST/api/v1/runners/{runnerId}/jobsPrint job an einen Runner geben
GET/api/v1/runners/{runnerId}/jobsAuftraege eines Runners
GET/api/v1/runner-groups/{groupId}/contextRead group-level context parameters
PUT/api/v1/runner-groups/{groupId}/context/{name}Set group-level context parameters
DELETE/api/v1/runner-groups/{groupId}/context/{name}Remove group-level context parameters
GET/api/v1/runners/{runnerId}/contextRead runner-level context parameters
PUT/api/v1/runners/{runnerId}/context/{name}Set runner-level context parameters
DELETE/api/v1/runners/{runnerId}/context/{name}Remove runner-level context parameters

Users

MethodEndpointBeschreibung
GET/api/v1/usersUsers auflisten
POST/api/v1/usersUsers anlegen
GET/api/v1/users/{userId}Users einzeln lesen
POST/api/v1/users/{userId}/rolesRolle vergeben
DELETE/api/v1/users/{userId}/roles/{role}Revoke role
POST/api/v1/users/{userId}/passwordPasswort eines Userss setzen
POST/api/v1/users/{userId}/deactivateZugang entziehen
POST/api/v1/users/{userId}/reactivateZugang wiederherstellen

Import

MethodEndpointBeschreibung
POST/api/v1/importQuelldatei in DSL-Dokumente konvertieren

AI

MethodEndpointBeschreibung
POST/api/v1/ai/lint-erklaerungLint-Befund erklaeren
POST/api/v1/ai/log-qaAudit-Log per strukturierter Frage erklaeren

Counters (Serialization)

MethodEndpointBeschreibung
POST/api/v1/countersZaehler-Sequenz anlegen
GET/api/v1/counters/{name}Stand einer Zaehler-Sequenz lesen
POST/api/v1/counters/{name}/deactivateZaehler-Sequenz stilllegen