.. _auto_finder_get_configurations: *GET FINDER CONFIGURATIONS* =========================== Returns the available filter configurations (schema) for a specified finder domain such as simulations, projects, studies, or HPC jobs. Use this worker before calling `global_finder` to discover which filter fields, types, labels, and options are valid for a given domain. Supports common domain name aliases (plural/singular variants). When to use ----------- Tagged: ``configuration``, ``domain_discovery``, ``filter_schema``, ``finder``, ``global_finder``, ``schema``. Inputs ------ .. list-table:: :header-rows: 1 :widths: 20 20 20 20 20 20 * - Label - ID - Type - Default - Required - Description * - Domain - domain - select - — - ✓ - The platform domain to retrieve filter configurations for; must be one of: simulation, projects, studies, physicaltest, responses, templates, hpcjobs, hpcjobsettings, user_workflows, library_workflows, or users. Common plural/singular aliases (e.g. 'simulations', 'workflow') are accepted and normalised automatically. Outputs ------- .. list-table:: :header-rows: 1 :widths: 20 20 20 20 * - Label - ID - Type - Description * - Status - status - text - Human-readable success or error message; on success reports the domain name and the number of filters found, e.g. 'Success: Filter schema for \'simulation\' retrieved successfully. 7 filters found.' * - Schema - schema - string - JSON-encoded array of filter definition objects for the requested domain; each object contains id, type, label, description, required, default, and (for select-type filters) an options array — pass this directly to `global_finder` to construct valid queries. Disciplines ----------- - platform.integration - platform.ontology - platform.workflow .. raw:: html
Auto-generated from platform schema. Worker id: finder_get_configurations. Schema hash: 0e47c946bdd7. Hand-curated docs in workerexamples/ override this page when present.