Compartir a través de

Time Series Instances - Search

  • Referencia
Servicio:
Time Series Insights
Versión de la API:
2020-07-31

Lista parcial de aciertos en la búsqueda de instancias de serie temporal basadas en atributos de instancia.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
environmentFqdn
 path True

string

Por FQDN de entorno, por ejemplo, 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Puede obtener este nombre de dominio de la respuesta de Get Environments API, Azure Portal o Azure Resource Manager.
api-version
 query True

string

Versión de la API que se va a usar con la solicitud de cliente. La versión admitida actualmente es "2020-07-31".

Encabezado de la solicitud

Nombre Requerido Tipo Description
x-ms-continuation

string

Token de continuación de la página anterior de resultados para recuperar la página siguiente de los resultados en llamadas que admiten la paginación. Para obtener los resultados de la primera página, especifique el token de continuación null como valor de parámetro. El token de continuación devuelto es NULL si se han devuelto todos los resultados y no hay ninguna página siguiente de resultados.
x-ms-client-request-id

string

Identificador de solicitud de cliente opcional. El servicio registra este valor. Permite al servicio realizar un seguimiento de la operación entre servicios y permite al cliente ponerse en contacto con el soporte técnico con respecto a una solicitud determinada.
x-ms-client-session-id

string

Identificador de sesión de cliente opcional. El servicio registra este valor. Permite al servicio realizar un seguimiento de un grupo de operaciones relacionadas entre servicios y permite al cliente ponerse en contacto con el soporte técnico con respecto a un grupo determinado de solicitudes.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
searchString True

string

Cadena de búsqueda de consulta que coincidirá con los atributos de las instancias de serie temporal. Ejemplo: "piso 100". No distingue mayúsculas de minúsculas, debe estar presente, pero puede ser una cadena vacía.
hierarchies

SearchInstancesHierarchiesParameters

Parámetros de cómo devolver jerarquías de instancias de serie temporal. Si es null, no se devuelven jerarquías. Si el parámetro instances es null y el parámetro hierarchies no es null, solo se devuelven jerarquías sin instancias.
instances

SearchInstancesParameters

Parámetros de cómo devolver instancias de serie temporal. Puede ser NULL. Cuando los parámetros de instancias y jerarquías son null, las instancias se devuelven en los resultados en función de los valores predeterminados de los parámetros y no se devuelven las jerarquías.
path

string[]

Filtre por la ruta de acceso de jerarquía de las instancias de serie temporal. La ruta de acceso se representa como matriz de segmentos de ruta de acceso de cadena. El primer elemento debe ser el nombre de la jerarquía. Ejemplo: ["Location", "California"]. Opcional, distingue mayúsculas de minúsculas, nunca está vacía y puede ser null.

Respuestas

Nombre Tipo Description
200 OK

SearchInstancesResponsePage

Respuesta de búsqueda correcta.

Encabezados

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

TsiError

error inesperado.

Encabezados

x-ms-request-id: string

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

SearchInstancesDefault
SearchInstancesExpandHierarchiesOnly
SearchInstancesHierarchiesDefaultInputPage1
SearchInstancesHierarchiesDefaultInputPage2
SearchInstancesHierarchiesDefaultInputPage3
SearchInstancesOneLevel
SearchInstancesRecursive
SearchInstancesUntilChildren

SearchInstancesDefault

Solicitud de ejemplo

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

{
  "searchString": "floor 100"
}

Respuesta de muestra

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

Solicitud de ejemplo

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
  }
}

Respuesta de muestra

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

Solicitud de ejemplo

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
  }
}

Respuesta de muestra

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

Solicitud de ejemplo

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
  }
}

Respuesta de muestra

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

Solicitud de ejemplo

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
  }
}

Respuesta de muestra

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

Solicitud de ejemplo

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
  }
}

Respuesta de muestra

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

SearchInstancesRecursive

Solicitud de ejemplo

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
}

Respuesta de muestra

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

Solicitud de ejemplo

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
  }
}

Respuesta de muestra

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
  }
}

Definiciones

Nombre Description
HierarchiesExpandKind

