Dela via

Time Series Hierarchies - Execute Batch

Tjänst:
Time Series Insights
API-version:
2020-07-31

Kör en batchåtgärd för att hämta, skapa, uppdatera, ta bort på flera definitioner av tidsseriehierarkin.

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

URI-parametrar

Name I Obligatorisk Typ Description
environmentFqdn
 path True

string

FQDN per miljö, till exempel 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Du kan hämta det här domännamnet från svaret från Get Environments API, Azure Portal eller Azure Resource Manager.
api-version
 query True

string

Version av API:et som ska användas med klientbegäran. Den version som stöds för närvarande är "2020-07-31".

Begärandehuvud

Name Obligatorisk Typ Description
x-ms-client-request-id

string

Valfritt klientbegärans-ID. Tjänsten registrerar det här värdet. Tillåter att tjänsten spårar åtgärder mellan tjänster och gör det möjligt för kunden att kontakta supporten angående en viss begäran.
x-ms-client-session-id

string

Valfritt klientsessions-ID. Tjänsten registrerar det här värdet. Gör att tjänsten kan spåra en grupp relaterade åtgärder mellan tjänster och gör det möjligt för kunden att kontakta supporten om en viss grupp med begäranden.

Begärandetext

Name Typ Description
delete

HierarchiesRequestBatchGetDelete

"delete" ska ställas in när du hämtar specifika hierarkier, antingen efter ID eller namn.
get

HierarchiesRequestBatchGetDelete

"get" ska ställas in när du hämtar specifika hierarkier, antingen med ID:n eller namn.
put

TimeSeriesHierarchy[]

"put" ska ställas in när du skapar eller uppdaterar hierarkier.

Svar

Name Typ Description
200 OK

HierarchiesBatchResponse

Åtgärden lyckades.

Sidhuvuden

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

TsiError

Oväntat fel.

Sidhuvuden

x-ms-request-id: string

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

HierarchiesBatchDeleteByIds
HierarchiesBatchDeleteByNames
HierarchiesBatchGetByIds
HierarchiesBatchGetByNames
HierarchiesBatchPut

HierarchiesBatchDeleteByIds

Exempelbegäran

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

Exempelsvar

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

HierarchiesBatchDeleteByNames

Exempelbegäran

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

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

Exempelsvar

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

HierarchiesBatchGetByIds

Exempelbegäran

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

Exempelsvar

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

Exempelbegäran

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

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

Exempelsvar

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

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
HierarchiesBatchRequest

Begäran om att utföra en enda åtgärd på en batch med hierarkier. Exakt en av "get", "put" eller "delete" måste anges.
HierarchiesBatchResponse

Svar från en enskild åtgärd i en batch med tidsseriehierarkier. Endast en av "get", "put" eller "delete" kommer att ställas in.
HierarchiesRequestBatchGetDelete

Begäran om att hämta eller ta bort flera tidsseriehierarkier. Exakt ett av "hierarchyIds" eller "names" måste anges.
Source

Definition av hur trädnivåer för tidsseriehierarki skapas.
TimeSeriesHierarchy

Tidsseriehierarkin organiserar tidsserieinstanser i ett träd.
TimeSeriesHierarchyOrError

Resultatet av en batchåtgärd i en viss tidsseriehierarki. Hierarkin anges när åtgärden lyckas och felobjektet anges när åtgärden misslyckas.
TsiError

Information om ett API-fel.
TsiErrorBody

Ett visst API-fel med en felkod och ett meddelande.
TsiErrorDetails

Ytterligare felinformation.

HierarchiesBatchRequest

Objekt

Begäran om att utföra en enda åtgärd på en batch med hierarkier. Exakt en av "get", "put" eller "delete" måste anges.

Name Typ Description
delete

HierarchiesRequestBatchGetDelete

"delete" ska ställas in när du hämtar specifika hierarkier, antingen efter ID eller namn.
get

HierarchiesRequestBatchGetDelete

"get" ska ställas in när du hämtar specifika hierarkier, antingen med ID:n eller namn.
put

