Commands — fim-portal-cli

Option	Description	Default
`-V, --version`	output the version number
`--base-url <url>`	API base URL (http/https only)	`https://fimportal.de`
`--timeout <ms>`	per-request timeout in milliseconds
`--user-agent <ua>`	User-Agent header value
`--max-retries <n>`	retries for transient 429/503 responses
`--max-response-bytes <n>`	cap response body size in bytes (0 = unlimited; default 100 MiB)
`--compact`	print JSON on a single line instead of pretty-printed
`-o, --output <file>`	for downloads: write bytes to this file instead of stdout

`fim-portal schemas`

Datenschemata (XDatenfelder)

`fim-portal schemas search`

Search/filter Datenschemata

fim-portal schemas search [options]

Options

Option	Description	Default
`--bezug-unterelemente <text>`	filter by Bezug of sub-elements
`--bezeichnung <text>`	filter by Bezeichnung
`--stichwort <text>`	filter by Stichwort (XDF3 only)
`--suche-nur-in <module>`	restrict full-text search to a module Choices: Rechtsgrundlagen, Status_gesetzt_durch, Versionshinweis, Stichwort
`--name <name>`	filter by name
`--nummernkreis <nk>`	filter by Nummernkreis (repeatable, prefix match)
`--freigabe-status <code>`	filter by Freigabestatus 1..8 (repeatable)
`--gueltig-am <date>`	only entries valid on this date (YYYY-MM-DD)
`--status-gesetzt-durch <who>`	filter by status author
`--status-gesetzt-seit <date>`	status set on/after this date
`--status-gesetzt-bis <date>`	status set on/before this date
`--bezug <text>`	filter by Bezug
`--versionshinweis <text>`	filter by Versionshinweis
`--updated-since <iso>`	filter by last-update timestamp (ISO-8601)
`--xdf-version <v>`	filter by XDatenfelder version Choices: 2.0, 2.0.0, 3.0.0
`--fts-query <q>`	full-text search query
`--is-latest`	only results that are the latest version of their kind
`--order-by <order>`	result order Choices: geaendert_datum_zeit_desc, geaendert_datum_zeit_asc, name_asc, name_desc, id_asc, id_desc
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..200)

`fim-portal schemas versions`

List all versions of a schema

fim-portal schemas versions [options] <fimId>

Arguments

<fimId> required

`fim-portal schemas get`

Get a full schema (version defaults to 'latest')

fim-portal schemas get [options] <fimId> [fimVersion]

Arguments

<fimId> required
[fimVersion] optional

`fim-portal schemas xdf`

Download the XDatenfelder XML for a schema

fim-portal schemas xdf [options] <fimId> [fimVersion]

Arguments

<fimId> required
[fimVersion] optional

`fim-portal schemas quality-report`

Get the quality report for a schema

fim-portal schemas quality-report [options] <fimId> [fimVersion]

Arguments

<fimId> required
[fimVersion] optional

`fim-portal document-profiles`

Dokumentsteckbriefe (document profiles)

`fim-portal document-profiles search`

Search/filter document profiles

fim-portal document-profiles search [options]

Options

Option	Description	Default
`--name <name>`	filter by name
`--nummernkreis <nk>`	filter by Nummernkreis (repeatable, prefix match)
`--freigabe-status <code>`	filter by Freigabestatus 1..8 (repeatable)
`--status-gesetzt-durch <who>`	filter by status author
`--status-gesetzt-seit <date>`	status set on/after this date
`--status-gesetzt-bis <date>`	status set on/before this date
`--bezeichnung <text>`	filter by Bezeichnung
`--dokumentart <code>`	filter by Dokumentart Choices: 001, 002, 003, 004, 005, 006, 007, 008, 009, 010, 011, 012, 013, 014, 999
`--bezug <text>`	filter by Bezug
`--fts-query <q>`	full-text search query
`--suche-nur-in <module>`	restrict full-text search to a module Choices: Rechtsgrundlagen, Status_gesetzt_durch, Versionshinweis
`--versionshinweis <text>`	filter by Versionshinweis
`--updated-since <iso>`	filter by last-update timestamp (ISO-8601)
`--xdf-version <v>`	filter by XDatenfelder version Choices: 2.0, 2.0.0, 3.0.0
`--stichwort <text>`	filter by Stichwort (XDF3 only)
`--is-latest`	only the latest version of each kind
`--order-by <order>`	result order Choices: geaendert_datum_zeit_desc, geaendert_datum_zeit_asc, name_asc, name_desc, id_asc, id_desc
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..200)

