Delen via

Time Series Hierarchies - Execute Batch

  • Referentie
Service:
Time Series Insights
API-versie:
2020-07-31

Hiermee wordt een batchbewerking voor ophalen, maken, bijwerken en verwijderen uitgevoerd op meerdere definities van de tijdreekshiërarchie.

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

URI-parameters

Name In Vereist Type Description
environmentFqdn
 path True

string

FQDN per omgeving, bijvoorbeeld 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. U kunt deze domeinnaam verkrijgen uit het antwoord van de API Get Environments, Azure Portal of Azure Resource Manager.
api-version
 query True

string

Versie van de API die moet worden gebruikt met de clientaanvraag. De momenteel ondersteunde versie is 2020-07-31.

Aanvraagkoptekst

Name Vereist Type Description
x-ms-client-request-id

string

Optionele clientaanvraag-id. Service registreert deze waarde. Hiermee kan de service de werking van verschillende services traceren en kan de klant contact opnemen met de ondersteuning met betrekking tot een bepaalde aanvraag.
x-ms-client-session-id

string

Optionele clientsessie-id. Service registreert deze waarde. Hiermee kan de service een groep gerelateerde bewerkingen in verschillende services traceren en kan de klant contact opnemen met ondersteuning met betrekking tot een bepaalde groep aanvragen.

Aanvraagbody

Name Type Description
delete

HierarchiesRequestBatchGetDelete

'delete' moet worden ingesteld tijdens het ophalen van specifieke hiërarchieën op basis van id's of namen.
get

HierarchiesRequestBatchGetDelete

'get' moet worden ingesteld tijdens het ophalen van specifieke hiërarchieën op basis van id's of namen.
put

TimeSeriesHierarchy[]

'put' moet worden ingesteld tijdens het maken of bijwerken van hiërarchieën.

Antwoorden

Name Type Description
200 OK

HierarchiesBatchResponse

Geslaagde bewerking.

Kopteksten

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

TsiError

Onverwachte fout.

Kopteksten

x-ms-request-id: string

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation uw gebruikersaccount imiteren

Voorbeelden

HierarchiesBatchDeleteByIds
HierarchiesBatchDeleteByNames
HierarchiesBatchGetByIds
HierarchiesBatchGetByNames
HierarchiesBatchPut

HierarchiesBatchDeleteByIds

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:
200 
{
  "delete": [
    null
  ]
}

HierarchiesBatchDeleteByNames

Voorbeeldaanvraag

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

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

Voorbeeldrespons

Statuscode:
200 
{
  "delete": [
    null
  ]
}

HierarchiesBatchGetByIds

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:
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

Voorbeeldaanvraag

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

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

Voorbeeldrespons

Statuscode:
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

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:
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
    }
  ]
}

Definities

Name Description
HierarchiesBatchRequest

Aanvraag om één bewerking uit te voeren op een batch hiërarchieën. Er moet precies één van 'get', 'put' of 'delete' zijn ingesteld.
HierarchiesBatchResponse

Antwoord van één bewerking in een batch tijdreekshiërarchieën. Er wordt slechts één van 'get', 'put' of 'delete' ingesteld.
HierarchiesRequestBatchGetDelete

Aanvraag om meerdere tijdreekshiërarchieën op te halen of te verwijderen. Er moet precies een van de 'hierarchyIds' of 'names' worden ingesteld.
Source

Definitie van hoe structuurniveaus voor tijdreekshiërarchie worden gemaakt.
TimeSeriesHierarchy

Tijdreekshiërarchie organiseert tijdreeksexemplaren in een structuur.
TimeSeriesHierarchyOrError

Resultaat van een batchbewerking in een bepaalde tijdreekshiërarchie. De hiërarchie wordt ingesteld wanneer de bewerking is geslaagd en het foutobject wordt ingesteld wanneer de bewerking is mislukt.
TsiError

Informatie over een API-fout.
TsiErrorBody

Een bepaalde API-fout met een foutcode en een bericht.
TsiErrorDetails

Aanvullende foutinformatie.

HierarchiesBatchRequest

Aanvraag om één bewerking uit te voeren op een batch hiërarchieën. Er moet precies één van 'get', 'put' of 'delete' zijn ingesteld.

Name Type Description
delete

HierarchiesRequestBatchGetDelete

'delete' moet worden ingesteld tijdens het ophalen van specifieke hiërarchieën op basis van id's of namen.
get

HierarchiesRequestBatchGetDelete

'get' moet worden ingesteld tijdens het ophalen van specifieke hiërarchieën op basis van id's of namen.
put

TimeSeriesHierarchy[]