TimeSeriesHierarchy[]

"put" ska ställas in när du skapar eller uppdaterar hierarkier.

HierarchiesBatchResponse

Objekt

Svar från en enskild åtgärd i en batch med tidsseriehierarkier. Endast en av "get", "put" eller "delete" kommer att ställas in.

Name Typ Description
delete

TsiErrorBody[]

Lista över felobjekt som motsvarar position för matrisen "ta bort" i begäran – null när åtgärden lyckas.
get

TimeSeriesHierarchyOrError[]

Lista över hierarki- eller felobjekt som motsvarar positionen till matrisen "get" i begäran. Hierarkiobjektet anges när åtgärden lyckas och felobjektet anges när åtgärden misslyckas.
put

TimeSeriesHierarchyOrError[]

Lista över hierarki- eller felobjekt som motsvarar positionen till matrisen "put" i begäran. Hierarkiobjektet anges när åtgärden lyckas och felobjektet anges när åtgärden misslyckas.

HierarchiesRequestBatchGetDelete

Objekt

Begäran om att hämta eller ta bort flera tidsseriehierarkier. Exakt ett av "hierarchyIds" eller "names" måste anges.

Name Typ Description
hierarchyIds

string[]

Lista över hierarki-ID:t.
names

string[]

Lista över hierarkinamn.

Source

Objekt

Definition av hur trädnivåer för tidsseriehierarki skapas.

Name Typ Description
instanceFieldNames

string[]

Lista över instansfältnamn som måste anges i alla tidsserieinstanser som tillhör den här hierarkin. Ordningen på instansfälten definierar nivåerna i hierarkin.

TimeSeriesHierarchy

Objekt

Tidsseriehierarkin organiserar tidsserieinstanser i ett träd.

Name Typ Description
id

string

Skiftlägeskänslig unik hierarkiidentifierare. Kan vara null när du skapar hierarkiobjekt och sedan genererar servern id:t, inte null vid get- och delete-åtgärder.
name

string

Användarspecifikt unikt namn för typen. Den är föränderlig och inte null.
source

Source

Definition av hur trädnivåer för tidsseriehierarki skapas.

TimeSeriesHierarchyOrError

Objekt

Resultatet av en batchåtgärd i en viss tidsseriehierarki. Hierarkin anges när åtgärden lyckas och felobjektet anges när åtgärden misslyckas.

Name Typ Description
error

TsiErrorBody

Felobjekt – ange när åtgärden misslyckas.
hierarchy

TimeSeriesHierarchy

Objekt för tidsseriehierarki – anges när åtgärden lyckas.

TsiError

Objekt

Information om ett API-fel.

Name Typ Description
error

TsiErrorBody

Ett visst API-fel med en felkod och ett meddelande.

TsiErrorBody

Objekt

Ett visst API-fel med en felkod och ett meddelande.

Name Typ Description
code

string

Språkoberoende, läsbar sträng som definierar en tjänstspecifik felkod. Den här koden fungerar som en mer specifik indikator för HTTP-felkoden som anges i svaret. Kan användas för att programmatiskt hantera specifika felfall.
details

TsiErrorDetails[]

Innehåller ytterligare felinformation. Kan vara null.
innerError

TsiErrorBody

Innehåller mer specifika fel som begränsar orsaken. Kan vara null.
message

string

Mänsklig läsbar, språkoberoende representation av felet. Det är avsett som ett stöd för utvecklare och är inte lämpligt för exponering för slutanvändare.
target

string

Målet för det specifika felet (till exempel namnet på egenskapen i fel). Kan vara null.

TsiErrorDetails

Objekt

Ytterligare felinformation.

Name Typ Description
code

string

Språkoberoende, läsbar sträng som definierar en tjänstspecifik felkod. Den här koden fungerar som en mer specifik indikator för HTTP-felkoden som anges i svaret. Kan användas för att programmatiskt hantera specifika felfall.
message

string

Mänsklig läsbar, språkoberoende representation av felet. Det är avsett som ett stöd för utvecklare och är inte lämpligt för exponering för slutanvändare.