Compartir a través de

Time Series Types - Execute Batch

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

Ejecuta una operación de obtención, creación, actualización, eliminación por lotes en varios tipos de series temporales.

POST https://{environmentFqdn}/timeseries/types/$batch?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. Actualmente, la versión admitida es "2020-07-31".

Encabezado de la solicitud

Nombre Requerido Tipo Description
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 Tipo Description
delete

TypesRequestBatchGetOrDelete

Definición de los tipos de serie temporal que se van a eliminar.
get

TypesRequestBatchGetOrDelete

Definición de los tipos de serie temporal que se van a devolver.
put

TimeSeriesType[]

Definición de los tipos de serie temporal que se van a actualizar o crear.

Respuestas

Nombre Tipo Description
200 OK

TypesBatchResponse

Operación correcta.

Encabezados

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

TsiError

Error inesperado.

Encabezados

x-ms-request-id: string

Seguridad

azure_auth

Flujo de 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 suplantar la cuenta de usuario

Ejemplos

TypesBatchDeleteByIds
TypesBatchDeleteByNames
TypesBatchGetByIds
TypesBatchGetByNames
TypesBatchPut

TypesBatchDeleteByIds

Solicitud de ejemplo

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

{
  "delete": {
    "typeIds": [
      "9250f816-faed-44c4-88e6-630e5eefa38b"
    ]
  }
}

Respuesta de muestra

status code:
200 
{
  "delete": [
    null
  ]
}

TypesBatchDeleteByNames

Solicitud de ejemplo

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

{
  "delete": {
    "names": [
      "TemperatureSensor"
    ]
  }
}

Respuesta de muestra

status code:
200 
{
  "delete": [
    null
  ]
}

TypesBatchGetByIds

Solicitud de ejemplo

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

{
  "get": {
    "typeIds": [
      "1be09af9-f089-4d6b-9f0b-48018b5f7393",
      "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8"
    ],
    "names": null
  }
}

Respuesta de muestra

status code:
200 
{
  "get": [
    {
      "timeSeriesType": {
        "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "name": "DefaultType",
        "description": "Default type",
        "variables": {
          "EventCount": {
            "kind": "aggregate",
            "filter": null,
            "aggregation": {
              "tsx": "count()"
            }
          }
        }
      },
      "error": null
    },
    {
      "timeSeriesType": {
        "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
        "name": "TemperatureSensor",
        "description": "This is a temperature sensor.",
        "variables": {
          "AverageTemperature": {
            "kind": "numeric",
            "value": {
              "tsx": "$event.Temperature.Double"
            },
            "filter": null,
            "aggregation": {
              "tsx": "avg($value)"
            }
          }
        }
      },
      "error": null
    }
  ]
}

TypesBatchGetByNames

Solicitud de ejemplo

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

{
  "get": {
    "names": [
      "DefaultType",
      "TemperatureSensor"
    ]
  }
}

Respuesta de muestra

status code:
200 
{
  "get": [
    {
      "timeSeriesType": {
        "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "name": "DefaultType",
        "description": "Default type",
        "variables": {
          "EventCount": {
            "kind": "aggregate",
            "filter": null,
            "aggregation": {
              "tsx": "count()"
            }
          }
        }
      },
      "error": null
    },
    {
      "timeSeriesType": {
        "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
        "name": "TemperatureSensor",
        "description": "This is a temperature sensor.",
        "variables": {
          "AverageTemperature": {
            "kind": "numeric",
            "value": {
              "tsx": "$event.Temperature.Double"
            },
            "filter": null,
            "aggregation": {
              "tsx": "avg($value)"
            }
          }
        }
      },
      "error": null
    }
  ]
}

TypesBatchPut

Solicitud de ejemplo

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

{
  "put": [
    {
      "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
      "name": "DefaultType",
      "description": "My Default type",
      "variables": {
        "EventCount": {
          "kind": "aggregate",
          "filter": null,
          "aggregation": {
            "tsx": "count()"
          }
        }
      }
    },
    {
      "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
      "name": "OutdoorTemperatureSensor",
      "description": "This is an outdoor temperature sensor.",
      "variables": {
        "AverageTemperature": {
          "kind": "numeric",
          "value": {
            "tsx": "$event.Temperature.Double"
          },
          "filter": {
            "tsx": "$event.Mode.String = 'outdoor'"
          },
          "aggregation": {
            "tsx": "avg($value)"
          }
        }
      }
    }
  ]
}

