Query - Get Event Schema

Referentie

Service:: Time Series Insights

API-versie:: 2020-07-31

Retourneert het gebeurtenisschema van de omgeving voor een bepaald zoekbereik. Gebeurtenisschema is een set eigenschapsdefinities. Gebeurtenisschema mag niet alle persistente eigenschappen bevatten wanneer er te veel eigenschappen zijn.

POST https://{environmentFqdn}/eventSchema?api-version=2020-07-31

Met optionele parameters:

POST https://{environmentFqdn}/eventSchema?api-version=2020-07-31&storeType={storeType}

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 ophalen uit het antwoord van de Get Environments-API, Azure Portal of Azure Resource Manager.
api-version	query	True	string	Versie van de API die moet worden gebruikt met de clientaanvraag. Momenteel wordt versie 2020-07-31 ondersteund.
storeType	query		string	Voor de omgevingen waarvoor warme opslag is ingeschakeld, kan de query worden uitgevoerd op de 'WarmStore' of 'ColdStore'. Deze parameter in de query definieert op welke opslag de query moet worden uitgevoerd. Als deze niet is gedefinieerd, wordt de query uitgevoerd op de koude opslag.

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 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 de ondersteuning met betrekking tot een bepaalde groep aanvragen.

Aanvraagbody

Name	Vereist	Type	Description
searchSpan	True	DateTimeRange	Het tijdsbereik waarop de query wordt uitgevoerd. Kan niet null zijn.

Antwoorden

Name	Type	Description
200 OK	EventSchema	Geslaagde bewerking. Kopteksten x-ms-request-id: string
Other Status Codes	TsiError	Onverwachte fout. Kopteksten x-ms-request-id: string

Name

Type

Description

200 OK

EventSchema

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

ColdStoreEventSchemaGet

EventSchemaGet

EventSchemaGetEmpty

WarmStoreEventSchemaGet

ColdStoreEventSchemaGet

Voorbeeldaanvraag

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/eventSchema?api-version=2020-07-31&storeType=coldstore

{
  "searchSpan": {
    "from": "2018-08-01T00:00:00.000Z",
    "to": "2018-08-31T00:00:00.000Z"
  }
}

Voorbeeldrespons

Statuscode:: 200

{
  "properties": [
    {
      "name": "Building",
      "type": "String"
    },
    {
      "name": "Room",
      "type": "String"
    },
    {
      "name": "DeviceId",
      "type": "Double"
    },
    {
      "name": "Temperature",
      "type": "Double"
    },
    {
      "name": "Pressure",
      "type": "Double"
    },
    {
      "name": "Status",
      "type": "String"
    }
  ]
}

EventSchemaGet

Voorbeeldaanvraag

HTTP

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

{
  "searchSpan": {
    "from": "2018-08-01T00:00:00.000Z",
    "to": "2018-08-31T00:00:00.000Z"
  }
}

Voorbeeldrespons

Statuscode:: 200

{
  "properties": [
    {
      "name": "Building",
      "type": "String"
    },
    {
      "name": "Room",
      "type": "String"
    },
    {
      "name": "DeviceId",
      "type": "Double"
    },
    {
      "name": "Temperature",
      "type": "Double"
    },
    {
      "name": "Pressure",
      "type": "Double"
    },
    {
      "name": "Status",
      "type": "String"
    }
  ]
}

EventSchemaGetEmpty

Voorbeeldaanvraag

HTTP

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

{
  "searchSpan": {
    "from": "2016-08-01T00:00:00.000Z",
    "to": "2016-08-31T00:00:00.000Z"
  }
}

Voorbeeldrespons

Statuscode:: 200

{
  "properties": []
}

WarmStoreEventSchemaGet

Voorbeeldaanvraag

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/eventSchema?api-version=2020-07-31&storeType=warmstore

{
  "searchSpan": {
    "from": "2018-08-01T00:00:00.000Z",
    "to": "2018-08-31T00:00:00.000Z"
  }
}

Voorbeeldrespons

Statuscode:: 200

{
  "properties": [
    {
      "name": "Building",
      "type": "String"
    },
    {
      "name": "Room",
      "type": "String"
    },
    {
      "name": "DeviceId",
      "type": "Double"
    },
    {
      "name": "Temperature",
      "type": "Double"
    },
    {
      "name": "Pressure",
      "type": "Double"
    },
    {
      "name": "Status",
      "type": "String"
    }
  ]
}

Definities

