Datenmodell

Abgeleitete Dokumente

Aus dem Antrag erzeugtes Dokument - Pitch-Deck, Exec-Summary, Finanzplan-Excel, Klärungsbrief, ... Wird separat geführt, damit es als 'veraltet' markiert werden kann, wenn der Antrag bumpt.

Modellname: derived_doc

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
kind	`string`	max. Länge`64`
status	`enum`	enum`missing \| generating \| fresh \| stale`
formats	`list`	-
grant_id	`string`	max. Länge`64`ref →`grant`
latest_format	`string`	max. Länge`32`
latest_blob_id	`string`	max. Länge`64`
based_on_version	`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
kind	string
status	enum
formats	list
grant_id	string
latest_format	string
latest_blob_id	string
based_on_version	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

grant_iddata__grant_id

kinddata__kind

statusdata__status

statusstatus

is_archivedis_archived

owned_byowned_by

Sortier-Keys

created_atcreated_at

updated_atupdated_at

kinddata__kind

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/derived_docderived_doc: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/derived_doc?limit=20"

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

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

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

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

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