Respuesta de muestra

status code:
200 
{
  "put": [
    {
      "timeSeriesType": {
        "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "name": "DefaultType",
        "description": "My Default type",
        "variables": {
          "EventCount": {
            "kind": "aggregate",
            "filter": null,
            "aggregation": {
              "tsx": "count()"
            }
          }
        }
      },
      "error": null
    },
    {
      "timeSeriesType": {
        "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
        "name": "OutdoorTemperatureSensor",
        "description": "This is an outdoor temperature sensor.",
        "variables": {
          "AverageTemperature": {
            "kind": "numeric",
            "value": {
              "tsx": "$event.Temperature.Double"
            },
            "filter": {
              "tsx": "$event.Mode.String = 'outdoor'"
            },
            "aggregation": {
              "tsx": "avg($value)"
            }
          }
        }
      },
      "error": null
    }
  ]
}

Definiciones

Nombre Description
AggregateVariable

La variable de agregado representa cualquier cálculo de agregación. Las variables de agregado no admiten la interpolación.
Boundary

Intervalo de tiempo a la izquierda y a la derecha del intervalo de búsqueda que se va a usar para interpolación. Esto resulta útil en escenarios en los que faltan puntos de datos cerca del inicio o final del intervalo de búsqueda de entrada. Puede ser NULL.
CategoricalVariable

La variable categórica representa la señal que debe analizarse en función del recuento o la duración de la aparición de un conjunto limitado de valores definidos.
Interpolation

Operación de interpolación que se va a realizar en los puntos de datos sin procesar. Actualmente, solo se permite el muestreo de series temporales interpoladas. Función de agregado permitida: por ejemplo: left($value). Puede ser NULL si no es necesario aplicar ninguna interpolación.
InterpolationKind

Tipo de técnica de interpolación: "Lineal" o "Paso".
NumericVariable

La variable numérica representa una única señal numérica continua que se puede reconstruir mediante la interpolación.
TimeSeriesAggregateCategory

Categoría usada en variables categóricas. Una categoría se define mediante "label" y los "valores" asignados a esta etiqueta.
TimeSeriesDefaultCategory

Representa la categoría predeterminada.
TimeSeriesType

El tipo de serie temporal define variables o fórmulas para realizar cálculos en eventos asociados a instancias de serie temporal. Cada instancia de serie temporal está asociada exactamente a un tipo. Un tipo puede tener una o varias variables. Por ejemplo, una instancia de serie temporal podría ser de tipo Sensor de temperatura, que consta de las variables avg temperature, min temperature y max temperature.
TimeSeriesTypeOrError

Resultado de una operación por lotes en un tipo de serie temporal determinado. El objeto type se establece cuando la operación es correcta y el objeto de error se establece cuando la operación no se realiza correctamente.
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 de error.
Tsx

Expresión de serie temporal (TSX) escrita como una sola cadena. Ejemplos: "$event. Status.String='Good'", "avg($event. Temperatura)". Consulte la documentación sobre cómo escribir expresiones de serie temporal.
TypesBatchRequest

Solicite realizar una sola operación en un lote de tipos de series temporales. Se debe establecer exactamente uno de los elementos "get", "put" o "delete".
TypesBatchResponse

Respuesta de una sola operación en un lote de tipos de series temporales. Se establecerá exactamente uno de "get", "put" o "delete".
TypesRequestBatchGetOrDelete

Solicite obtener o eliminar tipos de series temporales por identificadores o nombres de tipo. Debe establecerse exactamente uno de "typeIds" o "names".

AggregateVariable

Object

La variable de agregado representa cualquier cálculo de agregación. Las variables de agregado no admiten la interpolación.

Nombre Tipo Description
aggregation

Tsx

Expresión de serie temporal de agregación cuando el tipo es "agregado" se usa para representar la agregación que debe realizarse directamente mediante propiedades de evento como "$event. Temperatura". Por ejemplo, la agregación para calcular el intervalo de cambios de temperatura se puede escribir como: "max($event. Temperatura)-min($event. Temperatura)".
filter

Tsx

Filtre por los eventos que restringen el número de eventos que se consideran para el cálculo. Ejemplo: "$event. Status.String='Good'". Opcional.
kind string:

aggregate

