Optional. Number of results in the search page. If <=0, then defaults to 10. Max limit for pageSize is 1000. Throws an invalid argument for pageSize > 1000.
pageToken
string
Optional. Page token received from a previouslocations.searchEntriescall. Provide this to retrieve the subsequent page.
orderBy
string
Optional. Specifies the ordering of results. Supported values are:
relevance
last_modified_timestamp
last_modified_timestamp asc
scope
string
Optional. The scope under which the search should be operating. It must either beorganizations/<org_id>orprojects/<project_ref>. If it is unspecified, it defaults to the organization where the project provided innameis located.
semanticSearch
boolean
Optional. Specifies whether the search should understand the meaning and intent behind the query, rather than just matching keywords.
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-08 UTC."],[[["\u003cp\u003eThis webpage details the \u003ccode\u003esearchEntries\u003c/code\u003e method, which allows users to search for entries within a specified scope and project in Dataplex using a POST HTTP request.\u003c/p\u003e\n"],["\u003cp\u003eThe method requires a project name path parameter and several optional query parameters, including \u003ccode\u003equery\u003c/code\u003e, \u003ccode\u003epageSize\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e, \u003ccode\u003eorderBy\u003c/code\u003e, and \u003ccode\u003escope\u003c/code\u003e, for customizing the search operation.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must be empty, and the response body will contain an array of \u003ccode\u003eSearchEntriesResult\u003c/code\u003e objects, along with metadata like \u003ccode\u003etotalSize\u003c/code\u003e, \u003ccode\u003enextPageToken\u003c/code\u003e, and \u003ccode\u003eunreachable\u003c/code\u003e locations.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this method requires the OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e and the IAM permission \u003ccode\u003edataplex.projects.search\u003c/code\u003e on the specified project.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eSearchEntriesResult\u003c/code\u003e and \u003ccode\u003eSnippets\u003c/code\u003e objects are returned in the response body and contain deprecated fields such as \u003ccode\u003elinkedResource\u003c/code\u003e, \u003ccode\u003esnippets\u003c/code\u003e and \u003ccode\u003edataplexEntry\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.SearchEntriesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [SearchEntriesResult](#SearchEntriesResult)\n - [JSON representation](#SearchEntriesResult.SCHEMA_REPRESENTATION)\n- [Snippets](#Snippets)\n - [JSON representation](#Snippets.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nSearches for Entries matching the given query and scope.\n\nHTTP request\n\n`POST https://dataplex.googleapis.com/v1/{name=projects/*/locations/*}:searchEntries`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath parameters\n\n| Parameters ||\n|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The project to which the request should be attributed in the following form: `projects/{project}/locations/global`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `name`: - `dataplex.projects.search` |\n\nQuery parameters\n\n| Parameters ||\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `query` | `string` Required. The query against which entries in scope should be matched. The query syntax is defined in [Search syntax for Dataplex Universal Catalog](https://cloud.google.com/dataplex/docs/search-syntax). |\n| `pageSize` | `integer` Optional. Number of results in the search page. If \\\u003c=0, then defaults to 10. Max limit for pageSize is 1000. Throws an invalid argument for pageSize \\\u003e 1000. |\n| `pageToken` | `string` Optional. Page token received from a previous `locations.searchEntries` call. Provide this to retrieve the subsequent page. |\n| `orderBy` | `string` Optional. Specifies the ordering of results. Supported values are: - `relevance` - `last_modified_timestamp` - `last_modified_timestamp asc` |\n| `scope` | `string` Optional. The scope under which the search should be operating. It must either be `organizations/\u003corg_id\u003e` or `projects/\u003cproject_ref\u003e`. If it is unspecified, it defaults to the organization where the project provided in `name` is located. |\n| `semanticSearch` | `boolean` Optional. Specifies whether the search should understand the meaning and intent behind the query, rather than just matching keywords. |\n\nRequest body\n\nThe request body must be empty.\n\nResponse body If successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"results\": [ { object (/dataplex/docs/reference/rest/v1/projects.locations/searchEntries#SearchEntriesResult) } ], \"totalSize\": integer, \"nextPageToken\": string, \"unreachable\": [ string ] } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `results[]` | `object (`[SearchEntriesResult](/dataplex/docs/reference/rest/v1/projects.locations/searchEntries#SearchEntriesResult)`)` The results matching the search query. |\n| `totalSize` | `integer` The estimated total number of matching entries. This number isn't guaranteed to be accurate. |\n| `nextPageToken` | `string` Token to retrieve the next page of results, or empty if there are no more results in the list. |\n| `unreachable[]` | `string` Locations that the service couldn't reach. locations.search results don't include data from these locations. |\n\nAuthorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\nIAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource:\n\n- `dataplex.projects.search`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs).\n\nSearchEntriesResult A single result of a locations.searchEntries request.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"linkedResource\": string, \"dataplexEntry\": { object (/dataplex/docs/reference/rest/v1/projects.locations.entryGroups.entries#Entry) }, \"snippets\": { object (/dataplex/docs/reference/rest/v1/projects.locations/searchEntries#Snippets) } } ``` |\n\n| Fields ||\n|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|\n| `linkedResource` **(deprecated)** | `string` | This item is deprecated! Linked resource name. |\n| `dataplexEntry` | `object (`[Entry](/dataplex/docs/reference/rest/v1/projects.locations.entryGroups.entries#Entry)`)` |\n| `snippets` **(deprecated)** | `object (`[Snippets](/dataplex/docs/reference/rest/v1/projects.locations/searchEntries#Snippets)`)` | This item is deprecated! Snippets. |\n\nSnippets\n| This item is deprecated!\nSnippets for the entry, contains HTML-style highlighting for matched tokens, will be used in UI.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"dataplexEntry\": { object (/dataplex/docs/reference/rest/v1/projects.locations.entryGroups.entries#Entry) } } ``` |\n\n| Fields ||\n|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|\n| `dataplexEntry` **(deprecated)** | `object (`[Entry](/dataplex/docs/reference/rest/v1/projects.locations.entryGroups.entries#Entry)`)` | This item is deprecated! Entry |"]]
