Time Series Instances - Execute Batch

Référence

Service:: Time Series Insights

Version d'API:: 2020-07-31

Exécute une opération d’obtention, de création, de mise à jour et de suppression par lot sur plusieurs instances de série chronologique.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
environmentFqdn	path	True	string	Par nom de domaine complet de l’environnement, par exemple 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Vous pouvez obtenir ce nom de domaine à partir de la réponse de l’API Get Environments, Portail Azure ou azure Resource Manager.
api-version	query	True	string	Version de l’API à utiliser avec la demande cliente. La version actuellement prise en charge est « 31/07/2020 ».

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-request-id		string	ID de demande client facultative. Le service enregistre cette valeur. Permet au service de suivre l’opération entre les services et permet au client de contacter le support technique pour une demande particulière.
x-ms-client-session-id		string	ID de session client facultatif. Le service enregistre cette valeur. Permet au service de suivre un groupe d’opérations associées entre les services et permet au client de contacter le support technique concernant un groupe particulier de demandes.

Corps de la demande

Nom	Type	Description
delete	InstancesRequestBatchGetOrDelete	Instances de série chronologique à supprimer. L’ID ou le nom de la série chronologique peuvent être spécifiés.
get	InstancesRequestBatchGetOrDelete	ID de série chronologique ou noms d’instances de série chronologique à retourner.
put	TimeSeriesInstance[]	Instances de série chronologique à créer ou à mettre à jour.
update	TimeSeriesInstance[]	Les séries chronologiques instance à mettre à jour. Si instance n’existe pas, une erreur est retournée.

Réponses

Nom	Type	Description
200 OK	InstancesBatchResponse	Opération réussie. En-têtes x-ms-request-id: string
Other Status Codes	TsiError	Erreur inattendue. En-têtes x-ms-request-id: string

Nom

Type

Description

200 OK

InstancesBatchResponse

Opération réussie.

En-têtes

x-ms-request-id: string

Other Status Codes

TsiError

Erreur inattendue.

En-têtes

x-ms-request-id: string

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

InstancesBatchDeleteByIds

InstancesBatchDeleteByNames

InstancesBatchGetByIds

InstancesBatchGetByNames

InstancesBatchPut

InstancesBatchUpdate

InstancesBatchDeleteByIds

Exemple de requête

HTTP

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

{
  "delete": {
    "timeSeriesIds": [
      [
        "2da181d7-8346-4cf2-bd94-a17742237429",
        "T1"
      ],
      [
        "18672e3d-2beb-4007-9846-042b09ef3c72",
        "T2"
      ]
    ]
  }
}

Exemple de réponse

Code d’état:: 200

{
  "delete": [
    null,
    {
      "code": "InvalidInput",
      "message": "Time series instance with ID '[\"18672e3d-2beb-4007-9846-042b09ef3c72\", \"T2\"]' cannot be deleted. There are already ingested events associated with this time series ID.",
      "innerError": {
        "code": "CannotDeleteInstance"
      }
    }
  ]
}

InstancesBatchDeleteByNames

Exemple de requête

HTTP

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

{
  "delete": {
    "names": [
      "F2W6.GF",
      "F1W7.GS1"
    ]
  }
}

Exemple de réponse

Code d’état:: 200

{
  "delete": [
    null,
    {
      "code": "InvalidInput",
      "message": "Time series instance with ID '[\"18672e3d-2beb-4007-9846-042b09ef3c72\", \"T2\"]' cannot be deleted. There are already ingested events associated with this time series ID.",
      "innerError": {
        "code": "CannotDeleteInstance"
      }
    }
  ]
}

InstancesBatchGetByIds

Exemple de requête

HTTP

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

{
  "get": {
    "timeSeriesIds": [
      [
        "006dfc2d-0324-4937-998c-d16f3b4f1952",
        "T1"
      ]
    ]
  }
}

Exemple de réponse

Code d’état:: 200

{
  "get": [
    {
      "instance": {
        "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
        "name": "F1W7.GS1",
        "timeSeriesId": [
          "006dfc2d-0324-4937-998c-d16f3b4f1952",
          "T1"
        ],
        "description": "ContosoFarm1W7_GenSpeed1",
        "hierarchyIds": [
          "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
        ],
        "instanceFields": {
          "Name": "GeneratorSpeed",
          "Plant": "Contoso Plant 1",
          "Unit": "W7",
          "System": "Generator System",
          "Status": false,
          "Version": 1.3,
          "Code": 28
        }
      }
    }
  ]
}

InstancesBatchGetByNames

Exemple de requête

HTTP

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

{
  "get": {
    "names": [
      "F1W7.GS1"
    ]
  }
}

Exemple de réponse

Code d’état:: 200

{
  "get": [
    {
      "instance": {
        "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
        "name": "F1W7.GS1",
        "timeSeriesId": [
          "006dfc2d-0324-4937-998c-d16f3b4f1952",
          "T1"
        ],
        "description": "ContosoFarm1W7_GenSpeed1",
        "hierarchyIds": [
          "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
        ],
        "instanceFields": {
          "Name": "GeneratorSpeed",
          "Plant": "Contoso Plant 1",
          "Unit": "W7",
          "System": "Generator System",
          "Status": false,
          "Version": 1.3,
          "Code": 28
        }
      }
    }
  ]
}

InstancesBatchPut

Exemple de requête

HTTP

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