`fim-portal document-profiles versions`

List all versions of a document profile

fim-portal document-profiles versions [options] <fimId>

Arguments

<fimId> required

`fim-portal document-profiles get`

Get a single document profile (version defaults to 'latest')

fim-portal document-profiles get [options] <fimId> [fimVersion]

Arguments

<fimId> required
[fimVersion] optional

`fim-portal document-profiles xdf`

Download the XDatenfelder XML for a document profile

fim-portal document-profiles xdf [options] <fimId> [fimVersion]

Arguments

<fimId> required
[fimVersion] optional

`fim-portal fields`

Datenfelder (data fields)

`fim-portal fields search`

Search/filter data fields

fim-portal fields search [options]

Options

Option	Description	Default
`--suche-nur-in <module>`	restrict full-text search to a module Choices: Rechtsgrundlagen, Status_gesetzt_durch, Versionshinweis
`--feldart <art>`	filter by Feldart Choices: input, select, label, hidden, locked
`--datentyp <typ>`	filter by Datentyp Choices: text, text_latin, date, time, datetime, bool, num, num_int, num_currency, file, obj
`--name <name>`	filter by name
`--nummernkreis <nk>`	filter by Nummernkreis (repeatable, prefix match)
`--freigabe-status <code>`	filter by Freigabestatus 1..8 (repeatable)
`--gueltig-am <date>`	only entries valid on this date (YYYY-MM-DD)
`--status-gesetzt-durch <who>`	filter by status author
`--status-gesetzt-seit <date>`	status set on/after this date
`--status-gesetzt-bis <date>`	status set on/before this date
`--bezug <text>`	filter by Bezug
`--versionshinweis <text>`	filter by Versionshinweis
`--updated-since <iso>`	filter by last-update timestamp (ISO-8601)
`--xdf-version <v>`	filter by XDatenfelder version Choices: 2.0, 2.0.0, 3.0.0
`--fts-query <q>`	full-text search query
`--is-latest`	only results that are the latest version of their kind
`--order-by <order>`	result order Choices: geaendert_datum_zeit_desc, geaendert_datum_zeit_asc, name_asc, name_desc, id_asc, id_desc
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..200)

`fim-portal fields versions`

List all versions of a data field

fim-portal fields versions [options] <namespace> <fimId>

Arguments

<namespace> required
<fimId> required

`fim-portal fields get`

Get a single data field (version defaults to 'latest')

fim-portal fields get [options] <namespace> <fimId> [fimVersion]

Arguments

<namespace> required
<fimId> required
[fimVersion] optional

`fim-portal fields xdf`

Download the XDatenfelder XML for a data field

fim-portal fields xdf [options] <namespace> <fimId> [fimVersion]

Arguments

<namespace> required
<fimId> required
[fimVersion] optional

`fim-portal groups`

Datenfeldgruppen (data groups)

`fim-portal groups search`

Search/filter data groups

fim-portal groups search [options]

Options

Option	Description	Default
`--suche-nur-in <module>`	restrict full-text search to a module Choices: Rechtsgrundlagen, Status_gesetzt_durch, Versionshinweis
`--name <name>`	filter by name
`--nummernkreis <nk>`	filter by Nummernkreis (repeatable, prefix match)
`--freigabe-status <code>`	filter by Freigabestatus 1..8 (repeatable)
`--gueltig-am <date>`	only entries valid on this date (YYYY-MM-DD)
`--status-gesetzt-durch <who>`	filter by status author
`--status-gesetzt-seit <date>`	status set on/after this date
`--status-gesetzt-bis <date>`	status set on/before this date
`--bezug <text>`	filter by Bezug
`--versionshinweis <text>`	filter by Versionshinweis
`--updated-since <iso>`	filter by last-update timestamp (ISO-8601)
`--xdf-version <v>`	filter by XDatenfelder version Choices: 2.0, 2.0.0, 3.0.0
`--fts-query <q>`	full-text search query
`--is-latest`	only results that are the latest version of their kind
`--order-by <order>`	result order Choices: geaendert_datum_zeit_desc, geaendert_datum_zeit_asc, name_asc, name_desc, id_asc, id_desc
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..200)

