Time Series Instances - 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 tijdreeksexemplaren.

POST https://{environmentFqdn}/timeseries/instances/$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 Omgevingen ophalen, 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 bewerking tussen services traceren en kan de klant contact opnemen met 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 de ondersteuning voor een bepaalde groep aanvragen.

Aanvraagbody

Name	Type	Description
delete	InstancesRequestBatchGetOrDelete	Tijdreeksexemplaren die moeten worden verwijderd. Er kan een tijdreeks-id of -naam worden opgegeven.
get	InstancesRequestBatchGetOrDelete	Tijdreeks-id's of namen van tijdreeksexemplaren die moeten worden geretourneerd.
put	TimeSeriesInstance[]	Tijdreeksexemplaren die moeten worden gemaakt of bijgewerkt.
update	TimeSeriesInstance[]	Tijdreeksexemplaren die moeten worden bijgewerkt. Als het exemplaar niet bestaat, wordt er een fout geretourneerd.

Antwoorden

Name	Type	Description
200 OK	InstancesBatchResponse	De bewerking is voltooid. Kopteksten x-ms-request-id: string
Other Status Codes	TsiError	Onverwachte fout. Kopteksten x-ms-request-id: string

Name

Type

Description

200 OK

InstancesBatchResponse

De bewerking is voltooid.

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

InstancesBatchDeleteByIds

InstancesBatchDeleteByNames

InstancesBatchGetByIds

InstancesBatchGetByNames

InstancesBatchPut

InstancesBatchUpdate

InstancesBatchDeleteByIds

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

HTTP

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

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 200

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

InstancesBatchUpdate

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 200

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

Definities

Name	Description
InstanceOrError	Resultaat van een batchbewerking op een bepaald tijdreeksexemplaren. Het exemplaarobject wordt ingesteld wanneer de bewerking is voltooid (behalve de put-bewerking) en het foutobject wordt ingesteld wanneer de bewerking mislukt.
InstancesBatchRequest	Aanvraag om één bewerking uit te voeren op een batch met exemplaren. Er moet precies een van 'get', 'put', 'update' of 'delete' zijn ingesteld.
InstancesBatchResponse	Reactie van één bewerking op een batch met exemplaren. Er wordt slechts één van 'get', 'put', 'update' of 'delete' ingesteld op basis van de aanvraag.
InstancesRequestBatchGetOrDelete	Aanvragen om exemplaren op te halen of te verwijderen op basis van tijdreeks-id's of tijdreeksnamen. Er moet precies een van de 'timeSeriesIds' of 'names' worden ingesteld.
TimeSeriesInstance	Tijdreeksexemplaren zijn de tijdreeksen zelf. In de meeste gevallen is de deviceId of assetId de unieke id van de asset in de omgeving. Exemplaren bevatten beschrijvende informatie die instantievelden worden genoemd. Instantievelden bevatten minimaal hiërarchiegegevens. Ze kunnen ook nuttige, beschrijvende gegevens bevatten, zoals de fabrikant, operator of de laatste servicedatum.
TsiError	Informatie over een API-fout.
TsiErrorBody	Een bepaalde API-fout met een foutcode en een bericht.
TsiErrorDetails	Aanvullende foutinformatie.

InstanceOrError

Resultaat van een batchbewerking op een bepaald tijdreeksexemplaren. Het exemplaarobject wordt ingesteld wanneer de bewerking is voltooid (behalve de put-bewerking) en het foutobject wordt ingesteld wanneer de bewerking mislukt.

Name	Type	Description
error	TsiErrorBody	Foutobject: ingesteld wanneer de bewerking mislukt.
instance	TimeSeriesInstance	Time Series-exemplaarobject: wordt ingesteld wanneer de bewerking is voltooid (behalve de put-bewerking).

InstancesBatchRequest

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

Name	Type	Description
delete	InstancesRequestBatchGetOrDelete	Tijdreeksexemplaren die moeten worden verwijderd. Er kan een tijdreeks-id of -naam worden opgegeven.
get	InstancesRequestBatchGetOrDelete	Tijdreeks-id's of namen van tijdreeksexemplaren die moeten worden geretourneerd.
put	TimeSeriesInstance[]	Tijdreeksexemplaren die moeten worden gemaakt of bijgewerkt.
update	TimeSeriesInstance[]	Tijdreeksexemplaren die moeten worden bijgewerkt. Als het exemplaar niet bestaat, wordt er een fout geretourneerd.

InstancesBatchResponse

Reactie van één bewerking op een batch met exemplaren. Er wordt slechts één van 'get', 'put', 'update' of 'delete' ingesteld op basis van de aanvraag.

Name	Type	Description
delete	TsiErrorBody[]	Lijst met foutobjecten die per positie overeenkomen met de 'delete'-matrix in de aanvraag. Null betekent dat het exemplaar is verwijderd of niet bestaat. Foutobject wordt ingesteld wanneer de bewerking mislukt (bijvoorbeeld wanneer er gebeurtenissen zijn gekoppeld aan dit tijdreeksexemplaren).
get	InstanceOrError[]	Lijst met exemplaar- of foutobjecten die per positie overeenkomen met de 'get'-matrix in de aanvraag. Het exemplaarobject wordt ingesteld wanneer de bewerking is voltooid en het foutobject wordt ingesteld wanneer de bewerking is mislukt.
put	InstanceOrError[]	Lijst met foutobjecten die per positie overeenkomen met de 'put'-matrix in de aanvraag. Foutobject wordt ingesteld wanneer de bewerking is mislukt.
update	InstanceOrError[]	Lijst met foutobjecten die per positie overeenkomen met de matrix 'bijwerken' in de aanvraag. Het exemplaarobject wordt ingesteld wanneer de bewerking is voltooid en het foutobject wordt ingesteld wanneer de bewerking is mislukt.

InstancesRequestBatchGetOrDelete

Aanvragen om exemplaren op te halen of te verwijderen op basis van tijdreeks-id's of tijdreeksnamen. Er moet precies een van de 'timeSeriesIds' of 'names' worden ingesteld.

Name	Type	Description
names	string[]	Lijst met namen van de tijdreeksexemplaren die moeten worden geretourneerd of verwijderd.
timeSeriesIds	TimeSeriesId[]	Lijst met tijdreeks-id's van de tijdreeksexemplaren die moeten worden geretourneerd of verwijderd.