Condividi tramite

Time Series Hierarchies - Execute Batch

  • Riferimento
Servizio:
Time Series Insights
Versione API:
2020-07-31

Esegue un'operazione get, create, update, delete in più definizioni di gerarchia di serie temporali.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
environmentFqdn
 path True

string

Per FQDN dell'ambiente, ad esempio 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. È possibile ottenere questo nome di dominio dalla risposta dell'API Get Environment, portale di Azure o Azure Resource Manager.
api-version
 query True

string

Versione dell'API da usare con la richiesta client. La versione attualmente supportata è "2020-07-31".

Intestazione della richiesta

Nome Necessario Tipo Descrizione
x-ms-client-request-id

string

ID richiesta client facoltativo. Il servizio registra questo valore. Consente al servizio di tracciare l'operazione tra i servizi e consente al cliente di contattare il supporto tecnico per una richiesta specifica.
x-ms-client-session-id

string

ID sessione client facoltativo. Il servizio registra questo valore. Consente al servizio di tracciare un gruppo di operazioni correlate tra i servizi e consente al cliente di contattare il supporto tecnico per un determinato gruppo di richieste.

Corpo della richiesta

Nome Tipo Descrizione
delete

HierarchiesRequestBatchGetDelete

"delete" deve essere impostato durante il recupero di gerarchie specifiche in base agli ID o ai nomi.
get

HierarchiesRequestBatchGetDelete

"get" deve essere impostato durante il recupero di gerarchie specifiche in base agli ID o ai nomi.
put

TimeSeriesHierarchy[]

"put" deve essere impostato durante la creazione o l'aggiornamento delle gerarchie.

Risposte

Nome Tipo Descrizione
200 OK

HierarchiesBatchResponse

Operazione riuscita.

Intestazioni

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

TsiError

Errore imprevisto.

Intestazioni

x-ms-request-id: string

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

HierarchiesBatchDeleteByIds
HierarchiesBatchDeleteByNames
HierarchiesBatchGetByIds
HierarchiesBatchGetByNames
HierarchiesBatchPut

HierarchiesBatchDeleteByIds

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
200 
{
  "delete": [
    null
  ]
}

HierarchiesBatchDeleteByNames

Esempio di richiesta

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

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

Risposta di esempio

Codice di stato:
200 
{
  "delete": [
    null
  ]
}

HierarchiesBatchGetByIds

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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

Esempio di richiesta

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

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

Risposta di esempio

Codice di stato:
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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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
    }
  ]
}

Definizioni

Nome Descrizione
HierarchiesBatchRequest

Richiedere di eseguire una singola operazione in un batch di gerarchie. È necessario impostare esattamente uno di "get", "put" o "delete".
HierarchiesBatchResponse

Risposta di una singola operazione in un batch di gerarchie di serie temporali. Verrà impostato solo uno di "get", "put" o "delete".
HierarchiesRequestBatchGetDelete

Richiedere di ottenere o eliminare più gerarchie della serie temporale. È necessario impostare esattamente uno dei "hierarchyIds" o "name".
Source

Definizione del modo in cui vengono creati i livelli di albero della gerarchia delle serie temporali.
TimeSeriesHierarchy

La gerarchia di serie temporali organizza le istanze della serie temporale in un albero.
TimeSeriesHierarchyOrError

Risultato di un'operazione batch in una particolare gerarchia di serie temporali. La gerarchia viene impostata quando l'operazione ha esito positivo e l'oggetto errore viene impostato quando l'operazione ha esito negativo.
TsiError

Informazioni su un errore dell'API.
TsiErrorBody

Errore dell'API specifico con un codice di errore e un messaggio.
TsiErrorDetails

Informazioni aggiuntive sugli errori.

HierarchiesBatchRequest

Richiedere di eseguire una singola operazione in un batch di gerarchie. È necessario impostare esattamente uno di "get", "put" o "delete".

Nome Tipo Descrizione
delete

HierarchiesRequestBatchGetDelete

"delete" deve essere impostato durante il recupero di gerarchie specifiche in base agli ID o ai nomi.
get

HierarchiesRequestBatchGetDelete

"get" deve essere impostato durante il recupero di gerarchie specifiche in base agli ID o ai nomi.
put

TimeSeriesHierarchy[]

"put" deve essere impostato durante la creazione o l'aggiornamento delle gerarchie.

HierarchiesBatchResponse