`fim-portal groups versions`

List all versions of a data group

fim-portal groups versions [options] <namespace> <fimId>

Arguments

<namespace> required
<fimId> required

`fim-portal groups get`

Get a single data group (version defaults to 'latest')

fim-portal groups get [options] <namespace> <fimId> [fimVersion]

Arguments

<namespace> required
<fimId> required
[fimVersion] optional

`fim-portal groups xdf`

Download the XDatenfelder XML for a data group

fim-portal groups xdf [options] <namespace> <fimId> [fimVersion]

Arguments

<namespace> required
<fimId> required
[fimVersion] optional

`fim-portal service-profiles`

Leistungsteckbriefe (XZuFi service descriptions)

`fim-portal service-profiles search`

Search/filter Leistungsteckbriefe

fim-portal service-profiles search [options]

Options

Option	Description	Default
`--leistungstyp <typ>`	filter by Leistungstyp (repeatable)
`--typisierung <t>`	filter by Typisierung (repeatable)
`--fts-query <q>`	full-text search query
`--suche-nur-in <module>`	restrict full-text search Choices: leistungsschluessel, rechtsgrundlagen, leistungsbezeichnung, leistungsbezeichnung_II, ozg_id
`--title <text>`	filter by title
`--leistungsbezeichnung <text>`	filter by Leistungsbezeichnung
`--leistungsbezeichnung2 <text>`	filter by Leistungsbezeichnung II
`--leistungsschluessel <key>`	filter by Leistungsschluessel
`--rechtsgrundlagen <text>`	filter by Rechtsgrundlagen
`--freigabe-status <code>`	filter by Freigabestatus 1..8 (repeatable)
`--einheitlicher-ansprechpartner`	only services with Einheitlicher Ansprechpartner
`--updated-since <iso>`	filter by last-update timestamp (ISO-8601)
`--sdg <code>`	filter by SDG information area (repeatable)
`--sdg-relevant`	only SDG-relevant services
`--sprache <lang>`	filter by language Choices: Deutsch, Deutsch (leichte Sprache), Englisch, Polnisch, Sorbisch, Ukrainisch, Französisch
`--leistungsadressat <code>`	filter by Leistungsadressat (repeatable)
`--ozg-themenfeld <field>`	filter by OZG Themenfeld (repeatable)
`--ozg-id <id>`	filter by OZG id
`--vollzugsbehoerde <code>`	filter by Vollzugsbehoerde Choices: BAMF, BLE, DRV
`--lagen-portalverbund <text>`	filter by Lagen (Portalverbund)
`--order-by <order>`	result order Choices: erstellt_datum_zeit_desc, erstellt_datum_zeit_asc, geaendert_datum_zeit_desc, geaendert_datum_zeit_asc, titel_asc, leistungsschluessel_asc, relevance
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..200)

`fim-portal service-profiles get`

Get a single Leistungsteckbrief

fim-portal service-profiles get [options] <leistungsschluessel>

Arguments

<leistungsschluessel> required

`fim-portal service-profiles xzufi`

Download the XZuFi XML for a Leistungsteckbrief

fim-portal service-profiles xzufi [options] <leistungsschluessel>

Arguments

<leistungsschluessel> required

`fim-portal service-profiles pdf`

Export a Leistungsteckbrief as PDF

fim-portal service-profiles pdf [options] <leistungsschluessel> <languageCode>

Arguments

<leistungsschluessel> required
<languageCode> required

`fim-portal service-texts`

Leistungsstammtexte (XZuFi service master texts)

`fim-portal service-texts search`

Search/filter Leistungsstammtexte

fim-portal service-texts search [options]

