Partager via

Time Series Hierarchies - Execute Batch

  • Référence
Service:
Time Series Insights
Version d'API:
2020-07-31

Exécute une opération get, create, update, delete par lots sur plusieurs définitions de hiérarchie de série chronologique.

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

Paramètres URI

Nom Dans Obligatoire Type Description
environmentFqdn
 path True

string

Nom de domaine complet par 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 Obtenir des environnements, Portail Azure ou azure Resource Manager.
api-version
 query True

string

Version de l’API à utiliser avec la demande du client. La version actuellement prise en charge est « 2020-07-31 ».

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 les opérations entre les services et permet au client de contacter le support technique concernant 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

HierarchiesRequestBatchGetDelete

« delete » doit être défini lors de l’extraction de hiérarchies spécifiques par ID ou par noms.
get

HierarchiesRequestBatchGetDelete

« get » doit être défini lors de l’extraction de hiérarchies spécifiques par ID ou par noms.
put

TimeSeriesHierarchy[]

« put » doit être défini lors de la création ou de la mise à jour de hiérarchies.

Réponses

Nom Type Description
200 OK

HierarchiesBatchResponse

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

HierarchiesBatchDeleteByIds
HierarchiesBatchDeleteByNames
HierarchiesBatchGetByIds
HierarchiesBatchGetByNames
HierarchiesBatchPut

HierarchiesBatchDeleteByIds

Exemple de requête

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

{
  "delete": {
    "hierarchyIds": [
      "a28fd14c-6b98-4ab5-9301-3840f142d30e"
    ]
  }
}

Exemple de réponse

Code d’état:
200 
{
  "delete": [
    null
  ]
}

HierarchiesBatchDeleteByNames

Exemple de requête

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

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

Exemple de réponse

Code d’état:
200 
{
  "delete": [
    null
  ]
}

HierarchiesBatchGetByIds

Exemple de requête

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

{
  "get": {
    "hierarchyIds": [
      "6e292e54-9a26-4be1-9034-607d71492707",
      "a28fd14c-6b98-4ab5-9301-3840f142d30e"
    ]
  }
}

Exemple de réponse

Code d’état:
200 
{
  "get": [
    {
      "hierarchy": {
        "id": "6e292e54-9a26-4be1-9034-607d71492707",
        "name": "Location",
        "source": {
          "instanceFieldNames": [
            "state",
            "city"
          ]
        }
      }
    },
    {
      "hierarchy": {
        "id": "a28fd14c-6b98-4ab5-9301-3840f142d30e",
        "name": "ManufactureDate",
        "source": {
          "instanceFieldNames": [
            "year",
            "month"
          ]
        }
      }
    }
  ]
}

HierarchiesBatchGetByNames

Exemple de requête

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

{
  "get": {
    "names": [
      "Location",
      "ManufactureDate"
    ]
  }
}

Exemple de réponse

Code d’état:
200 
{
  "get": [
    {
      "hierarchy": {
        "id": "6e292e54-9a26-4be1-9034-607d71492707",
        "name": "Location",
        "source": {
          "instanceFieldNames": [
            "state",
            "city"
          ]
        }
      }
    },
    {
      "hierarchy": {
        "id": "a28fd14c-6b98-4ab5-9301-3840f142d30e",
        "name": "ManufactureDate",
        "source": {
          "instanceFieldNames": [
            "year",
            "month"
          ]
        }
      }
    }
  ]
}

HierarchiesBatchPut

Exemple de requête

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

{
  "put": [
    {
      "id": "6e292e54-9a26-4be1-9034-607d71492707",
      "name": "Location",
      "source": {
        "instanceFieldNames": [
          "state",
          "city"
        ]
      }
    },
    {
      "id": "a28fd14c-6b98-4ab5-9301-3840f142d30e",
      "name": "ManufactureDate",
      "source": {
        "instanceFieldNames": [
          "year",
          "month"
        ]
      }
    }
  ]
}

Exemple de réponse

Code d’état:
200 
{
  "put": [
    {
      "hierarchy": {
        "id": "6e292e54-9a26-4be1-9034-607d71492707",
        "name": "Location",
        "source": {
          "instanceFieldNames": [
            "state",
            "city"
          ]
        }
      },
      "error": null
    },
    {
      "hierarchy": {
        "id": "a28fd14c-6b98-4ab5-9301-3840f142d30e",
        "name": "ManufactureDate",
        "source": {
          "instanceFieldNames": [
            "year",
            "month"
          ]
        }
      },
      "error": null
    }
  ]
}

Définitions

Nom Description
HierarchiesBatchRequest

Demande d’effectuer une seule opération sur un lot de hiérarchies. L’une des valeurs « get », « put » ou « delete » doit être définie.
HierarchiesBatchResponse

Réponse d’une seule opération sur un lot de hiérarchies de série chronologique. Une seule des valeurs « get », « put » ou « delete » est définie.
HierarchiesRequestBatchGetDelete

Demande d’obtention ou de suppression de plusieurs hiérarchies de série chronologique. L’un des « hierarchyIds » ou « names » doit être défini.
Source

Définition de la façon dont les niveaux d’arborescence de hiérarchie de série chronologique sont créés.
TimeSeriesHierarchy

