LIBRARY WORKFLOW — GET METADATA¶
Reads a library workflow zip and returns its metadata: START worker inputs, dropdown/list (Task) inputs, report_generator workers, total worker count, and unique worker types. Caches the result alongside the zip as <name>.meta.json and reuses it until the zip is re-saved.
When to use¶
Tagged: cache, d3wfzip, library, library_workflow, meta_json, report_generators, start_inputs, unique_workers.
Inputs¶
| Label | ID | Type | Default | Required | Description |
|---|---|---|---|---|---|
| Library Workflow ID | library_id | text | — | ✓ | Numeric or string identifier of the library workflow entry as returned by /api/workflow/library (e.g. ‘001’); used to resolve the .d3wfzip file path on disk — required. |
| Force Refresh | force_refresh | boolean | False | When true, bypasses the sibling .meta.json cache and re-invokes the Python extractor even if the cache is newer than the zip; defaults to false (use cached result when fresh). |
Outputs¶
| Label | ID | Type | Description |
|---|---|---|---|
| Metadata JSON | metadata | text | Full metadata blob serialized as a JSON string, containing all extracted fields (START inputs, task inputs, report generators, worker count, unique workers) in one payload for callers that need everything at once. |
| Worker Count | worker_count | integer | Total number of worker nodes found in the library workflow, excluding terminal/connector nodes (integer). |
| Unique Workers | unique_workers | dataset | Dataset of distinct worker types present in the workflow, one row per type with column {worker_type}, sorted alphabetically. |
| START Inputs | start_inputs | dataset | Dataset of inputs defined on the START worker, with columns {id, label, type, required, options_count}; represents the parameters a user must supply when launching the workflow. |
| Report Generators | report_generators | dataset | Dataset of report-generator (REPORTER) workers found in the workflow, with columns {id, title, type}; surfaces the reports the workflow can produce. |
| Cached | cached | string | Indicates whether the metadata was served from the .meta.json cache (‘yes’) or freshly extracted by the Python helper (‘no’). |
| Meta Path | meta_path | string | Absolute filesystem path to the .meta.json cache file written alongside the .d3wfzip (e.g. /…/data/workflows/<name>.meta.json). |
| Status | status | string | Human-readable summary of the execution result; populated with an ‘Error: …’ message on any failure path, or a success summary on completion. |
Disciplines¶
- platform.workflow
Auto-generated from platform schema. Worker id: workflow_library_get_metadata. Schema hash: 3f1c3cdbb334. Hand-curated docs in workerexamples/ override this page when present.