Name	Description
DateTimeRange	Het tijdsbereik. Kan niet null of negatief zijn.
EventProperty	Eigenschap van een gebeurtenis die wordt opgeslagen of berekend. Eigenschappen worden geïdentificeerd door zowel de naam als het type. Verschillende gebeurtenissen kunnen eigenschappen met dezelfde naam hebben, maar een ander type.
EventSchema	Gebeurtenisschema van alle gebeurtenissen binnen een bepaald zoekbereik. Gebeurtenisschema is een set eigenschapsdefinities. Eigenschappen worden geïdentificeerd door zowel de naam als het type. Verschillende gebeurtenissen kunnen eigenschappen met dezelfde naam hebben, maar een ander type. Gebeurtenisschema mag niet alle persistente eigenschappen bevatten wanneer er te veel eigenschappen zijn.
GetEventSchemaRequest	Aanvraag om het gebeurtenisschema van alle gebeurtenissen binnen een bepaald zoekbereik op te halen.
PropertyTypes	Het type eigendom.
TsiError	Informatie over een API-fout.
TsiErrorBody	Een bepaalde API-fout met een foutcode en een bericht.
TsiErrorDetails	Aanvullende foutinformatie.

DateTimeRange

Object

Het tijdsbereik. Kan niet null of negatief zijn.

Name	Type	Description
from	string (date-time)	Begintijdstempel van het tijdsbereik. Begintijdstempel is inclusief bij gebruik in tijdreeksqueryaanvragen. Gebeurtenissen met deze tijdstempel zijn opgenomen.
to	string (date-time)	Eindtijdstempel van het tijdsbereik. Eindtijdstempel is exclusief wanneer deze wordt gebruikt in queryaanvragen van tijdreeksen. Gebeurtenissen die overeenkomen met deze tijdstempel worden uitgesloten. Houd er rekening mee dat de eindtijdstempel inclusief is wanneer deze wordt geretourneerd door Beschikbaarheid ophalen (wat betekent dat er een gebeurtenis is met dit exacte 'naar'-tijdstempel).

EventProperty

Object

Eigenschap van een gebeurtenis die wordt opgeslagen of berekend. Eigenschappen worden geïdentificeerd door zowel de naam als het type. Verschillende gebeurtenissen kunnen eigenschappen met dezelfde naam hebben, maar een ander type.

Name	Type	Description
name	string	De naam van de eigenschap.
type	PropertyTypes	Het type eigendom.

EventSchema

Object

Gebeurtenisschema van alle gebeurtenissen binnen een bepaald zoekbereik. Gebeurtenisschema is een set eigenschapsdefinities. Eigenschappen worden geïdentificeerd door zowel de naam als het type. Verschillende gebeurtenissen kunnen eigenschappen met dezelfde naam hebben, maar een ander type. Gebeurtenisschema mag niet alle persistente eigenschappen bevatten wanneer er te veel eigenschappen zijn.

Name	Type	Description
properties	EventProperty[]	Een set eigenschapsdefinities. Wanneer de omgeving geen gegevens bevat, is de geretourneerde matrix leeg.

GetEventSchemaRequest

Object

Aanvraag om het gebeurtenisschema van alle gebeurtenissen binnen een bepaald zoekbereik op te halen.

Name	Type	Description
searchSpan	DateTimeRange	Het tijdsbereik waarop de query wordt uitgevoerd. Kan niet null zijn.

PropertyTypes

Inventarisatie

Het type eigendom.

Waarde	Description
Bool
DateTime
Double
Long
String
TimeSpan

TsiError

Object

Informatie over een API-fout.

Name	Type	Description
error	TsiErrorBody	Een bepaalde API-fout met een foutcode en een bericht.

TsiErrorBody

Object

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 om programmatisch specifieke foutcases af te handelen.
details	TsiErrorDetails[]	Bevat aanvullende foutinformatie. Kan null zijn.
innerError	TsiErrorBody	Bevat specifiekere fouten die de oorzaak beperken. Kan null zijn.
message	string	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

Object

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 om programmatisch specifieke foutcases af te handelen.
message	string	Leesbare, taalonafhankelijke weergave van de fout. Het is bedoeld als hulpmiddel voor ontwikkelaars en is niet geschikt voor blootstelling aan eindgebruikers.

Delen via

Query - Get Event Schema

URI-parameters

Aanvraagkoptekst

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

ColdStoreEventSchemaGet

Voorbeeldaanvraag

Voorbeeldrespons

EventSchemaGet

Voorbeeldaanvraag

Voorbeeldrespons

EventSchemaGetEmpty

Voorbeeldaanvraag

Voorbeeldrespons

WarmStoreEventSchemaGet

Voorbeeldaanvraag

Voorbeeldrespons

Definities

DateTimeRange

EventProperty

EventSchema

GetEventSchemaRequest

PropertyTypes

TsiError

TsiErrorBody

TsiErrorDetails

Aanvullende resources