Request

Response

    Payloads

    SearchPayload

    object

    Contains the paginated results of a search query.


    Fields

    pagination*
    Pagination! non-null
    Contains information about the current page, when results are split into multiple pages.
    results*The search results that matched the specified criteria.
    * Required


    Where Used

    UsageUsed ByDescription
    Query By 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! }