Tipo de expansión de nodos de jerarquía. Cuando se establece en "UntilChildren", los nodos de jerarquía se expanden de forma recursiva hasta que haya más de un elemento secundario. Cuando se establece en "OneLevel", las jerarquías solo se expanden en el parámetro de instancias de búsqueda de ruta de acceso coincidente de nivel único. Opcional, el valor predeterminado es "UntilChildren".
HierarchiesExpandParameter

Definición de si se van a expandir los nodos de jerarquía en la misma llamada de instancias de búsqueda.
HierarchiesSortBy

Valor que se va a usar para la ordenación de nodos de jerarquía. Cuando se establece en "CumulativeInstanceCount", las jerarquías devueltas se ordenan en función de las instancias totales que pertenecen al nodo de jerarquía y a sus nodos de jerarquía secundarios. Cuando se establece en "Name", las jerarquías devueltas se ordenan en función del nombre de la jerarquía. Opcional, el valor predeterminado es "CumulativeInstanceCount".
HierarchiesSortParameter

Definición de la ordenación de nodos de jerarquía.
HierarchyHit

Nodo de jerarquía que contiene las instancias que coinciden con la consulta en función de la entrada. Puede estar vacío o nulo.
Highlights

Texto resaltado de la instancia de serie temporal que se mostrará al usuario. Resaltado de inserciones y etiquetas en las partes del texto que coinciden con la cadena de búsqueda. No use ninguna de las propiedades resaltadas para realizar más llamadas API.
InstanceHit

Instancia de serie temporal que devuelve la llamada de búsqueda de instancias. La instancia devuelta coincide con la solicitud de búsqueda y contiene el texto resaltado que se mostrará al usuario si está establecido en "true".
InstancesSortBy

Valor que se va a usar para ordenar las instancias de serie temporal antes de que las instancias de búsqueda llamen a . Cuando se establece en "Rank", las instancias devueltas se ordenan en función de la relevancia. Cuando se establece en "DisplayName", los resultados devueltos se ordenan en función del nombre para mostrar. El nombre para mostrar es el nombre de la instancia si existe; de lo contrario, el nombre para mostrar es el identificador de serie temporal. El valor predeterminado es "Rank".
InstancesSortParameter

Definición de cómo se ordenan las instancias de serie temporal antes de devolverse mediante la llamada a instancias de búsqueda.
SearchHierarchyNodesResponse

Nodos de jerarquía que contienen las instancias que coinciden con la consulta en función de la entrada. Puede estar vacío o nulo.
SearchInstancesHierarchiesParameters

Parámetro de cómo devolver jerarquías de instancias de serie temporal mediante la llamada a instancias de búsqueda.
SearchInstancesParameters

Parámetros de cómo devolver instancias de serie temporal mediante la llamada a instancias de búsqueda.
SearchInstancesRequest

Solicite ejecutar una consulta de búsqueda en las instancias de serie temporal y devolver instancias de serie temporal coincidentes.
SearchInstancesResponse

Las instancias que coinciden con la consulta en función de la entrada. Puede estar vacío o nulo.
SearchInstancesResponsePage

Página única de los resultados de la búsqueda.
TsiError

Información sobre un error de API.
TsiErrorBody

Un error de API determinado con un código de error y un mensaje.
TsiErrorDetails

Información adicional sobre errores.

HierarchiesExpandKind

Tipo de expansión de nodos de jerarquía. Cuando se establece en "UntilChildren", los nodos de jerarquía se expanden de forma recursiva hasta que haya más de un elemento secundario. Cuando se establece en "OneLevel", las jerarquías solo se expanden en el parámetro de instancias de búsqueda de ruta de acceso coincidente de nivel único. Opcional, el valor predeterminado es "UntilChildren".

Nombre Tipo Description
OneLevel

string

UntilChildren

string

HierarchiesExpandParameter

Definición de si se van a expandir los nodos de jerarquía en la misma llamada de instancias de búsqueda.

Nombre Tipo Description
kind

HierarchiesExpandKind

Tipo de expansión de nodos de jerarquía. Cuando se establece en "UntilChildren", los nodos de jerarquía se expanden de forma recursiva hasta que haya más de un elemento secundario. Cuando se establece en "OneLevel", las jerarquías solo se expanden en el parámetro de instancias de búsqueda de ruta de acceso coincidente de nivel único. Opcional, el valor predeterminado es "UntilChildren".

