Share via

Time Series Instances - Search

  • Başvuru
Service:
Time Series Insights
API Version:
2020-07-31

Örnek özniteliklerine göre zaman serisi örnekleri için aramada isabetlerin kısmi listesi.

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

URI Parametreleri

Name İçinde Gerekli Tür Description
environmentFqdn
 path True

string

Ortam başına FQDN, örneğin 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Bu etki alanı adını Get Environments API, Azure portal veya Azure Resource Manager yanıtından alabilirsiniz.
api-version
 query True

string

İstemci isteğiyle kullanılacak API sürümü. Şu anda desteklenen sürüm :"2020-07-31".

İstek Başlığı

Name Gerekli Tür Description
x-ms-continuation

string

Sayfalandırmayı destekleyen çağrılarda sonuçların sonraki sayfasını almak için önceki sonuç sayfasından devam belirteci. İlk sayfa sonuçlarını almak için parametre değeri olarak null devamlılık belirteci belirtin. Tüm sonuçlar döndürüldüyse ve bir sonraki sonuç sayfası yoksa döndürülen devamlılık belirteci null olur.
x-ms-client-request-id

string

İsteğe bağlı istemci isteği kimliği. Hizmet bu değeri kaydeder. Hizmetin hizmetler arasında işlemi izlemesine ve müşterinin belirli bir istekle ilgili desteğe başvurmasına olanak tanır.
x-ms-client-session-id

string

İsteğe bağlı istemci oturum kimliği. Hizmet bu değeri kaydeder. Hizmetin hizmetler arasında bir grup ilgili işlemi izlemesine ve müşterinin belirli bir istek grubuyla ilgili desteğe başvurmasına olanak tanır.

İstek Gövdesi

Name Gerekli Tür Description
searchString True

string

Zaman serisi örneklerinin öznitelikleriyle eşleştirilecek sorgu arama dizesi. Örnek: "kat 100". Büyük/küçük harfe duyarsız olmalıdır, ancak boş dize olabilir.
hierarchies

SearchInstancesHierarchiesParameters

Zaman serisi örnek hiyerarşilerinin nasıl döndürüleceğiyle ilgili parametreler. Null ise hiyerarşiler döndürülmüyor. Instances parametresi null ise ve hiyerarşiler parametresi null değilse, yalnızca örneği olmayan hiyerarşiler döndürülür.
instances

SearchInstancesParameters

Zaman serisi örneklerinin nasıl döndürüleceğiyle ilgili parametreler. Boş olabilir. Hem örnekler hem de hiyerarşi parametreleri null olduğunda, parametrelerdeki varsayılan değerlere göre sonuçlarda örnekler döndürülür ve hiyerarşiler döndürülür.
path

string[]

Zaman serisi örneklerinin hiyerarşi yoluna göre filtreleyin. Yol, dize yolu kesimleri dizisi olarak temsil edilir. İlk öğe hiyerarşi adı olmalıdır. Örnek: ["Konum", "California"]. İsteğe bağlı, büyük/küçük harfe duyarlı, hiçbir zaman boş değildir ve null olabilir.

Yanıtlar

Name Tür Description
200 OK

SearchInstancesResponsePage

Başarılı arama yanıtı.

Headers

x-ms-request-id: string
Other Status Codes

TsiError

Beklenmeyen hata.

Headers

x-ms-request-id: string

Güvenlik

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 kullanıcı hesabınızın kimliğine bürünme

Örnekler

SearchInstancesDefault
SearchInstancesExpandHierarchiesOnly
SearchInstancesHierarchiesDefaultInputPage1
SearchInstancesHierarchiesDefaultInputPage2
SearchInstancesHierarchiesDefaultInputPage3
SearchInstancesOneLevel
SearchInstancesRecursive
SearchInstancesUntilChildren

SearchInstancesDefault

Sample Request

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

{
  "searchString": "floor 100"
}

Sample Response

