Search

Method	Description
search	Search project items, return them and print the results as a table.

search

search(
    text: str | None = None,
    *,
    name_only: bool = False,
    limit: int | None = 100,
    types: (
        Literal["all"]
        | list[
            Literal[
                "Assertion",
                "Extract",
                "Calibration",
                "ComputationalModel",
                "DataTable",
                "Document",
                "MeasureDesign",
                "SimpleOutputSet",
                "ProtocolDesign",
                "RawFile",
                "ScoringDesign",
                "AdvancedOutputSet",
                "Source",
                "SubsamplingDesign",
                "Trial",
                "TrialVisualization",
                "Vpop",
                "VpopDesign",
            ]
        ]
    ) = "all",
    order_by: SearchColumn = "updated",
    desc_order: bool = True,
    deleted: bool = False,
    template_only: bool = False,
    show_table: bool = True,
    show_table_hint: bool = True,
    columns: (
        Literal["default", "compact", "all"] | list[SearchColumn]
    ) = "default",
    table_color: bool = True
) -> list[ProjectItem]

Search project items, return them and print the results as a table.

The search matches item names, descriptions, and author fields unless name_only=True, in which case only item names are searched. Results are optionally filtered by item types, deleted status, and template status.

columns controls which table columns are displayed:

• "compact" shows a narrow view for small screens.
• "default" shows a slightly richer view.
• "all" shows every available column.
• A list of SearchColumn values selects columns explicitly.

For the "compact" and "default" presets, the active sort column is added automatically so the ordering remains visible. When deleted=True, preset views also add the deleted column automatically. Explicit column lists are used as-is.

order_by accepts any SearchColumn. updated and created are passed through to the API sort parameters. All other values are sorted client-side after fetching the matching items. In all cases, limit is applied to the final displayed order.

When color_output is enabled, matched text is highlighted in the printed table.

Some types values are equivalent, to allow the name used by the API or the SDK: "SimpleOutputSet" <=> "MeasureDesign", "AdvancedOutputSet": <=> "ScoringDesign", "Extract" <=> "Assertion"