Risposta di una singola operazione in un batch di gerarchie di serie temporali. Verrà impostato solo uno di "get", "put" o "delete".

Nome Tipo Descrizione
delete

TsiErrorBody[]

Elenco di oggetti di errore corrispondenti in base alla posizione della matrice "delete" nella richiesta - Null quando l'operazione ha esito positivo.
get

TimeSeriesHierarchyOrError[]

Elenco di oggetti gerarchia o di errore corrispondenti in base alla posizione della matrice "get" nella richiesta. L'oggetto Hierarchy viene impostato quando l'operazione ha esito positivo e l'oggetto errore viene impostato quando l'operazione ha esito negativo.
put

TimeSeriesHierarchyOrError[]

Elenco dell'oggetto gerarchia o dell'errore corrispondente in base alla posizione della matrice "put" nella richiesta. L'oggetto Hierarchy viene impostato quando l'operazione ha esito positivo e l'oggetto errore viene impostato quando l'operazione ha esito negativo.

HierarchiesRequestBatchGetDelete

Richiedere di ottenere o eliminare più gerarchie della serie temporale. È necessario impostare esattamente uno dei "hierarchyIds" o "name".

Nome Tipo Descrizione
hierarchyIds

string[]

Elenco degli ID gerarchia.
names

string[]

Elenco dei nomi della gerarchia.

Source

Definizione del modo in cui vengono creati i livelli di albero della gerarchia delle serie temporali.

Nome Tipo Descrizione
instanceFieldNames

string[]

Elenco dei nomi dei campi dell'istanza che devono essere impostati in tutte le istanze della serie temporale appartenenti a questa gerarchia. L'ordine dei campi dell'istanza definisce i livelli nella gerarchia.

TimeSeriesHierarchy

La gerarchia di serie temporali organizza le istanze della serie temporale in un albero.

Nome Tipo Descrizione
id

string

Identificatore di gerarchia univoca con distinzione tra maiuscole e minuscole. Può essere null durante la creazione di oggetti gerarchia e quindi il server genera l'ID, non Null per le operazioni di recupero ed eliminazione.
name

string

Nome univoco specificato dall'utente per il tipo. È modificabile e non null.
source

Source

Definizione del modo in cui vengono creati i livelli di albero della gerarchia delle serie temporali.

TimeSeriesHierarchyOrError

Risultato di un'operazione batch in una particolare gerarchia di serie temporali. La gerarchia viene impostata quando l'operazione ha esito positivo e l'oggetto errore viene impostato quando l'operazione ha esito negativo.

Nome Tipo Descrizione
error

TsiErrorBody

Oggetto Errore: impostare quando l'operazione non riesce.
hierarchy

TimeSeriesHierarchy

Oggetto gerarchia serie temporali: impostare quando l'operazione ha esito positivo.

TsiError

Informazioni su un errore dell'API.

Nome Tipo Descrizione
error

TsiErrorBody

Errore dell'API specifico con un codice di errore e un messaggio.

TsiErrorBody

Errore dell'API specifico con un codice di errore e un messaggio.

Nome Tipo Descrizione
code

string

Stringa di errore indipendente dal linguaggio e leggibile che definisce un codice di errore specifico del servizio. Questo codice funge da indicatore più specifico per il codice di errore HTTP specificato nella risposta. Può essere usato per gestire casi di errore specifici a livello di codice.
details

TsiErrorDetails[]

Contiene informazioni aggiuntive sugli errori. Può essere Null.
innerError

TsiErrorBody

Contiene un errore più specifico che restringe la causa. Può essere Null.
message

string

Rappresentazione indipendente dal linguaggio e leggibile dell'errore. È destinato agli sviluppatori e non è adatto per l'esposizione agli utenti finali.
target

string

Destinazione del particolare errore (ad esempio, il nome della proprietà in errore). Può essere Null.

TsiErrorDetails

Informazioni aggiuntive sugli errori.

Nome Tipo Descrizione
code

string

Stringa di errore indipendente dal linguaggio e leggibile che definisce un codice di errore specifico del servizio. Questo codice funge da indicatore più specifico per il codice di errore HTTP specificato nella risposta. Può essere usato per gestire casi di errore specifici a livello di codice.
message

string

Rappresentazione indipendente dal linguaggio e leggibile dell'errore. È destinato agli sviluppatori e non è adatto per l'esposizione agli utenti finali.