Status code:
200 
{
  "instances": {
    "hits": [
      {
        "timeSeriesId": [
          "Id1One",
          "Id2One",
          "1.0"
        ],
        "name": "instance1",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": null
      },
      {
        "timeSeriesId": [
          "Id1Two",
          "Id2Two",
          "2.0"
        ],
        "name": "instance2",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": null
      }
    ],
    "hitCount": 2,
    "continuationToken": null
  },
  "hierarchyNodes": null
}

SearchInstancesExpandHierarchiesOnly

Sample Request

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

{
  "searchString": "floor 100",
  "path": [
    "Location"
  ],
  "instances": null,
  "hierarchies": {
    "expand": {
      "kind": "UntilChildren"
    },
    "sort": {
      "by": "Name"
    },
    "pageSize": 2
  }
}

Sample Response

Status code:
200 
{
  "instances": {
    "hits": [],
    "hitCount": 0,
    "continuationToken": null
  },
  "hierarchyNodes": {
    "hits": [
      {
        "name": "California",
        "cumulativeInstanceCount": 2,
        "hierarchyNodes": {
          "hits": [
            {
              "name": "San Diego",
              "cumulativeInstanceCount": 1,
              "hierarchyNodes": null
            },
            {
              "name": "San Francisco",
              "cumulativeInstanceCount": 1,
              "hierarchyNodes": null
            }
          ],
          "hitCount": 2,
          "continuationToken": null
        }
      }
    ],
    "hitCount": 1,
    "continuationToken": null
  }
}

SearchInstancesHierarchiesDefaultInputPage1

Sample Request

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

{
  "searchString": "floor 100",
  "path": null,
  "instances": {
    "recursive": true,
    "sort": {
      "by": "Rank"
    },
    "highlights": true,
    "pageSize": 1
  },
  "hierarchies": {
    "expand": {
      "kind": "UntilChildren"
    },
    "sort": {
      "by": "CumulativeInstanceCount"
    },
    "pageSize": 1
  }
}

Sample Response

Status code:
200 
{
  "instances": {
    "hits": [
      {
        "timeSeriesId": [
          "Id1Two",
          "Id2Two",
          "2.0"
        ],
        "name": "instance2",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": {
          "timeSeriesId": [
            "Id1Two",
            "Id2Two",
            "2.0"
          ],
          "typeName": "DefaultType",
          "name": "instance2",
          "description": "<hit>floor</hit> <hit>100</hit>",
          "hierarchyIds": [
            "1643004c-0a84-48a5-80e5-7688c5ae9295"
          ],
          "hierarchyNames": [
            "Location"
          ],
          "instanceFieldNames": [
            "state",
            "city"
          ],
          "instanceFieldValues": [
            "California",
            "San Francisco"
          ]
        }
      }
    ],
    "hitCount": 2,
    "continuationToken": "c3sic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNTE3MDUxOTg0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0="
  },
  "hierarchyNodes": {
    "hits": [
      {
        "name": "Location",
        "cumulativeInstanceCount": 2,
        "hierarchyNodes": {
          "hits": [
            {
              "name": "California",
              "cumulativeInstanceCount": 2,
              "hierarchyNodes": {
                "hits": [
                  {
                    "name": "San Francisco",
                    "cumulativeInstanceCount": 1,
                    "hierarchyNodes": null
                  }
                ],
                "hitCount": 2,
                "continuationToken": "aHsic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNzA4NTgyODU0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0="
              }
            }
          ],
          "hitCount": 1,
          "continuationToken": null
        }
      }
    ],
    "hitCount": 1,
    "continuationToken": null
  }
}

SearchInstancesHierarchiesDefaultInputPage2

Sample Request

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

{
  "searchString": "floor 100",
  "path": null,
  "instances": {
    "recursive": true,
    "sort": {
      "by": "Rank"
    },
    "highlights": true,
    "pageSize": 1
  },
  "hierarchies": {
    "expand": {
      "kind": "UntilChildren"
    },
    "sort": {
      "by": "CumulativeInstanceCount"
    },
    "pageSize": 1
  }
}

