Discovery - Auto Complete
Get auto complete options.
POST {endpoint}/datamap/api/search/autocomplete?api-version=2023-09-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
|
api-version
|
query | True |
string |
The API version to use for this operation. |
Request Body
Name | Type | Description |
---|---|---|
filter |
|
The filter for the autocomplete request. |
keywords |
string |
The keywords applied to all fields that support autocomplete operation. It must be at least 1 character, and no more than 100 characters. |
limit |
integer |
The number of autocomplete results we hope to return. The default value is 50. The value must be a number between 1 and 100. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The request has succeeded. |
|
Other Status Codes |
An unexpected error response. |
Security
OAuth2Auth
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
https://purview.azure.net/.default |
Examples
Discovery_AutoComplete
Sample request
POST {endpoint}/datamap/api/search/autocomplete?api-version=2023-09-01
{
"keywords": "exa",
"filter": {
"and": [
{
"entityType": "azure_blob_path",
"includeSubTypes": false
}
]
},
"limit": 10
}
Sample response
{
"value": [
{
"text": "example",
"queryPlusText": "example"
},
{
"text": "exampleconfiguration",
"queryPlusText": "exampleconfiguration"
},
{
"text": "exampleresources",
"queryPlusText": "exampleresources"
}
]
}
Definitions
Name | Description |
---|---|
Atlas |
An error response from the service |
Auto |
The payload of autocomplete request. |
Auto |
The result of the autocomplete request. |
Auto |
The value item of the autocomplete suggest. |
AtlasErrorResponse
An error response from the service
Name | Type | Description |
---|---|---|
errorCode |
string |
The error code. |
errorMessage |
string |
The error message. |
requestId |
string |
The request ID. |
AutoCompleteOptions
The payload of autocomplete request.
Name | Type | Description |
---|---|---|
filter |
|
The filter for the autocomplete request. |
keywords |
string |
The keywords applied to all fields that support autocomplete operation. It must be at least 1 character, and no more than 100 characters. |
limit |
integer |
The number of autocomplete results we hope to return. The default value is 50. The value must be a number between 1 and 100. |
AutoCompleteResult
The result of the autocomplete request.
Name | Type | Description |
---|---|---|
value |
The result value |
AutoCompleteResultValue
The value item of the autocomplete suggest.
Name | Type | Description |
---|---|---|
queryPlusText |
string |
The completed search query text. |
text |
string |
The completed term or phrase. |