{
  "put": [
    {
      "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
      "name": "F1W7.GS1",
      "timeSeriesId": [
        "006dfc2d-0324-4937-998c-d16f3b4f1952",
        "T1"
      ],
      "description": "ContosoFarm1W7_GenSpeed1",
      "hierarchyIds": [
        "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
      ],
      "instanceFields": {
        "Name": "GeneratorSpeed",
        "Plant": "Contoso Plant 1",
        "Unit": "W7",
        "System": "Generator System",
        "Status": false,
        "Version": 1.3,
        "Code": 28
      }
    }
  ]
}

Exemple de réponse

Code d’état:: 200

{
  "put": [
    {
      "error": null
    }
  ]
}

InstancesBatchUpdate

Exemple de requête

HTTP

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

{
  "update": [
    {
      "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
      "name": "F1W7.GS1",
      "timeSeriesId": [
        "006dfc2d-0324-4937-998c-d16f3b4f1952",
        "T1"
      ],
      "description": "ContosoFarm1W7_GenSpeed1",
      "hierarchyIds": [
        "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
      ],
      "instanceFields": {
        "Name": "GeneratorSpeed",
        "Plant": "Contoso Plant 1",
        "Unit": "W7",
        "System": "Generator System",
        "Status": false,
        "Version": 1.3,
        "Code": 28
      }
    }
  ]
}

Exemple de réponse

Code d’état:: 200

{
  "update": [
    {
      "error": null
    }
  ]
}

Définitions

Nom	Description
InstanceOrError	Résultat d’une opération par lot sur une série chronologique particulière instance. L’objet Instance est défini lorsque l’opération réussit (à l’exception de l’opération put) et l’objet d’erreur est défini en cas d’échec de l’opération.
InstancesBatchRequest	Demande d’effectuer une seule opération sur un lot d’instances. L’un des éléments « get », « put », « update » ou « delete » doit être défini.
InstancesBatchResponse	Réponse d’une opération unique sur un lot d’instances. Un seul des éléments « get », « put », « update » ou « delete » sera défini en fonction de la demande.
InstancesRequestBatchGetOrDelete	Demande d’obtention ou de suppression d’instances par ID de série chronologique ou de noms de série chronologique. L’un des « timeSeriesIds » ou « noms » doit être défini.
TimeSeriesInstance	Les instances de série chronologique sont les séries chronologiques elles-mêmes. Dans la plupart des cas, deviceId ou assetId est l’identificateur unique de la ressource dans l’environnement. Les instances sont associées à des informations descriptives appelées champs instance. Au minimum, instance champs incluent des informations de hiérarchie. Elles peuvent également inclure des données utiles et des descriptifs, par exemple le fabricant, l’opérateur ou la date du dernier entretien.
TsiError	Informations sur une erreur d’API.
TsiErrorBody	Erreur d’API particulière avec un code d’erreur et un message.
TsiErrorDetails	Informations supplémentaires sur l’erreur.

InstanceOrError

Résultat d’une opération par lot sur une série chronologique particulière instance. L’objet Instance est défini lorsque l’opération réussit (à l’exception de l’opération put) et l’objet d’erreur est défini en cas d’échec de l’opération.

Nom	Type	Description
error	TsiErrorBody	Objet Error : défini en cas d’échec de l’opération.
instance	TimeSeriesInstance	Série chronologique instance objet : défini lorsque l’opération réussit (à l’exception de l’opération put).

InstancesBatchRequest

Demande d’effectuer une seule opération sur un lot d’instances. L’un des éléments « get », « put », « update » ou « delete » doit être défini.

Nom	Type	Description
delete	InstancesRequestBatchGetOrDelete	Instances de série chronologique à supprimer. L’ID ou le nom de la série chronologique peuvent être spécifiés.
get	InstancesRequestBatchGetOrDelete	ID de série chronologique ou noms d’instances de série chronologique à retourner.
put	TimeSeriesInstance[]	Instances de série chronologique à créer ou à mettre à jour.
update	TimeSeriesInstance[]	Les séries chronologiques instance à mettre à jour. Si instance n’existe pas, une erreur est retournée.

InstancesBatchResponse

Réponse d’une opération unique sur un lot d’instances. Un seul des éléments « get », « put », « update » ou « delete » sera défini en fonction de la demande.

Nom	Type	Description
delete	TsiErrorBody[]	Liste des objets d’erreur correspondant par position au tableau « delete » dans la demande. Null signifie que le instance a été supprimé ou n’existait pas. L’objet Error est défini en cas d’échec de l’opération (par exemple, quand des événements sont associés à cette série chronologique instance).
get	InstanceOrError[]	Liste des objets instance ou d’erreur correspondant par position au tableau « get » dans la requête. L’objet Instance est défini lorsque l’opération réussit et que l’objet d’erreur est défini en cas d’échec de l’opération.
put	InstanceOrError[]	Liste des objets d’erreur correspondant par position au tableau « put » dans la demande. L’objet Error est défini en cas d’échec de l’opération.
update	InstanceOrError[]	Liste des objets d’erreur correspondant par position au tableau « update » dans la demande. L’objet Instance est défini lorsque l’opération réussit et que l’objet d’erreur est défini en cas d’échec de l’opération.

InstancesRequestBatchGetOrDelete

Demande d’obtention ou de suppression d’instances par ID de série chronologique ou de noms de série chronologique. L’un des « timeSeriesIds » ou « noms » doit être défini.

Nom	Type	Description
names	string[]	Liste des noms des instances de série chronologique à retourner ou à supprimer.
timeSeriesIds	TimeSeriesId[]	Liste des ID de série chronologique des instances de série chronologique à retourner ou à supprimer.