HierarchiesSortBy

Valor que se va a usar para la ordenación de nodos de jerarquía. Cuando se establece en "CumulativeInstanceCount", las jerarquías devueltas se ordenan en función de las instancias totales que pertenecen al nodo de jerarquía y a sus nodos de jerarquía secundarios. Cuando se establece en "Name", las jerarquías devueltas se ordenan en función del nombre de la jerarquía. Opcional, el valor predeterminado es "CumulativeInstanceCount".

Nombre Tipo Description
CumulativeInstanceCount

string

Name

string

HierarchiesSortParameter

Definición de la ordenación de nodos de jerarquía.

Nombre Tipo Description
by

HierarchiesSortBy

Valor que se va a usar para la ordenación de nodos de jerarquía. Cuando se establece en "CumulativeInstanceCount", las jerarquías devueltas se ordenan en función de las instancias totales que pertenecen al nodo de jerarquía y sus nodos de jerarquía secundarios. Cuando se establece en "Name", las jerarquías devueltas se ordenan en función del nombre de la jerarquía. Opcional, el valor predeterminado es "CumulativeInstanceCount".

HierarchyHit

Nodo de jerarquía que contiene las instancias que coinciden con la consulta en función de la entrada. Puede estar vacío o nulo.

Nombre Tipo Description
cumulativeInstanceCount

integer

Número total de instancias que pertenecen a este nodo y sus subárboles coinciden con la consulta.
hierarchyNodes

SearchHierarchyNodesResponse

Nodos de jerarquía secundaria de este nodo. Puede estar vacío o nulo.
name

string

Nombre del nodo de jerarquía. Puede estar vacío, no puede ser null.

Highlights

Texto resaltado de la instancia de serie temporal que se mostrará al usuario. Resaltado de inserciones y etiquetas en las partes del texto que coinciden con la cadena de búsqueda. No use ninguna de las propiedades resaltadas para realizar más llamadas API.

Nombre Tipo Description
description

string

Descripción resaltada de la instancia de serie temporal. Su valor puede ser null.
hierarchyIds

string[]

Lista de identificadores de jerarquía de series temporales resaltados a los que pertenece la instancia de serie temporal. No se puede usar para buscar jerarquías. Su valor puede ser null.
hierarchyNames

string[]

Lista de nombres de jerarquía de series temporales resaltados a los que pertenece la instancia de serie temporal. No se puede usar para buscar jerarquías. Su valor puede ser null.
instanceFieldNames

string[]

Lista de nombres de campo de instancia de serie temporal resaltados. Su valor puede ser null.
instanceFieldValues

string[]

Lista de valores de campo de instancia de serie temporal resaltados. Su valor puede ser null.
name

string

Nombre resaltado de la instancia de serie temporal. Su valor puede ser null.
timeSeriesId

string[]

Lista de valores de cadena resaltados del identificador de serie temporal para mostrar. No se puede usar para la instancia de búsqueda.
typeName

string

Nombre de tipo de serie temporal resaltado al que pertenece esta instancia.

InstanceHit

Instancia de serie temporal que devuelve la llamada de búsqueda de instancias. La instancia devuelta coincide con la solicitud de búsqueda y contiene el texto resaltado que se mostrará al usuario si está establecido en "true".

Nombre Tipo Description
hierarchyIds

string[]

Lista de identificadores de jerarquía de series temporales a los que pertenece la instancia de serie temporal que coincide con la solicitud de búsqueda. No se puede usar para buscar jerarquías. Su valor puede ser null.
highlights

Highlights

Texto resaltado de la instancia de serie temporal que se mostrará al usuario. Resaltado de inserciones y etiquetas en las partes del texto que coinciden con la cadena de búsqueda. No use ninguna de las propiedades resaltadas para realizar más llamadas API.
name

string

Nombre de la instancia de serie temporal que coincide con la solicitud de búsqueda. Su valor puede ser null.
timeSeriesId

TimeSeriesId[]