Sample Response

Status code:
200 
{
  "instances": {
    "hits": [
      {
        "timeSeriesId": [
          "Id1One",
          "Id2One",
          "1.0"
        ],
        "name": "instance1",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": {
          "timeSeriesId": [
            "Id1One",
            "Id2One",
            "1.0"
          ],
          "typeName": "DefaultType",
          "name": "instance1",
          "description": "<hit>floor</hit> <hit>100</hit>",
          "hierarchyIds": [
            "1643004c-0a84-48a5-80e5-7688c5ae9295"
          ],
          "hierarchyNames": [
            "Location"
          ],
          "instanceFieldNames": [
            "state",
            "city"
          ],
          "instanceFieldValues": [
            "California",
            "Los Angeles"
          ]
        }
      }
    ],
    "hitCount": 2,
    "continuationToken": null
  },
  "hierarchyNodes": null
}

SearchInstancesHierarchiesDefaultInputPage3

Sample Request

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

{
  "searchString": "floor 100",
  "path": null,
  "instances": {
    "recursive": true,
    "sort": {
      "by": "Rank"
    },
    "highlights": true,
    "pageSize": 1
  },
  "hierarchies": {
    "expand": {
      "kind": "UntilChildren"
    },
    "sort": {
      "by": "CumulativeInstanceCount"
    },
    "pageSize": 1
  }
}

Sample Response

Status code:
200 
{
  "instances": null,
  "hierarchyNodes": {
    "hits": [
      {
        "name": "Location",
        "cumulativeInstanceCount": 2,
        "hierarchyNodes": {
          "hits": [
            {
              "name": "California",
              "cumulativeInstanceCount": 2,
              "hierarchyNodes": {
                "hits": [
                  {
                    "name": "San Diego",
                    "cumulativeInstanceCount": 1,
                    "hierarchyNodes": null
                  }
                ],
                "hitCount": 2,
                "continuationToken": "aHsic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNzA4NTgyODU0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0="
              }
            }
          ],
          "hitCount": 1,
          "continuationToken": null
        }
      }
    ],
    "hitCount": 1,
    "continuationToken": null
  }
}

SearchInstancesOneLevel

Sample Request

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

{
  "searchString": "floor 100",
  "path": null,
  "instances": {
    "recursive": false,
    "sort": {
      "by": "DisplayName"
    },
    "highlights": false,
    "pageSize": 2
  },
  "hierarchies": {
    "expand": {
      "kind": "OneLevel"
    },
    "sort": {
      "by": "Name"
    },
    "pageSize": 2
  }
}

Sample Response

Status code:
200 
{
  "instances": {
    "hits": [],
    "hitCount": 0,
    "continuationToken": null
  },
  "hierarchyNodes": {
    "hits": [
      {
        "name": "Location",
        "cumulativeInstanceCount": 2,
        "hierarchyNodes": null
      }
    ],
    "hitCount": 1,
    "continuationToken": null
  }
}

SearchInstancesRecursive

Sample Request

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

{
  "searchString": "floor 100",
  "path": null,
  "instances": {
    "recursive": true,
    "sort": {
      "by": "DisplayName"
    },
    "highlights": false,
    "pageSize": 2
  },
  "hierarchies": null
}

Sample Response

Status code:
200 
{
  "instances": {
    "hits": [
      {
        "timeSeriesId": [
          "Id1One",
          "Id2One",
          "1.0"
        ],
        "name": "instance1",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": null
      },
      {
        "timeSeriesId": [
          "Id1Two",
          "Id2Two",
          "2.0"
        ],
        "name": "instance2",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": null
      }
    ],
    "hitCount": 2,
    "continuationToken": null
  },
  "hierarchyNodes": null
}

SearchInstancesUntilChildren

Sample Request

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