Options

Option	Description	Default
`--leistungsschluessel <key>`	filter by Leistungsschluessel
`--redaktion-id <id>`	filter by Redaktion id
`--title <text>`	filter by title
`--leistungsbezeichnung <text>`	filter by Leistungsbezeichnung
`--leistungsbezeichnung2 <text>`	filter by Leistungsbezeichnung II
`--rechtsgrundlagen <text>`	filter by Rechtsgrundlagen
`--leistungstyp <typ>`	filter by Leistungstyp (repeatable)
`--typisierung <t>`	filter by Typisierung (repeatable)
`--updated-since <iso>`	filter by last-update timestamp (ISO-8601)
`--leistungsadressat <code>`	filter by Leistungsadressat (repeatable)
`--ozg-themenfeld <field>`	filter by OZG Themenfeld (repeatable)
`--ozg-id <id>`	filter by OZG id
`--vollzugsbehoerde <code>`	filter by Vollzugsbehoerde Choices: BAMF, BLE, DRV
`--einheitlicher-ansprechpartner`	only services with Einheitlicher Ansprechpartner
`--source <src>`	filter by XZuFi source Choices: leika, landesredaktion, pvog
`--fts-query <q>`	full-text search query
`--suche-nur-in <module>`	restrict full-text search Choices: leistungsschluessel, rechtsgrundlagen, leistungsbezeichnung, leistungsbezeichnung_II, ozg_id
`--lagen-portalverbund <text>`	filter by Lagen (Portalverbund)
`--order-by <order>`	result order Choices: relevance, erstellt_datum_zeit_desc, erstellt_datum_zeit_asc, geaendert_datum_zeit_desc, geaendert_datum_zeit_asc, titel_asc
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..200)

`fim-portal service-texts get`

Get a single Leistungsstammtext (source: leika|landesredaktion|pvog)

fim-portal service-texts get [options] <redaktionId> <leistungId> <source>

Arguments

<redaktionId> required
<leistungId> required
<source> required

`fim-portal service-texts xzufi`

Download the XZuFi XML for a Leistungsstammtext

fim-portal service-texts xzufi [options] <redaktionId> <leistungId> <source>

Arguments

<redaktionId> required
<leistungId> required
<source> required

`fim-portal service-texts pdf`

Export a Leistungsstammtext as PDF

fim-portal service-texts pdf [options] <redaktionId> <leistungId> <source> <languageCode>

Arguments

<redaktionId> required
<leistungId> required
<source> required
<languageCode> required

`fim-portal service-texts parsed-xzufi`

Get the parsed XZuFi JSON (INSTABLE per API docs)

fim-portal service-texts parsed-xzufi [options] <redaktionId> <leistungId> <source>

Arguments

<redaktionId> required
<leistungId> required
<source> required

`fim-portal organizational-units`

Organisationseinheiten (XZuFi)

`fim-portal organizational-units list`

List organizational-units (cursor paginated)

fim-portal organizational-units list [options]

Options

Option	Description	Default
`--cursor <n>`	pagination cursor (>= 0)
`--limit <n>`	max number of results (1..200)

`fim-portal organizational-units xzufi`

Download the XZuFi XML for a organizational-units entity

fim-portal organizational-units xzufi [options] <redaktionId> <id>

Arguments

<redaktionId> required
<id> required

`fim-portal specializations`

Spezialisierungen (XZuFi)

`fim-portal specializations list`

List specializations (cursor paginated)

fim-portal specializations list [options]

Options

Option	Description	Default
`--cursor <n>`	pagination cursor (>= 0)
`--limit <n>`	max number of results (1..200)

`fim-portal specializations xzufi`

Download the XZuFi XML for a specializations entity

fim-portal specializations xzufi [options] <redaktionId> <id>

Arguments

<redaktionId> required
<id> required

`fim-portal online-services`

Onlinedienste (XZuFi)

`fim-portal online-services list`

List online-services (cursor paginated)

fim-portal online-services list [options]

Options

Option	Description	Default
`--cursor <n>`	pagination cursor (>= 0)
`--limit <n>`	max number of results (1..200)

