Datenmodell

Angebote

Angebotsschreiben zu einer Bewerbung. Trägt Bruttogehalt, Bonus, Eintrittsdatum, Befristung, Status (Entwurf / Versendet / Akzeptiert / Abgelehnt / Zurückgezogen).

Modellname: offer

Endpunkte: 5

Max. Seitengröße: 100

Felder

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

Feld	Typ	Regeln
term	`enum`
bonus	`number`	-
job_id	`string`	max. Länge`64`
status	`enum`	enum`draft \| sent \| accepted \| declined \| withdrawn \| expired`
sent_at	`string`	max. Länge`32`
currency	`string`	max. Länge`8`
bonus_note	`string`	max. Länge`600`
decided_at	`string`	max. Länge`32`
expires_at	`string`	max. Länge`32`
start_date	`string`	max. Länge`32`
term_until	`string`	max. Länge`32`
letter_body	`string`	max. Länge`16000`
candidate_id	`string`	max. Länge`64`
salary_gross	`number`	-
weekly_hours	`number`	-
remote_policy	`string`	max. Länge`200`
salary_period	`enum`	enum`yearly \| monthly \| daily \| hourly`
vacation_days	`number`	-
application_id	`string`	max. Länge`64`ref →`application`
decline_reason	`string`	max. Länge`600`
letter_blob_id	`string`	max. Länge`64`

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.

Feld	Typ	Anlegbar	Änderbar
term	enum
bonus	number
job_id	string
status	enum
sent_at	string
currency	string
bonus_note	string
decided_at	string
expires_at	string
start_date	string
term_until	string
letter_body	string
candidate_id	string
salary_gross	number
weekly_hours	number
remote_policy	string
salary_period	enum
vacation_days	number
application_id	string
decline_reason	string
letter_blob_id	string

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

application_iddata__application_id

candidate_iddata__candidate_id

job_iddata__job_id

statusdata__status

currencydata__currency

statusstatus

is_archived

owned_byowned_by

created_bycreated_by

Sortier-Keys

created_atcreated_at

start_datedata__start_date

sent_atdata__sent_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/offeroffer: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://www.ki-bewerber-management.de/xapi2/data/offer?limit=20"

GET/xapi2/data/offer/{id}offer: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://www.ki-bewerber-management.de/xapi2/data/offer/OBJECT_ID

POST/xapi2/data/offeroffer: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://www.ki-bewerber-management.de/xapi2/data/offer \
     -d '{"name": "…"}'

PATCH/xapi2/data/offer/{id}offer:update

Aktualisieren

Teilweise Aktualisierung. Nur Felder im Body werden verändert; alles andere bleibt erhalten. Gleiche Erlaubnisliste wie bei Create, abzüglich der nach dem Anlegen unveränderlichen Felder.

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

DELETE/xapi2/data/offer/{id}offer:delete

Löschen

Entfernt das Objekt. Es verschwindet sofort aus allen Standard-Listen und wird von read / list nicht mehr zurückgegeben.

curl -H "Authorization: Bearer pat_…" \
     -X DELETE https://www.ki-bewerber-management.de/xapi2/data/offer/OBJECT_ID

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 offer list --limit 5
atscli offer get <id>
atscli offer create --application-id "Hello"
atscli offer upsert --unique application_id --csv items.csv
atscli offer schema   # Felder & Limits

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