{
  "searchString": "floor 100",
  "path": [
    "Location"
  ],
  "instances": {
    "recursive": false,
    "sort": {
      "by": "DisplayName"
    },
    "highlights": false,
    "pageSize": 2
  },
  "hierarchies": {
    "expand": {
      "kind": "UntilChildren"
    },
    "sort": {
      "by": "Name"
    },
    "pageSize": 2
  }
}

Sample Response

Status code:
200 
{
  "instances": {
    "hits": [],
    "hitCount": 0,
    "continuationToken": null
  },
  "hierarchyNodes": {
    "hits": [
      {
        "name": "California",
        "cumulativeInstanceCount": 2,
        "hierarchyNodes": {
          "hits": [
            {
              "name": "San Diego",
              "cumulativeInstanceCount": 1,
              "hierarchyNodes": null
            },
            {
              "name": "San Francisco",
              "cumulativeInstanceCount": 1,
              "hierarchyNodes": null
            }
          ],
          "hitCount": 2,
          "continuationToken": null
        }
      }
    ],
    "hitCount": 1,
    "continuationToken": null
  }
}

Tanımlar

Name Description
HierarchiesExpandKind

Hiyerarşi düğümlerinin genişletilmesi türü. 'UntilChildren' olarak ayarlandığında, hiyerarşi düğümleri birden fazla alt öğe olana kadar yinelemeli olarak genişletilir. 'OneLevel' olarak ayarlandığında, hiyerarşiler yalnızca tek düzeyli eşleşen yol arama örnekleri parametresinde genişletilir. İsteğe bağlı, varsayılan değer 'UntilChildren'dır.
HierarchiesExpandParameter

Aynı arama örnekleri çağrısında hiyerarşi düğümlerinin genişletilip genişletılmeyeceğinin tanımı.
HierarchiesSortBy

Hiyerarşi düğümü sıralama için kullanılacak değer. 'CumulativeInstanceCount' olarak ayarlandığında, döndürülen hiyerarşiler hiyerarşi düğümüne ve alt hiyerarşi düğümlerine ait toplam örneklere göre sıralanır. 'Ad' olarak ayarlandığında, döndürülen hiyerarşiler hiyerarşi adına göre sıralanır. İsteğe bağlı olarak varsayılan değer 'CumulativeInstanceCount'tır.
HierarchiesSortParameter

Hiyerarşi düğümlerinin sıralama tanımı.
HierarchyHit

Girişe göre sorguyla eşleşen örnekleri içeren hiyerarşi düğümü. Boş veya null olabilir.
Highlights

Kullanıcıya görüntülenecek zaman serisi örneğinin vurgulanan metni. Metnin arama dizesiyle eşleşen bölümlerine ekler ve etiketler vurgulanır. Daha fazla API çağrısı yapmak için vurgulanan özelliklerden hiçbirini kullanmayın.
InstanceHit

Örnekler arama çağrısı tarafından döndürülen zaman serisi örneği. Döndürülen örnek arama isteğiyle eşleşmiş ve 'true' olarak ayarlanmışsa kullanıcıya görüntülenecek vurgulanmış metin içeriyor.
InstancesSortBy

Arama örnekleri çağrısı tarafından döndürülmeden önce zaman serisi örneklerini sıralamak için kullanılacak değer. 'Derece' olarak ayarlandığında, döndürülen örnekler ilgi düzeyine göre sıralanır. 'DisplayName' olarak ayarlandığında, döndürülen sonuçlar görünen ada göre sıralanır. Görünen ad, varsa örneğin adıdır, aksi takdirde görünen ad zaman serisi kimliğidir. Varsayılan değer 'Derece'dir.
InstancesSortParameter

Zaman serisi örneklerinin arama örnekleri çağrısı tarafından döndürülmeden önce nasıl sıralandığının tanımı.
SearchHierarchyNodesResponse

Girişe göre sorguyla eşleşen örnekleri içeren hiyerarşi düğümleri. Boş veya null olabilir.
SearchInstancesHierarchiesParameters