`fim-portal online-services xzufi`

Download the XZuFi XML for a online-services entity

fim-portal online-services xzufi [options] <redaktionId> <id>

Arguments

<redaktionId> required
<id> required

`fim-portal process-classes`

Prozessklassen (XProzess)

`fim-portal process-classes search`

Search/filter process classes

fim-portal process-classes search [options]

Options

Option	Description	Default
`--fts-query <q>`	full-text search query
`--freigabe-status <code>`	filter by Freigabestatus 1..8 (repeatable)
`--operatives-ziel <code>`	filter by Operatives Ziel Choices: 101, 201, 202, 203, 204, 205, 206, 207, 208, 311, 312, 313, 314, 321, 401, 501, 601, 602, 999
`--verfahrensart <code>`	filter by Verfahrensart Choices: 101, 111, 121, 201, 221, 222, 231, 301, 302, 303, 304, 311, 312, 321, 322, 331, 332, 333, 334, 341, 361, 401, 421, 422, 403, 441, 451, 461, 501, 503, 541, 561, 801, 831, 832, 833, 834, 841, 842, 843, 844, 851, 852, 853, 854, 861, 871, 911, 912, 921, 998, 999
`--handlungsform <code>`	filter by Handlungsform Choices: 101, 102, 103, 104, 105, 111, 112, 113, 114, 115, 121, 201, 202, 203, 204, 205, 210, 221, 222, 301, 302, 303, 304, 305, 310, 410, 420, 430, 450, 801, 802, 803, 804, 805, 806, 999
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..200)

`fim-portal process-classes get`

Get a specific process class

fim-portal process-classes get [options] <id> <version>

Arguments

<id> required
<version> required

`fim-portal process-classes xprozess`

Get the XProzess representation of a process class (JSON)

fim-portal process-classes xprozess [options] <id> <version>

Arguments

<id> required
<version> required

`fim-portal processes`

Prozesse (XProzess)

`fim-portal processes search`

Search/filter processes

fim-portal processes search [options]

Options

Option	Description	Default
`--freigabe-status <code>`	filter by Freigabestatus 1..8 (repeatable)
`--detaillierungsstufe <code>`	filter by Detaillierungsstufe Choices: 101, 102, 103, 104, 105
`--anwendungsgebiet <code>`	filter by Anwendungsgebiet Choices: 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12, 13, 14, 15, 16, 17
`--is-musterprozess`	only Musterprozesse
`--fts-query <q>`	full-text search query
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..200)

`fim-portal processes get`

Get a specific process (stufe: 101..105)

fim-portal processes get [options] <id> <version> <stufe>

Arguments

<id> required
<version> required
<stufe> required

`fim-portal processes xprozess`

Download the XProzess XML for a process

fim-portal processes xprozess [options] <id> <version> <stufe>

Arguments

<id> required
<version> required
<stufe> required

`fim-portal processes report`

Download the report PDF for a process

fim-portal processes report [options] <id> <version> <stufe>

Arguments

<id> required
<version> required
<stufe> required

`fim-portal processes visualization`

Download the visualization PDF for a process

fim-portal processes visualization [options] <id> <version> <stufe>

Arguments

<id> required
<version> required
<stufe> required

`fim-portal processes visualization-display`

Download the display visualization PDF for a process

fim-portal processes visualization-display [options] <id> <version> <stufe>

Arguments

<id> required
<version> required
<stufe> required

`fim-portal code-lists`

List the code lists referenced by data fields

fim-portal code-lists [options]

Options

Option	Description	Default
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..200)

`fim-portal search-csv`

Download a search result as CSV (tools/search-csv-download)

fim-portal search-csv [options]

Options

Option	Description	Default
`--resource <name>` required	resource to export (e.g. schemas, fields, groups, steckbriefe, leistungen, processes)
`--term <text>`	search term
`--xdf-version <v>`	XDatenfelder version
`--order-by <order>`	result order
`--feldart <art>`	filter by Feldart
`--datentyp <typ>`	filter by Datentyp
`--dokumentart <code>`	filter by Dokumentart
`--sprache <lang>`	filter by language

Global options