Request

Response

    Inputs

    SearchInput

    input

    Specifies the search criteria, including free-text queries, property-based filters, result type filters, and sort order.


    Fields

    queryThe free-text query string to search for. Not required if searchFields is specified.
    searchFieldsProperty-based search criteria. Values within a single property are combined with OR logic; different properties are combined with AND logic.
    desiredSearchResultTypesRestricts results to the specified entity types. If empty or omitted, all supported types are returned.
    sortThe sort criteria for ordering search results.


    Where Used

    UsageUsed ByDescription
    Argument for Query searchByHub Performs a hub-wide search across supported entity types. Filter control via SearchResultTypeEnum - COMPONENT, MODEL, FOLDER, FILE(DesignItem, DrawingItem, BasicItem, ConfiguredDesignItem), PROJECT - query: Free-text query string. There is no explicit maximum length enforced for the search query string. - searchFields: [PropertyNameValuePair] to match by specific searchable properties (values OR’ed within a property & AND’ed across different searchFields entries). - desiredSearchResultTypes: [SearchResultTypeEnum] to restrict result types in Search Results; If empty or omitted, ALL supported types are returned by default (COMPONENT, MODEL, FILE, FOLDER, PROJECT). - sort: [Sort] to order results by a propertyId in ASC/DESC order. Returns SearchPayload with: - pagination: cursor and page size, - SearchPayload: - results: display name, optional thumbnail, match highlights, and the matched object (union). - SearchResultMatch { matchedPropertyId: ID!, matchedText: String! }