Arama örnekleri çağrısına göre zaman serisi örneği hiyerarşilerinin nasıl döndürüleceği parametresi.
SearchInstancesParameters

Arama örneklerine göre zaman serisi örneklerinin nasıl döndürüleceğiyle ilgili parametreler çağrısı.
SearchInstancesRequest

Zaman serisi örneklerine karşı bir arama sorgusu yürütme ve eşleşen zaman serisi örneklerini döndürme isteği.
SearchInstancesResponse

Girişe göre sorguyla eşleşen örnekler. Boş veya null olabilir.
SearchInstancesResponsePage

Arama sonuçlarının tek sayfası.
TsiError

API hatası hakkında bilgi.
TsiErrorBody

Hata kodu ve ileti içeren belirli bir API hatası.
TsiErrorDetails

Ek hata bilgileri.

HierarchiesExpandKind

Hiyerarşi düğümlerinin genişletilmesi türü. 'UntilChildren' olarak ayarlandığında, hiyerarşi düğümleri birden fazla alt öğe olana kadar yinelemeli olarak genişletilir. 'OneLevel' olarak ayarlandığında, hiyerarşiler yalnızca tek düzeyli eşleşen yol arama örnekleri parametresinde genişletilir. İsteğe bağlı, varsayılan değer 'UntilChildren'dır.

Name Tür Description
OneLevel

string

UntilChildren

string

HierarchiesExpandParameter

Aynı arama örnekleri çağrısında hiyerarşi düğümlerinin genişletilip genişletılmeyeceğinin tanımı.

Name Tür Description
kind

HierarchiesExpandKind

Hiyerarşi düğümlerinin genişletilmesi türü. 'UntilChildren' olarak ayarlandığında, hiyerarşi düğümleri birden fazla alt öğe olana kadar yinelemeli olarak genişletilir. 'OneLevel' olarak ayarlandığında, hiyerarşiler yalnızca tek düzeyli eşleşen yol arama örnekleri parametresinde genişletilir. İsteğe bağlı, varsayılan değer 'UntilChildren'dır.

HierarchiesSortBy

Hiyerarşi düğümü sıralama için kullanılacak değer. 'CumulativeInstanceCount' olarak ayarlandığında, döndürülen hiyerarşiler hiyerarşi düğümüne ve alt hiyerarşi düğümlerine ait toplam örneklere göre sıralanır. 'Ad' olarak ayarlandığında, döndürülen hiyerarşiler hiyerarşi adına göre sıralanır. İsteğe bağlı olarak varsayılan değer 'CumulativeInstanceCount'tır.

Name Tür Description
CumulativeInstanceCount

string

Name

string

HierarchiesSortParameter

Hiyerarşi düğümlerinin sıralama tanımı.

Name Tür Description
by

HierarchiesSortBy

Hiyerarşi düğümü sıralama için kullanılacak değer. 'CumulativeInstanceCount' olarak ayarlandığında, döndürülen hiyerarşiler hiyerarşi düğümüne ve alt hiyerarşi düğümlerine ait toplam örneklere göre sıralanır. 'Ad' olarak ayarlandığında, döndürülen hiyerarşiler hiyerarşi adına göre sıralanır. İsteğe bağlı olarak varsayılan değer 'CumulativeInstanceCount'tır.

HierarchyHit

Girişe göre sorguyla eşleşen örnekleri içeren hiyerarşi düğümü. Boş veya null olabilir.

Name Tür Description
cumulativeInstanceCount

integer

Bu düğüme ait olan toplam örnek sayısı ve sorguyla eşleşen alt çizgiler.
hierarchyNodes

SearchHierarchyNodesResponse

Bu düğümün alt hiyerarşi düğümleri. Boş veya null olabilir.
name

string

Hiyerarşi düğümünün adı. Boş olabilir, null olamaz.

Highlights