'put' moet worden ingesteld tijdens het maken of bijwerken van hiërarchieën.

HierarchiesBatchResponse

Antwoord van één bewerking in een batch tijdreekshiërarchieën. Er wordt slechts één van 'get', 'put' of 'delete' ingesteld.

Name Type Description
delete

TsiErrorBody[]

Lijst met foutobjecten die per positie overeenkomen met de 'delete'-matrix in de aanvraag- null wanneer de bewerking is geslaagd.
get

TimeSeriesHierarchyOrError[]

Lijst met hiërarchie- of foutobjecten die per positie overeenkomen met de 'get'-matrix in de aanvraag. Het object Hierarchy wordt ingesteld wanneer de bewerking is geslaagd en het foutobject wordt ingesteld wanneer de bewerking mislukt.
put

TimeSeriesHierarchyOrError[]

Lijst met hiërarchie- of foutobjecten die per positie overeenkomen met de 'put'-matrix in de aanvraag. Het object Hierarchy wordt ingesteld wanneer de bewerking is geslaagd en het foutobject wordt ingesteld wanneer de bewerking mislukt.

HierarchiesRequestBatchGetDelete

Aanvraag om meerdere tijdreekshiërarchieën op te halen of te verwijderen. Er moet precies een van de 'hierarchyIds' of 'names' worden ingesteld.

Name Type Description
hierarchyIds

string[]

Lijst met hiërarchie-id's.
names

string[]

Lijst met hiërarchienamen.

Source

Definitie van hoe structuurniveaus voor tijdreekshiërarchie worden gemaakt.

Name Type Description
instanceFieldNames

string[]

Lijst met namen van instantievelden die moeten worden ingesteld in alle tijdreeksexemplaren die tot deze hiërarchie behoren. De volgorde van de instantievelden definieert de niveaus in de hiërarchie.

TimeSeriesHierarchy

Tijdreekshiërarchie organiseert tijdreeksexemplaren in een structuur.

Name Type Description
id

string

Hoofdlettergevoelige unieke hiërarchie-id. Kan null zijn tijdens het maken van hiërarchieobjecten en vervolgens genereert de server de id, niet null bij get- en verwijderbewerkingen.
name

string

Door de gebruiker opgegeven unieke naam voor het type. Deze is veranderlijk en niet null.
source

Source

Definitie van hoe structuurniveaus voor tijdreekshiërarchie worden gemaakt.

TimeSeriesHierarchyOrError

Resultaat van een batchbewerking in een bepaalde tijdreekshiërarchie. De hiërarchie wordt ingesteld wanneer de bewerking is geslaagd en het foutobject wordt ingesteld wanneer de bewerking is mislukt.

Name Type Description
error

TsiErrorBody

Foutobject : ingesteld wanneer de bewerking mislukt.
hierarchy

TimeSeriesHierarchy

Tijdreekshiërarchieobject : ingesteld wanneer de bewerking is geslaagd.

TsiError

Informatie over een API-fout.

Name Type Description
error

TsiErrorBody

Een bepaalde API-fout met een foutcode en een bericht.

TsiErrorBody

Een bepaalde API-fout met een foutcode en een bericht.

Name Type Description
code

string

Taalonafhankelijke, door mensen leesbare tekenreeks die een servicespecifieke foutcode definieert. Deze code fungeert als een specifiekere indicator voor de HTTP-foutcode die is opgegeven in het antwoord. Kan worden gebruikt voor het programmatisch afhandelen van specifieke foutgevallen.
details

TsiErrorDetails[]

Bevat aanvullende foutinformatie. Kan null zijn.
innerError

TsiErrorBody

Bevat een specifiekere fout die de oorzaak beperkt. Kan null zijn.
message

string

Door de mens leesbare, taalonafhankelijke weergave van de fout. Het is bedoeld als hulpmiddel voor ontwikkelaars en is niet geschikt voor blootstelling aan eindgebruikers.
target

string

Doel van de specifieke fout (bijvoorbeeld de naam van de eigenschap in fout). Kan null zijn.

TsiErrorDetails

Aanvullende foutinformatie.

Name Type Description
code

string

Taalonafhankelijke, door mensen leesbare tekenreeks die een servicespecifieke foutcode definieert. Deze code fungeert als een specifiekere indicator voor de HTTP-foutcode die is opgegeven in het antwoord. Kan worden gebruikt voor het programmatisch afhandelen van specifieke foutgevallen.
message

string

Door de mens leesbare, taalonafhankelijke weergave van de fout. Het is bedoeld als hulpmiddel voor ontwikkelaars en is niet geschikt voor blootstelling aan eindgebruikers.