Befehle

Alle Befehle, Argumente und Optionen von fim-portal 0.6.2, direkt aus der CLI gelesen.

Die Beschreibungen der Befehle, Argumente und Optionen stammen direkt aus der CLI und sind englisch.

Globale Optionen

Diese Optionen gelten für jeden Befehl.

OptionBeschreibungStandard
-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 and connection resets (0..10; each waits the server's Retry-After, up to 30 s)
--max-response-bytes <n> cap response body size in bytes (0 = unlimited; default 100 MiB)
--log-format <format> how errors, warnings and notes are written to stderr: text (log4j style: time, level, [topic], message) or jsonl (one JSON object per line: ts, level, topic, msg); default text
--compact print JSON on a single line instead of pretty-printed
-o, --output <file> for downloads: write bytes to this file instead of stdout ("-" = stdout)

fim-portal schemas

Datenschemata (XDatenfelder)

fim-portal schemas versions

List all versions of a schema

fim-portal schemas versions [options] <fimId>

Argumente

<fimId> erforderlich
FIM id (e.g. S07000009)

fim-portal schemas get

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

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

Argumente

<fimId> erforderlich
FIM id (e.g. S07000009)
[fimVersion] optional
FIM version (default: latest)

fim-portal schemas xdf

Download the XDatenfelder XML for a schema

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

Argumente

<fimId> erforderlich
FIM id (e.g. S07000009)
[fimVersion] optional
FIM version (default: latest)

fim-portal schemas quality-report

Get the quality report for a schema

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

Argumente

<fimId> erforderlich
FIM id (e.g. S07000009)
[fimVersion] optional
FIM version (default: latest)

fim-portal document-profiles

Dokumentsteckbriefe (document profiles)

fim-portal document-profiles versions

List all versions of a document profile

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

Argumente

<fimId> erforderlich
FIM id (e.g. S07000009)

fim-portal document-profiles get

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

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

Argumente

<fimId> erforderlich
FIM id (e.g. S07000009)
[fimVersion] optional
FIM version (default: latest)

fim-portal document-profiles xdf

Download the XDatenfelder XML for a document profile

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

Argumente

<fimId> erforderlich
FIM id (e.g. S07000009)
[fimVersion] optional
FIM version (default: latest)

fim-portal fields

Datenfelder (data fields)

fim-portal fields versions

List all versions of a data field

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

Argumente

<namespace> erforderlich
namespace of the element
<fimId> erforderlich
FIM id (e.g. S07000009)

fim-portal fields get

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

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

Argumente

<namespace> erforderlich
namespace of the element
<fimId> erforderlich
FIM id (e.g. S07000009)
[fimVersion] optional
FIM version (default: latest)

fim-portal fields xdf

Download the XDatenfelder XML for a data field

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

Argumente

<namespace> erforderlich
namespace of the element
<fimId> erforderlich
FIM id (e.g. S07000009)
[fimVersion] optional
FIM version (default: latest)

fim-portal groups

Datenfeldgruppen (data groups)

fim-portal groups versions

List all versions of a data group

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

Argumente

<namespace> erforderlich
namespace of the element
<fimId> erforderlich
FIM id (e.g. S07000009)

fim-portal groups get

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

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

Argumente

<namespace> erforderlich
namespace of the element
<fimId> erforderlich
FIM id (e.g. S07000009)
[fimVersion] optional
FIM version (default: latest)

fim-portal groups xdf

Download the XDatenfelder XML for a data group

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

Argumente

<namespace> erforderlich
namespace of the element
<fimId> erforderlich
FIM id (e.g. S07000009)
[fimVersion] optional
FIM version (default: latest)

fim-portal service-profiles

Leistungsteckbriefe (XZuFi service descriptions)

fim-portal service-profiles get

Get a single Leistungsteckbrief

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

Argumente

<leistungsschluessel> erforderlich
Leistungsschluessel (LeiKa key)

fim-portal service-profiles xzufi

Download the XZuFi XML for a Leistungsteckbrief

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

Argumente

<leistungsschluessel> erforderlich
Leistungsschluessel (LeiKa key)

fim-portal service-profiles pdf

Export a Leistungsteckbrief as PDF

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

Argumente

<leistungsschluessel> erforderlich
Leistungsschluessel (LeiKa key)
<languageCode> erforderlich
language code of the PDF (e.g. de-DE)

fim-portal service-texts

Leistungsstammtexte (XZuFi service master texts)

fim-portal service-texts get

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

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

Argumente

<redaktionId> erforderlich
Redaktion id
<leistungId> erforderlich
Leistung id
<source> erforderlich
XZuFi source (leika|landesredaktion|pvog)

fim-portal service-texts xzufi

Download the XZuFi XML for a Leistungsstammtext

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

Argumente

<redaktionId> erforderlich
Redaktion id
<leistungId> erforderlich
Leistung id
<source> erforderlich
XZuFi source (leika|landesredaktion|pvog)

fim-portal service-texts pdf

Export a Leistungsstammtext as PDF

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

Argumente

<redaktionId> erforderlich
Redaktion id
<leistungId> erforderlich
Leistung id
<source> erforderlich
XZuFi source (leika|landesredaktion|pvog)
<languageCode> erforderlich
language code of the PDF (depends on the source: de-DE for leika, de or en for pvog)

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>

Argumente

<redaktionId> erforderlich
Redaktion id
<leistungId> erforderlich
Leistung id
<source> erforderlich
XZuFi source (leika|landesredaktion|pvog)

fim-portal organizational-units

Organisationseinheiten (XZuFi)

fim-portal organizational-units list

List organizational-units (cursor paginated)

fim-portal organizational-units list [options]

Optionen

OptionBeschreibungStandard
--cursor <n> pagination cursor (>= 0)
--limit <n> max number of results (1..200)
--fts-query <q> full-text search query

fim-portal organizational-units xzufi

Download the XZuFi XML for a organizational-units entity

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

Argumente

<redaktionId> erforderlich
Redaktion id
<id> erforderlich
entity id

fim-portal specializations

Spezialisierungen (XZuFi)

fim-portal specializations list

List specializations (cursor paginated)

fim-portal specializations list [options]

Optionen

OptionBeschreibungStandard
--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>

Argumente

<redaktionId> erforderlich
Redaktion id
<id> erforderlich
entity id

fim-portal online-services

Onlinedienste (XZuFi)

fim-portal online-services list

List online-services (cursor paginated)

fim-portal online-services list [options]

Optionen

OptionBeschreibungStandard
--cursor <n> pagination cursor (>= 0)
--limit <n> max number of results (1..200)
--fts-query <q> full-text search query

fim-portal online-services xzufi

Download the XZuFi XML for a online-services entity

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

Argumente

<redaktionId> erforderlich
Redaktion id
<id> erforderlich
entity id

fim-portal process-classes

Prozessklassen (XProzess)

fim-portal process-classes get

Get a specific process class

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

Argumente

<id> erforderlich
process class id
<version> erforderlich
process class version

fim-portal process-classes xprozess

Download the XProzess XML for a process class

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

Argumente

<id> erforderlich
process class id
<version> erforderlich
process class version

fim-portal processes

Prozesse (XProzess)

fim-portal processes get

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

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

Argumente

<id> erforderlich
process id
<version> erforderlich
process version
<stufe> erforderlich
Detaillierungsstufe (101..105)
<kodierung> erforderlich
verwaltungspolitische Kodierung (the verwaltungspolitische_kodierung of a search result, e.g. 17)

fim-portal processes xprozess

Download the XProzess XML for a process

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

Argumente

<id> erforderlich
process id
<version> erforderlich
process version
<stufe> erforderlich
Detaillierungsstufe (101..105)
<kodierung> erforderlich
verwaltungspolitische Kodierung (the verwaltungspolitische_kodierung of a search result, e.g. 17)

fim-portal processes report

Download the report PDF for a process

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

Argumente

<id> erforderlich
process id
<version> erforderlich
process version
<stufe> erforderlich
Detaillierungsstufe (101..105)
<kodierung> erforderlich
verwaltungspolitische Kodierung (the verwaltungspolitische_kodierung of a search result, e.g. 17)

fim-portal processes visualization

Download the visualization PDF for a process

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

Argumente

<id> erforderlich
process id
<version> erforderlich
process version
<stufe> erforderlich
Detaillierungsstufe (101..105)
<kodierung> erforderlich
verwaltungspolitische Kodierung (the verwaltungspolitische_kodierung of a search result, e.g. 17)

fim-portal processes visualization-display

Download the display visualization PDF for a process

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

Argumente

<id> erforderlich
process id
<version> erforderlich
process version
<stufe> erforderlich
Detaillierungsstufe (101..105)
<kodierung> erforderlich
verwaltungspolitische Kodierung (the verwaltungspolitische_kodierung of a search result, e.g. 17)

fim-portal code-lists

List the code lists referenced by data fields

fim-portal code-lists [options]

Optionen

OptionBeschreibungStandard
--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]

Optionen

OptionBeschreibungStandard
--resource <name> erforderlich resource to export Werte: schema, document-profile, field, group, leistung-steckbriefe, processclass, process
--term <text> search term
--xdf-version <v> XDatenfelder version (schema, document-profile, field, group) Werte: 2.0, 3.0.0
--order-by <order> result order (the sort orders of the resource's JSON search; none for process, processclass)
--feldart <art> filter by Feldart (field) Werte: input, select, label, hidden, locked
--datentyp <typ> filter by Datentyp (field) Werte: text, text_latin, date, time, datetime, bool, num, num_int, num_currency, file, obj
--dokumentart <code> filter by Dokumentart (document-profile) Werte: 001, 002, 003, 004, 005, 006, 007, 008, 009, 010, 011, 012, 013, 014, 999
--sprache <lang> filter by language (leistung-steckbriefe) Werte: Deutsch, Deutsch (leichte Sprache), Englisch, Polnisch, Sorbisch, Ukrainisch, Französisch