Kullanıcıya görüntülenecek zaman serisi örneğinin vurgulanan metni. Metnin arama dizesiyle eşleşen bölümlerine ekler ve etiketler vurgulanır. Daha fazla API çağrısı yapmak için vurgulanan özelliklerden hiçbirini kullanmayın.

Name Tür Description
description

string

Zaman serisi örneğinin vurgulanmış açıklaması. Null olabilir.
hierarchyIds

string[]

Zaman serisi örneğinin ait olduğu vurgulanan zaman serisi hiyerarşi kimliklerinin listesi. Hiyerarşileri aramak için kullanılamaz. Null olabilir.
hierarchyNames

string[]

Zaman serisi örneğinin ait olduğu vurgulanan zaman serisi hiyerarşi adlarının listesi. Hiyerarşileri aramak için kullanılamaz. Null olabilir.
instanceFieldNames

string[]

Vurgulanan zaman serisi örneği alan adlarının listesi. Null olabilir.
instanceFieldValues

string[]

Vurgulanan zaman serisi örneği alan değerlerinin listesi. Null olabilir.
name

string

Zaman serisi örneğinin vurgulanan adı. Null olabilir.
timeSeriesId

string[]

Görüntülenecek Zaman Serisi Kimliği'nin vurgulanan dize değerlerinin listesi. Örneği aramak için kullanılamaz.
typeName

string

Bu örneğin ait olduğu zaman serisi türü adı vurgulandı.

InstanceHit

Örnekler arama çağrısı tarafından döndürülen zaman serisi örneği. Döndürülen örnek arama isteğiyle eşleşmiş ve 'true' olarak ayarlanmışsa kullanıcıya görüntülenecek vurgulanmış metin içeriyor.

Name Tür Description
hierarchyIds

string[]

Arama isteğiyle eşleşen zaman serisi örneğinin ait olduğu zaman serisi hiyerarşi kimliklerinin listesi. Hiyerarşileri aramak için kullanılamaz. Null olabilir.
highlights

Highlights

Kullanıcıya görüntülenecek zaman serisi örneğinin vurgulanan metni. Metnin arama dizesiyle eşleşen bölümlerine ekler ve etiketler vurgulanır. Daha fazla API çağrısı yapmak için vurgulanan özelliklerden hiçbirini kullanmayın.
name

string

Arama isteğiyle eşleşen zaman serisi örneğinin adı. Null olabilir.
timeSeriesId

TimeSeriesId[]

Arama isteğiyle eşleşen zaman serisi örneğinin zaman serisi kimliği.
typeId

string

Arama isteğiyle eşleşen zaman serisi örneğinin ait olduğu türü temsil eder. Hiçbir zaman null.

InstancesSortBy

Arama örnekleri çağrısı tarafından döndürülmeden önce zaman serisi örneklerini sıralamak için kullanılacak değer. 'Derece' olarak ayarlandığında, döndürülen örnekler ilgi düzeyine göre sıralanır. 'DisplayName' olarak ayarlandığında, döndürülen sonuçlar görünen ada göre sıralanır. Görünen ad, varsa örneğin adıdır, aksi takdirde görünen ad zaman serisi kimliğidir. Varsayılan değer 'Derece'dir.

Name Tür Description
DisplayName

string

Rank

string

InstancesSortParameter

Zaman serisi örneklerinin arama örnekleri çağrısı tarafından döndürülmeden önce nasıl sıralandığının tanımı.

Name Tür Description
by

InstancesSortBy

Arama örnekleri çağrısı tarafından döndürülmeden önce zaman serisi örneklerini sıralamak için kullanılacak değer. 'Derece' olarak ayarlandığında, döndürülen örnekler ilgi düzeyine göre sıralanır. 'DisplayName' olarak ayarlandığında, döndürülen sonuçlar görünen ada göre sıralanır. Görünen ad, varsa örneğin adıdır, aksi takdirde görünen ad zaman serisi kimliğidir. Varsayılan değer 'Derece'dir.

