Dela via

Time Series Instances - 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 och ta bort på flera tidsserieinstanser.

POST https://{environmentFqdn}/timeseries/instances/$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

InstancesRequestBatchGetOrDelete

Tidsserieinstanser som ska tas bort. Tidsserie-ID eller namn kan anges.
get

InstancesRequestBatchGetOrDelete

Tidsserie-ID:t eller namn på tidsserieinstanser som ska returneras.
put

TimeSeriesInstance[]

Tidsserieinstanser som ska skapas eller uppdateras.
update

TimeSeriesInstance[]

Tidsserieinstansen som ska uppdateras. Om instansen inte finns returneras ett fel.

Svar

Name Typ Description
200 OK

InstancesBatchResponse

Å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

InstancesBatchDeleteByIds
InstancesBatchDeleteByNames
InstancesBatchGetByIds
InstancesBatchGetByNames
InstancesBatchPut
InstancesBatchUpdate

InstancesBatchDeleteByIds

Exempelbegäran

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

Exempelsvar

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

Exempelbegäran

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

Exempelsvar

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

Exempelbegäran

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

Exempelsvar

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

Exempelbegäran

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

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

Exempelsvar

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

Exempelbegäran

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

Exempelsvar

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

InstancesBatchUpdate

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
InstanceOrError

Resultatet av en batchåtgärd på en viss tidsserieinstans. Instansobjektet anges när åtgärden lyckas (förutom placeringsåtgärden) och felobjektet anges när åtgärden misslyckas.
InstancesBatchRequest

Begäran om att utföra en enda åtgärd på en batch med instanser. Exakt en av "hämta", "place", "uppdatera" eller "ta bort" måste anges.
InstancesBatchResponse

Svar från en enskild åtgärd på en batch med instanser. Endast en av "hämta", "placera", "uppdatera" eller "ta bort" kommer att ställas in baserat på begäran.
InstancesRequestBatchGetOrDelete

Begäran om att hämta eller ta bort instanser efter tidsserie-ID:t eller tidsserienamn. Exakt en av "timeSeriesIds" eller "names" måste anges.
TimeSeriesInstance

Tidsserieinstanser är själva tidsserien. I de flesta fall är deviceId eller assetId den unika identifieraren för tillgången i miljön. Instanser har beskrivande information som är associerad med dem som kallas instansfält. Instansfält innehåller minst hierarkiinformation. De kan också innehålla användbara, beskrivande data som tillverkare, operatör eller det senaste servicedatumet.
TsiError

Information om ett API-fel.
TsiErrorBody

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

Ytterligare felinformation.

InstanceOrError

Objekt

Resultatet av en batchåtgärd på en viss tidsserieinstans. Instansobjektet anges när åtgärden lyckas (förutom placeringsåtgärden) och felobjektet anges när åtgärden misslyckas.

Name Typ Description
error

TsiErrorBody

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

TimeSeriesInstance

Tidsserieinstansobjekt – anges när åtgärden lyckas (förutom placeringsåtgärden).

InstancesBatchRequest

Objekt

Begäran om att utföra en enda åtgärd på en batch med instanser. Exakt en av "hämta", "place", "uppdatera" eller "ta bort" måste anges.

Name Typ Description
delete

InstancesRequestBatchGetOrDelete

Tidsserieinstanser som ska tas bort. Tidsserie-ID eller namn kan anges.
get

InstancesRequestBatchGetOrDelete

Tidsserie-ID:t eller namn på tidsserieinstanser som ska returneras.
put

TimeSeriesInstance[]

Tidsserieinstanser som ska skapas eller uppdateras.
update

TimeSeriesInstance[]

Tidsserieinstansen som ska uppdateras. Om instansen inte finns returneras ett fel.

InstancesBatchResponse

Objekt

Svar från en enskild åtgärd på en batch med instanser. Endast en av "hämta", "placera", "uppdatera" eller "ta bort" kommer att ställas in baserat på begäran.

Name Typ Description
delete

TsiErrorBody[]

Lista över felobjekt som motsvarar positionen "delete" matrisen i begäran. Null innebär att instansen har tagits bort eller inte fanns. Felobjektet anges när åtgärden misslyckas (t.ex. när det finns händelser som är associerade med den här tidsserieinstansen).
get

InstanceOrError[]

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

InstanceOrError[]

Lista över felobjekt som motsvarar positionen till matrisen "put" i begäran. Felobjektet anges när åtgärden misslyckas.
update

InstanceOrError[]

Lista över felobjekt som motsvarar efter position till matrisen "update" i begäran. Instansobjektet anges när åtgärden lyckas och felobjektet anges när åtgärden misslyckas.

InstancesRequestBatchGetOrDelete

Objekt

Begäran om att hämta eller ta bort instanser efter tidsserie-ID:t eller tidsserienamn. Exakt en av "timeSeriesIds" eller "names" måste anges.

Name Typ Description
names

string[]

Lista över namn på de tidsserieinstanser som ska returneras eller tas bort.
timeSeriesIds

TimeSeriesId[]

Lista över tidsserie-ID:t för de tidsserieinstanser som ska returneras eller tas bort.

TimeSeriesInstance

Objekt

Tidsserieinstanser är själva tidsserien. I de flesta fall är deviceId eller assetId den unika identifieraren för tillgången i miljön. Instanser har beskrivande information som är associerad med dem som kallas instansfält. Instansfält innehåller minst hierarkiinformation. De kan också innehålla användbara, beskrivande data som tillverkare, operatör eller det senaste servicedatumet.

Name Typ Description
description

string

Det här valfria fältet innehåller en beskrivning av instansen.
hierarchyIds

string[]

En uppsättning ID:n för tidsseriehierarkin som instansen tillhör. Kan vara null.
instanceFields

En uppsättning nyckel/värde-par som innehåller användardefinierade instansegenskaper. Det kan vara null. Egenskapsvärdetyper som stöds är: bool, string, long, double och det kan inte vara kapslat eller null.
name

string

Valfritt namn på instansen som är unik i en miljö. Names fungerar som ett föränderligt alias eller visningsnamn för tidsserieinstansen. Föränderlig, kan vara null.
timeSeriesId

TimeSeriesId[]

Time Series-ID som unikt identifierar instansen. Den matchar Time Series ID-egenskaper i en miljö. Oföränderlig, aldrig null.
typeId

string

Detta representerar den typ som den här instansen tillhör. Aldrig null.

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.