La hiérarchie des séries chronologiques organise les instances de série chronologique dans une arborescence.
TimeSeriesHierarchyOrError

Résultat d’une opération de lot sur une hiérarchie de séries chronologiques particulière. La hiérarchie est définie lorsque l’opération réussit et que l’objet d’erreur est défini en cas d’échec de l’opération.
TsiError

Informations sur une erreur d’API.
TsiErrorBody

Une erreur d’API particulière avec un code d’erreur et un message.
TsiErrorDetails

Informations supplémentaires sur l’erreur.

HierarchiesBatchRequest

Demande d’effectuer une seule opération sur un lot de hiérarchies. L’une des valeurs « get », « put » ou « delete » doit être définie.

Nom Type Description
delete

HierarchiesRequestBatchGetDelete

« delete » doit être défini lors de l’extraction de hiérarchies spécifiques par ID ou par noms.
get

HierarchiesRequestBatchGetDelete

« get » doit être défini lors de l’extraction de hiérarchies spécifiques par ID ou par noms.
put

TimeSeriesHierarchy[]

« put » doit être défini lors de la création ou de la mise à jour de hiérarchies.

HierarchiesBatchResponse

Réponse d’une seule opération sur un lot de hiérarchies de série chronologique. Une seule des valeurs « get », « put » ou « delete » est définie.

Nom Type Description
delete

TsiErrorBody[]

Liste des objets d’erreur correspondant par position au tableau « delete » dans la requête - null lorsque l’opération réussit.
get

TimeSeriesHierarchyOrError[]

Liste des objets de hiérarchie ou d’erreur correspondant par position au tableau « get » dans la requête. L’objet Hierarchy est défini lorsque l’opération réussit et l’objet error est défini en cas d’échec de l’opération.
put

TimeSeriesHierarchyOrError[]

Liste d’objets de hiérarchie ou d’erreur correspondant par position au tableau « put » dans la requête. L’objet Hierarchy est défini lorsque l’opération réussit et l’objet error est défini en cas d’échec de l’opération.

HierarchiesRequestBatchGetDelete

Demande d’obtention ou de suppression de plusieurs hiérarchies de série chronologique. L’un des « hierarchyIds » ou « names » doit être défini.

Nom Type Description
hierarchyIds

string[]

Liste des ID de hiérarchie.
names

string[]

Liste des noms de hiérarchie.

Source

Définition de la façon dont les niveaux d’arborescence de hiérarchie de série chronologique sont créés.

Nom Type Description
instanceFieldNames

string[]

Liste des noms de champs instance qui doivent être définis dans toutes les instances de série chronologique qui appartiennent à cette hiérarchie. L’ordre des champs instance définit les niveaux dans la hiérarchie.

TimeSeriesHierarchy

La hiérarchie des séries chronologiques organise les instances de série chronologique dans une arborescence.

Nom Type Description
id

string

Identificateur de hiérarchie unique respectant la casse. Peut être null lors de la création d’objets de hiérarchie, puis le serveur génère l’ID, et non null lors des opérations get et delete.
name

string

Nom unique donné par l’utilisateur pour le type. Il est mutable et non null.
source

Source

Définition de la façon dont les niveaux d’arborescence de hiérarchie de série chronologique sont créés.

TimeSeriesHierarchyOrError

Résultat d’une opération de lot sur une hiérarchie de séries chronologiques particulière. La hiérarchie est définie lorsque l’opération réussit et que l’objet d’erreur est défini en cas d’échec de l’opération.

Nom Type Description
error

TsiErrorBody

Objet Error : défini lorsque l’opération échoue.
hierarchy

TimeSeriesHierarchy

Objet de hiérarchie de série chronologique : défini lorsque l’opération réussit.

TsiError

Informations sur une erreur d’API.

Nom Type Description
error

TsiErrorBody

Une erreur d’API particulière avec un code d’erreur et un message.

TsiErrorBody

Une erreur d’API particulière avec un code d’erreur et un message.

Nom Type Description
code

string

Chaîne indépendante du langage et lisible par l’homme qui définit un code d’erreur spécifique au service. Ce code sert d’indicateur plus spécifique pour le code d’erreur HTTP spécifié dans la réponse. Peut être utilisé pour gérer par programmation des cas d’erreur spécifiques.
details

TsiErrorDetails[]

Contient des informations d’erreur supplémentaires. Ce paramètre peut être null.
innerError

TsiErrorBody

Contient une erreur plus spécifique qui limite la cause. Ce paramètre peut être null.
message

string

Représentation lisible et indépendante du langage de l’erreur. Il est destiné à aider les développeurs et n’est pas adapté à l’exposition des utilisateurs finaux.
target

string

Cible de l’erreur particulière (par exemple, le nom de la propriété dans l’erreur). Ce paramètre peut être null.

TsiErrorDetails

Informations supplémentaires sur l’erreur.

Nom Type Description
code

string

Chaîne indépendante du langage et lisible par l’homme qui définit un code d’erreur spécifique au service. Ce code sert d’indicateur plus spécifique pour le code d’erreur HTTP spécifié dans la réponse. Peut être utilisé pour gérer par programmation des cas d’erreur spécifiques.
message

string

Représentation lisible et indépendante du langage de l’erreur. Il est destiné à aider les développeurs et n’est pas adapté à l’exposition des utilisateurs finaux.