Time Series Instances - Suggest

Service:

Time Series Insights

API Version:

2020-07-31

Suggests keywords based on time series instance attributes to be later used in Search Instances.

POST https://{environmentFqdn}/timeseries/instances/suggest?api-version=2020-07-31

URI Parameters

Name	In	Required	Type	Description
environmentFqdn	path	True	string	Per environment FQDN, for example 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. You can obtain this domain name from the response of the Get Environments API, Azure portal, or Azure Resource Manager.
api-version	query	True	string	Version of the API to be used with the client request. Currently supported version is "2020-07-31".

Request Header

Name	Required	Type	Description
x-ms-client-request-id		string	Optional client request ID. Service records this value. Allows the service to trace operation across services, and allows the customer to contact support regarding a particular request.
x-ms-client-session-id		string	Optional client session ID. Service records this value. Allows the service to trace a group of related operations across services, and allows the customer to contact support regarding a particular group of requests.

Request Body

Name	Required	Type	Description
searchString	True	string	Search string for which suggestions are required. Empty is allowed, but not null.
take		integer	Maximum number of suggestions expected in the result. Defaults to 10 when not set.

Responses

Name	Type	Description
200 OK	InstancesSuggestResponse	Successful operation. Headers x-ms-request-id: string
Other Status Codes	TsiError	Unexpected error. Headers x-ms-request-id: string

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

InstancesSuggest

Sample Request

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/suggest?api-version=2020-07-31

{
  "searchString": "flo",
  "take": 3
}

Sample Response

Status code:

200

{
  "suggestions": [
    {
      "searchString": "floor 100",
      "highlightedSearchString": "<hit>flo</hit>or 100"
    },
    {
      "searchString": "sensor on floor 0",
      "highlightedSearchString": "sensor on <hit>flo</hit>or 0"
    },
    {
      "searchString": "sensor on floor 1",
      "highlightedSearchString": "sensor on <hit>flo</hit>or 1"
    }
  ]
}

Definitions

Name	Description
InstancesSearchStringSuggestion	Suggested search string to be used for further search for time series instances.
InstancesSuggestRequest	Request to get search string suggestions for time series instances search based on prefix text.
InstancesSuggestResponse	Response of getting suggestions for search for time series instances.
TsiError	Information about an API error.
TsiErrorBody	A particular API error with an error code and a message.
TsiErrorDetails	Additional error information.

InstancesSearchStringSuggestion

Suggested search string to be used for further search for time series instances.

Name	Type	Description
highlightedSearchString	string	Highlighted suggested search string to be displayed to the user. Highlighting inserts and tags in the portions of text that matched the search string. Do not use highlighted search string to do further search calls.
searchString	string	Suggested search string. Can be used for further search for time series instances.

InstancesSuggestRequest

Request to get search string suggestions for time series instances search based on prefix text.

Name	Type	Description
searchString	string	Search string for which suggestions are required. Empty is allowed, but not null.
take	integer	Maximum number of suggestions expected in the result. Defaults to 10 when not set.

InstancesSuggestResponse

Response of getting suggestions for search for time series instances.

Name	Type	Description
suggestions	InstancesSearchStringSuggestion[]	List of instance suggestions for searching time series models.

TsiError

Information about an API error.

Name	Type	Description
error	TsiErrorBody	A particular API error with an error code and a message.

TsiErrorBody

A particular API error with an error code and a message.

Name	Type	Description
code	string	Language-independent, human-readable string that defines a service-specific error code. This code serves as a more specific indicator for the HTTP error code specified in the response. Can be used to programmatically handle specific error cases.
details	TsiErrorDetails[]	Contains additional error information. May be null.
innerError	TsiErrorBody	Contains more specific error that narrows down the cause. May be null.
message	string	Human-readable, language-independent representation of the error. It is intended as an aid to developers and is not suitable for exposure to end users.
target	string	Target of the particular error (for example, the name of the property in error). May be null.

TsiErrorDetails

Additional error information.

Name	Type	Description
code	string	Language-independent, human-readable string that defines a service-specific error code. This code serves as a more specific indicator for the HTTP error code specified in the response. Can be used to programmatically handle specific error cases.
message	string	Human-readable, language-independent representation of the error. It is intended as an aid to developers and is not suitable for exposure to end users.