Identificador de serie temporal de la instancia de serie temporal que coincide con la solicitud de búsqueda.
typeId

string

Representa el tipo al que pertenece la instancia de serie temporal que coincide con la solicitud de búsqueda. Nunca es null.

InstancesSortBy

Valor que se va a usar para ordenar las instancias de serie temporal antes de que las instancias de búsqueda llamen a . Cuando se establece en "Rank", las instancias devueltas se ordenan en función de la relevancia. Cuando se establece en "DisplayName", los resultados devueltos se ordenan en función del nombre para mostrar. El nombre para mostrar es el nombre de la instancia si existe; de lo contrario, el nombre para mostrar es el identificador de serie temporal. El valor predeterminado es "Rank".

Nombre Tipo Description
DisplayName

string

Rank

string

InstancesSortParameter

Definición de cómo se ordenan las instancias de serie temporal antes de devolverse mediante la llamada a instancias de búsqueda.

Nombre Tipo Description
by

InstancesSortBy

Valor que se va a usar para ordenar las instancias de serie temporal antes de que las instancias de búsqueda llamen a . Cuando se establece en "Rank", las instancias devueltas se ordenan en función de la relevancia. Cuando se establece en "DisplayName", los resultados devueltos se ordenan en función del nombre para mostrar. El nombre para mostrar es el nombre de la instancia si existe; de lo contrario, el nombre para mostrar es el identificador de serie temporal. El valor predeterminado es "Rank".

SearchHierarchyNodesResponse

Nodos de jerarquía que contienen las instancias que coinciden con la consulta en función de la entrada. Puede estar vacío o nulo.

Nombre Tipo Description
continuationToken

string

Si se devuelve, esto significa que los resultados actuales representan un resultado parcial. El token de continuación permite obtener la siguiente página de resultados. Para obtener la siguiente página de resultados de la consulta, envíe la misma solicitud con el parámetro de token de continuación en el encabezado HTTP "x-ms-continuation".
hitCount

integer

Número total de nodos de jerarquía que contiene las instancias que coinciden con la consulta en función de la entrada.
hits

HierarchyHit[]

Lista de nodos de jerarquía que contiene las instancias que coinciden con la consulta en función de la entrada. Puede estar vacío.

SearchInstancesHierarchiesParameters

Parámetro de cómo devolver jerarquías de instancias de serie temporal mediante la llamada a instancias de búsqueda.

Nombre Tipo Description
expand

HierarchiesExpandParameter

Definición de si se van a expandir los nodos de jerarquía en la misma llamada de instancias de búsqueda. Opcional, el valor predeterminado es "UntilChildren".
pageSize

integer

Número máximo de jerarquías en el mismo nivel que devolver en la misma página. Opcional, el valor predeterminado es 10 cuando no se establece. El intervalo es de 1 a 100. Si hay resultados más allá del tamaño de página, el token de continuación se puede usar para capturar la página siguiente.
sort

HierarchiesSortParameter

Definición de la ordenación de nodos de jerarquía. Opcional, el valor predeterminado es "CumulativeInstanceCount".

SearchInstancesParameters

Parámetros de cómo devolver instancias de serie temporal mediante la llamada a instancias de búsqueda.

Nombre Tipo Description
highlights

boolean

Definición de los resultados de búsqueda resaltados o no. Cuando se establece en "true", se devuelven los resultados de búsqueda resaltados. Cuando se establece en "false", no se devuelven los resultados de búsqueda resaltados. El valor predeterminado es 'true'.
pageSize

integer

Número máximo de instancias esperadas en cada página del resultado. El valor predeterminado es 10 cuando no se establece. Oscila entre 1 y 100. Si hay resultados más allá del tamaño de página, el usuario puede usar el token de continuación para capturar la página siguiente.
recursive

boolean

Definición de qué instancias se devuelven. Cuando se establece recursiva en "true", se devuelven todas las instancias que tienen la ruta de acceso que comienza por path. Cuando se establece recursiva en "false", solo se devuelven las instancias que tienen la ruta de acceso que coincide exactamente con el parámetro path. El uso de la búsqueda recursiva permite implementar la experiencia del usuario de búsqueda, mientras que el uso de la búsqueda no recursiva permite implementar la experiencia de navegación. Opcional, el valor predeterminado es "true".
sort

