Request

Response

    Queries

    searchByHub

    query

    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! }

    Template for Query:

    query GetSearchByHub($hubId: ID!, $searchCriteria: SearchInput, $pagination: PaginationInput) {
      searchByHub(hubId: $hubId, searchCriteria: $searchCriteria, pagination: $pagination) {
        # SearchPayload Fields
      }
    }
    

    Arguments

    hubId*
    ID! non-null
    The hub to search within.
    searchCriteriaPlease specify either query or searchFields.
    paginationCursor
    * Required

    Possible Returns

    Value TypeDescription
    SearchPayload Contains the paginated results of a search query.


    Examples

    Example 1

    Hub-wide search using plain text query.

    Query:

    query SearchByHub($hubId: ID!, $searchCriteria: SearchInput, $pagination: PaginationInput) {  searchByHub(hubId: $hubId, searchCriteria: $searchCriteria, pagination: $pagination) {    pagination { cursor pageSize }    results {      name      score      thumbnail { id status }      matches { matchedPropertyId matchedText }      searchResultObject {        __typename        ... on Component { id }        ... on Folder { id }        ... on Model { id }        ... on BasicItem { id }        ... on DesignItem { id }        ... on DrawingItem { id }        ... on ConfiguredDesignItem { id }      }    }  }  }
    

    Query Variables:

    {   "hubId": "urn:adsk.ace:beta.scope:02dd340f-3e84-4db8-b6a1-56a964a202c7",  "searchCriteria": {    "query": "Cup" , "desiredSearchResultTypes": ["COMPONENT","FILE","MODEL","FOLDER"]  },  "pagination": { "limit": 10 } }
    

    Response:

    {
       "data": {
           "searchByHub": {
               "pagination": {
                   "cursor": null,
                   "pageSize": 5
               },
               "results": [
                   {
                       "name": "Cup",
                       "score": 14.640575,
                       "thumbnail": {
                           "id": "dGh1bWJ-dXJuOmFkc2sud2lwc3RnOmZzLmZpbGU6dmYublAxbk9ZMFdUcTJfbm5hZEN2bHg5dz92ZXJzaW9uPTN-MTk5MzQ0YjAtMGI1ZS00Mzg3LTllMmEtMjYyMGQxOWE5YTEw",
                           "status": "SUCCESS"
                       },
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjplZDE1MzVlNGM5M2M0ZWQzOTU3YTA1MmU1NmRjMzE3My0xLjAuMA",
                               "matchedText": "Cup"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "DesignItem",
                           "id": "urn:adsk.wipstg:dm.lineage:nP1nOY0WTq2_nnadCvlx9w"
                       }
                   },
                   {
                       "name": "Transparent Cup",
                       "score": 14.582447,
                       "thumbnail": {
                           "id": "dGh1bWJ-dXJuOmFkc2sud2lwc3RnOmZzLmZpbGU6dmYuOTRiQjEzdGlSSkN3UzkyN1FZUWVSUT92ZXJzaW9uPTJ-MTk5MzQ0YjAtMGI1ZS00Mzg3LTllMmEtMjYyMGQxOWE5YTEw",
                           "status": "SUCCESS"
                       },
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjplZDE1MzVlNGM5M2M0ZWQzOTU3YTA1MmU1NmRjMzE3My0xLjAuMA",
                               "matchedText": "Transparent Cup"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "DesignItem",
                           "id": "urn:adsk.wipstg:dm.lineage:94bB13tiRJCwS927QYQeRQ"
                       }
                   },
                   {
                       "name": "Cup",
                       "score": 15.23653,
                       "thumbnail": {
                           "id": "dGh1bWJ-dXJuOmFkc2sud2lwc3RnOmZzLmZpbGU6dmYublAxbk9ZMFdUcTJfbm5hZEN2bHg5dz92ZXJzaW9uPTN-MTk5MzQ0YjAtMGI1ZS00Mzg3LTllMmEtMjYyMGQxOWE5YTEw",
                           "status": "SUCCESS"
                       },
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjplZDE1MzVlNGM5M2M0ZWQzOTU3YTA1MmU1NmRjMzE3My0xLjAuMA",
                               "matchedText": "Cup"
                           },
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjozN2Q0Y2NiMzA2Njg0NzE0YWYyMmExZjMwZDI5YzMzNi0xLjAuMA",
                               "matchedText": "Cup component"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Component",
                           "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35NeWpwUUR6Q3YwdFZQQzBYMVRhUVdPX2FnYQ"
                       }
                   },
                   {
                       "name": "Cup",
                       "score": 14.862717,
                       "thumbnail": {
                           "id": "dGh1bWJ-dXJuOmFkc2sud2lwc3RnOmZzLmZpbGU6dmYublAxbk9ZMFdUcTJfbm5hZEN2bHg5dz92ZXJzaW9uPTN-MTk5MzQ0YjAtMGI1ZS00Mzg3LTllMmEtMjYyMGQxOWE5YTEw",
                           "status": "SUCCESS"
                       },
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjplZDE1MzVlNGM5M2M0ZWQzOTU3YTA1MmU1NmRjMzE3My0xLjAuMA",
                               "matchedText": "Cup"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-emExWlNFS1BuVEd4NWlvT24wdWdVQV9hZ2E"
                       }
                   },
                   {
                       "name": "Transparent Cup",
                       "score": 14.717251,
                       "thumbnail": {
                           "id": "dGh1bWJ-dXJuOmFkc2sud2lwc3RnOmZzLmZpbGU6dmYuOTRiQjEzdGlSSkN3UzkyN1FZUWVSUT92ZXJzaW9uPTJ-MTk5MzQ0YjAtMGI1ZS00Mzg3LTllMmEtMjYyMGQxOWE5YTEw",
                           "status": "SUCCESS"
                       },
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjplZDE1MzVlNGM5M2M0ZWQzOTU3YTA1MmU1NmRjMzE3My0xLjAuMA",
                               "matchedText": "Transparent Cup"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-ckd5YWhPQjNMbzlvR2N4d1pkZjR0UF9hZ2E"
                       }
                   }
               ]
           }
       }
    }
    
    Show More

    Example 2

    Hub-wide search using one searchable property with a single query value.

    Query:

    query SearchByHub($hubId: ID!, $searchCriteria: SearchInput, $pagination: PaginationInput) {  searchByHub(hubId: $hubId, searchCriteria: $searchCriteria, pagination: $pagination) {    pagination { cursor pageSize }    results {      name      score      matches { matchedPropertyId matchedText }      searchResultObject { __typename ... on Component { id } ... on Folder { id } ... on Model { id } ... on BasicItem { id } ... on DesignItem { id } ... on DrawingItem { id } ... on ConfiguredDesignItem { id } }    }  }  }
    

    Query Variables:

    {   "hubId": "urn:adsk.ace:beta.scope:02dd340f-3e84-4db8-b6a1-56a964a202c7",  "searchCriteria": {    "searchFields": [      {        "searchableProperty": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",        "PropertyQuery": ["steel"]      }    ]  },  "pagination": { "limit": 10 } }
    

    Response:

    {
       "data": {
           "searchByHub": {
               "pagination": {
                   "cursor": "eyJmaWxlT2Zmc2V0IjowLCJjb21wb25lbnRPZmZzZXQiOjEwLCJ0b3RhbEZpbGVFbnRyaWVzIjowLCJ0b3RhbENvbXBvbmVudEVudHJpZXMiOjk0fQ==",
                   "pageSize": 10
               },
               "results": [
                   {
                       "name": "Configuration_27_20",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-dUdVUjZTYVQ4T1gyTHJ5d0JvME5xNV9hZ2E"
                       }
                   },
                   {
                       "name": "Configuration_10_10",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-TFZJZkM0d1VZc01qQVF3dkVtcVpqTl9hZ2E"
                       }
                   },
                   {
                       "name": "Espresso PCB",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-SmNJVjl4OEVNZ3A0WFlsSkJxeE9CZl9hZ2E"
                       }
                   },
                   {
                       "name": "1-soldermask",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-REhRd1pWYkRJWXZXT2NuMXJMakJROV9hZ2E"
                       }
                   },
                   {
                       "name": "16-soldermask",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-SDd5dWpaQ2tQZXFVcmZXd2U0cnpUZF9hZ2E"
                       }
                   },
                   {
                       "name": "Board",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-aUVoMk5GSHIyUG9oVXpDcFVtNUhZQV9hZ2E"
                       }
                   },
                   {
                       "name": "Pump",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-RklmZk1yMG5qSGlwenFTamloVWdRVV9hZ2E"
                       }
                   },
                   {
                       "name": "Buttons",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-eVpzZDl6VDhTSGdRM0RaWDFnNGNpaF9hZ2E"
                       }
                   },
                   {
                       "name": "Configuration_15_15",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-V0hGM1pUSGRiUUZFZm9qV09jRXVEel9hZ2E"
                       }
                   },
                   {
                       "name": "Controls",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-ZHE0VHA4eE9rVjJOemtYbEY2RGdYbl9hZ2E"
                       }
                   }
               ]
           }
       }
    }
    
    Show More

    Example 3

    Hub-wide search using one searchable property with multiple values (OR within a property).

    Query:

    query SearchByHub($hubId: ID!, $searchCriteria: SearchInput, $pagination: PaginationInput) {  searchByHub(hubId: $hubId, searchCriteria: $searchCriteria, pagination: $pagination) {    pagination { cursor pageSize }    results {      name      score      matches { matchedPropertyId matchedText }      searchResultObject { __typename ... on Component { id } ... on Folder { id } ... on Model { id } ... on BasicItem { id } ... on DesignItem { id } ... on DrawingItem { id } ... on ConfiguredDesignItem { id } }    }  }  }
    

    Query Variables:

    {   "hubId": "urn:adsk.ace:beta.scope:02dd340f-3e84-4db8-b6a1-56a964a202c7",  "searchCriteria": {    "searchFields": [      {        "searchableProperty": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",        "PropertyQuery": ["steel", "aluminum"]      }    ]  },  "pagination": { "limit": 10 } }
    

    Response:

    {
       "data": {
           "searchByHub": {
               "pagination": {
                   "cursor": "eyJmaWxlT2Zmc2V0IjowLCJjb21wb25lbnRPZmZzZXQiOjEwLCJ0b3RhbEZpbGVFbnRyaWVzIjowLCJ0b3RhbENvbXBvbmVudEVudHJpZXMiOjk0fQ==",
                   "pageSize": 10
               },
               "results": [
                   {
                       "name": "Configuration_27_20",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-dUdVUjZTYVQ4T1gyTHJ5d0JvME5xNV9hZ2E"
                       }
                   },
                   {
                       "name": "Configuration_10_10",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-TFZJZkM0d1VZc01qQVF3dkVtcVpqTl9hZ2E"
                       }
                   },
                   {
                       "name": "Espresso PCB",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-SmNJVjl4OEVNZ3A0WFlsSkJxeE9CZl9hZ2E"
                       }
                   },
                   {
                       "name": "1-soldermask",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-REhRd1pWYkRJWXZXT2NuMXJMakJROV9hZ2E"
                       }
                   },
                   {
                       "name": "16-soldermask",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-SDd5dWpaQ2tQZXFVcmZXd2U0cnpUZF9hZ2E"
                       }
                   },
                   {
                       "name": "Board",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-aUVoMk5GSHIyUG9oVXpDcFVtNUhZQV9hZ2E"
                       }
                   },
                   {
                       "name": "Pump",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-RklmZk1yMG5qSGlwenFTamloVWdRVV9hZ2E"
                       }
                   },
                   {
                       "name": "Buttons",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-eVpzZDl6VDhTSGdRM0RaWDFnNGNpaF9hZ2E"
                       }
                   },
                   {
                       "name": "Configuration_15_15",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-V0hGM1pUSGRiUUZFZm9qV09jRXVEel9hZ2E"
                       }
                   },
                   {
                       "name": "Controls",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-ZHE0VHA4eE9rVjJOemtYbEY2RGdYbl9hZ2E"
                       }
                   }
               ]
           }
       }
    }
    
    Show More

    Example 4

    Hub-wide search filtering by result types and sorted by property definition.

    Query:

    query SearchByHub($hubId: ID!, $searchCriteria: SearchInput, $pagination: PaginationInput) {  searchByHub(hubId: $hubId, searchCriteria: $searchCriteria, pagination: $pagination) {    pagination { cursor pageSize }    results {      name      score      matches { matchedPropertyId matchedText }      searchResultObject { __typename ... on Component { id } ... on Folder { id } ... on Model { id } ... on BasicItem { id } ... on DesignItem { id } ... on DrawingItem { id } ... on ConfiguredDesignItem { id } }    }  }  }
    

    Query Variables:

    {   "hubId": "urn:adsk.ace:beta.scope:02dd340f-3e84-4db8-b6a1-56a964a202c7",  "searchCriteria": {    "searchFields": [      {        "searchableProperty": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",        "PropertyQuery": ["steel"]      }    ],    "desiredSearchResultTypes": ["COMPONENT", "MODEL"],    "sort": [      {        "order": "ASC",        "propertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA"      }    ]  },  "pagination": { "limit": 10 } }
    

    Response:

    {
       "data": {
           "searchByHub": {
               "pagination": {
                   "cursor": "eyJmaWxlT2Zmc2V0IjowLCJjb21wb25lbnRPZmZzZXQiOjEwLCJ0b3RhbEZpbGVFbnRyaWVzIjowLCJ0b3RhbENvbXBvbmVudEVudHJpZXMiOjk0fQ==",
                   "pageSize": 10
               },
               "results": [
                   {
                       "name": "Configuration_27_20",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-dUdVUjZTYVQ4T1gyTHJ5d0JvME5xNV9hZ2E"
                       }
                   },
                   {
                       "name": "Configuration_10_10",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-TFZJZkM0d1VZc01qQVF3dkVtcVpqTl9hZ2E"
                       }
                   },
                   {
                       "name": "Espresso PCB",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-SmNJVjl4OEVNZ3A0WFlsSkJxeE9CZl9hZ2E"
                       }
                   },
                   {
                       "name": "1-soldermask",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-REhRd1pWYkRJWXZXT2NuMXJMakJROV9hZ2E"
                       }
                   },
                   {
                       "name": "16-soldermask",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-SDd5dWpaQ2tQZXFVcmZXd2U0cnpUZF9hZ2E"
                       }
                   },
                   {
                       "name": "Board",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-aUVoMk5GSHIyUG9oVXpDcFVtNUhZQV9hZ2E"
                       }
                   },
                   {
                       "name": "Pump",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-RklmZk1yMG5qSGlwenFTamloVWdRVV9hZ2E"
                       }
                   },
                   {
                       "name": "Buttons",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-eVpzZDl6VDhTSGdRM0RaWDFnNGNpaF9hZ2E"
                       }
                   },
                   {
                       "name": "Configuration_15_15",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-V0hGM1pUSGRiUUZFZm9qV09jRXVEel9hZ2E"
                       }
                   },
                   {
                       "name": "Controls",
                       "score": 1,
                       "matches": [
                           {
                               "matchedPropertyId": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo4MmVjZDZkZjA5NDg0YmQzYmFhZTRiY2ZiNGRhM2NjYS0xLjAuMA",
                               "matchedText": "Steel"
                           }
                       ],
                       "searchResultObject": {
                           "__typename": "Model",
                           "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-ZHE0VHA4eE9rVjJOemtYbEY2RGdYbl9hZ2E"
                       }
                   }
               ]
           }
       }
    }
    
    Show More