Datenmodell

Förderanträge

Arbeitsbereich für einen Förderantrag. Enthält den Dateibaum und Metadaten zu Förderer, Programm und Einreichungsstatus.

Modellname: grant

Endpunkte: 5

Max. Seitengröße: 200

Felder

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

Feld	Typ	Regeln
tags	`tags`	-
color	`string`	max. Länge`24`
notes	`string`	max. Länge`4000`
title	`string`	max. Länge`300`
status	`enum`	enum`drafting \| submitted \| under_review \| awarded \| rejected \| abandoned`
program	`string`	max. Länge`200`
currency	`string`	max. Länge`8`
deadline	`string`	max. Länge`32`
team_size	`number`	-
description	`string`	max. Länge`2000`
root_file_id	`string`	max. Länge`64`
grant_type_key	`string`	max. Länge`64`
requested_amount	`number`	-

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
tags	tags
color	string
notes	string
title	string
status	enum
program	string
currency	string
deadline	string
team_size	number
description	string
root_file_id	string
grant_type_key	string
requested_amount	number
funder	-
compiler	-
intake_blob_id	-
intake_url	-
intake_extracted	-
import_status	-
import_started_at	-
import_finished_at	-
intake_extracted_by_source	-
intake_sources	-
awarded_amount	-
awarded_at	-
profile	-
baseline_score	-
spellcheck_language_override	-
spellcheck_whitelist	-
spellcheck_disabled_rules	-

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

funderdata__funder

tagsdata__tags

deadlinedata__deadline

grant_type_keydata__grant_type_key

statusstatus

is_archivedis_archived

owned_byowned_by

Sortier-Keys

created_atcreated_at

updated_atupdated_at

titledata__title

deadlinedata__deadline

statusdata__status

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/grantgrant: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/grant?limit=20"

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

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

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

DELETE/xapi2/data/grant/{id}grant: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/grant/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 grant list --limit 5
grantscli grant get <id>
grantscli grant create --grant-type-key "Hello"
grantscli grant upsert --unique grant_type_key --csv items.csv
grantscli grant schema   # Felder & Limits

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