Time Series Hierarchies - List
Returns time series hierarchies definitions in pages.
GET https://{environmentFqdn}/timeseries/hierarchies?api-version=2020-07-31
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
environment
|
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-continuation |
string |
Continuation token from previous page of results to retrieve the next page of the results in calls that support pagination. To get the first page results, specify null continuation token as parameter value. Returned continuation token is null if all results have been returned, and there is no next page of results. |
|
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. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Successful operation. Headers x-ms-request-id: string |
|
Other Status Codes |
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
Hierarchies |
Hierarchies |
Hierarchies |
HierarchiesListPage1
Sample request
GET https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/hierarchies?api-version=2020-07-31
Sample response
{
"hierarchies": [
{
"id": "6e292e54-9a26-4be1-9034-607d71492707",
"name": "Location",
"source": {
"instanceFieldNames": [
"state",
"city"
]
}
}
],
"continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}
HierarchiesListPage2
Sample request
GET https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/hierarchies?api-version=2020-07-31
Sample response
{
"hierarchies": [
{
"id": "6e292e54-9a26-4be1-9034-607d71492707",
"name": "Location",
"source": {
"instanceFieldNames": [
"state",
"city"
]
}
}
],
"continuationToken": "aXsic2tpcCI6MTAwMCwidGFrASI6MTAwMH0="
}
HierarchiesListPage3
Sample request
GET https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/hierarchies?api-version=2020-07-31
Sample response
{
"hierarchies": []
}
Definitions
Name | Description |
---|---|
Get |
Partial list of time series hierarchies returned in a single request. |
Source |
Definition of how time series hierarchy tree levels are created. |
Time |
Time series hierarchy organizes time series instances into a tree. |
Tsi |
Information about an API error. |
Tsi |
A particular API error with an error code and a message. |
Tsi |
Additional error information. |
GetHierarchiesPage
Partial list of time series hierarchies returned in a single request.
Name | Type | Description |
---|---|---|
continuationToken |
string |
If returned, this means that current results represent a partial result. Continuation token allows to get the next page of results. To get the next page of query results, send the same request with continuation token parameter in "x-ms-continuation" HTTP header. |
hierarchies |
Partial list of time series hierarchies returned in a single request. Can be empty if server was unable to fill the page in this request, or there is no more objects when continuation token is null. |
Source
Definition of how time series hierarchy tree levels are created.
Name | Type | Description |
---|---|---|
instanceFieldNames |
string[] |
List of instance field names that must be set in all time series instances that belong to this hierarchy. The order of the instance fields defines the levels in the hierarchy. |
TimeSeriesHierarchy
Time series hierarchy organizes time series instances into a tree.
Name | Type | Description |
---|---|---|
id |
string |
Case-sensitive unique hierarchy identifier. Can be null while creating hierarchy objects and then server generates the id, not null on get and delete operations. |
name |
string |
User-given unique name for the type. It is mutable and not null. |
source |
Definition of how time series hierarchy tree levels are created. |
TsiError
Information about an API error.
Name | Type | Description |
---|---|---|
error |
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 |
Contains additional error information. May be null. |
|
innerError |
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. |