API de modelo de Azure Time Series Insights Gen2

Información general

Cada uno de los tres componentes que hacen que un modelo de serie temporal (instancias, jerarquías y tipos) tenga las API REST correspondientes que admiten operaciones CREATE, READ, UPDATE y DELETE, paginadas o por lotes.

• Instance API admite operaciones GET paginadas, operaciones CREATE, READ, UPDATE y DELETE paginadas, búsquedas y sugerencias de palabras clave para las operaciones de búsqueda.
• Hierarchy API admite operaciones GET paginadas y operaciones CREATE, READ, UPDATE y DELETE paginadas.
• Type API admite operaciones GET paginadas y operaciones CREATE, READ, UPDATE y DELETE paginadas.

Una cuarta API proporciona compatibilidad con REST para la configuración del modelo de serie temporal:

• La API de configuración del modelo admite operaciones HTTP GET y UPDATE para las opciones de configuración del modelo de serie temporal. Lea Modelo de serie temporal para obtener información detallada sobre el modelo de serie temporal y las definiciones de instancia, jerarquía y tipo .

API de instancias

Instances API permite realizar operaciones CREATE, READ, UPDATE y DELETE en instancias de serie temporal:

• Get Instances API devuelve todas las instancias de serie temporal que coinciden con la solicitud.

• Manage Instances API habilita las operaciones por lotes en instancias. Todas las operaciones en esta API son operaciones HTTP POST . Cada operación acepta una carga. La carga es un objeto JSON. Este objeto define una sola propiedad. La clave de propiedad es el nombre de una operación permitida por la API. Las operaciones admitidas son PUT, UPDATE y DELETE.

• Estas API permiten la detección de instancias de serie temporal:

  • Sugerir habilitará escenarios de autocompletar mientras se busca una instancia.
  • La búsqueda ayuda a identificar las instancias en función de las palabras clave proporcionadas.

  Sugerencia

  Obtenga información sobre las características de consulta de búsqueda a continuación.

API de jerarquías

Hierarchies API habilita CREATE, READ, UPDATE y DELETE en jerarquías de serie temporal.

API	Descripción
Get Hierarchies API	Devuelve todas las jerarquías de serie temporal que coinciden con la solicitud.
Administración de las API de jerarquías	Habilita las operaciones por lotes en jerarquías. Todas las operaciones en esta API son operaciones HTTP POST . Cada operación acepta una carga. La carga es un objeto JSON. Este objeto define una sola propiedad. La clave de propiedad es el nombre de una operación que la API permite. Las operaciones admitidas son PUT, UPDATE y DELETE.

API de tipos

La API types habilita CREATE, READ, UPDATE y DELETE en tipos de serie temporal y sus variables asociadas.

API	Descripción
Get Types API	Devuelve todos los tipos de serie temporal y sus variables asociadas.
API de tipos posteriores	Habilita las operaciones por lotes en tipos. Todas las operaciones en esta API son operaciones HTTP POST . Cada operación acepta una carga. La carga es un objeto JSON. Este objeto define una sola propiedad. La clave de propiedad es el nombre de una operación que la API permite. Las operaciones admitidas son PUT, UPDATE y DELETE.

API de configuración del modelo

La API de configuración del modelo habilita CREATE, READ, UPDATE y DELETE en los modelos creados automáticamente en el entorno por TimeSeriesIds.

API	Descripción
Get Model Settings API	Devuelve el modelo creado automáticamente en el entorno de TimeSeriesIds.
Update Model Settings API	Novedades el modelo en el entorno de TimeSeriesIds con los nuevos valores proporcionados en la solicitud.

Características de búsqueda

Búsquedas con caracteres comodín

Se admiten búsquedas de caracteres comodín únicos y múltiples dentro de términos únicos (no dentro de las búsquedas de frases).

Cualquier carácter

Para realizar una búsqueda de caracteres comodín de un solo carácter, use el ? símbolo . La búsqueda de caracteres comodín de un solo carácter busca términos que coincidan con la cadena con el carácter único reemplazado.

Para buscar o texttest, busque: te?t.

Varios caracteres

Para realizar una búsqueda con caracteres comodín de varios caracteres, use el * símbolo . Varias búsquedas de caracteres comodín buscan cero o más caracteres.

Para buscar test, testso tester, use la búsqueda: test*.

También puede usar las búsquedas de caracteres comodín en medio de un término. Para buscar dryer, puede usar la búsqueda: dr*r.

Operadores booleanos

Los operadores booleanos permiten combinar términos mediante operadores lógicos. Se admite AND, OR, +, -y NOT como operadores booleanos.

Importante

• Los operadores booleanos deben estar en ALL CAPS.
• Los operadores booleanos deben estar separados de cláusulas de búsqueda mediante espacios en blanco.
• dryer AND washer es válido pero no dryer ANDwasheres .

Operador AND

El operador AND coincide con los documentos en los que ambos términos existen en cualquier parte del texto de un único documento.

Para buscar documentos que contengan dryer washer y foo bar usen la búsqueda: dryer washer AND foo bar.

Nota

El símbolo && se puede usar en lugar del operador AND.

Operador OR

El operador OR vincula dos términos y busca un documento coincidente si alguno de los términos existe en un documento. El operador OR es el operador de combinación predeterminado. Esto significa que si no hay ningún operador booleano entre dos términos, se usa el operador OR .

Para buscar documentos que contengan dryer washer o simplemente dryer usen cualquiera de las búsquedas siguientes:

1. 'dryer washer' dryer
2. 'dryer washer' OR dryer

Nota

El símbolo || se puede usar en lugar del operador OR.

+ (Operador)

El + operador o obligatorio requiere que el término después del + símbolo exista en algún lugar de un campo de un único documento.

Para buscar documentos que deben contener dryer y que pueden contener washer , use la búsqueda: +dryer washer.

- (Operador)

El - operador o de prohibición excluye documentos que contienen el término después del - símbolo.

Para buscar documentos que contengan dryer washer pero no foo bar usen la búsqueda: dryer washer -foo bar.

NOT

El operador NOT excluye los documentos que contienen el término después NOTde .

Para buscar documentos que contengan dryer washer pero no foo bar usen la búsqueda: dryer washer NOT foo bar.

El operador NOT no se puede usar con un solo término.

La siguiente búsqueda no devolverá ningún resultado: NOT dryer washer.

Nota

El símbolo ! se puede usar en lugar del operador NOT.

• Debe preceder inmediatamente al término de búsqueda excluido.
• dryer !washer es válido pero no dryer ! washeres .

Consulte también

• Para más información sobre el registro de aplicaciones y el modelo de programación de Azure Active Directory, consulte Azure Active Directory para desarrolladores.

• Para obtener información sobre los parámetros de solicitud y autenticación, lea Autenticación y autorización.

• Entre las herramientas que ayudan a probar las solicitudes y respuestas HTTP se incluyen las siguientes:

• Fiddler. Este proxy de depuración web gratuito puede interceptar las solicitudes REST, por lo que puede diagnosticar los mensajes de solicitud y respuesta HTTP.

• JWT.io. Puede usar esta herramienta para volcar rápidamente las notificaciones en el token de portador y, a continuación, validar su contenido.

• Postman. Se trata de una herramienta gratuita de prueba de solicitudes y respuestas HTTP para depurar las API REST.

• Para obtener más información sobre Azure Time Series Insights Gen2, revise la documentación de Gen2.