TracePass
Loslegen
Pässe

Einzelnes Feld in einem Pass aktualisieren

Patcht ein einzelnes Feld auf einem Pass. Der Wert wird gegen den Feldschlüssel validiert (muss in der Vorlage des Passes vorhanden sein) und mit einem Audit-Trail-Eintrag persistiert, der mit `via API key <prefix>` gekennzeichnet ist. Bevorzugen Sie das gegenüber dem Schreiben der gesamten `fields`-Karte, wenn Sie nur eine Zahl aktualisieren müssen — das ist ein kleinerer Schreibvorgang und der Audit-Eintrag ist das, was Dashboard-Prüfer sehen.

PATCH/api/v1/passports/{id}/fields/{key}
OpenAPI 3.1 herunterladen
PATCH/api/v1/passports/{id}/fields/{key}

Einzelnes Feld in einem Pass aktualisieren

Patcht ein einzelnes Feld auf einem Pass. Der Wert wird gegen den Feldschlüssel validiert (muss in der Vorlage des Passes vorhanden sein) und mit einem Audit-Trail-Eintrag persistiert, der mit `via API key <prefix>` gekennzeichnet ist. Bevorzugen Sie das gegenüber dem Schreiben der gesamten `fields`-Karte, wenn Sie nur eine Zahl aktualisieren müssen — das ist ein kleinerer Schreibvorgang und der Audit-Eintrag ist das, was Dashboard-Prüfer sehen.

Schreibvorgänge sind standardmäßig `status: "approved"` — API-Schlüssel-getriebene Integrationen sind per Konvention vertrauenswürdig (anders als Dashboard-Editoren, wo Nicht-Admins `pending_review` schreiben). Überschreiben Sie mit `source: "ai_suggested"` oder `source: "supplier"`, wenn der Wert stattdessen in die Prüf-Queue gehen soll.

Eine alternative Adressierungsform existiert unter PATCH /api/v1/passports/by-serial/{serial}/fields/{key} — gleicher Body, gleiche Antwort, nützlich wenn Ihr ERP nur die kundenseitige Seriennummer kennt. Zählt als ein v1-Schreibvorgang. Unterstützt Idempotency-Key.

Pfad-Parameter

  • iderforderlich

    ObjectId

    Pass-ID. Adressierung per Seriennummer: PATCH /api/v1/passports/by-serial/{serial}/fields/{key}.

    e.g. 6650b2c3d4e5f6a7b8c9d0e1

  • keyerforderlich

    string

    Feldschlüssel (snake_case) wie in der Vorlage des Passes definiert — z. B. `nominal_voltage`, `recycled_content_pct`, `country_of_origin`. 400, wenn der Schlüssel nicht in der Vorlage existiert.

    e.g. rated_capacity_kwh

Header

  • Authorizationerforderlich

    string

    `Bearer <api-key>`.

    e.g. Bearer tp_REDACTED_xxxxxxxxxxxx

  • Idempotency-Key

    string

    UUID v4 pro logischer Operation.

Body-Felder

  • valueerforderlich

    string | number | boolean | array | object

    Neuer Wert. Die Plattform formatiert keine Strings in Zahlen um — senden Sie den Wert im erwarteten Feldtyp.

    e.g. 5.24

  • source

    enum

    Markiert den Ursprung des Werts. Einer von: `manual`, `ai_suggested`, `ai_approved`, `reference_db`, `supplier`, `system`. Standard `manual`. `ai_suggested` und `supplier` landen in der Prüf-Queue; alles andere wird als approved geschrieben.

  • sourceLocale

    string (ISO 639-1)

    Locale des Werts (eines der 24 EU-Locales). Steuert Übersetzungsrichtung + Sprachauflösung des öffentlichen Viewers. Standardmäßig der `sourceLocale` des Passes, wenn ausgelassen.

Anfrage

curl -sS -X PATCH \
  https://app.tracepass.eu/api/v1/passports/6650b2c3d4e5f6a7b8c9d0e1/fields/rated_capacity_kwh \
  -H "Authorization: Bearer tp_REDACTED_xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{ "value": 5.24 }'

Antwort

{
  "field": {
    "value": 5.24,
    "source": "manual",
    "status": "approved",
    "accessLevel": "public",
    "sourceLocale": "en",
    "lastUpdatedAt": "2026-05-09T10:30:00.000Z",
    "lastUpdatedBy": "api_key:tp_89b2482d"
  },
  "version": 4
}

Verwandte Endpoints