Datenmodell

Unternehmensprofil

Branding, Datenschutz und Karriereseiten-Einstellungen für diese Tenant - genau eine Zeile pro App.

Modellname: company_profile

Endpunkte: 5

Max. Seitengröße: 5

Felder

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

Feld	Typ	Regeln
name	`string`
size	`enum`	enum`1-10 \| 11-50 \| 51-200 \| 201-500 \| 500+`
summary	`string`	max. Länge`4000`
website	`url`	max. Länge`2048`
industry	`string`	max. Länge`200`
logo_url	`string`	max. Länge`1500000`
banner_url	`string`	max. Länge`2500000`
show_about	`bool`	-
imprint_url	`url`	max. Länge`2048`
privacy_url	`url`	max. Länge`2048`
accent_color	`string`	max. Länge`16`
display_name	`string`	max. Länge`200`
main_location	`string`	max. Länge`200`
retention_unit	`enum`	enum`weeks \| months \| years`
retention_value	`number`	-
show_other_jobs	`bool`	-
public_careers_enabled	`bool`	-

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
name	string
size	enum
summary	string
website	url
industry	string
logo_url	string
banner_url	string
show_about	bool
imprint_url	url
privacy_url	url
accent_color	string
display_name	string
main_location	string
retention_unit	enum
retention_value	number
show_other_jobs	bool
public_careers_enabled	bool

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

statusstatus

is_archivedis_archived

owned_byowned_by

created_bycreated_by

Sortier-Keys

created_atcreated_at

updated_atupdated_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/company_profilecompany_profile: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/company_profile?limit=20"

GET/xapi2/data/company_profile/{id}company_profile: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/company_profile/OBJECT_ID

POST/xapi2/data/company_profilecompany_profile: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/company_profile \
     -d '{"name": "…"}'

PATCH/xapi2/data/company_profile/{id}company_profile: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://ki-bewerber-management.de/xapi2/data/company_profile/OBJECT_ID \
     -d '{"name": "…"}'

DELETE/xapi2/data/company_profile/{id}company_profile: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://ki-bewerber-management.de/xapi2/data/company_profile/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 company_profile list --limit 5
atscli company_profile get <id>
atscli company_profile create --name "Hello"
atscli company_profile upsert --unique name --csv items.csv
atscli company_profile schema   # Felder & Limits

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