InstancesSortParameter

Definición de cómo se ordenan las instancias de serie temporal antes de devolverse mediante la llamada a instancias de búsqueda: relevancia o alfabética. Opcional, el valor predeterminado es "Rank".

SearchInstancesRequest

Solicite ejecutar una consulta de búsqueda en las instancias de serie temporal y devolver instancias de serie temporal coincidentes.

Nombre Tipo Description
hierarchies

SearchInstancesHierarchiesParameters

Parámetros de cómo devolver jerarquías de instancias de serie temporal. Si es null, no se devuelven jerarquías. Si el parámetro instances es null y el parámetro hierarchies no es NULL, solo se devuelven jerarquías sin instancias.
instances

SearchInstancesParameters

Parámetros de cómo devolver instancias de serie temporal. Puede ser NULL. Cuando las instancias y los parámetros de jerarquía son null, las instancias se devuelven en los resultados en función de los valores predeterminados de los parámetros y no se devuelven las jerarquías.
path

string[]

Filtre por la ruta de acceso de jerarquía de las instancias de serie temporal. La ruta de acceso se representa como matriz de segmentos de ruta de acceso de cadena. El primer elemento debe ser el nombre de la jerarquía. Ejemplo: ["Location", "California"]. Opcional, distingue mayúsculas de minúsculas, nunca está vacía y puede ser null.
searchString

string

Cadena de búsqueda de consulta que coincidirá con los atributos de las instancias de serie temporal. Ejemplo: "piso 100". No distingue mayúsculas de minúsculas, debe estar presente, pero puede ser una cadena vacía.

SearchInstancesResponse

Las instancias que coinciden con la consulta en función de la entrada. Puede estar vacío o nulo.

Nombre Tipo Description
continuationToken

string

Si se devuelve, esto significa que los resultados actuales representan un resultado parcial. El token de continuación permite obtener la siguiente página de resultados. Para obtener la siguiente página de resultados de la consulta, envíe la misma solicitud con el parámetro de token de continuación en el encabezado HTTP "x-ms-continuation".
hitCount

integer

Número total de instancias que coinciden con la consulta en función de la entrada.
hits

InstanceHit[]

Lista de instancias que coinciden con la consulta en función de la entrada. Puede estar vacío.

SearchInstancesResponsePage

Página única de los resultados de la búsqueda.

Nombre Tipo Description
hierarchyNodes

SearchHierarchyNodesResponse

Nodos de jerarquía que contienen las instancias que coinciden con la consulta en función de la entrada. Puede estar vacío o nulo.
instances

SearchInstancesResponse

Las instancias que coinciden con la consulta en función de la entrada. Puede estar vacío o nulo.

TsiError

Información sobre un error de API.

Nombre Tipo Description
error

TsiErrorBody

Un error de API determinado con un código de error y un mensaje.

TsiErrorBody

Un error de API determinado con un código de error y un mensaje.

Nombre Tipo Description
code

string

Cadena legible e independiente del lenguaje que define un código de error específico del servicio. Este código actúa como un indicador más específico para el código de error HTTP especificado en la respuesta. Se puede usar para controlar mediante programación casos de error específicos.
details

TsiErrorDetails[]

Contiene información de error adicional. Su valor puede ser null.
innerError

TsiErrorBody

Contiene un error más específico que limita la causa. Su valor puede ser null.
message

string

Representación independiente del idioma y legible del error. Está pensado como ayuda para los desarrolladores y no es adecuado para la exposición a los usuarios finales.
target

string

Destino del error determinado (por ejemplo, el nombre de la propiedad en error). Su valor puede ser null.

TsiErrorDetails

Información adicional sobre errores.

Nombre Tipo Description
code

string

Cadena legible e independiente del lenguaje que define un código de error específico del servicio. Este código sirve como indicador más específico para el código de error HTTP especificado en la respuesta. Se puede usar para controlar mediante programación casos de error específicos.
message

string

Representación independiente del idioma y legible del error. Está pensado como ayuda para los desarrolladores y no es adecuado para la exposición a los usuarios finales.