Los valores permitidos "kind" son: "numeric" o "aggregate". Aunque "numeric" permite especificar el valor de la señal reconstruida y la expresión para agregarlas, el tipo "agregado" le permite agregar directamente en las propiedades del evento sin especificar el valor.

Boundary

Object

Intervalo de tiempo a la izquierda y a la derecha del intervalo de búsqueda que se va a usar para interpolación. Esto resulta útil en escenarios en los que faltan puntos de datos cerca del inicio o final del intervalo de búsqueda de entrada. Puede ser NULL.

Nombre Tipo Description
span

string (duration)

CategoricalVariable

Object

La variable categórica representa la señal que debe analizarse en función del recuento o la duración de la aparición de un conjunto limitado de valores definidos.

Nombre Tipo Description
categories

TimeSeriesAggregateCategory[]

Categoría usada en variables categóricas. Una categoría se define mediante "label" y los "valores" asignados a esta etiqueta.
defaultCategory

TimeSeriesDefaultCategory

Representa la categoría predeterminada.
filter

Tsx

Filtre por los eventos que restringen el número de eventos que se consideran para el cálculo. Ejemplo: "$event. Status.String='Good'". Opcional.
interpolation

Interpolation

La variable categórica solo admite la interpolación de "paso".
kind string:

categorical

Los valores permitidos "kind" son: "numeric" o "aggregate". Aunque "numeric" permite especificar el valor de la señal reconstruida y la expresión para agregarlas, el tipo "agregado" le permite agregar directamente en las propiedades del evento sin especificar el valor.
value

Tsx

La expresión de serie temporal de valor se usa para representar el valor de la señal que se va a clasificar. Solo se puede evaluar como tipo "String" o "Long" para variables categóricas.

Interpolation

Object

Operación de interpolación que se va a realizar en los puntos de datos sin procesar. Actualmente, solo se permite el muestreo de series temporales interpoladas. Función de agregado permitida: por ejemplo: left($value). Puede ser NULL si no es necesario aplicar ninguna interpolación.

Nombre Tipo Description
boundary

Boundary

Intervalo de tiempo a la izquierda y a la derecha del intervalo de búsqueda que se va a usar para interpolación. Esto resulta útil en escenarios en los que faltan puntos de datos cerca del inicio o final del intervalo de búsqueda de entrada. Puede ser NULL.
kind

InterpolationKind

Tipo de técnica de interpolación: "Lineal" o "Paso".

InterpolationKind

Enumeración

Tipo de técnica de interpolación: "Lineal" o "Paso".

Valor Description
Linear
Step

NumericVariable

Object

La variable numérica representa una única señal numérica continua que se puede reconstruir mediante la interpolación.

Nombre Tipo Description
aggregation

Tsx

Expresión de serie temporal de agregación cuando el tipo es "numérico" se usa para representar la agregación que se debe realizar en la expresión de $value. Esto requiere que se especifique $value y solo puede usar $value dentro de las funciones de agregado. Por ejemplo, la agregación para calcular el mínimo del $value se escribe como: "min($value)".
filter

Tsx

Filtre por los eventos que restringen el número de eventos que se consideran para el cálculo. Ejemplo: "$event. Status.String='Good'". Opcional.
interpolation

Interpolation

Operación de interpolación que se va a realizar en los puntos de datos sin procesar. Actualmente, solo se permite el muestreo de series temporales interpoladas. Función de agregado permitida: por ejemplo: left($value). Puede ser NULL si no es necesario aplicar ninguna interpolación.
kind string:

numeric

Los valores permitidos "kind" son: "numeric" o "aggregate". Aunque "numeric" permite especificar el valor de la señal reconstruida y la expresión para agregarlas, el tipo "agregado" le permite agregar directamente en las propiedades del evento sin especificar el valor.
value

Tsx

La expresión de serie temporal de valor se usa para representar el valor de la señal que se va a agregar o interpolar. Por ejemplo, los valores de temperatura del evento se representan de la siguiente manera: "$event. Temperature.Double".

TimeSeriesAggregateCategory

Object

Categoría usada en variables categóricas. Una categoría se define mediante "label" y los "valores" asignados a esta etiqueta.

Nombre Tipo Description
label

string

Nombre de la categoría que se usará para construir los nombres de las variables de salida.
values

object[]