SearchHierarchyNodesResponse

Girişe göre sorguyla eşleşen örnekleri içeren hiyerarşi düğümleri. Boş veya null olabilir.

Name Tür Description
continuationToken

string

Döndürülürse, geçerli sonuçların kısmi sonucu temsil ettiğini gösterir. Devamlılık belirteci, bir sonraki sonuç sayfasını almaya olanak tanır. Sorgu sonuçlarının sonraki sayfasını almak için aynı isteği "x-ms-continuation" HTTP üst bilgisinde devamlılık belirteci parametresiyle gönderin.
hitCount

integer

Girişe göre sorguyla eşleşen örnekleri içeren hiyerarşi düğümlerinin toplam sayısı.
hits

HierarchyHit[]

Girişe göre sorguyla eşleşen örnekleri içeren hiyerarşi düğümlerinin listesi. Boş olabilir.

SearchInstancesHierarchiesParameters

Arama örnekleri çağrısına göre zaman serisi örneği hiyerarşilerinin nasıl döndürüleceği parametresi.

Name Tür Description
expand

HierarchiesExpandParameter

Aynı arama örnekleri çağrısında hiyerarşi düğümlerinin genişletilip genişletılmeyeceğinin tanımı. İsteğe bağlı, varsayılan değer 'UntilChildren'dır.
pageSize

integer

Aynı sayfada döndürülecek aynı düzeydeki hiyerarşi sayısı üst sınırı. İsteğe bağlı olarak, ayarlanmadığında varsayılan değer 10'dur. Aralık 1 ile 100 arasındadır. Sayfa boyutunu aşan sonuçlar varsa, sonraki sayfayı getirmek için devamlılık belirteci kullanılabilir.
sort

HierarchiesSortParameter

Hiyerarşi düğümlerinin sıralama tanımı. İsteğe bağlı olarak varsayılan değer 'CumulativeInstanceCount'tır.

SearchInstancesParameters

Arama örneklerine göre zaman serisi örneklerinin nasıl döndürüleceğiyle ilgili parametreler çağrısı.

Name Tür Description
highlights

boolean

Vurgulanan arama sonuçlarının tanımı veya olmaması. 'True' olarak ayarlandığında, vurgulanan arama sonuçları döndürülür. 'false' olarak ayarlandığında, vurgulanan arama sonuçları döndürülmüyor. Varsayılan değer :'true'.
pageSize

integer

Sonucun her sayfasında beklenen en fazla örnek sayısı. Ayarlanmadığında varsayılan değer 10'dır. 1 ile 100 arasında değişir. Sayfa boyutunu aşan sonuçlar varsa, kullanıcı bir sonraki sayfayı getirmek için devamlılık belirtecini kullanabilir.
recursive

boolean

Döndürülen örneklerin tanımı. Özyinelemeli 'true' olarak ayarlandığında path parametresiyle başlayan yolu olan tüm örnekler döndürülür. Özyinelemeli 'false' olarak ayarlandığında, yalnızca path parametresiyle tam olarak eşleşen yolu olan örnekler döndürülür. Özyinelemeli arama kullanmak arama kullanıcı deneyimini uygulamaya olanak sağlarken, özyinelemeli olmayan arama kullanmak gezinti deneyimini uygulamaya olanak tanır. İsteğe bağlı, varsayılan değer 'true'.
sort

InstancesSortParameter

Zaman serisi örneklerinin arama örnekleri tarafından döndürülmeden önce nasıl sıralandığının tanımı - ilgi veya alfabetik. İsteğe bağlı olarak, varsayılan değer "Derece"dir.

SearchInstancesRequest

Zaman serisi örneklerine karşı bir arama sorgusu yürütme ve eşleşen zaman serisi örneklerini döndürme isteği.

Name Tür Description
hierarchies

SearchInstancesHierarchiesParameters

