Datenmodell

Dateien

Eine Datei im Förderantrag. kind=doc enthält rohen LaTeX im content-Feld (Editor zeigt lesbaren Text; is_root=true markiert den Kompilierungs-Einstiegspunkt). kind=asset referenziert hochgeladene Binärdaten via blob_id (Bilder, .bib-Dateien, PDFs).

Modellname: file

Endpunkte: 5

Max. Seitengröße: 500

Felder

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

Feld	Typ	Regeln
doc	`dict`	-
kind	`enum`	enum`doc \| asset`
name	`string`	max. Länge`300`
blob_id	`string`	max. Länge`64`
content	`string`	max. Länge`200000`
eval_at	`number`	-
is_root	`bool`	-
grant_id	`string`	max. Länge`64`ref →`grant`
eval_hash	`string`	max. Länge`64`
folder_id	`string`	max. Länge`64`
mime_type	`string`	max. Länge`120`
eval_tasks	`list`	-
size_bytes	`number`	-
sort_order	`number`	-
ai_messages	`list`	-
eval_result	`dict`	-
chapter_type	`string`	max. Länge`64`
chapter_answers	`dict`	-

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
doc	dict
kind	enum
name	string
blob_id	string
content	string
eval_at	number
is_root	bool
grant_id	string
eval_hash	string
folder_id	string
mime_type	string
eval_tasks	list
size_bytes	number
sort_order	number
ai_messages	list
eval_result	dict
chapter_type	string
chapter_answers	dict
import_status	-
import_gaps	-
import_at	-

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

grant_iddata__grant_id

folder_iddata__folder_id

kinddata__kind

is_rootdata__is_root

mime_typedata__mime_type

statusstatus

owned_byowned_by

Sortier-Keys

namedata__name

sort_orderdata__sort_order

kinddata__kind

created_atcreated_at

updated_atupdated_at

Standard: sort_order

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/filefile: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://granttool.de/xapi2/data/file?limit=20"

GET/xapi2/data/file/{id}file: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://granttool.de/xapi2/data/file/OBJECT_ID

POST/xapi2/data/filefile: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://granttool.de/xapi2/data/file \
     -d '{"name": "…"}'

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

DELETE/xapi2/data/file/{id}file: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://granttool.de/xapi2/data/file/OBJECT_ID

In der CLI

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

grantscli file list --limit 5
grantscli file get <id>
grantscli file create --name "Hello"
grantscli file upsert --unique name --csv items.csv
grantscli file schema   # Felder & Limits

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