Lista de valores a los que se asigna una categoría. Puede ser una lista única de cadenas o una lista de long.

TimeSeriesDefaultCategory

Object

Representa la categoría predeterminada.

Nombre Tipo Description
label

string

Nombre de la categoría predeterminada que se asignará a los valores que no coinciden con ninguno de los definidos en las "categorías".

TimeSeriesType

Object

El tipo de serie temporal define variables o fórmulas para realizar cálculos en eventos asociados a instancias de serie temporal. Cada instancia de serie temporal está asociada exactamente a un tipo. Un tipo puede tener una o varias variables. Por ejemplo, una instancia de serie temporal podría ser de tipo Sensor de temperatura, que consta de las variables avg temperature, min temperature y max temperature.

Nombre Tipo Description
description

string

Descripción del tipo. Puede ser null.
id

string

Identificador de tipo único que distingue mayúsculas de minúsculas que es inmutable. Puede ser NULL en las solicitudes de creación o actualización y, a continuación, el servidor genera el identificador. No null en las operaciones get y delete.
name

string

Nombre único especificado por el usuario para el tipo. Mutable, no null.
variables

object

Variables diferentes asociadas al tipo. No está vacío, no es null.

TimeSeriesTypeOrError

Object

Resultado de una operación por lotes en un tipo de serie temporal determinado. El objeto type se establece cuando la operación es correcta y el objeto de error se establece cuando la operación no se realiza correctamente.

Nombre Tipo Description
error

TsiErrorBody

Objeto error: se establece cuando la operación no se realiza correctamente.
timeSeriesType

TimeSeriesType

Objeto de tipo de serie temporal: se establece cuando la operación se realiza correctamente.

TsiError

Object

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

Object

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

Nombre Tipo Description
code

string

Cadena legible y 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 adicional de error. Puede ser null.
innerError

TsiErrorBody

Contiene un error más específico que limita la causa. 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 en particular (por ejemplo, el nombre de la propiedad en error). Puede ser null.

TsiErrorDetails

Object

Información adicional de error.

Nombre Tipo Description
code

string

Cadena legible y 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.
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.

Tsx

Object

Expresión de serie temporal (TSX) escrita como una sola cadena. Ejemplos: "$event. Status.String='Good'", "avg($event. Temperatura)". Consulte la documentación sobre cómo escribir expresiones de serie temporal.

Nombre Tipo Description
tsx

string

Expresión de serie temporal (TSX) escrita como una sola cadena. Ejemplos: "$event. Status.String='Good'", "avg($event. Temperatura)". Consulte la documentación sobre cómo escribir expresiones de serie temporal.

TypesBatchRequest

Object

Solicite realizar una sola operación en un lote de tipos de series temporales. Se debe establecer exactamente uno de los elementos "get", "put" o "delete".

Nombre Tipo Description
delete

TypesRequestBatchGetOrDelete

Definición de los tipos de serie temporal que se van a eliminar.
get

TypesRequestBatchGetOrDelete

Definición de los tipos de serie temporal que se van a devolver.
put

TimeSeriesType[]

Definición de los tipos de serie temporal que se van a actualizar o crear.

TypesBatchResponse

Object

Respuesta de una sola operación en un lote de tipos de series temporales. Se establecerá exactamente uno de "get", "put" o "delete".

Nombre Tipo Description
delete

TsiErrorBody[]

Lista de objetos de error correspondientes por posición a la matriz "delete" de la solicitud: null cuando la operación se realiza correctamente.
get

TimeSeriesTypeOrError[]

Lista de tipos o objetos de error correspondientes por posición a la matriz "get" de la solicitud. El objeto type se establece cuando la operación es correcta y el objeto de error se establece cuando la operación no se realiza correctamente.
put

TimeSeriesTypeOrError[]

Lista de tipos o objetos de error correspondientes por posición a la matriz "put" en la solicitud. El objeto type se establece cuando la operación es correcta y el objeto de error se establece cuando la operación no se realiza correctamente.

TypesRequestBatchGetOrDelete

Object

Solicite obtener o eliminar tipos de series temporales por identificadores o nombres de tipo. Debe establecerse exactamente uno de "typeIds" o "names".

Nombre Tipo Description
names

string[]

Lista de nombres de tipos de series temporales que se van a devolver o eliminar.
typeIds

string[]

Lista de identificadores de tipos de series temporales para devolver o eliminar.