Datenmodell

Postfach-Protokoll

Jeder Inbox-Scan, der eine Bewerbung importierte, übersprungen hat oder fehlschlug.

Modellname: email_import_log
Endpunkte: 3
Max. Seitengröße: 200

Felder

Validierungsregeln pro Feld. Werte, die diese Bedingungen verletzen, werden mit 400 abgewiesen, bevor sie die Datenbank erreichen.

FeldTypRegeln
scorenumber-
reasonstring
max. Länge1000
senderstring
max. Länge320
statusenum
enumimported | duplicate | ignored | error
previewstring
max. Länge2000
signalslist-
subjectstring
max. Länge500
message_idstring
max. Länge400
source_uidnumber-
attachmentslist-
match_scorenumber-
received_atstring
max. Länge32
sender_namestring
max. Länge200
sender_emailstring
max. Länge320
error_messagestring
max. Länge1000
source_folderstring
max. Länge200
email_inbox_idstring
max. Länge64
matched_job_idstring
max. Länge64
matched_job_titlestring
max. Länge200
matched_candidate_idstring
max. Länge64
matched_application_idstring
max. Länge64

Mutabilität

Welche Felder darfst du senden, und wann? Felder ohne Markierung werden vom Server vergeben - das Senden ist kein Fehler, sie werden stillschweigend ignoriert.

Anlegbar - im POST-Body lesbar.Änderbar - im PATCH-Body lesbar.Server-verwaltet - vom Body ignoriert.
FeldAnlegbarÄnderbar
score
reason
sender
status
preview
signals
subject
message_id
source_uid
attachments
match_score
received_at
sender_name
sender_email
error_message
source_folder
email_inbox_id
matched_job_id
matched_job_title
matched_candidate_id
matched_application_id

Felder mit Anlegbar, aber ohne Änderbar, sind nach dem Erstellen unveränderlich. Server-verwaltete Felder umfassen id, Zeitstempel, Eigentümerschaft und Status.

Filter & Sortierung

Auf Listen-Endpunkten kombinierbar. Wiederholte Filter-Keys werden zu IN-Bedingungen, ein - vor einem Sort-Key kehrt die Richtung um. Beispiel: ?status=open&status=blocked&sort=-created_at.

Filter-Keys

statusdata__status
email_inbox_iddata__email_inbox_id
matched_job_iddata__matched_job_id
matched_candidate_iddata__matched_candidate_id
matched_application_iddata__matched_application_id
message_iddata__message_id
statusstatus
owned_byowned_by
created_bycreated_by

Sortier-Keys

created_atcreated_at
received_atdata__received_at

Standard: created_at

Endpunkte

Jeder Endpunkt unten zeigt seine HTTP-Methode, den Pfad und den dafür benötigten PAT-Scope. Code-Beispiele decken curl, JavaScript, TypeScript, Python, Rust, Java und WebSocket ab.

GET/xapi2/data/email_import_logemail_import_log:list

Objekte auflisten

Liefert eine paginierte Liste sichtbarer Objekte. Standard-Seitengröße 20; mit ?limit= änderbar (typabhängig begrenzt). ?after=<id> für Keyset-Paginierung bei nach created_at sortierten Listen, ?offset= für Offset-Paginierung.

curl -H "Authorization: Bearer pat_…" \
     "https://ki-bewerber-management.de/xapi2/data/email_import_log?limit=20"
GET/xapi2/data/email_import_log/{id}email_import_log:read

Einzelnes Objekt lesen

Liefert das Objekt anhand der ID. 404, falls es nicht existiert oder du keinen Lese-Zugriff hast (beide Fälle sind bewusst zusammengelegt).

curl -H "Authorization: Bearer pat_…" \
     https://ki-bewerber-management.de/xapi2/data/email_import_log/OBJECT_ID
POST/xapi2/data/email_import_logemail_import_log:create

Erstellen

Erstellt ein neues Objekt. Der Body ist ein flaches JSON-Dict mit Feldwerten. Server-seitige Felder (id, Zeitstempel, Ownership) werden automatisch gefüllt; nur die unten als anlegbar gelisteten Felder werden aus dem Body übernommen.

curl -H "Authorization: Bearer pat_…" \
     -H "Content-Type: application/json" \
     -X POST https://ki-bewerber-management.de/xapi2/data/email_import_log \
     -d '{"name": "…"}'

In der CLI

Dieselben Endpunkte sind auch über die KI BMS CLI verfügbar. Für Skripte, CI und Bulk-Imports ist sie meist die schnellere Wahl.

atscli email_import_log list --limit 5
atscli email_import_log get <id>
atscli email_import_log create --email-inbox-id "Hello"
atscli email_import_log schema   # Felder & Limits

Volle Befehlsreferenz, Profile, CSV-Import, Auto-Retry, NDJSON-Streaming → /docs/cli