MetricBase-Zeitreihen-API

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 49 Minuten Lesedauer

    • Die MetricBase-Zeitreihen- API bietet Endpunkte zum Einfügen von Daten in, zum Abrufen von Informationen aus und zum Ausführen von Transformationen für eine MetricBase -Datenbank.

    Diese API kann nur verwendet werden, wenn das Plugin MetricBase „“ (com.snc.textil) installiert und aktiviert ist.

    Zum Schreiben in diese API erforderliche Rolle: Clotho_rest_put

    Die Beispiele in diesem Abschnitt wurden mit Daten im Plugin MetricBase (com.snc.textil) erstellt.

    MetricBase-Zeitreihe – GET /now/clotho/table/{table}/{subject}/{metric}

    Ruft die angegebenen Zeitreihendaten aus der Datenbank MetricBase ab.

    URL-Format

    URL mit Versionsnummer: /api/now/{api_version}/clotho/table/{table}/{subject}/{metric}

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    Name Beschreibung
    api_version
    Metrik Name der Spalte in der Tabelle, die im Parameter subject als Metrik verwendet werden soll.

    Datentyp: Zeichenfolge
    Betreff Sys_id des GlideRecord, der dieser Serie zugeordnet ist.

    Datentyp: Zeichenfolge
    Tabelle Name der Tabelle, die den GlideRecord enthält, der dieser Serie zugeordnet ist.

    Datentyp: Zeichenfolge
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    sysparm_display_value Kennzeichnung, die angibt, ob die Ergebnisdaten mit dem Anzeigewert des Betreffdatensatzes gekennzeichnet werden sollen, wenn keine andere Bezeichnung angegeben ist.
    Gültige Werte:
    • „wahr“: Die Ergebnisdaten werden mit dem Anzeigewert des Betreffdatensatzes beschriftet.
    • „falsch“: Ergebnisdaten werden nicht mit dem Anzeigewert des Betreffdatensatzes beschriftet.

    Datentyp: Boolesch

    Standardwert: false
    sysparm_end Erforderlich. Endzeit des Bewertungszeitraums. Ein leerer oder fehlender Wert wird als aktuelle Uhrzeit behandelt. Zeitwerte enthalten diese Endzeit.

    Datentyp: Zeichenfolge

    Format: ISO 8601 (UTC), entweder:
    • Absolutes Datumsformat [JJJJ-MM-DDThh:mm:ss], z. B. 2019-03-20T17:04:55.
    • Relativ zum aktuellen Zeitdauerformat [P(n)Y(n)M(n)DT(n)H(n)M(n)S], z. B. P1M.
    sysparm_start Erforderlich. Startzeit des Bewertungszeitraums. Der spezielle Wert all kann verwendet werden, um die Startzeit als die aktuelle Zeit minus den maximalen Aufbewahrungszeitraum für die angegebenen Metriken festzulegen. Ein leerer oder fehlender Wert wird als impliziter allbehandelt. Zeitwerte enthalten diese Startzeit.

    Datentyp: Zeichenfolge

    Format: ISO 8601 (UTC), entweder:
    • Absolutes Datumsformat [JJJJ-MM-DDThh:mm:ss], z. B. 2019-03-20T17:04:55
    • Relativ zum aktuellen Zeitdauerformat [P(n)Y(n)M(n)DT(n)H(n)M(n)S], z. B. P1M.
    Tabelle : 3. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.

    Tabelle : 4. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 5. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    label Die zur Identifizierung des Ergebnissatzes dieser Metrik verwendete Bezeichnung.

    Datentyp: Zeichenfolge
    SeriesRef Datenreihenergebnisse.

    Datentyp: Array

    "seriesRef": [
  {
    "metric": "String",
    "subject": "String",
    "table": "String"
  }
]
    SeriesRef.Metrik Der Name der Metrik, aus der die Datenreihe abgerufen wurde. Wird nur angezeigt, wenn das Objekt metrics in der Anforderung übergeben wird.

    Datentyp: Zeichenfolge
    SeriesRef.Subject Die sys_id des Datenreihen-Datensatzes. Befindet sich in der in seriesRef.tableangegebenen Tabelle.

    Datentyp: Zeichenfolge
    SeriesRef.Tabelle Der Name der Tabelle, aus der die Datenreihe abgerufen wurde.

    Datentyp: Zeichenfolge
    Werte Die transformierten Reihenwerte.

    Datentyp: Array

    "values": [
  {
    "timestamp": "String",
    "value": Number
  }
]
    Werte.Zeitstempel Der ISO 8601-Zeitstempel des Werts.

    Datentyp: Zeichenfolge
    Werte.Wert Die Werte der Metrik.

    Datentyp: Zahl

    cURL-Anforderung

    curl "https://instance.servicenow.com/api/now/v1/clotho/
  table/mb_demo_drone/626b051787333200a328c5b836cb0b99/
  mb_demo_mt_altitude?sysparm_start=2019-03-20T17%3A04%3A55
  &sysparm_end=2019-03-20T17%3A09%3A55" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    {
  "seriesRef": {
    "subject": "626b051787333200a328c5b836cb0b99",
    "table": "mb_demo_drone",
    "metric": "mb_demo_mt_altitude"
  },
  "label": "626b051787333200a328c5b836cb0b99:
            mb_demo_drone|mb_demo_mt_altitude",
  "values": [
    {
      "timestamp": "2019-03-20T17:05:00Z",
      "value": 83.150185
    },
    {
      "timestamp": "2019-03-20T17:06:00Z",
      "value": 83.46074
    },
    {
      "timestamp": "2019-03-20T17:07:00Z",
      "value": 83.83104
    },
    {
      "timestamp": "2019-03-20T17:08:00Z",
      "value": 84.260635
    },
    {
      "timestamp": "2019-03-20T17:09:00Z",
      "value": 84.749
    }
  ]
}

    MetricBase-Zeitreihe – GET /now/clotho/transform/{table}/{metric}

    Transformiert die angegebenen Daten basierend auf den angegebenen Parametern.

    URL-Format

    URL mit Versionsangabe: /api/now/{api_version}/clotho/transform/{table}/{metric}

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfadparameter
    Name Beschreibung
    api_version
    Metrik Name der Spalte in der Tabelle, die im Parameter subject als Metrik verwendet werden soll.

    Datentyp: Zeichenfolge
    Tabelle Name der Tabelle, die den GlideRecord enthält, der dieser Serie zugeordnet ist.

    Datentyp: Zeichenfolge
    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    sysparm_display_value Kennzeichnung, die angibt, ob die Ergebnisdaten mit dem Anzeigewert des Betreffdatensatzes gekennzeichnet werden sollen, wenn keine andere Bezeichnung angegeben ist.
    Gültige Werte:
    • „wahr“: Die Ergebnisdaten werden mit dem Anzeigewert des Betreffdatensatzes beschriftet.
    • „falsch“: Ergebnisdaten werden nicht mit dem Anzeigewert des Betreffdatensatzes beschriftet.

    Datentyp: Boolesch

    Standardwert: false
    sysparm_end Erforderlich. Endzeit des Bewertungszeitraums. Ein leerer oder fehlender Wert wird als aktuelle Uhrzeit behandelt. Zeitwerte enthalten diese Endzeit.

    Datentyp: Zeichenfolge

    Format: ISO 8601 (UTC), entweder:
    • Absolutes Datumsformat [JJJJ-MM-DDThh:mm:ss], z. B. 2019-03-20T17:04:55.
    • Relativ zum aktuellen Zeitdauerformat [P(n)Y(n)M(n)DT(n)H(n)M(n)S], z. B. P1M.
    sysparm_query Codierte Abfragezeichenfolge zum Suchen der Betreffdatensätze.

    Datentyp: Zeichenfolge

    Standard: Keine
    sysparm_start Erforderlich. Startzeit des Bewertungszeitraums. Der spezielle Wert all kann verwendet werden, um die Startzeit als die aktuelle Zeit minus den maximalen Aufbewahrungszeitraum für die angegebenen Metriken festzulegen. Ein leerer oder fehlender Wert wird als impliziter allbehandelt. Zeitwerte enthalten diese Startzeit.

    Datentyp: Zeichenfolge

    Format: ISO 8601 (UTC), entweder:
    • Absolutes Datumsformat [JJJJ-MM-DDThh:mm:ss], z. B. 2019-03-20T17:04:55
    • Relativ zum aktuellen Zeitdauerformat [P(n)Y(n)M(n)DT(n)H(n)M(n)S], z. B. P1M.
    sysparm_subject_limit Beschränken Sie die Größe des Betreffabfrageergebnisses.

    Datentyp: Zahl

    Standard: 10.000
    sysparm_transforms Kommagetrennte Liste der Transformationen.
    Gültige Transformationen:
    • Hinzufügen
    • avg
    • label
    • mul
    • erneut berechnen
    • sum
    • top

    Datentyp: Zeichenfolge

    Standard: Keine
    Tabelle : 9. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.

    Tabelle : 10. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 11. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

    Tabelle : 12. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    label Die zur Identifizierung des Ergebnissatzes dieser Metrik verwendete Bezeichnung.

    Datentyp: Zeichenfolge
    SeriesRef Datenreihenergebnisse.

    Datentyp: Array

    "seriesRef": [
  {
    "metric": "String",
    "subject": "String",
    "table": "String"
  }
]
    SeriesRef.Metrik Der Name der Metrik, aus der die Datenreihe abgerufen wurde. Wird nur angezeigt, wenn das Objekt metrics in der Anforderung übergeben wird.

    Datentyp: Zeichenfolge
    SeriesRef.Subject Die sys_id des Datenreihen-Datensatzes. Befindet sich in der in seriesRef.tableangegebenen Tabelle.

    Datentyp: Zeichenfolge
    SeriesRef.Tabelle Der Name der Tabelle, aus der die Datenreihe abgerufen wurde.

    Datentyp: Zeichenfolge
    Werte Die transformierten Reihenwerte.

    Datentyp: Array

    "values": [
  {
    "timestamp": "String",
    "value": Number
  }
]
    Werte.Zeitstempel Der ISO 8601-Zeitstempel des Werts.

    Datentyp: Zeichenfolge
    Werte.Wert Die Werte der Metrik.

    Datentyp: Zahl

    cURL-Anforderung

    curl "https://instance.servicenow.com/api/now/v1/clotho/
  transform/mb_demo_drone/mb_demo_mt_speed?
  sysparm_query=model%3DKingfisher%20Phantom&
  sysparm_start=2019-03-25T17%3A04%3A55&
  sysparm_end=2019-03-25T17%3A05%3A10" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    Ausgabe:

    [
  {
    "seriesRef": {
      "subject": "2a6b051787333200a328c5b836cb0b92",
      "table": "mb_demo_drone",
      "metric": "mb_demo_mt_speed"
    },
    "label": "2a6b051787333200a328c5b836cb0b92:mb_demo_drone
             |mb_demo_mt_speed",
    "values": [
      {
        "timestamp": "2019-03-25T17:05:00Z",
        "value": 33.67892
      }
    ]
  },
  {
    "seriesRef": {
      "subject": "666b051787333200a328c5b836cb0b92",
      "table": "mb_demo_drone",
      "metric": "mb_demo_mt_speed"
    },
    "label": "666b051787333200a328c5b836cb0b92:mb_demo_drone
             |mb_demo_mt_speed",
    "values": [
      {
        "timestamp": "2019-03-25T17:05:00Z",
        "value": 41.94985
      }
    ]
  },
  {
    "seriesRef": {
      "subject": "a26b051787333200a328c5b836cb0b92",
      "table": "mb_demo_drone",
      "metric": "mb_demo_mt_speed"
    },
    "label": "a26b051787333200a328c5b836cb0b92:mb_demo_drone
             |mb_demo_mt_speed",
    "values": [
      {
        "timestamp": "2019-03-25T17:05:00Z",
        "value": 37.74187
      }
    ]
  },
  {
    "seriesRef": {
      "subject": "ea6b051787333200a328c5b836cb0b92",
      "table": "mb_demo_drone",
      "metric": "mb_demo_mt_speed"
    },
    "label": "ea6b051787333200a328c5b836cb0b92:mb_demo_drone
             |mb_demo_mt_speed",
    "values": [
      {
        "timestamp": "2019-03-25T17:05:00Z",
        "value": 34.914192
      }
    ]
  },
  {
    "seriesRef": {
      "subject": "ee6b051787333200a328c5b836cb0b91",
      "table": "mb_demo_drone",
      "metric": "mb_demo_mt_speed"
    },
    "label": "ee6b051787333200a328c5b836cb0b91:mb_demo_drone
             |mb_demo_mt_speed",
    "values": [
      {
        "timestamp": "2019-03-25T17:05:00Z",
        "value": 44.170887
      }
    ]
  }
]

    MetricBase-Zeitreihe – POST /now/clotho/accomulate

    Akkumuliert Metrikwerte mit einem angegebenen Zeitstempel und speichert das Ergebnis in der Datenbank, anstatt den Wert zu überschreiben.

    Verwenden Sie diese API , um Metriken zu verarbeiten, die für eine Akkumulation summiert werden können, z. B. Kilowattstunden (kWh) Strom. Beim Akkumulieren wird für jede Metrik zum angegebenen Zeitstempel ein Aufruf durchgeführt. Zum Beispiel würden gesammelte Kilowattstunden für eine Heizkörper, einen Elektroherd und eineWaschmaschine zu drei Anrufen führen, die zu akkumulieren sind.

    URL-Format

    URL mit Versionsnummer: /api/now/{api_version}/clotho/accomulate

    Unterstützte Anforderungsparameter

    Tabelle : 13. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 14. Abfrageparameter
    Name Beschreibung
    default_value Standardwert für die Akkumulation bei einem bestimmten Zeitstempel. Wird nur während des ersten Anrufs verwendet, um zu akkumulieren, wenn ein Wert für einen bestimmten Zeitstempel nicht verfügbar ist.

    Ein Anwendungsfall könnte das Sammeln einer Watt-Metrik für eine Gesamtleistung sein. Sie möchten die Leistung in Leistung für einen Router, der an eine Steckdose ohne Leistungsmesser verbunden ist, sammeln, um die Leistung zu messen. Wenn Sie den Verbrauchswert kennen und dieser konstant ist, können Sie den konstanten Wert als Standardwert verwenden, um „total_power“ zu akkumulieren. Zum Beispiel würden Sie 20 verwenden, wenn der Router ständig mit dem Stromnetz verbunden ist und 20 Watt verbraucht.

    Datentyp: Zeichenfolge

    Standard: 0
    sysparm_ignore_unknown_series

    Kennzeichnung, die angibt, ob eine unbekannte Serie ignoriert und die Transaktion ohne Rückgabe eines Fehlers fortgesetzt werden soll.

    Gültige Werte:
    • „wahr“: Unbekannte Serie ignorieren.
    • „falsch“: Unbekannte Serie nicht ignorieren.

    Standardwert: true
    Tabelle : 15. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    SeriesRef Liste von Zeichenfolgen, die zu aktualisierende Datenreiheninformationen darstellen.

    Datentyp: Array

    "seriesRef": [
  {
    "metric": "String",
    "subject": "String",
    "table": "String"
  }
]
    SeriesRef.Metrik Erforderlich. Der Name der zu aktualisierenden akkumulierenden Metrik.

    Datentyp: Zeichenfolge
    SeriesRef.Subject Erforderlich. Die sys_id des Datensatzes, in dem die Daten aktualisiert werden sollen. Befindet sich in der in seriesRef.tableangegebenen Tabelle.

    Datentyp: Zeichenfolge
    SeriesRef.Tabelle Erforderlich. Der Name der Tabelle, in der die Daten gespeichert werden sollen.

    Datentyp: Zeichenfolge
    Werte Erforderlich. Die zu akkumulierenden und zu speichernden Serienwerte. Werte mit demselben Zeitstempel werden mit dem Abfrageparameter default_value zusammengefasst.

    Datentyp: Array

    "values": [
  {
    "timestamp": "String",
    "value": Number
  }
]
    Werte.Zeitstempel Erforderlich. Der ISO 8601-Zeitstempel des Werts.

    Datentyp: Zeichenfolge

    Format: JJJJ-MM-ttTHH:mm:ttZ

    Das durch „Z“ dargestellte Zeichen bezeichnet die UTC-Zeitzone in einem ISO-formatierten Zeitstempel. Dieser Teil des Zeitstempelformats ist optional.

    Beispiel: 2019-03-21T17:05:00Z
    Werte.Wert Erforderlich. Der Wert der Metrik.

    Datentyp: Zahl

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.

    Tabelle : 16. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 17. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

    Tabelle : 18. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Nachricht Meldung, die eine erfolgreiche Ausführung oder einen -Fehleranzeigt.

    cURL-Anforderung

    In diesem Beispiel wird gezeigt, wie Metrikwerte zu einem bestimmten Zeitstempel akkumuliert werden.

    curl "https://instance.servicenow.com/api/now/v1/clotho/accumulate" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"seriesRef\": {
    \"subject\": \"3D666b051787333200a328c5b836cb0b92\",
    \"table\": \"power_monitoring\",
    \"metric\": \"total_power\"
  },
  \"values\": [
    {
      \"timestamp\": \"2019-03-21T17:05:00Z\",
      \"value\": 0.150185
    },
    {
      \"timestamp\": \"2019-03-21T17:05:00Z \",
      \"value\": 0.46074
    },
    {
      \"timestamp\": \"2019-03-21T17:05:00Z \",
      \"value\": 0.83104
    },
    {
      \"timestamp\": \"2019-03-21T17:05:00Z \",
      \"value\": 1.260635
    },
    {
      \"timestamp\": \"2019-03-21T17:05:00Z \",
      \"value\": 1.749
    }
  ]
}" \
--user "username":"password"

    Ausgabe mit erfolgreichen Ergebnissen bereitgestellt.

    {
    "result": {
        "message": "ok"
    }
}

    MetricBase-Zeitreihe – POST /now/clotho/transform

    Ruft Zeitreihendaten für eine oder mehrere Metriken ab und gruppiert sie optional, nachdem eine angegebene Liste von Transformationen angewendet wurde, die eine lineare Pipeline bilden.

    URL-Format

    URL mit Versionsnummer: /api/now/{api_version}/clotho/transform

    Unterstützte Anforderungsparameter

    Tabelle : 19. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    sysparm_display_value Kennzeichnung, die angibt, ob die Ergebnisdaten mit dem Anzeigewert des Betreffdatensatzes gekennzeichnet werden sollen, wenn keine andere Bezeichnung angegeben ist.
    Gültige Werte:
    • „wahr“: Die Ergebnisdaten werden mit dem Anzeigewert des Betreffdatensatzes beschriftet.
    • „falsch“: Ergebnisdaten werden nicht mit dem Anzeigewert des Betreffdatensatzes beschriftet.

    Datentyp: Boolesch

    Standardwert: false
    Tabelle : 21. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    end Erforderlich. Endzeit des Bewertungszeitraums. Ein leerer oder fehlender Wert wird als aktuelle Uhrzeit behandelt. Zeitwerte enthalten diese Endzeit.

    Datentyp: Zeichenfolge

    Format: ISO 8601 (UTC), entweder:
    • Absolutes Datumsformat [JJJJ-MM-DDThh:mm:ss], z. B. 2019-03-20T17:04:55.
    • Relativ zum aktuellen Zeitdauerformat [P(n)Y(n)M(n)DT(n)H(n)M(n)S], z. B. P1M.
    limit Maximale Anzahl der zurückzugebenden Datensätze. Ungewöhnlich große Werte können sich auf die Systemleistung auswirken.

    Datentyp: Zahl

    Standard: 10.000
    Metriken Liste der Metrikobjekte, die bei der Transformation verwendet werden sollen. Weitere Informationen zu den Metriken finden Sie unter Metrics.

    Datentyp: Array

    "metrics": [
  {
    "groupBy": "String"
    "label": "String",
    "metric": "String",
    "transforms": [Array]
  }
]
    metrics.groupBy Kommagetrennte Liste von Feldern, die in der im Parameter table angegebenen Tabelle enthalten sind, nach der die Reihe gruppiert wird, bevor aggregierte Transformationen gesammelt oder angewendet werden.

    Die Reihenfolge der Elemente in der Liste entspricht der Reihenfolge, in der die Daten gruppiert werden. Wenn beispielsweise zwei Elemente in der Liste vorhanden sind, „Bundesland, Postleitzahl“, wird die Serie zuerst nach dem Bundesland und dann nach der Postleitzahl innerhalb des Bundeslandes gruppiert.

    Datentyp: Zeichenfolge

    Standard: Daten sind nicht gruppiert.
    metrics.label Für den Ergebnissatz dieser Metrik zu verwendende Bezeichnung. Es ersetzt alle von der Transformationskette generierten Bezeichnungen.

    Datentyp: Zeichenfolge

    Standard: Generierte Standardbezeichnung.
    metrics.metric Erforderlich, wenn Objekt metrics übergeben wird. Bei der Transformation zu verwendendes Metrikfeld. Dieses Feld muss sich in der im Parameter table angegebenen Tabelle befinden.

    Datentyp: Zeichenfolge
    metrics.transforms Liste der Transformationen (Transformationskette), die auf die abgerufenen Zeitreihendaten angewendet werden sollen. Jede Transformation baut auf den Ergebnissen der vorherigen Transformation auf. Eine Liste der verfügbaren Transformationen finden Sie unten unter Unterstützte Transformationen.

    Datentyp: Array

    "transforms": [
  {
    "arg": {Object},
    "name": "String"
  }
]
    metrics.transforms.arg Abhängig von der Transformation. Parameter, die an die Transformation übergeben werden sollen.
    Allgemeine Richtlinien:
    • Verwenden Sie den Parameter arg nicht, wenn Sie Transformationen angeben, die keinen Parameter akzeptieren.
    • Verwenden Sie Zahl, Zeichenfolge oder einen booleschen Wert für Transformationen, die einen einzelnen Parameter akzeptieren.
    • Verwenden Sie ein JSON-Objekt mit den entsprechenden Name/Wert-Paaren für Transformationen, die mehr als einen Parameter akzeptieren.

    Datentyp: Zahl, Zeichenfolge, boolescher Wert oder JSON-Objekt, je nach Transformation. (Eine Liste der verfügbaren Transformationen finden Sie in der Tabelle „ Unterstützte Transformationen “.)
    metrics.transforms.name Erforderlich, wenn ein transforms -Objekt angegeben ist. Name der Transformation

    Eine Liste der verfügbaren Transformationen finden Sie in der Tabelle „Unterstützte Transformationen“ weiter unten.

    Datentyp: Zeichenfolge
    query Codierte Abfrage zum Filtern des Ergebnissatzes.

    Sie können die Abfrage mit dem Filtereditor der angegebenen Tabelle verfassen. Wählen Sie nach der Erstellung im Breadcrumbs-Kontextmenü des Filters die Option URL kopieren aus.

    Datentyp: Zeichenfolge

    Standard: Keine
    start Erforderlich. Startzeit des Bewertungszeitraums. Der spezielle Wert all kann verwendet werden, um die Startzeit als die aktuelle Zeit minus den maximalen Aufbewahrungszeitraum für die angegebenen Metriken festzulegen. Ein leerer oder fehlender Wert wird als impliziter allbehandelt. Zeitwerte enthalten diese Startzeit.

    Datentyp: Zeichenfolge

    Format: ISO 8601 (UTC), entweder:
    • Absolutes Datumsformat [JJJJ-MM-DDThh:mm:ss], z. B. 2019-03-20T17:04:55
    • Relativ zum aktuellen Zeitdauerformat [P(n)Y(n)M(n)DT(n)H(n)M(n)S], z. B. P1M.
    Tabelle Erforderlich. Name der Tabelle, die den GlideRecord enthält, der dieser Serie zugeordnet ist.

    Datentyp: Zeichenfolge

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.

    Tabelle : 22. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 23. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

    Tabelle : 24. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    405 Ungültige Methode. Die Funktion ist deaktiviert.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Ergebnisse Null oder mehr Rückgabeergebnisobjekte, die die Abfrage erfüllen. Enthält entweder ein series -Array oder ein grouped -Array.

    Datentyp: Array

    "results":[
  {
    "grouped": [Array],
    "marker": "String",
    "series": [Array]
  }
]
    Ergebnisse.gruppiert Liste der gruppierten Ergebnisobjekte, wobei jedes grouped -Ergebnisobjekt einer bestimmten Gruppe entspricht. Dieses Format wird zurückgegeben, wenn der Parameter metrics.groupBy im Anforderungstext übergeben wird.

    Datentyp: Array

    "grouped": [
  {
    "groupingBy": "String",
    "groups": [Array]
  }
]
    ergebnisse.gruppiert.gruppierungNach Wert, der im Parameter metrics.groupBy in der Anforderung übergeben wird.

    Datentyp: Zeichenfolge
    Ergebnisse.gruppiert.Gruppen Liste der generierten Gruppen basierend auf dem Inhalt des Parameters metrics.groupBy in der Anforderung.

    Datentyp: Array

    "groups": [
  {
    "group": "String",
    "label": "String",
    "series": {Object}
  }
]
    results.grouped.groups.group Name der Gruppe.

    Datentyp: Zeichenfolge
    ergebnisse.gruppiert.gruppen.bezeichnung Bezeichnung der Gruppe.

    Datentyp: Zeichenfolge
    Ergebnisse.gruppiert.Gruppen.Serie Transformierte Werte für das Ergebnis der Gruppe.

    Datentyp: Array

    "series": [
  {
    "label": "String",
    "seriesRef": {Object},
    "values": [Array]
  }
]
    Ergebnisse.gruppiert.Gruppen.Serie.Bezeichnung Bezeichnung der Serie.

    Datentyp: Zeichenfolge
    ergebnisse.gruppiert.gruppen.series.seriesRef Ergebnisse einer einzelnen Datenreihe. Wird nicht angezeigt, wenn die Antwort mehrere Datenreihen enthält.

    Datentyp: Objekt

    "seriesRef": {
  "metric": "String",
  "subject": "String",
  "table": "String"
}
    ergebnisse.gruppiert.gruppen.series.seriesRef.metric Name der Metrik, aus der die Datenreihe abgerufen wurde. Wird nur angezeigt, wenn das Objekt metrics in der Anforderung übergeben wird.

    Datentyp: Zeichenfolge
    ergebnisse.gruppiert.gruppen.series.seriesRef.subject Sys_id des Datenreihen-Datensatzes. Befindet sich in der in results.series.seriesRef.tableangegebenen Tabelle.

    Datentyp: Zeichenfolge
    ergebnisse.gruppiert.gruppen.series.seriesRef.tabelle Name der Tabelle, aus der die Datenreihe abgerufen wurde.

    Datentyp: Zeichenfolge
    ergebnisse.gruppiert.Gruppen.Serie.Werte Liste der Ergebniswerte für die Gruppe.

    Datentyp: Array

    "values": [
  {
    "timestamp": "String",
    "value": Number
  }
]
    Ergebnisse.gruppiert.Gruppen.Serie.Werte.Zeitstempel ISO 8601-Zeitstempel des Werts.

    Datentyp: Zeichenfolge
    ergebnisse.gruppiert.gruppen.series.werte.wert Transformierter Wert

    Datentyp: Zahl
    Ergebnisse.Marker Eindeutiger Bezeichner für die entsprechenden Ergebnisse.

    Datentyp: Zeichenfolge
    ergebnisse.series Liste der nicht gruppierten Serie von Ergebnisobjekten.

    Datentyp: Array

    "series": [
  {
    "label": "String",
    "seriesRef": {Object},
    "values": [Array]
  }
]
    ergebnisse.series.bezeichnung Datenreihenbezeichnung. Dieser Wert wird entweder vom Endpunkt generiert oder ist der Wert, der im Parameter metrics.label übergeben wird.

    Datentyp: Zeichenfolge
    ergebnisse.series.seriesRef Ergebnisse einer einzelnen Datenreihe. Wird nicht angezeigt, wenn die Antwort mehrere Datenreihen enthält.

    Datentyp: Objekt

    "seriesRef": {
  "metric": "String",
  "subject": "String",
  "table": "String"
}
    ergebnisse.series.seriesReferenz.metrik Name der Metrik, aus der die Datenreihe abgerufen wurde. Wird nur angezeigt, wenn das Objekt metrics in der Anforderung übergeben wird.

    Datentyp: Zeichenfolge
    ergebnisse.series.seriesRef.subject Sys_id des Datenreihen-Datensatzes. Befindet sich in der in results.series.seriesRef.tableangegebenen Tabelle.

    Datentyp: Zeichenfolge
    ergebnisse.series.seriesReferenz.tabelle Name der Tabelle, aus der die Datenreihe abgerufen wurde.

    Datentyp: Zeichenfolge
    Ergebnisse.Reihe.Werte Transformierte Reihenwerte.

    Datentyp: Array

    "values": [
  {
    "timestamp": "String",
    "value": Number
  }
]
    ergebnisse.series.werte.zeitstempel ISO 8601-Zeitstempel des Werts.

    Datentyp: Zeichenfolge
    ergebnisse.series.werte.wert Transformierter Wert

    Datentyp: Zahl

    Unterstützte Transformationen

    Tabelle : 25. Datentypen transformieren
    Umwandeln Beschreibung
    Hinzufügen Addiert die angegebene Anzahl zu jedem Zeitstempelwert.

    Argument: Argument (Datentyp „Decimal“): Zahl, die hinzugefügt werden soll.

    Beispiel:
    "transforms": [
  {
    "name": "add",
    "arg": 8
  }
]
    Autokorrelation Berechnet die Korrelation zwischen Zeitstempelwerten, die durch eine zunehmende Anzahl von Punkten getrennt sind, beginnend bei 1.
    avg Fasst die Zeitreihe in einer Reihe zusammen, die den Durchschnittswert für jeden entsprechenden Zeitstempel in der Eingabe enthält.
    bottom Gibt die angegebene Anzahl der Serien mit den niedrigsten Werten zurück.

    Argument: Argument (Ganzzahl) – Die Anzahl der zurückzugebenden Serien.

    Im Folgenden werden beispielsweise die beiden Zeitreihen zurückgegeben, die die niedrigsten Werte enthalten.
    "transforms": [
  {
     "name": "bottom",
     "arg": 2
  }
]
    decken Rundet den Wert in jedem Zeitstempel auf die angegebene Genauigkeit: ceil(value /<arg> ) * )

    Argument: Argument (Datentyp „Decimal“): Dezimalgenauigkeit, auf die aufgerundet wird.
    sammeln Zeigt die Transformationsergebnisse der Transformationskette bis zum Punkt des Erfassungstransformationsaufrufs an. Sammeltransformationsergebnisse enthalten eine eindeutige Markierung, Sie können jedoch auch eine Bezeichnung definieren.
    Beispiel:
    {
  "start": "PT1H",
  "end": "",
  "table": "mb_demo_drone",
  "limit": 5000,
  "metrics": [
    {
      "metric": "mb_demo_mt_altitude",
      "transforms": [
        {
          "name": "label",
          "arg": "Series Timestamp Values"
        },
        {
          "name": "collect"
        },
        {
          "name": "avg"
        },
        {
          "name": "label",
          "arg": "Average Timestamp Values"
        }
      ]
    }
  ]
}
    eingeschränkteWerte Ersetzt jeden Wert außerhalb des angegebenen Bereichs durch den entsprechenden Höchst- oder Mindestwert.
    Wenn Sie beispielsweise Folgendes angegeben haben, ersetzt die Transformation jeden Wert, der kleiner als 0 ist, durch 0 und jeden Wert, der größer als 100 ist, durch 100.
    "transforms": [
  {
    "name": "constrainValues",
    "val1": 0,
    "val2": 100
  }
]
    Parameter:
    • val1 (Datentyp „Decimal“): Mindest- oder Höchstwert.
    • val2 (Datentyp „Decimal“): Mindest- oder Höchstwert.
    count Fasst die Zeitreihen in einer Reihe zusammen. Die neue Serie enthält für jeden entsprechenden Zeitstempel in der Serie die Anzahl der Werte, die nicht NaN (Not a Number) sind.
    Ableitung Bestimmt die Rate der Änderung zwischen Zeitstempeln. Teilt die Differenz zwischen dem Wert in jedem Zeitstempel und dem Wert im nächsten Zeitstempel durch den Zeitraum des Zeitstempels.
    Hinweis:
    Diese Transformation gibt einen Wert weniger zurück als die Anzahl der Werte in der Reihe.
    div Teilt den Wert in jedem Zeitstempel durch die angegebene Zahl (Argument).

    Argument: Argument (Dezimalzahl: Die Zahl, durch die der Wert jedes Zeitstempels dividiert werden soll.
    Umschlag Gibt zwei Zeitreihen zurück, von denen zu jedem Zeitpunkt eine den größten Wert und die andere den kleinsten Wert enthält.
    Hinweis:
    NaNs werden ignoriert, aber zurückgegeben, wenn keine anderen Rückgabewerte vorhanden sind.
    abgel Potenziert den Wert der angegebenen Basis mit dem Wert in jedem Zeitstempel.

    Argument: Argument (Datentyp „Decimal“): Der Basiswert.
    filter Wendet einen Aggregator auf den Inhalt eines gleitenden Fensters an, um z. B. einen gleitenden Durchschnitt zu erzeugen.
    Parameter:
    • Aggregator (Datentyp „Aggregator“): Typ der auszuführenden Zusammenfassung.
    • Fenster (Datentyp „Dauer“): Die Dauer des gleitenden Fensters.
    Stockwerk Rundet den Wert in jedem Zeitstempel auf die angegebene Genauigkeit ab: tage (Wert /<arg> ) *

    Argument: Argument (Datentyp „Decimal“): Die Dezimalgenauigkeit, auf die abgerundet werden soll.
    Fraktile Gibt eine Zeitreihe für jeden Bruch im angegebenen Array zurück. Jeder Zeitstempelwert ist der Wert, um den der angegebene Bruchteil der Werte für den entsprechenden Zeitstempel in der Eingabereihe unter dem angegebenen Prozentsatz liegt. Beispiel: Wenn der Bruch 0,5 beträgt, ist der Wert im Zeitstempel der Wert, bei dem die Hälfte der Werte in der Eingabereihe unter 0,5 liegt.

    Argument: Argument (Dezimalzahl-Array) – Die in der Eingabeserie zu verwendenden Teile.

    Beispiel:
    "transforms": [
  {
    "name": "fractiles",
    "arg": [0.25, 0.5, 0.75, 1]
  }
]
    groupBy Gruppiert Daten nach den angegebenen Feldern, bevor aggregierte Transformationen gesammelt oder angewendet werden.

    Argument: Argument (Zeichenfolge) – Eine kommagetrennte Liste von Feldern in der Tabelle, die zum Gruppieren der Transformationsergebnisse verwendet werden sollen.

    Beispiel:
     "transforms": [
  {
    "name": "groupBy",
    "arg": "model"
  },
  {
    "name": "avg"
  },
  {
    "name": "label",
    "arg": "Model: %g"
  }
]
    integrieren Multipliziert den Wert in jedem Zeitstempel mit dem Zeitraum.
    interpolieren Erstellt einen Datenwert für ein NaN-Datenelement durch Interpolation aus angrenzenden Datenwerten.

    Argument: Argument (Ganzzahl) – Anzahl der Datenmuster in jeder Richtung, um auf einen Nicht-NaN-Wert zu prüfen. Wenn kein Nicht-NaN-Wert gefunden wird, wird NaN verwendet.
    invers Berechnet die Umkehrung jedes Zeitstempelwerts.
    IQR Führt eine Interquartil-Bereichsumwandlung durch und erstellt einen Ergebnissatz, der vier Serien enthält:
    1. -IQR: Der Medianwert aller Einträge unter Q1 – (1,5 * IQR).
    2. F1: Der Median der kleinsten Hälfte der Einträge.
    3. F3: Der Median der größten Hälfte der Einträge.
    4. +IQR: Median aller Einträge über Q3 + (1,5 * IQR).
    Hinweis:
    IQR = Q3 – Q1
    label Beschriftet eine Transformationskette.
    Hinweis:
    Nachfolgende Transformationen können die Bezeichnung ändern oder ersetzen.
    Argument: Argument (Zeichenfolge) – Text der Bezeichnung. Kann die folgenden Formatierungsausdrücke enthalten:
    • %%: „%“-Text mit Escape-Zeichen versehen.
    • %l: Aktuelle Bezeichnung, die ersetzt wird.
    • %s: Betreff der Serie.
    • %g: Wert des Felds für Gruppierung. Wenn dies ein referenzierter Datensatz ist, ist dies der Wert des Namensfelds des Datensatzes. Wenn in der Transformation groupBy mehrere Gruppen angegeben sind, werden die Bezeichnungen durch Kommas getrennt.
    • %G: Wert des Felds für Gruppierung. Wenn dies ein referenzierter Datensatz ist, die sys_id des Datensatzes. Wenn mehrere Gruppen ausgewählt sind, werden die Werte durch Kommas getrennt.
    Beispiel:
    "transforms": [
  {
    "name": "label",
    "arg": "Series Timestamp Values"
  },
]
    "transforms": [
  {
    "name": "groupBy",
    "arg": "model"
  },
  {
    "name": "avg"
  },
  {
    "name": "label",
    "arg": "Model: %g"
  }
]
    limit Gibt höchstens die angegebene Dauer oder Anzahl von Werten zurück, beginnend mit dem zuletzt gespeicherten Wert.
    Parameter:
    • Argument (Ganzzahl): Anzahl der Zeitstempelwerte, die für jede Zeitreihe zurückgegeben werden sollen.

      ODER

    • miss (Datentyp „Dauer“): Dauer, auf die jede Zeitreihe beschränkt werden soll.
    Protokoll Führt einen Logarithmus für den Wert in jedem Zeitstempel aus, wobei das Ergebnis das Protokoll der angegebenen Basis für den Zeitstempelwert ist.

    Argument: Argument (Datentyp „Decimal“): Basis für die Logarithmusberechnung.
    mapValues Ersetzt alle Werte innerhalb des angegebenen Bereichs (einschließlich) durch den angegebenen Wert. Wenn lowerBound und upperBound sowohl als NaN angegeben sind, wird ein beliebiger NaN-Wert durch targetValueersetzt.
    Parameter:
    • niedrigererGrenze (Datentyp „Dezimal“): Der niedrigste Wert im Bereich.
    • obere Grenze (Datentyp „Dezimal“): Der höchste Wert im Bereich.
    • targetValue (Datentyp „Decimal“): Ersatzwert.
    Beispiel: Durch die folgende Einstellung werden alle Werte in der Zeitreihe, die zwischen .1 und .9 liegen, in 1 geändert:
    "transforms": [
  {
    "name": "mapValues",
    "lowerBound": .1,
    "upperBound": .9,
    "targetValue": 1
  }
]
    max. Gibt eine Reihe zurück, die den Höchstwert für jeden entsprechenden Zeitstempel in der Eingabe enthält.
    Median Erstellt eine Serie, die den Median der Werte für jeden Zeitstempel in einer Reihe von Serien enthält.
    Wenn n Serien vorhanden sind:
    • Wenn n ungegradet ist, ist der Median der (n / 2 + 1) -Wert für einen Zeitstempel.
    • Wenn n gerade ist, ist der Median der Durchschnitt der Werte (n / 2) und (n / 2 + 1) für einen Zeitstempel.
    min Gibt eine Reihe zurück, die den Mindestwert für jeden entsprechenden Zeitstempel in der Eingabe enthält.
    mul Multipliziert den Wert in jedem Zeitstempel mit der angegebenen Zahl.

    Argument: Argument (Datentyp „Decimal“): Zahl, mit der der Wert jedes Zeitstempels multipliziert werden soll.
    partition

    Erstellt eine neue Serie mit Werten, die durch Anwenden eines angegebenen Aggregators auf ein nicht überlappendes Fenster gefiltert werden.

    Parameter:
    • Aggregator (Datentyp „Aggregator“): Typ der auszuführenden Zusammenfassung.
    • Fenster (Datentyp „Dauer“): Die Dauer des nicht überlappenden Fensters, auf das der Aggregator angewendet werden soll.
    • base (DateTime-Datentyp): Der für die Partitionierung zu verwendende Null-Offset. Um beispielsweise nach Tag (24 Stunden) zu partitionieren, legen Sie diesen Wert auf Montag um Mitternacht in Ihrer Zeitzone fest. Zur Partitionierung nach einem Zeitraum von 30 Tagen legen Sie diesen Wert auf den ersten Tag des letzten Monats fest.

      Standard: Beginn der EPOCH.
    pow Erhöht jeden Zeitstempelwert auf die angegebene Potenz.

    Argument: Argument (Datentyp „Decimal“): Potenz, auf die jeder Wert erhöht werden soll.
    product Fasst die ausgewählte Metrikreihe in einer einzelnen Reihe zusammen, die das Produkt aller Werte für jeden Zeitstempel enthält. NaNs sind ausgeschlossen. Wenn alle Zahlen in der Reihe NaN sind, ist die Ausgabe auch NaN.
    erneut berechnen Ändert das Resampling einer Zeitreihe entweder in eine feste Anzahl von Punkten oder von einer Häufigkeit zur nächsten.

    Verwenden Sie die Resample-Transformation, um die Anzahl der Beispiele im Ergebnissatz so zu reduzieren, dass er der Anzahl der anzuzeigenden Beispiele besser entspricht.

    Argumente: Sie können verschiedene Argumente für diese Transformation übergeben. Nachfolgend finden Sie eine Liste aller möglichen Argumentgruppen. Nur eine dieser Argumentgruppen kann innerhalb einer einzigen Transformation übergeben werden. Die folgenden Argumentgruppen werden durch UND/ODER abgegrenzt. UND bedeutet, dass das Argument Teil der aktuellen Gruppe ist; ODER bedeutet, dass es der Beginn einer neuen Argumentgruppe ist.
    • Argument (Ganzzahl): Anzahl der Beispiele, die in den Ergebnissatz aufgenommen werden sollen. Wenn die verfügbaren Beispiele kleiner als diese Anzahl sind, verwendet der Endpunkt Interpolation, um zusätzliche Beispiele zu erstellen. Wenn mehr Beispiele als diese Anzahl vorhanden sind, werden sie durch Mittelung reduziert.

      ODER

    • Argument (Datentyp „Dauer“): Die Häufigkeit, mit der ein erneutes Sampling durchgeführt werden soll. Wenn die verfügbaren Beispiele kleiner als diese Anzahl sind, verwendet der Endpunkt Interpolation, um zusätzliche Beispiele zu erstellen. Wenn mehr Beispiele als diese Anzahl vorhanden sind, werden sie durch Mittelung reduziert.

      ODER

    • minValues (Integer): Die Mindestanzahl von Mustern, die in den Ergebnissatz aufgenommen werden sollen. Wenn die verfügbaren Beispiele kleiner als diese Anzahl sind, verwendet der Endpunkt Interpolation, um zusätzliche Beispiele zu erstellen.

      UND

    • maxValues (Integer): Die maximale Anzahl von Mustern, die in den Ergebnissatz aufgenommen werden sollen. Wenn mehr Beispiele als diese Anzahl vorhanden sind, werden sie durch Mittelung reduziert.

      ODER

    • aggregator (Datentyp „Aggregator“): Der Aggregator, der beim Resampling verwendet werden soll.

      UND

    • Werte (Ganzzahl): Die Anzahl der Beispiele, die in den Ergebnissatz aufgenommen werden sollen. Wenn die verfügbaren Beispiele kleiner als diese Anzahl sind, verwendet der Endpunkt Interpolation, um zusätzliche Beispiele zu erstellen. Wenn mehr Beispiele als diese Anzahl vorhanden sind, werden sie reduziert, indem der angegebene aggregator darauf angewendet wird.

      ODER

    • aggregator (Datentyp „Aggregator“): Der Aggregator, der beim Resampling verwendet werden soll.

      UND

    • Zeitraum (Datentyp „Dauer“): Die Häufigkeit, mit der ein erneutes Sampling durchgeführt werden soll. Wenn die verfügbaren Beispiele kleiner als diese Anzahl sind, verwendet der Endpunkt Interpolation, um zusätzliche Beispiele zu erstellen. Wenn mehr Beispiele als diese Anzahl vorhanden sind, werden sie reduziert, indem der angegebene aggregator darauf angewendet wird.

      ODER

    • aggregator (Datentyp „Aggregator“): Der Aggregator, der beim Resampling verwendet werden soll.

      UND

    • minValues (Integer): Die Mindestanzahl von Mustern, die in den Ergebnissatz aufgenommen werden sollen. Wenn die verfügbaren Beispiele kleiner als diese Anzahl sind, verwendet der Endpunkt Interpolation, um zusätzliche Beispiele zu erstellen.

      UND

    • maxValues (Integer): Die maximale Anzahl von Mustern, die in den Ergebnissatz aufgenommen werden sollen. Wenn mehr Beispiele als diese Anzahl vorhanden sind, werden sie durch Mittelung reduziert.
    Runden Rundet den Wert in jedem Zeitstempel auf die angegebene Genauigkeit: (Wert /<arg> ) *

    Argument: Argument (Datentyp „Decimal“): Die Dezimalgenauigkeit, bis zu der abgerundet werden soll.
    root Berechnet den Stamm jedes Zeitstempelwerts anhand des angegebenen Index.

    Argument: Argument (Datentyp „Decimal“) – Der Index des Stamms.

    Beispiel:
    "transforms": [
  {
    "name": "root",
    "arg": "2"
  },
]
    Stddev Erstellt eine Reihe, die die Standardabweichung der Werte für jeden Zeitstempel in einer Reihe von Reihen enthält.
    sub Subtrahiert die angegebene Zahl vom Wert in jedem Zeitstempel.

    Argument: Argument (Zahl) – Die Zahl, die vom Wert in jedem Zeitstempel subtrahiert werden soll.
    sum Fasst die ausgewählte Metrikreihe in einer Reihe zusammen, die die Summe aller Werte für jeden Zeitstempel ohne NaN-Werte enthält. Wenn alle Zahlen in der Reihe NaN sind, ist die Ausgabe NaN.
    Zeitverschiebung Verschiebt den Zeitbereich, indem der angegebene Offset zum Zeitstempel eines Werts addiert wird, ohne den Wert zu ändern. Verwenden Sie diese Transformation, um Zeitstempel in eine andere Zeitzone zu verschieben.

    Argument: Argument (Datentyp „Dauer“): Die Zeitmenge, um die verschoben wird.
    top Gibt die angegebene Anzahl von Reihen mit den höchsten Werten zurück.

    Argument: Argument (Ganzzahl) – Die Anzahl der zurückzugebenden Serien.

    Im Folgenden werden beispielsweise die beiden Zeitreihen zurückgegeben, die die höchsten Wertesätze enthalten.
    "transforms": [
  {
     "name": "top",
     "arg": 2
  }
]
    Datentyp Beschreibung
    Aggregator Verfügbare Aggregatoren, die innerhalb der Transformation verwendet werden sollen.
    • Durchschnitt: Berechnet den arithmetischen Mittelwert aller aktuell ausgewählten Serien.
    • CHISQUARE: Zeigt an, wie gut ein statistisches Modell zum Metrikdatensatz passt.
    • LAST: Gibt den letzten definierten Wert im Zeitraumfenster zurück.
    • MAX: Zeigt den größten Wert für den Metrikdatensatz zu jedem Zeitpunkt an.
    • Median: Zeigt den Median des Metrikdatensatzes an. Der Median trennt die höheren Werte des Metrik-Datensatzes von den niedrigeren Werten.
    • MIN: Zeigt den kleinsten Wert für den Metrikdatensatz zu jedem Zeitpunkt an.
    • STDDEV: Berechnet die Standardabweichung für die zugrunde liegenden Daten. Wird verwendet, um die Variation oder Streuung einer Menge von Datenwerten im Metrik-Datensatz zu quantifizieren.
    • SUMME: Berechnet die Summe aller aktuell ausgewählten Serien.
    DateTime Absolute Datums-/Uhrzeitwerte werden durch das ISO 8601-Datums- und Uhrzeitformat angegeben: JJJJ-MM-DDThh:mm:ss. Beispiel: 2020-02-28T13:10:42.

    Wobei:

    • [JJJJ]: Vierstellige Jahreszahl.
    • [MM]: Mit Nullen aufgefüllter Monat zwischen 01 und 12.
    • [DD]: Mit Nullen aufgefüllter Tag zwischen 01 und 31.
    • T: Stellt die Zeit dar und ist obligatorisch, bevor eine der Zeitkomponenten angegeben wird.
    • [hh]: Mit Nullen aufgefüllte Stunde zwischen 00 und 23.
    • [mm]: Mit Nullen aufgefüllte Minuten zwischen 00 und 59.
    • [ss]: Mit Nullen aufgefüllte Sekunden zwischen 00 und 59. Beachten Sie, dass die Schaltsekunden gleichmäßig über die letzten 1.000 Sekunden verteilt werden.

    Relative Datums-/Uhrzeitwerte werden mithilfe einer Dauer (Datentyp „Dauer“) angegeben, die von der aktuellen Uhrzeit subtrahiert wird.

    Beispiel: P7D = vor sieben Tagen.
    Dezimalzahl Dezimalwert, der entweder sein kann:
    • Eine vorzeichenbehaftete Dezimalzahl mit beliebiger Genauigkeit, die exponentielle Notation verwenden kann.

      Wie zum Beispiel:

      • 2
      • 1,7
      • -3.47
      • 1,0E+2
    • Eine Zeichenfolgendarstellung von:
      • Eine Dezimalzahl mit Vorzeichen, die Exponentialschreibweise verwenden kann und garantiert eine 64-Bit-IEEE 754-Gleitkommazahl mit doppelter Genauigkeit ist.
      • „NaN“
      • „-Unendlich“
      • „+Unendlich“
    Dauer Zeit in einem Zeitintervall. Die Werte für die Dauer werden im ISO 8601-Dauerformat angegeben: P[n]Y[n]M[n]DT[n]H[n]M[n]S
    Wobei:
    • P: Dauerbezeichner, wird als „Zeitraum“ bezeichnet und wird immer am Anfang der Dauer platziert.
    • [n]Y: Anzahl der Jahre.
    • [n]M: Anzahl der Monate.
    • [n]D: Anzahl der Tage.
    • T: Zeitbezeichner und ist obligatorisch, bevor eine der Zeitkomponenten angegeben wird.
    • [n]H: Anzahl der Stunden.
    • [n]M: Anzahl der Minuten.
    • [n]S: Anzahl der Sekunden.
    Beispiel:
    • P7D: Zeitraum von sieben Tagen.
    • P1M: Zeitraum von einem Monat.
    • PT15M: Zeitraum von 15 Minuten.
    • P1DT12H: Zeitraum von einem Tag und zwölf Stunden.

    cURL-Anforderung

    curl "https://instance.servicenow.com/api/now/v1/clotho/transform \
--request POST \
--header "Accept:application/json", "Content-Type:application/json" \
--user "username":"password"
-d {\
  "start": "PT15M",\
  "end": "",\
  "table": "mb_demo_drone",\
  "query": "fleet.nameSTARTSWITHB",\
  "limit": 5000,\
  "metrics": [\
    {\
      "metric": "mb_demo_mt_altitude",\
      "label": "Series - Avg",\
      "transforms": [\
        {\
          "name": "partition",\
          "arg": {\
            "aggregator": "AVG",\
            "window": "PT5M"\
          }\
        },
        {\
          "name": "avg"\
        }\
      ]\
    },
    {\
      "metric": "mb_demo_mt_altitude",\
      "groupBy": "fleet",\
      "label": "Fleet - AVG",\
      "transforms": [\
        {\
          "name": "partition",\
          "arg": {\
            "aggregator": "AVG",\
            "window": "PT5M"\
          }\
        },
        {\
          "name": "avg"\
        }\
      ]\
    }\
  ]\
} \

    Ausgabe:

    "results:" [
  {
    "marker": "674d86ba-a810-4065-942b-0b7ca2f95db2",
    "series": [
      {
        "label": "Series - Avg",
        "values": [
          {
            "timestamp": "2020-05-01T21:05:00Z",
            "value": 157.43086
          },
          {
            "timestamp": "2020-05-01T21:10:00Z",
            "value": 162.92278
          }
        ]
      }
    ]
  },
  {
    "marker": "846aa334-232a-4015-b033-d18ebc4b1d23",
    "grouped": [
      {
        "groupingBy": "fleet",
        "groups": [
          {
            "group": "86fac11787333200a328c5b836cb0b4e",
            "label": "Bantams",
            "series": {
              "label": "Fleet - AVG",
              "values": [
                {
                  "timestamp": "2020-05-01T21:05:00Z",
                  "value": 159.70201
                },
                {
                  "timestamp": "2020-05-01T21:10:00Z",
                  "value": 165.1136
                }
              ]
            }
          },
          {
            "group": "4afac11787333200a328c5b836cb0b4e",
            "label": "Bumble Untd",
            "series": {
              "label": "Fleet - AVG",
              "values": [
                {
                  "timestamp": "2020-05-01T21:05:00Z",
                  "value": 154.5403
                },
                {
                  "timestamp": "2020-05-01T21:10:00Z",
                  "value": 160.13445
                }
              ]
            }
          }
        ]
      }
    ]
  }
]

    MetricBase-Zeitreihe – POST /now/clotho/transform/stream

    Gibt einen Stream transformierter Zeitreihendaten für eine oder mehrere Metriken zurück, nachdem die angegebene Liste der Transformationen angewendet wurde.

    Durch das Streaming von Daten auf diese Weise können Sie die Daten verarbeiten, während einzelne Transformationen abgeschlossen und zurückgegeben werden, anstatt darauf zu warten, dass alle Transformationsergebnisse abgeschlossen und heruntergeladen werden. Wenn große Datenmengen vom Client verarbeitet werden müssen, reduziert diese Art der Verarbeitung die End-to-End-Verarbeitungszeit und potenziell die Auslastung des Arbeitsspeichers auf dem Client.

    Durch Festlegen des entsprechenden Headerwerts „Akzeptieren“ in Ihrer Anforderung können Sie:
    • Geben Sie die gestreamten Daten an, die in einem Binärformat codiert werden sollen.
    • Serialisieren Sie gestreamte Daten in ein JSON-Array oder
    • Streamen Sie Daten in einem breiten oder schmalen CSV-Format zurück an den Client.
    Der Endpunkt strömt die Daten, wenn die Transformationen auf dem Server MetricBase ohne Gruppierungen oder eine vorgegebene Reihenfolge abgeschlossen werden. Im Binärformat gestreamte Daten sind kleiner als die vom Endpunkt MetricBase-Zeitreihe – POST /now/clotho/transform zurückgegebene JSON-Darstellung.

    URL-Format

    URL mit Versionsnummer: /api/now/{api_version}/clotho/transform/stream

    Unterstützte Anforderungsparameter

    Tabelle : 26. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 27. Abfrageparameter
    Name Beschreibung
    sysparm_display_value Kennzeichnung, die angibt, ob die Ergebnisdaten mit dem Anzeigewert des Betreffdatensatzes gekennzeichnet werden sollen, wenn keine andere Bezeichnung angegeben ist.
    Gültige Werte:
    • „wahr“: Die Ergebnisdaten werden mit dem Anzeigewert des Betreffdatensatzes beschriftet.
    • „falsch“: Ergebnisdaten werden nicht mit dem Anzeigewert des Betreffdatensatzes beschriftet.

    Datentyp: Boolesch

    Standardwert: false
    Tabelle : 28. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    end Erforderlich. Endzeit des Bewertungszeitraums. Ein leerer oder fehlender Wert wird als aktuelle Uhrzeit behandelt. Zeitwerte enthalten diese Endzeit.

    Datentyp: Zeichenfolge

    Format: ISO 8601 (UTC), entweder:
    • Absolutes Datumsformat [JJJJ-MM-DDThh:mm:ss], z. B. 2019-03-20T17:04:55.
    • Relativ zum aktuellen Zeitdauerformat [P(n)Y(n)M(n)DT(n)H(n)M(n)S], z. B. P1M.
    limit Maximale Anzahl der zurückzugebenden Datensätze. Ungewöhnlich große Werte können sich auf die Systemleistung auswirken.

    Datentyp: Zahl

    Standard: 10.000
    Metriken Liste der Metrikobjekte, die bei der Transformation verwendet werden sollen. Weitere Informationen zu Metriken finden Sie unter Metriken.

    Datentyp: Array

    "metrics": [
  {
    "label": "String",
    "metric": "String",
    "transforms": [Array]
  }
]
    metrics.label Für den Ergebnissatz dieser Metrik zu verwendende Bezeichnung. Es ersetzt alle von der Transformationskette generierten Bezeichnungen.

    Datentyp: Zeichenfolge

    Standard: Generierte Standardbezeichnung.
    metrics.metric Erforderlich, wenn Objekt metrics übergeben wird. Bei der Transformation zu verwendendes Metrikfeld. Dieses Feld muss sich in der im Parameter table angegebenen Tabelle befinden.

    Datentyp: Zeichenfolge
    metrics.transforms Liste der Transformationen (Transformationskette), die auf die abgerufenen Zeitreihendaten angewendet werden sollen. Jede Transformation baut auf den Ergebnissen der vorherigen Transformation auf. Eine Liste der verfügbaren Transformationen finden Sie unten unter Unterstützte Transformationen.

    Datentyp: Array

    "transforms": [
  {
    "arg": {Object},
    "name": "String"
  }
]
    metrics.transforms.arg Abhängig von der Transformation. Parameter, die an die Transformation übergeben werden sollen.
    Allgemeine Richtlinien:
    • Verwenden Sie den Parameter arg nicht, wenn Sie Transformationen angeben, die keinen Parameter akzeptieren.
    • Verwenden Sie Zahl, Zeichenfolge oder einen booleschen Wert für Transformationen, die einen einzelnen Parameter akzeptieren.
    • Verwenden Sie ein JSON-Objekt mit den entsprechenden Name/Wert-Paaren für Transformationen, die mehr als einen Parameter akzeptieren.

    Datentyp: Zahl, Zeichenfolge, boolescher Wert oder JSON-Objekt, je nach Transformation. (Eine Liste der verfügbaren Transformationen finden Sie in der Tabelle „ Unterstützte Transformationen “.)
    metrics.transforms.name Erforderlich, wenn ein transforms -Objekt angegeben ist. Name der Transformation

    Eine Liste der verfügbaren Transformationen finden Sie in der Tabelle „Unterstützte Transformationen“ weiter unten.

    Datentyp: Zeichenfolge
    query Codierte Abfrage zum Filtern des Ergebnissatzes.

    Sie können die Abfrage mit dem Filtereditor der angegebenen Tabelle verfassen. Wählen Sie nach der Erstellung im Breadcrumbs-Kontextmenü des Filters die Option URL kopieren aus.

    Datentyp: Zeichenfolge

    Standard: Keine
    start Erforderlich. Startzeit des Bewertungszeitraums. Der spezielle Wert all kann verwendet werden, um die Startzeit als die aktuelle Zeit minus den maximalen Aufbewahrungszeitraum für die angegebenen Metriken festzulegen. Ein leerer oder fehlender Wert wird als impliziter allbehandelt. Zeitwerte enthalten diese Startzeit.

    Datentyp: Zeichenfolge

    Format: ISO 8601 (UTC), entweder:
    • Absolutes Datumsformat [JJJJ-MM-DDThh:mm:ss], z. B. 2019-03-20T17:04:55
    • Relativ zum aktuellen Zeitdauerformat [P(n)Y(n)M(n)DT(n)H(n)M(n)S], z. B. P1M.
    Tabelle Erforderlich. Name der Tabelle, die den GlideRecord enthält, der dieser Serie zugeordnet ist.

    Datentyp: Zeichenfolge

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.

    Tabelle : 29. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt:
    • application/json
    • application/octet-stream oder
    • text/csv
    Um das CSV-Format anzugeben, verwenden Sie text/csv;format=nrow oder text/csv;format=breit.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 30. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine Datenformat des Antworttexts. Basierend auf den angegebenen Werten für das Akzeptieren der Anforderung verwenden Sie:
    • application/json
    • application/octet-stream oder
    • text/csv

    Wenn mehrere akzeptierte Typen angegeben sind, wird der erste unterstützte Typ zurückgegeben.

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

    Tabelle : 31. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet und das Streaming von Daten beginnt.
    Hinweis:
    Eine 200-Antwort kann immer noch zu einem Verarbeitungsfehler führen, während die Transformationen berechnet werden.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    405 Ungültige Methode. Die Funktion ist deaktiviert.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (Octet-Stream oder JSON)

    Name Beschreibung
    Ausgabestream (Oktett-Stream) Wenn der Header „Anforderung akzeptieren“ auf application/octet-streamfestgelegt ist, werden die übereinstimmenden MetricBase-Daten als binär serialisierter Stream zurückgegeben. Clotho-Util for Java-Anwendungen bieten einen Deserialisator, mit dem Sie diese Daten analysieren können.

    Der Stream besteht aus einer binären Serialisierung jedes Datums, dem eine Ganzzahl vorangestellt wird, die seine Länge darstellt. Die folgenden Einträge beschreiben die Daten innerhalb der Binärdarstellung und die Reihenfolge dieser Daten.
    CSV-Stream (UTF-8-Stream) Wenn der Header „Anforderung akzeptieren“ auf text/csvfestgelegt ist, werden die übereinstimmenden MetricBase-Daten als UTF-8-codierte CSV-Daten im breiten oder schmalen Format zurückgegeben.

    Ein schmales Format gibt Betreff- und Zeitstempelspalten sowie eine Spalte für jede zurückgegebene Metrik zurück. Ein breites Format gibt eine Zeitstempelspalte mit einer separaten Spalte für jedes Metrik-Betreff-Paar zurück.
    Betreff Quelle der Daten. Wenn die Metrik für die Daten beispielsweise Drohnenhöhen sind, kann dieser Wert die ID einer bestimmten Drohne sein. Wenn der Wert einen Doppelpunkt enthält, geben die Teile nach dem Betreff die Metrik an, zu der die Daten gehören. Null-Werte werden durch eine codierte leere Zeichenfolge dargestellt.

    Größe: 2+ Byte

    Datentyp: Geänderte Java-UTF-Zeichenfolge
    Maß Metrik, aus der die Daten stammen. Null-Werte werden durch eine codierte leere Zeichenfolge dargestellt.

    Größe: 2+ Byte

    Datentyp: Geänderte Java-UTF-Zeichenfolge
    Bezeichnung Bezeichnung der Daten. Null-Werte werden durch eine codierte leere Zeichenfolge dargestellt.

    Größe: 2+ Byte

    Datentyp: Geänderte Java-UTF-Zeichenfolge
    Typ Typ der Daten, die in einem Byte codiert sind.

    Mögliche Werte:

    • Float-Signal
    • Doppelsignal
    • Float-Modus
    • Doppelmodell

    Größe: 1 Byte

    Datentyp: Byte
    Flags Codierte Variable serializeFlags. Wenn serializeTags auf „wahr“ festgelegt ist und die Daten Tags enthalten, ist der Wert 2, andernfalls ist er 0.

    Größe: 1 Byte

    Datentyp: Byte
    Zeitraum Zeitraum, der den Daten zugeordnet ist.

    Größe: 4 Byte

    Datentyp: Ganzzahl
    Anzahl der Tags Wenn serializeTags auf „wahr“ festgelegt ist, ist dies die Anzahl der in den Daten gespeicherten Tags.

    Größe: 4 Byte

    Datentyp: Ganzzahl
    Tags Wenn serializeTags auf „wahr“ festgelegt ist, wird jedes Tag in den Daten gespeichert.

    Größe: Hängt von der Anzahl der Tags ab (mehr als Byte).

    Datentyp: Von Java modifizierte UTF-Zeichenfolgen
    Startepochensekunde Epochen-UTC-Zeit, die die Startzeit dieser Datenreihe darstellt.

    Größe: 8 Byte

    Datentyp: lang
    Anzahl der Werte Anzahl der in diesen Daten gespeicherten Werte.

    Größe: 4 Byte

    Datentyp: Ganzzahl
    Werte Wenn Type ein Float-Signalist, besteht der Rest aus Float-Werten.

    Größe: Number of Values * 4

    Datentyp: Gleitkommazahlen
    Werte Wenn TypeDoppeltes Signalist, besteht der Rest aus doppelten Werten.

    Größe: Number of Values * 4 Byte

    Datentyp: Doppelte
    Modell-JSON (Modell) Wenn Type ein Float-Modell oder ein Doppelmodellist, ist der Rest eine in Java geänderte UTF-Zeichenfolge, die das Modell als JSON darstellt.

    Größe: 2+ Byte

    Datentyp: JSON (Java Modified UTF String)
    Marker für großes Modell (großes Modell) Wenn die Länge der JSON des Modells größer als 65.535 Byte ist, wird dieses Feld anstelle von Model Jsongeschrieben.

    Größe: 5

    Datentyp: Geänderte Java-UTF-Zeichenfolge
    Größe des großen Modells (großes Modell) Länge der JSON-Darstellung des großen Modells.

    Größe: 4 Byte

    Datentyp: Ganzzahl
    Big Model JSON (Big Model) JSON-Darstellung des Modells als Reihe von UTF-Zeichen. Die Größe wird durch das Feld Big Model Size bestimmt.

    Größe: 65535–256000 Byte

    Datentyp: UTF-Zeichen
    JSON-Stream (JSON) Wenn der Header „Anforderung akzeptieren“ auf application/jsonfestgelegt ist, werden die übereinstimmenden MetricBase-Daten als Stream von durch neue Zeilen getrennten JSON-Objekten zurückgegeben. Die folgenden Einträge beschreiben die möglichen Elemente in jedem zurückgegebenen Objekt.
    label Bezeichnung der Daten. Dieser Wert wird entweder vom Endpunkt generiert oder ist der Wert, der im Parameter metrics.label übergeben wird.

    Datentyp: Zeichenfolge
    Zeitraum Zeitspanne zwischen den einzelnen Werten. Ein Zeitraum von 60 bedeutet beispielsweise, dass jeder Wert eine Minute voneinander entfernt ist.

    Einheit: Sekunden

    Datentyp: Zahl
    range Start- und Endzeiten der Daten im ISO 8601-Format (UTC).

    Datentyp: Array
    Serie Identifiziert die einzelnen Daten. Wenn vorhanden, hat das normalerweise das Format [Glide-Datensatz-ID]:[Metrik]. Ist möglicherweise nicht vorhanden, wenn Transformationen verwendet werden.

    Datentyp: Zeichenfolge
    Arten Typ der Rückgabedaten. Für eine Reihe von Gleitkommazahlen oder doppelten Werten ist dies entweder FLOAT_SIGNAL oder DOUBLE_SIGNAL. Für ein Modell, das Float- oder double-Daten analysieren soll, ist dies entweder FLOAT_MODEL oder DOUBLE_MODEL.

    Datentyp: Zeichenfolge
    tags Tags, die den Daten zugeordnet sind.

    Datentyp: Zeichenfolgen-Array
    Wert Float- oder double-Werte für die Daten.

    Datentyp: Zahlen-Array
    Fehler Fehlermeldung, wenn die Transformation der angegebenen Datenreihe fehlschlägt.

    Datentyp: Zeichenfolge

    Unterstützte Transformationen

    Tabelle : 32. Datentypen transformieren
    Umwandeln Beschreibung
    Hinzufügen Addiert die angegebene Anzahl zu jedem Zeitstempelwert.

    Argument: Argument (Datentyp „Decimal“): Zahl, die hinzugefügt werden soll.

    Beispiel:
    "transforms": [
  {
    "name": "add",
    "arg": 8
  }
]
    Autokorrelation Berechnet die Korrelation zwischen Zeitstempelwerten, die durch eine zunehmende Anzahl von Punkten getrennt sind, beginnend bei 1.
    avg Fasst die Zeitreihe in einer Reihe zusammen, die den Durchschnittswert für jeden entsprechenden Zeitstempel in der Eingabe enthält.
    bottom Gibt die angegebene Anzahl der Serien mit den niedrigsten Werten zurück.

    Argument: Argument (Ganzzahl) – Die Anzahl der zurückzugebenden Serien.

    Im Folgenden werden beispielsweise die beiden Zeitreihen zurückgegeben, die die niedrigsten Werte enthalten.
    "transforms": [
  {
     "name": "bottom",
     "arg": 2
  }
]
    decken Rundet den Wert in jedem Zeitstempel auf die angegebene Genauigkeit: ceil(value /<arg> ) * )

    Argument: Argument (Datentyp „Decimal“): Dezimalgenauigkeit, auf die aufgerundet wird.
    sammeln Zeigt die Transformationsergebnisse der Transformationskette bis zum Punkt des Erfassungstransformationsaufrufs an. Sammeltransformationsergebnisse enthalten eine eindeutige Markierung, Sie können jedoch auch eine Bezeichnung definieren.
    Beispiel:
    {
  "start": "PT1H",
  "end": "",
  "table": "mb_demo_drone",
  "limit": 5000,
  "metrics": [
    {
      "metric": "mb_demo_mt_altitude",
      "transforms": [
        {
          "name": "label",
          "arg": "Series Timestamp Values"
        },
        {
          "name": "collect"
        },
        {
          "name": "avg"
        },
        {
          "name": "label",
          "arg": "Average Timestamp Values"
        }
      ]
    }
  ]
}
    eingeschränkteWerte Ersetzt jeden Wert außerhalb des angegebenen Bereichs durch den entsprechenden Höchst- oder Mindestwert.
    Wenn Sie beispielsweise Folgendes angegeben haben, ersetzt die Transformation jeden Wert, der kleiner als 0 ist, durch 0 und jeden Wert, der größer als 100 ist, durch 100.
    "transforms": [
  {
    "name": "constrainValues",
    "val1": 0,
    "val2": 100
  }
]
    Parameter:
    • val1 (Datentyp „Decimal“): Mindest- oder Höchstwert.
    • val2 (Datentyp „Decimal“): Mindest- oder Höchstwert.
    count Fasst die Zeitreihen in einer Reihe zusammen. Die neue Serie enthält für jeden entsprechenden Zeitstempel in der Serie die Anzahl der Werte, die nicht NaN (Not a Number) sind.
    Ableitung Bestimmt die Rate der Änderung zwischen Zeitstempeln. Teilt die Differenz zwischen dem Wert in jedem Zeitstempel und dem Wert im nächsten Zeitstempel durch den Zeitraum des Zeitstempels.
    Hinweis:
    Diese Transformation gibt einen Wert weniger zurück als die Anzahl der Werte in der Reihe.
    div Teilt den Wert in jedem Zeitstempel durch die angegebene Zahl (Argument).

    Argument: Argument (Dezimalzahl: Die Zahl, durch die der Wert jedes Zeitstempels dividiert werden soll.
    Umschlag Gibt zwei Zeitreihen zurück, von denen zu jedem Zeitpunkt eine den größten Wert und die andere den kleinsten Wert enthält.
    Hinweis:
    NaNs werden ignoriert, aber zurückgegeben, wenn keine anderen Rückgabewerte vorhanden sind.
    abgel Potenziert den Wert der angegebenen Basis mit dem Wert in jedem Zeitstempel.

    Argument: Argument (Datentyp „Decimal“): Der Basiswert.
    filter Wendet einen Aggregator auf den Inhalt eines gleitenden Fensters an, um z. B. einen gleitenden Durchschnitt zu erzeugen.
    Parameter:
    • Aggregator (Datentyp „Aggregator“): Typ der auszuführenden Zusammenfassung.
    • Fenster (Datentyp „Dauer“): Die Dauer des gleitenden Fensters.
    Stockwerk Rundet den Wert in jedem Zeitstempel auf die angegebene Genauigkeit ab: tage (Wert /<arg> ) *

    Argument: Argument (Datentyp „Decimal“): Die Dezimalgenauigkeit, auf die abgerundet werden soll.
    Fraktile Gibt eine Zeitreihe für jeden Bruch im angegebenen Array zurück. Jeder Zeitstempelwert ist der Wert, um den der angegebene Bruchteil der Werte für den entsprechenden Zeitstempel in der Eingabereihe unter dem angegebenen Prozentsatz liegt. Beispiel: Wenn der Bruch 0,5 beträgt, ist der Wert im Zeitstempel der Wert, bei dem die Hälfte der Werte in der Eingabereihe unter 0,5 liegt.

    Argument: Argument (Dezimalzahl-Array) – Die in der Eingabeserie zu verwendenden Teile.

    Beispiel:
    "transforms": [
  {
    "name": "fractiles",
    "arg": [0.25, 0.5, 0.75, 1]
  }
]
    groupBy Gruppiert Daten nach den angegebenen Feldern, bevor aggregierte Transformationen gesammelt oder angewendet werden.

    Argument: Argument (Zeichenfolge) – Eine kommagetrennte Liste von Feldern in der Tabelle, die zum Gruppieren der Transformationsergebnisse verwendet werden sollen.

    Beispiel:
     "transforms": [
  {
    "name": "groupBy",
    "arg": "model"
  },
  {
    "name": "avg"
  },
  {
    "name": "label",
    "arg": "Model: %g"
  }
]
    integrieren Multipliziert den Wert in jedem Zeitstempel mit dem Zeitraum.
    interpolieren Erstellt einen Datenwert für ein NaN-Datenelement durch Interpolation aus angrenzenden Datenwerten.

    Argument: Argument (Ganzzahl) – Anzahl der Datenmuster in jeder Richtung, um auf einen Nicht-NaN-Wert zu prüfen. Wenn kein Nicht-NaN-Wert gefunden wird, wird NaN verwendet.
    invers Berechnet die Umkehrung jedes Zeitstempelwerts.
    IQR Führt eine Interquartil-Bereichsumwandlung durch und erstellt einen Ergebnissatz, der vier Serien enthält:
    1. -IQR: Der Medianwert aller Einträge unter Q1 – (1,5 * IQR).
    2. F1: Der Median der kleinsten Hälfte der Einträge.
    3. F3: Der Median der größten Hälfte der Einträge.
    4. +IQR: Median aller Einträge über Q3 + (1,5 * IQR).
    Hinweis:
    IQR = Q3 – Q1
    label Beschriftet eine Transformationskette.
    Hinweis:
    Nachfolgende Transformationen können die Bezeichnung ändern oder ersetzen.
    Argument: Argument (Zeichenfolge) – Text der Bezeichnung. Kann die folgenden Formatierungsausdrücke enthalten:
    • %%: „%“-Text mit Escape-Zeichen versehen.
    • %l: Aktuelle Bezeichnung, die ersetzt wird.
    • %s: Betreff der Serie.
    • %g: Wert des Felds für Gruppierung. Wenn dies ein referenzierter Datensatz ist, ist dies der Wert des Namensfelds des Datensatzes. Wenn in der Transformation groupBy mehrere Gruppen angegeben sind, werden die Bezeichnungen durch Kommas getrennt.
    • %G: Wert des Felds für Gruppierung. Wenn dies ein referenzierter Datensatz ist, die sys_id des Datensatzes. Wenn mehrere Gruppen ausgewählt sind, werden die Werte durch Kommas getrennt.
    Beispiel:
    "transforms": [
  {
    "name": "label",
    "arg": "Series Timestamp Values"
  },
]
    "transforms": [
  {
    "name": "groupBy",
    "arg": "model"
  },
  {
    "name": "avg"
  },
  {
    "name": "label",
    "arg": "Model: %g"
  }
]
    limit Gibt höchstens die angegebene Dauer oder Anzahl von Werten zurück, beginnend mit dem zuletzt gespeicherten Wert.
    Parameter:
    • Argument (Ganzzahl): Anzahl der Zeitstempelwerte, die für jede Zeitreihe zurückgegeben werden sollen.

      ODER

    • miss (Datentyp „Dauer“): Dauer, auf die jede Zeitreihe beschränkt werden soll.
    Protokoll Führt einen Logarithmus für den Wert in jedem Zeitstempel aus, wobei das Ergebnis das Protokoll der angegebenen Basis für den Zeitstempelwert ist.

    Argument: Argument (Datentyp „Decimal“): Basis für die Logarithmusberechnung.
    mapValues Ersetzt alle Werte innerhalb des angegebenen Bereichs (einschließlich) durch den angegebenen Wert. Wenn lowerBound und upperBound sowohl als NaN angegeben sind, wird ein beliebiger NaN-Wert durch targetValueersetzt.
    Parameter:
    • niedrigererGrenze (Datentyp „Dezimal“): Der niedrigste Wert im Bereich.
    • obere Grenze (Datentyp „Dezimal“): Der höchste Wert im Bereich.
    • targetValue (Datentyp „Decimal“): Ersatzwert.
    Beispiel: Durch die folgende Einstellung werden alle Werte in der Zeitreihe, die zwischen .1 und .9 liegen, in 1 geändert:
    "transforms": [
  {
    "name": "mapValues",
    "lowerBound": .1,
    "upperBound": .9,
    "targetValue": 1
  }
]
    max. Gibt eine Reihe zurück, die den Höchstwert für jeden entsprechenden Zeitstempel in der Eingabe enthält.
    Median Erstellt eine Serie, die den Median der Werte für jeden Zeitstempel in einer Reihe von Serien enthält.
    Wenn n Serien vorhanden sind:
    • Wenn n ungegradet ist, ist der Median der (n / 2 + 1) -Wert für einen Zeitstempel.
    • Wenn n gerade ist, ist der Median der Durchschnitt der Werte (n / 2) und (n / 2 + 1) für einen Zeitstempel.
    min Gibt eine Reihe zurück, die den Mindestwert für jeden entsprechenden Zeitstempel in der Eingabe enthält.
    mul Multipliziert den Wert in jedem Zeitstempel mit der angegebenen Zahl.

    Argument: Argument (Datentyp „Decimal“): Zahl, mit der der Wert jedes Zeitstempels multipliziert werden soll.
    partition

    Erstellt eine neue Serie mit Werten, die durch Anwenden eines angegebenen Aggregators auf ein nicht überlappendes Fenster gefiltert werden.

    Parameter:
    • Aggregator (Datentyp „Aggregator“): Typ der auszuführenden Zusammenfassung.
    • Fenster (Datentyp „Dauer“): Die Dauer des nicht überlappenden Fensters, auf das der Aggregator angewendet werden soll.
    • base (DateTime-Datentyp): Der für die Partitionierung zu verwendende Null-Offset. Um beispielsweise nach Tag (24 Stunden) zu partitionieren, legen Sie diesen Wert auf Montag um Mitternacht in Ihrer Zeitzone fest. Zur Partitionierung nach einem Zeitraum von 30 Tagen legen Sie diesen Wert auf den ersten Tag des letzten Monats fest.

      Standard: Beginn der EPOCH.
    pow Erhöht jeden Zeitstempelwert auf die angegebene Potenz.

    Argument: Argument (Datentyp „Decimal“): Potenz, auf die jeder Wert erhöht werden soll.
    product Fasst die ausgewählte Metrikreihe in einer einzelnen Reihe zusammen, die das Produkt aller Werte für jeden Zeitstempel enthält. NaNs sind ausgeschlossen. Wenn alle Zahlen in der Reihe NaN sind, ist die Ausgabe auch NaN.
    erneut berechnen Ändert das Resampling einer Zeitreihe entweder in eine feste Anzahl von Punkten oder von einer Häufigkeit zur nächsten.

    Verwenden Sie die Resample-Transformation, um die Anzahl der Beispiele im Ergebnissatz so zu reduzieren, dass er der Anzahl der anzuzeigenden Beispiele besser entspricht.

    Argumente: Sie können verschiedene Argumente für diese Transformation übergeben. Nachfolgend finden Sie eine Liste aller möglichen Argumentgruppen. Nur eine dieser Argumentgruppen kann innerhalb einer einzigen Transformation übergeben werden. Die folgenden Argumentgruppen werden durch UND/ODER abgegrenzt. UND bedeutet, dass das Argument Teil der aktuellen Gruppe ist; ODER bedeutet, dass es der Beginn einer neuen Argumentgruppe ist.
    • Argument (Ganzzahl): Anzahl der Beispiele, die in den Ergebnissatz aufgenommen werden sollen. Wenn die verfügbaren Beispiele kleiner als diese Anzahl sind, verwendet der Endpunkt Interpolation, um zusätzliche Beispiele zu erstellen. Wenn mehr Beispiele als diese Anzahl vorhanden sind, werden sie durch Mittelung reduziert.

      ODER

    • Argument (Datentyp „Dauer“): Die Häufigkeit, mit der ein erneutes Sampling durchgeführt werden soll. Wenn die verfügbaren Beispiele kleiner als diese Anzahl sind, verwendet der Endpunkt Interpolation, um zusätzliche Beispiele zu erstellen. Wenn mehr Beispiele als diese Anzahl vorhanden sind, werden sie durch Mittelung reduziert.

      ODER

    • minValues (Integer): Die Mindestanzahl von Mustern, die in den Ergebnissatz aufgenommen werden sollen. Wenn die verfügbaren Beispiele kleiner als diese Anzahl sind, verwendet der Endpunkt Interpolation, um zusätzliche Beispiele zu erstellen.

      UND

    • maxValues (Integer): Die maximale Anzahl von Mustern, die in den Ergebnissatz aufgenommen werden sollen. Wenn mehr Beispiele als diese Anzahl vorhanden sind, werden sie durch Mittelung reduziert.

      ODER

    • aggregator (Datentyp „Aggregator“): Der Aggregator, der beim Resampling verwendet werden soll.

      UND

    • Werte (Ganzzahl): Die Anzahl der Beispiele, die in den Ergebnissatz aufgenommen werden sollen. Wenn die verfügbaren Beispiele kleiner als diese Anzahl sind, verwendet der Endpunkt Interpolation, um zusätzliche Beispiele zu erstellen. Wenn mehr Beispiele als diese Anzahl vorhanden sind, werden sie reduziert, indem der angegebene aggregator darauf angewendet wird.

      ODER

    • aggregator (Datentyp „Aggregator“): Der Aggregator, der beim Resampling verwendet werden soll.

      UND

    • Zeitraum (Datentyp „Dauer“): Die Häufigkeit, mit der ein erneutes Sampling durchgeführt werden soll. Wenn die verfügbaren Beispiele kleiner als diese Anzahl sind, verwendet der Endpunkt Interpolation, um zusätzliche Beispiele zu erstellen. Wenn mehr Beispiele als diese Anzahl vorhanden sind, werden sie reduziert, indem der angegebene aggregator darauf angewendet wird.

      ODER

    • aggregator (Datentyp „Aggregator“): Der Aggregator, der beim Resampling verwendet werden soll.

      UND

    • minValues (Integer): Die Mindestanzahl von Mustern, die in den Ergebnissatz aufgenommen werden sollen. Wenn die verfügbaren Beispiele kleiner als diese Anzahl sind, verwendet der Endpunkt Interpolation, um zusätzliche Beispiele zu erstellen.

      UND

    • maxValues (Integer): Die maximale Anzahl von Mustern, die in den Ergebnissatz aufgenommen werden sollen. Wenn mehr Beispiele als diese Anzahl vorhanden sind, werden sie durch Mittelung reduziert.
    Runden Rundet den Wert in jedem Zeitstempel auf die angegebene Genauigkeit: (Wert /<arg> ) *

    Argument: Argument (Datentyp „Decimal“): Die Dezimalgenauigkeit, bis zu der abgerundet werden soll.
    root Berechnet den Stamm jedes Zeitstempelwerts anhand des angegebenen Index.

    Argument: Argument (Datentyp „Decimal“) – Der Index des Stamms.

    Beispiel:
    "transforms": [
  {
    "name": "root",
    "arg": "2"
  },
]
    Stddev Erstellt eine Reihe, die die Standardabweichung der Werte für jeden Zeitstempel in einer Reihe von Reihen enthält.
    sub Subtrahiert die angegebene Zahl vom Wert in jedem Zeitstempel.

    Argument: Argument (Zahl) – Die Zahl, die vom Wert in jedem Zeitstempel subtrahiert werden soll.
    sum Fasst die ausgewählte Metrikreihe in einer Reihe zusammen, die die Summe aller Werte für jeden Zeitstempel ohne NaN-Werte enthält. Wenn alle Zahlen in der Reihe NaN sind, ist die Ausgabe NaN.
    Zeitverschiebung Verschiebt den Zeitbereich, indem der angegebene Offset zum Zeitstempel eines Werts addiert wird, ohne den Wert zu ändern. Verwenden Sie diese Transformation, um Zeitstempel in eine andere Zeitzone zu verschieben.

    Argument: Argument (Datentyp „Dauer“): Die Zeitmenge, um die verschoben wird.
    top Gibt die angegebene Anzahl von Reihen mit den höchsten Werten zurück.

    Argument: Argument (Ganzzahl) – Die Anzahl der zurückzugebenden Serien.

    Im Folgenden werden beispielsweise die beiden Zeitreihen zurückgegeben, die die höchsten Wertesätze enthalten.
    "transforms": [
  {
     "name": "top",
     "arg": 2
  }
]
    Datentyp Beschreibung
    Aggregator Verfügbare Aggregatoren, die innerhalb der Transformation verwendet werden sollen.
    • Durchschnitt: Berechnet den arithmetischen Mittelwert aller aktuell ausgewählten Serien.
    • CHISQUARE: Zeigt an, wie gut ein statistisches Modell zum Metrikdatensatz passt.
    • LAST: Gibt den letzten definierten Wert im Zeitraumfenster zurück.
    • MAX: Zeigt den größten Wert für den Metrikdatensatz zu jedem Zeitpunkt an.
    • Median: Zeigt den Median des Metrikdatensatzes an. Der Median trennt die höheren Werte des Metrik-Datensatzes von den niedrigeren Werten.
    • MIN: Zeigt den kleinsten Wert für den Metrikdatensatz zu jedem Zeitpunkt an.
    • STDDEV: Berechnet die Standardabweichung für die zugrunde liegenden Daten. Wird verwendet, um die Variation oder Streuung einer Menge von Datenwerten im Metrik-Datensatz zu quantifizieren.
    • SUMME: Berechnet die Summe aller aktuell ausgewählten Serien.
    DateTime Absolute Datums-/Uhrzeitwerte werden durch das ISO 8601-Datums- und Uhrzeitformat angegeben: JJJJ-MM-DDThh:mm:ss. Beispiel: 2020-02-28T13:10:42.

    Wobei:

    • [JJJJ]: Vierstellige Jahreszahl.
    • [MM]: Mit Nullen aufgefüllter Monat zwischen 01 und 12.
    • [DD]: Mit Nullen aufgefüllter Tag zwischen 01 und 31.
    • T: Stellt die Zeit dar und ist obligatorisch, bevor eine der Zeitkomponenten angegeben wird.
    • [hh]: Mit Nullen aufgefüllte Stunde zwischen 00 und 23.
    • [mm]: Mit Nullen aufgefüllte Minuten zwischen 00 und 59.
    • [ss]: Mit Nullen aufgefüllte Sekunden zwischen 00 und 59. Beachten Sie, dass die Schaltsekunden gleichmäßig über die letzten 1.000 Sekunden verteilt werden.

    Relative Datums-/Uhrzeitwerte werden mithilfe einer Dauer (Datentyp „Dauer“) angegeben, die von der aktuellen Uhrzeit subtrahiert wird.

    Beispiel: P7D = vor sieben Tagen.
    Dezimalzahl Dezimalwert, der entweder sein kann:
    • Eine vorzeichenbehaftete Dezimalzahl mit beliebiger Genauigkeit, die exponentielle Notation verwenden kann.

      Wie zum Beispiel:

      • 2
      • 1,7
      • -3.47
      • 1,0E+2
    • Eine Zeichenfolgendarstellung von:
      • Eine Dezimalzahl mit Vorzeichen, die Exponentialschreibweise verwenden kann und garantiert eine 64-Bit-IEEE 754-Gleitkommazahl mit doppelter Genauigkeit ist.
      • „NaN“
      • „-Unendlich“
      • „+Unendlich“
    Dauer Zeit in einem Zeitintervall. Die Werte für die Dauer werden im ISO 8601-Dauerformat angegeben: P[n]Y[n]M[n]DT[n]H[n]M[n]S
    Wobei:
    • P: Dauerbezeichner, wird als „Zeitraum“ bezeichnet und wird immer am Anfang der Dauer platziert.
    • [n]Y: Anzahl der Jahre.
    • [n]M: Anzahl der Monate.
    • [n]D: Anzahl der Tage.
    • T: Zeitbezeichner und ist obligatorisch, bevor eine der Zeitkomponenten angegeben wird.
    • [n]H: Anzahl der Stunden.
    • [n]M: Anzahl der Minuten.
    • [n]S: Anzahl der Sekunden.
    Beispiel:
    • P7D: Zeitraum von sieben Tagen.
    • P1M: Zeitraum von einem Monat.
    • PT15M: Zeitraum von 15 Minuten.
    • P1DT12H: Zeitraum von einem Tag und zwölf Stunden.

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie dieser Endpunkt aufgerufen wird, um einen JSON-Stream für Metriken in der Tabelle „mb_demo_drone“ zurückzugeben. Hinweis: Während die Objekte in diesem Beispiel aus Gründen der Lesbarkeit auf mehrere Zeilen erweitert sind, befindet sich in einem tatsächlichen Ergebnis jedes zurückgegebene Objekt in einer eigenen Zeile. Sie können denselben Aufruf tätigen und einen Oktett-Stream zurückgeben, indem Sie --header "Accept:application/octet-stream" \ festlegen.

    curl "localhost:8080/api/now/v1/clotho/transform/stream" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--user "username":"password" \
-d "{\
  \"start\": \"PT5M\",\
  \"end\": \"\",\
  \"table\": \"mb_demo_drone\",\
  \"query\": \"fleet.nameSTARTSWITHB\",\
  \"limit\": 5000,\
  \"metrics\": [\
    {\
      \"metric\": \"mb_demo_mt_altitude\",\
      \"label\": \"Series - Avg\",\
      \"transforms\": [\
        {\
          \"name\": \"partition\",\
          \"arg\": {\
            \"aggregator\": \"AVG\",\
            \"window\": \"PT5M\"\
          }\
        },
        {\
          \"name\": \"avg\"\
        }\
      ]\
    },
    {\
      \"metric\": \"mb_demo_mt_altitude\",\
      \"groupBy\": \"fleet\",\
      \"label\": \"Fleet - AVG\",\
      \"transforms\": [\
        {\
          \"name\": \"partition\",\
          \"arg\": {\
            \"aggregator\": \"AVG\",\
            \"window\": \"PT5M\"\
          }\
        },
        {\
          \"name\": \"avg\"\
        }\
      ]\
    }\
  ]\
}"

    Antwort:

    [
  {
    "label": "Series - Avg",
    "tags": [
      "#4fb1114f-2426-4acb-8e3e-6435dd62134c"
    ],
    "species": "DOUBLE_SIGNAL",
    "range": [
      "2022-06-16T17:50:00Z",
      "2022-06-16T17:50:00Z"
    ],
    "values": [
      132.86805196126303
    ],
    "period": 300
  },
  {
    "label": "Fleet - AVG",
    "tags": [
      ":fleet:86fac11787333200a328c5b836cb0b4e:Bantams",
      "#6641aab4-c55f-4d11-8846-26b0b706ec1c"
    ],
    "species": "DOUBLE_SIGNAL",
    "range": [
      "2022-06-16T17:50:00Z",
      "2022-06-16T17:50:00Z"
    ],
    "values": [
      134.3775875908988
    ],
    "period": 300
  },
  {
    "label": "Fleet - AVG",
    "tags": [
      "#6641aab4-c55f-4d11-8846-26b0b706ec1c",
      ":fleet:4afac11787333200a328c5b836cb0b4e:Bumble Untd"
    ],
    "species": "DOUBLE_SIGNAL",
    "range": [
      "2022-06-16T17:50:00Z",
      "2022-06-16T17:50:00Z"
    ],
    "values": [
      129.02530271356756
    ],
    "period": 300
  }
]

    Im folgenden cURL-Beispiel wird die CSV-Formatoption verwendet, um die Höhenwerte (in der Datenbank als „mb_demo_mt_altatur“ gespeichert) des letzten Tages für jede Drohne, die in der Tabelle „mb_demo_drone“ [Drones] des Metricbase-Demo-Plugins gespeichert ist, zurückzustreamen. Im Beispiel werden die Daten in einem schmalen Tabellenformat mit drei Spalten zurückgegeben: der Sys_id des Antragstellers, der die Drohne identifiziert, dem Zeitstempel des Werts und dem Höhenwert.

    curl "https://instance.servicenow.com/api/now/v1/clotho/transform/stream" \
--request POST \
--header "Accept:text/csv;format=narrow" \
--header "Content-Type:application/json" \
--user "user name":"password" \
-d "{\
  \"start\": \"P1D\",\
  \"end\": \"\",\
  \"table\": \"mb_demo_drone\",\
  \"metrics\": [\
    {\
      \"metric\": \"mb_demo_mt_altitude\",\
      \"transforms\": []\
    }]\
}"

    Ausgabe:

    Subject, Timestamp,"mb_demo_drone|mb_demo_mt_altitude"
"a66b051787333200a328c5b836cb0b97",2022-11-07T22:35:00Z,92.84400939941406
"a66b051787333200a328c5b836cb0b94",2022-11-07T22:35:00Z,92.2428970336914
"6a6b051787333200a328c5b836cb0b97",2022-11-07T22:35:00Z,92.0076904296875
"ea6b051787333200a328c5b836cb0b92",2022-11-07T22:35:00Z,97.3113021850586
"a66b051787333200a328c5b836cb0b91",2022-11-07T22:35:00Z,108.49791717529297
"6a6b051787333200a328c5b836cb0b94",2022-11-07T22:35:00Z,109.04239654541016
"6a6b051787333200a328c5b836cb0b91",2022-11-07T22:35:00Z,93.72159576416016
"ee6b051787333200a328c5b836cb0b91",2022-11-07T22:35:00Z,107.69989776611328
"ee6b051787333200a328c5b836cb0b97",2022-11-07T22:35:00Z,100.86473083496094
"ee6b051787333200a328c5b836cb0b94",2022-11-07T22:35:00Z,95.77774047851562
"666b051787333200a328c5b836cb0b92",2022-11-07T22:35:00Z,105.19712829589844
"666b051787333200a328c5b836cb0b95",2022-11-07T22:35:00Z,105.92308807373047
"6e6b051787333200a328c5b836cb0b99",2022-11-07T22:35:00Z,93.59339141845703
"666b051787333200a328c5b836cb0b98",2022-11-07T22:35:00Z,94.51266479492188
"e26b051787333200a328c5b836cb0b94",2022-11-07T22:35:00Z,105.4367904663086
"6e6b051787333200a328c5b836cb0b96",2022-11-07T22:35:00Z,94.64836883544922
"6e6b051787333200a328c5b836cb0b93",2022-11-07T22:35:00Z,94.78523254394531
"e26b051787333200a328c5b836cb0b97",2022-11-07T22:35:00Z,96.99283599853516
"aa6b051787333200a328c5b836cb0b96",2022-11-07T22:35:00Z,106.67017364501953
"e26b051787333200a328c5b836cb0b91",2022-11-07T22:35:00Z,94.2446517944336
"aa6b051787333200a328c5b836cb0b93",2022-11-07T22:35:00Z,91.659912109375
"226b051787333200a328c5b836cb0b94",2022-11-07T22:35:00Z,99.5401840209961
"226b051787333200a328c5b836cb0b97",2022-11-07T22:35:00Z,98.13501739501953
"226b051787333200a328c5b836cb0b91",2022-11-07T22:35:00Z,92.2428970336914
"226b051787333200a328c5b836cb0b90",2022-11-07T22:35:00Z,106.41876983642578
"aa6b051787333200a328c5b836cb0b99",2022-11-07T22:35:00Z,107.69989776611328
"626b051787333200a328c5b836cb0b93",2022-11-07T22:35:00Z,92.96666717529297
"e66b051787333200a328c5b836cb0b99",2022-11-07T22:35:00Z,93.85079193115234
"e66b051787333200a328c5b836cb0b93",2022-11-07T22:35:00Z,96.07303619384766
"e66b051787333200a328c5b836cb0b96",2022-11-07T22:35:00Z,98.47595977783203
"2a6b051787333200a328c5b836cb0b92",2022-11-07T22:35:00Z,95.9247055053711
"226b051787333200a328c5b836cb0b9a",2022-11-07T22:35:00Z,99.5401840209961
"2a6b051787333200a328c5b836cb0b98",2022-11-07T22:35:00Z,103.1417465209961
"2a6b051787333200a328c5b836cb0b95",2022-11-07T22:35:00Z,96.99283599853516
"ae6b051787333200a328c5b836cb0b95",2022-11-07T22:35:00Z,94.64836883544922
"ae6b051787333200a328c5b836cb0b98",2022-11-07T22:35:00Z,101.8689956665039
"ae6b051787333200a328c5b836cb0b92",2022-11-07T22:35:00Z,107.4388198852539
"a26b051787333200a328c5b836cb0b98",2022-11-07T22:35:00Z,94.78523254394531
"266b051787333200a328c5b836cb0b93",2022-11-07T22:35:00Z,94.51266479492188
"2e6b051787333200a328c5b836cb0b97",2022-11-07T22:35:00Z,108.49791717529297
"2e6b051787333200a328c5b836cb0b91",2022-11-07T22:35:00Z,97.15129852294922
"2e6b051787333200a328c5b836cb0b94",2022-11-07T22:35:00Z,103.36128997802734
"a26b051787333200a328c5b836cb0b92",2022-11-07T22:35:00Z,100.47681427001953
"266b051787333200a328c5b836cb0b96",2022-11-07T22:35:00Z,103.5830078125
"266b051787333200a328c5b836cb0b99",2022-11-07T22:35:00Z,97.3113021850586
"a26b051787333200a328c5b836cb0b95",2022-11-07T22:35:00Z,105.92308807373047
"ea6b051787333200a328c5b836cb0b98",2022-11-07T22:35:00Z,95.34477996826172
"ea6b051787333200a328c5b836cb0b95",2022-11-07T22:35:00Z,100.47681427001953
"626b051787333200a328c5b836cb0b99",2022-11-07T22:35:00Z,100.86473083496094
"626b051787333200a328c5b836cb0b96",2022-11-07T22:35:00Z,106.9239730834961

    MetricBase-Zeitreihe – POST /now/clotho/put

    Fügt der Datenbank MetricBase Zeitreihendaten hinzu.

    URL-Format

    URL mit Versionsnummer: /api/now/{api_version}/clotho/put

    Unterstützte Anforderungsparameter

    Tabelle : 33. Pfadparameter
    Name Beschreibung
    api_version Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 34. Abfrageparameter
    Name Beschreibung
    sysparm_ignore_unknown_series Kennzeichnung, die angibt, ob unbekannte Serien ignoriert und die Transaktion ohne Rückgabe eines Fehlers fortgesetzt werden sollen.
    Gültige Werte:
    • „wahr“: Unbekannte Serie ignorieren.
    • „falsch“: Unbekannte Serie nicht ignorieren.

    Standardwert: true
    Tabelle : 35. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    SeriesRef Erforderlich. Zu aktualisierende Informationen.

    Datentyp: Array

    "seriesRef": [
  {
    "metric": "String",
    "subject": "String",
    "table": "String"
  }
]
    SeriesRef.Metrik Erforderlich. Der Name der zu aktualisierenden Metrik.

    Datentyp: Zeichenfolge
    SeriesRef.Subject Erforderlich. Die sys_id des Datensatzes, in dem die Daten aktualisiert werden sollen. Befindet sich in der in seriesRef.tableangegebenen Tabelle.

    Datentyp: Zeichenfolge
    SeriesRef.Tabelle Erforderlich. Der Name der Tabelle, in der die Daten gespeichert werden sollen.

    Datentyp: Zeichenfolge
    Werte Erforderlich. Die zu speichernden Reihenwerte.

    Datentyp: Array

    "values": [
  {
    "timestamp": "String",
    "value": Number
  }
]
    Werte.Zeitstempel Erforderlich. Der ISO 8601-Zeitstempel des Werts.

    Datentyp: Zeichenfolge

    Format: JJJJ-MM-ttTHH:mm:ttZ

    Die Endung „Z“, die die UTC-Zeitzone in einem ISO-formatierten Zeitstempel angibt, ist optional.
    Werte.Wert Erforderlich. Der Wert der Metrik.

    Datentyp: Zahl

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.

    Tabelle : 36. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 37. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

    Tabelle : 38. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Nachricht Nachricht, die den Status der Anforderung angibt, z. B. „ OK “, wenn die Anforderung erfolgreich verarbeitet wurde.

    cURL-Anforderung

    curl "https://instance.servicenow.com/api/now/v1/clotho/put" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"seriesRef\": {
    \"subject\": \"3D666b051787333200a328c5b836cb0b92\",
    \"table\": \"mb_demo_drone\",
    \"metric\": \"mb_demo_mt_altitude\"
  },
  \"values\": [
    {
      \"timestamp\": \"2019-03-21T17:05:00Z\",
      \"value\": 0.150185
    },
    {
      \"timestamp\": \"2019-03-21T17:06:00Z\",
      \"value\": 0.46074
    },
    {
      \"timestamp\": \"2019-03-21T17:07:00Z\",
      \"value\": 0.83104
    },
    {
      \"timestamp\": \"2019-03-21T17:08:00Z\",
      \"value\": 1.260635
    },
    {
      \"timestamp\": \"2019-03-21T17:09:00Z\",
      \"value\": 1.749
    }
  ]
}" \
--user "username":"password"
    {
    "result": {
        "message": "ok"
    }
}