manage_export
List available genealogy exporters, inspect their options, or generate export files such as GEDCOM or Gramps XML. Run exports synchronously or asynchronously with configurable filters.
Instructions
List exporters or produce an export file (GEDCOM, Gramps XML...). Writes: run.
action=list returns every available exporter (GET /exporters/);
action=info describes one exporter (GET /exporters/);
action=run starts an asynchronous export (POST /exporters//file)
and returns a task reference (poll with manage_transaction or re-call to
fetch); action=file runs a synchronous export (GET /exporters//file)
and returns the file as base64. Exports run on the whole tree unless
filtered; pass options as a dict of query params: compress, living
(IncludeAll/FullNameOnly/LastNameOnly/ReplaceCompleteName/ExcludeAll),
private, person, event, note, reference, sequence, handle, gramps_id,
years_after_death, current_year, locale, include_individuals,
include_children, include_marriages, include_places, include_media,
include_witnesses, translate_headers. Extensions: ged, gramps, gw, csv, etc.
Args: action: "list", "info", "run" or "file". extension: Exporter extension (e.g. 'ged' or 'gramps'); required for info, run, file. options: Dict of export option query parameters (see docstring). instance: Gramps Web base URL from get_instances; default = first.
Returns: dict: {"status", "url", "data": exporter list, task ref, or base64 file}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| action | Yes | ||
| options | No | ||
| instance | No | ||
| extension | No |