Zaman serisi örnek hiyerarşilerinin nasıl döndürüleceğiyle ilgili parametreler. Null ise hiyerarşiler döndürülmüyor. Instances parametresi null ise ve hiyerarşiler parametresi null değilse, yalnızca örneği olmayan hiyerarşiler döndürülür.
instances

SearchInstancesParameters

Zaman serisi örneklerinin nasıl döndürüleceğiyle ilgili parametreler. Boş olabilir. Hem örnekler hem de hiyerarşi parametreleri null olduğunda, parametrelerdeki varsayılan değerlere göre sonuçlarda örnekler döndürülür ve hiyerarşiler döndürülür.
path

string[]

Zaman serisi örneklerinin hiyerarşi yoluna göre filtreleyin. Yol, dize yolu kesimleri dizisi olarak temsil edilir. İlk öğe hiyerarşi adı olmalıdır. Örnek: ["Konum", "California"]. İsteğe bağlı, büyük/küçük harfe duyarlı, hiçbir zaman boş değildir ve null olabilir.
searchString

string

Zaman serisi örneklerinin öznitelikleriyle eşleştirilecek sorgu arama dizesi. Örnek: "kat 100". Büyük/küçük harfe duyarsız olmalıdır, ancak boş dize olabilir.

SearchInstancesResponse

Girişe göre sorguyla eşleşen örnekler. Boş veya null olabilir.

Name Tür Description
continuationToken

string

Döndürülürse, geçerli sonuçların kısmi sonucu temsil ettiğini gösterir. Devamlılık belirteci, bir sonraki sonuç sayfasını almaya olanak tanır. Sorgu sonuçlarının sonraki sayfasını almak için aynı isteği "x-ms-continuation" HTTP üst bilgisinde devamlılık belirteci parametresiyle gönderin.
hitCount

integer

Girişe göre sorguyla eşleşen toplam örnek sayısı.
hits

InstanceHit[]

Girişe göre sorguyla eşleşen örneklerin listesi. Boş olabilir.

SearchInstancesResponsePage

Arama sonuçlarının tek sayfası.

Name Tür Description
hierarchyNodes

SearchHierarchyNodesResponse

Girişe göre sorguyla eşleşen örnekleri içeren hiyerarşi düğümleri. Boş veya null olabilir.
instances

SearchInstancesResponse

Girişe göre sorguyla eşleşen örnekler. Boş veya null olabilir.

TsiError

API hatası hakkında bilgi.

Name Tür Description
error

TsiErrorBody

Hata kodu ve ileti içeren belirli bir API hatası.

TsiErrorBody

Hata kodu ve ileti içeren belirli bir API hatası.

Name Tür Description
code

string

Hizmete özgü hata kodunu tanımlayan dilden bağımsız, okunabilir dize. Bu kod, yanıtta belirtilen HTTP hata kodu için daha özel bir gösterge görevi görür. Belirli hata durumlarını program aracılığıyla işlemek için kullanılabilir.
details

TsiErrorDetails[]

Ek hata bilgileri içerir. Null olabilir.
innerError

TsiErrorBody

Nedeni daraltan daha belirli bir hata içerir. Null olabilir.
message

string

Hatanın insan tarafından okunabilir, dilden bağımsız gösterimi. Geliştiricilere yardım amaçlıdır ve son kullanıcılara açıklanma için uygun değildir.
target

string

Belirli bir hatanın hedefi (örneğin, hatadaki özelliğin adı). Null olabilir.

TsiErrorDetails

Ek hata bilgileri.

Name Tür Description
code

string

Hizmete özgü hata kodunu tanımlayan dilden bağımsız, okunabilir dize. Bu kod, yanıtta belirtilen HTTP hata kodu için daha özel bir gösterge görevi görür. Belirli hata durumlarını program aracılığıyla işlemek için kullanılabilir.
message

string

Hatanın insan tarafından okunabilir, dilden bağımsız gösterimi. Geliştiricilere yardım amaçlıdır ve son kullanıcılara açıklanma için uygun değildir.