MetricBase-Zeitreihen-API

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 49 Minuten Lesedauer
  • Die MetricBase-Zeitreihe Die API stellt Endpunkte bereit, um Daten in einzufügen, Informationen aus abzurufen und Transformationen für auszuführen MetricBase Datenbank.

    Diese API kann nur verwendet werden, wenn MetricBase Plugin (com.snc.clotho) ist installiert und aktiviert.

    Rolle, die zum Schreiben in diese API erforderlich ist: Clotho_Rest_put.

    Die Beispiele in diesem Abschnitt wurden mithilfe von Daten im MetricBase-Plugin (com.snc.clotho) erstellt.

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

    Ruft die angegebenen Zeitreihendaten aus dem ab MetricBase Datenbank.

    URL-Format

    Versionierte URL: /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 in identifiziert wurde subjectParameter, der als Metrik verwendet werden soll.

    Datentyp: Zeichenfolge

    subject SYS_ID des GlideRecord, der dieser Serie zugeordnet ist.

    Datentyp: Zeichenfolge

    table 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 bezeichnet werden sollen, wenn keine andere Bezeichnung angegeben ist.
    Gültige Werte:
    • Wahr: Ergebnisdaten werden mit dem Anzeigewert des Betreffdatensatzes gekennzeichnet.
    • Falsch: Ergebnisdaten sind nicht mit dem Anzeigewert des Betreffdatensatzes gekennzeichnet.

    Datentyp: Boolesch

    Standardwert: false

    sysparm_end Erforderlich. Endzeit des Auswertungszeitraums. Ein leerer oder fehlender Wert wird als aktuelle Zeit behandelt. Zeitwerte sind einschließlich dieser Endzeit.

    Datentyp: Zeichenfolge

    Format: ISO 8601 (UTC), entweder:
    • Absolutes Datumsformat [JJJJ-MM-TTThh: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. P1 M .
    sysparm_start Erforderlich. Startzeit des Auswertungszeitraums. Der Sonderwert Alle Kann verwendet werden, um die Startzeit als aktuelle Zeit abzüglich der maximalen Aufbewahrungsdauer für die angegebenen Metriken festzulegen. Ein leerer oder fehlender Wert wird als implizit behandelt Alle . Zeitwerte sind inklusive dieser Startzeit.

    Datentyp: Zeichenfolge

    Format: ISO 8601 (UTC), entweder:
    • Absolutes Datumsformat [JJJJ-MM-TTThh: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. P1 M .
    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 REST API-HTTP-Antwortcodes .

    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.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    label Bezeichnung, die zum Identifizieren des Ergebnissatzes dieser Metrik verwendet wird.

    Datentyp: Zeichenfolge

    SerienRef Datenreihenergebnisse.

    Datentyp: Array von Objekten

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

    Datentyp: Zeichenfolge

    SerienRef.Betreff SYS_ID des Datenreihendatensatzes. Befindet sich in der in angegebenen Tabelle seriesRef.table.

    Datentyp: Zeichenfolge

    SeriesRef.table Name der Tabelle, aus der die Datenreihe abgerufen wurde.

    Datentyp: Zeichenfolge

    Werte Transformierte Serienwerte.

    Datentyp: Array von Objekten

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

    Datentyp: Zeichenfolge

    Format: ISO 8601

    Werte.Wert Metrikwerte.

    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}

    Wandelt die angegebenen Daten basierend auf den angegebenen Parametern um.

    URL-Format

    Versionierte URL: /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 in identifiziert wurde subjectParameter, der als Metrik verwendet werden soll.

    Datentyp: Zeichenfolge

    table 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 bezeichnet werden sollen, wenn keine andere Bezeichnung angegeben ist.
    Gültige Werte:
    • Wahr: Ergebnisdaten werden mit dem Anzeigewert des Betreffdatensatzes gekennzeichnet.
    • Falsch: Ergebnisdaten sind nicht mit dem Anzeigewert des Betreffdatensatzes gekennzeichnet.

    Datentyp: Boolesch

    Standardwert: false

    sysparm_end Erforderlich. Endzeit des Auswertungszeitraums. Ein leerer oder fehlender Wert wird als aktuelle Zeit behandelt. Zeitwerte sind einschließlich dieser Endzeit.

    Datentyp: Zeichenfolge

    Format: ISO 8601 (UTC), entweder:
    • Absolutes Datumsformat [JJJJ-MM-TTThh: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. P1 M .
    sysparm_query Codierte Abfragezeichenfolge zum Suchen der Betreffdatensätze.

    Datentyp: Zeichenfolge

    Standard: Keine

    sysparm_start Erforderlich. Startzeit des Auswertungszeitraums. Der Sonderwert Alle Kann verwendet werden, um die Startzeit als aktuelle Zeit abzüglich der maximalen Aufbewahrungsdauer für die angegebenen Metriken festzulegen. Ein leerer oder fehlender Wert wird als implizit behandelt Alle . Zeitwerte sind inklusive dieser Startzeit.

    Datentyp: Zeichenfolge

    Format: ISO 8601 (UTC), entweder:
    • Absolutes Datumsformat [JJJJ-MM-TTThh: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. P1 M .
    sysparm_subject_limit Größe des Betreffabfrageergebnisses begrenzen.

    Datentyp: Zahl

    Standard: 10.000

    sysparm_transforms Kommagetrennte Liste von Transformationen.
    Gültige Transformationen:
    • Hinzufügen
    • avg
    • label
    • mul
    • Erneute Messung
    • 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 REST API-HTTP-Antwortcodes .

    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.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    label Bezeichnung, die zum Identifizieren des Ergebnissatzes dieser Metrik verwendet wird.

    Datentyp: Zeichenfolge

    SerienRef Datenreihenergebnisse.

    Datentyp: Array von Objekten

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

    Datentyp: Zeichenfolge

    SerienRef.Betreff SYS_ID des Datenreihendatensatzes. Befindet sich in der in angegebenen Tabelle seriesRef.table.

    Datentyp: Zeichenfolge

    SeriesRef.table Name der Tabelle, aus der die Datenreihe abgerufen wurde.

    Datentyp: Zeichenfolge

    Werte Transformierte Serienwerte.

    Datentyp: Array von Objekten

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

    Datentyp: Zeichenfolge

    Format: ISO 8601

    Werte.Wert Metrikwerte.

    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/accumulate

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

    Verwenden Sie diese API Zur Verarbeitung von Metriken, die für eine Akkumulation summiert werden können, z. B. Kilowattstunden (kWhs) Strom. Accumulate führt einen Aufruf für jede Metrik zum angegebenen Zeitstempel durch. Beispielsweise würden gesammelte Kilowatt für eine Heizung, einen elektrischen Wasserkocher und eine Waschmaschine dazu führen, dass drei Anrufe akkumuliert werden.

    URL-Format

    Versionierte URL: /api/now/{api_Version}/clotho/accumulate

    Unterstützte Anforderungsparameter

    Tabelle : 13. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. 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 zu einem bestimmten Zeitstempel. Wird nur während des ersten Aufrufs verwendet, um zu akkumulieren, wenn ein Wert für einen bestimmten Zeitstempel nicht verfügbar ist.

    Ein Anwendungsfall könnte eine Watt-Metrik für total_Power akkumulieren. Sie möchten Watt für einen Router sammeln, der an eine Steckdose ohne Leistungsmesser angeschlossen ist, um sie zu messen. Wenn Sie den Verbrauchswert kennen und konstant ist), können Sie den konstanten Wert als Standardwert verwenden, um total_Power zu akkumulieren. Sie würden beispielsweise 20 verwenden, wenn der Router ständig angeschlossen ist und 20 Watt verbraucht.

    Datentyp: Zeichenfolge

    Standard: 0

    sysparm_ignore_unknown_series Kennzeichnung, die angibt, ob eine unbekannte Serie ignoriert und die Transaktion fortgesetzt werden soll, ohne einen Fehler zurückzugeben.
    Gültige Werte:
    • Wahr: Unbekannte Serie ignorieren.
    • Falsch: Unbekannte Serien nicht ignorieren.

    Standardwert: wahr

    Tabelle : 15. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    SerienRef Liste von Zeichenfolgen, die Datenreiheninformationen darstellen, die aktualisiert werden sollen.

    Datentyp: Array

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

    Datentyp: Zeichenfolge

    SerienRef.Betreff Erforderlich. SYS_ID des Datensatzes, in dem die Daten aktualisiert werden sollen.

    Datentyp: Zeichenfolge

    Tabelle: Angegeben in seriesRef.table

    SeriesRef.table Erforderlich. Name der Tabelle, in der die Daten gespeichert werden sollen.

    Datentyp: Zeichenfolge

    Werte Erforderlich. Reihenwerte, die gesammelt und gespeichert werden sollen. Werte mit demselben Zeitstempel werden mit summiert default_valueAbfrageparameter.

    Datentyp: Array

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

    Datentyp: Zeichenfolge

    Format: JJJJ-MM-TTTHH:mm:DDZ

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

    Beispiel: 2019-03-21T17:05:00Z

    Werte.Wert Erforderlich. Metrikwert.

    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 REST API-HTTP-Antwortcodes .

    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.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Nachricht Meldung, die den Erfolg (OK) oder Fehler anzeigt.

    cURL-Anforderung

    Dieses Beispiel zeigt, 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

    Versionierte URL: /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. 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 bezeichnet werden sollen, wenn keine andere Bezeichnung angegeben ist.
    Gültige Werte:
    • Wahr: Ergebnisdaten werden mit dem Anzeigewert des Betreffdatensatzes gekennzeichnet.
    • Falsch: Ergebnisdaten sind nicht mit dem Anzeigewert des Betreffdatensatzes gekennzeichnet.

    Datentyp: Boolesch

    Standardwert: false

    Tabelle : 21. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Ende Erforderlich. Endzeit des Auswertungszeitraums. Ein leerer oder fehlender Wert wird als aktuelle Zeit behandelt. Zeitwerte sind einschließlich dieser Endzeit.

    Datentyp: Zeichenfolge

    Format: ISO 8601 (UTC), entweder:
    • Absolutes Datumsformat [JJJJ-MM-TTThh: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. P1 M .
    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 in 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 in angegebenen Tabelle enthalten sind tableParameter, nach dem die Serie gruppiert werden soll, bevor aggregierte Transformationen erfasst oder angewendet werden.

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

    Datentyp: Zeichenfolge

    Standard: Daten sind nicht gruppiert.

    Metriken.Bezeichnung Bezeichnung, die für den Ergebnissatz dieser Metrik verwendet werden soll. Sie ersetzt alle von der Transformationskette generierten Bezeichnungen.

    Datentyp: Zeichenfolge

    Standard: Generierte Standardbezeichnung.

    Metriken.Metrik Erforderlich, wenn metricsObjekt wurde übergeben. Metrikfeld, das in der Transformation verwendet werden soll. Dieses Feld muss sich in der Tabelle befinden, die in angegeben ist tableParameter.

    Datentyp: Zeichenfolge

    Metriken.Transformationen 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 unter Unterstützte Transformationen Unten.

    Datentyp: Array von Objekten

    "transforms": [
      {
        "arg": {Object},
        "name": "String"
      }
    ]
    Metriken.Transforms.arg Abhängig von der Transformation. Parameter, die an die Transformation übergeben werden sollen.
    Allgemeine Richtlinien:
    • Verwenden Sie nicht argParameter, wenn Transformationen angegeben werden, die keinen Parameter verwenden.
    • Verwenden Sie „Zahl“, „Zeichenfolge“ oder „Boolesch“ für Transformationen, die einen einzelnen Parameter verwenden.
    • Verwenden Sie ein JSON-Objekt mit den entsprechenden Name-Wert-Paaren für Transformationen, die mehr als einen Parameter enthalten.

    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 Unten.)

    metrics.transforms.name Erforderlich, wenn transformsObjekt ist angegeben. Name der Transformation.

    Eine Liste der verfügbaren Transformationen finden Sie in der Tabelle Unterstützte Transformationen Unten.

    Datentyp: Zeichenfolge

    query Codierte Abfrage, die zum Filtern des Ergebnissatzes verwendet werden soll.

    Sie können die Abfrage mit dem Filtereditor der angegebenen Tabelle erstellen. Wählen Sie nach der Erstellung aus URL kopieren Über das Breadcrumbs-Kontextmenü des Filters.

    Datentyp: Zeichenfolge

    Standard: Keine

    Start Erforderlich. Startzeit des Auswertungszeitraums. Der Sonderwert Alle Kann verwendet werden, um die Startzeit als aktuelle Zeit abzüglich der maximalen Aufbewahrungsdauer für die angegebenen Metriken festzulegen. Ein leerer oder fehlender Wert wird als implizit behandelt Alle . Zeitwerte sind inklusive dieser Startzeit.

    Datentyp: Zeichenfolge

    Format: ISO 8601 (UTC), entweder:
    • Absolutes Datumsformat [JJJJ-MM-TTThh: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. P1 M .
    table 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 REST API-HTTP-Antwortcodes .

    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.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Ergebnisse Null oder mehr geben Ergebnisobjekte zurück, die die Abfrage erfüllen. Enthält entweder einen seriesArray oder ein groupedArray.

    Datentyp: Array

    "results":[
      {
        "grouped": [Array],
        "marker": "String",
        "series": [Array]
      }
    ]
    results.grouped Liste der gruppierten Ergebnisobjekte, wobei jeweils groupedErgebnisobjekt entspricht einer bestimmten Gruppe. Dieses Format wird zurückgegeben, wenn metrics.groupByParameter wird im Anforderungstext übergeben.

    Datentyp: Array

    "grouped": [
      {
        "groupingBy": "String",
        "groups": [Array]
      }
    ]
    results.grouped.groupingBy Wert, der in übergeben wurde metrics.groupByParameter in der Anforderung.

    Datentyp: Zeichenfolge

    results.grouped.groups Liste der generierten Gruppen basierend auf dem Inhalt von metrics.groupByParameter in der Anforderung.

    Datentyp: Array

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

    Datentyp: Zeichenfolge

    results.grouped.groups.label Bezeichnung der Gruppe.

    Datentyp: Zeichenfolge

    results.grouped.groups.series Transformierte Werte für das Ergebnis der Gruppe.

    Datentyp: Array

    "series": [
      {
        "label": "String",
        "seriesRef": {Object},
        "values": [Array]
      }
    ]
    results.grouped.groups.series.label Bezeichnung der Serie.

    Datentyp: Zeichenfolge

    results.grouped.groups.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"
    }
    results.grouped.groups.series.seriesRef.metric Name der Metrik, aus der die Datenreihe abgerufen wurde. Wird nur angezeigt, wenn metricsObjekt wird in der Anforderung übergeben.

    Datentyp: Zeichenfolge

    results.grouped.groups.series.seriesRef.subject SYS_ID des Datenreihendatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Tabelle, die in angegeben wurde results.series.seriesRef.tableParameter.

    results.grouped.groups.series.seriesRef.table Name der Tabelle, aus der die Datenreihe abgerufen wurde.

    Datentyp: Zeichenfolge

    results.grouped.groups.series.values Liste der Ergebniswerte für die Gruppe.

    Datentyp: Array

    "values": [
      {
        "timestamp": "String",
        "value": Number
      }
    ]
    results.grouped.groups.series.values.timestamp ISO 8601-Zeitstempel des Werts.

    Datentyp: Zeichenfolge

    results.grouped.groups.series.values.value Transformierter Wert.

    Datentyp: Zahl

    Ergebnisse.Marker Eindeutiger Bezeichner für die entsprechenden Ergebnisse.

    Datentyp: Zeichenfolge

    results.series Liste der nicht gruppierten Serien von Ergebnisobjekten.

    Datentyp: Array von Objekten

    "series": [
      {
        "label": "String",
        "seriesRef": {Object},
        "values": [Array]
      }
    ]
    results.series.label Datenreihenbezeichnung. Dieser Wert wird entweder vom Endpunkt generiert oder ist der in übergebene Wert metrics.labelParameter.

    Datentyp: Zeichenfolge

    results.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"
    }
    results.series.seriesRef.metric Name der Metrik, aus der die Datenreihe abgerufen wurde. Wird nur angezeigt, wenn metricsObjekt wird in der Anforderung übergeben.

    Datentyp: Zeichenfolge

    results.series.seriesRef.subject SYS_ID des Datenreihendatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Spezifiziert in results.series.seriesRef.tableParameter.

    results.series.seriesRef.table Name der Tabelle, aus der die Datenreihe abgerufen wurde.

    Datentyp: Zeichenfolge

    results.series.values Transformierte Serienwerte.

    Datentyp: Array von Objekten

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

    Datentyp: Zeichenfolge

    results.series.values.value Transformierter Wert.

    Datentyp: Zahl

    Unterstützte Transformationen

    Tabelle : 25. Transformieren Sie Datentypen
    Umwandeln Beschreibung
    Hinzufügen Fügt jedem Zeitstempelwert die angegebene Zahl hinzu.

    Argument: Argument (Datentyp „Dezimalzahl“) – hinzuzufügende Zahl.

    Zum Beispiel:
    "transforms": [
      {
        "name": "add",
        "arg": 8
      }
    ]
    Automatische Korrelation Berechnet die Korrelation zwischen Zeitstempelwerten, getrennt durch eine steigende Anzahl von Zeiträumen ab 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 von Serien mit den niedrigsten Werten zurück.

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

    Beispiel: Gibt die beiden Zeitreihen zurück, die die niedrigsten Wertsätze enthalten.
    "transforms": [
      {
         "name": "bottom",
         "arg": 2
      }
    ]
    Ceil Rundet den Wert in jedem Zeitstempel auf die angegebene Genauigkeit auf: Ceil(Wert/<arg>) * <arg>)

    Argument: Argument (Datentyp „Dezimalzahl“): Dezimalgenauigkeit, auf die abgerundet werden soll.

    Sammeln Zeigt die Transformationsergebnisse der Transformationskette bis zum Punkt des Erfassungs-Transformationsaufrufs an. Transformierungsergebnisse der Sammlung enthalten eine eindeutige Markierung, Sie möchten jedoch auch eine Bezeichnung definieren.
    Zum 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"
            }
          ]
        }
      ]
    }
    Einschränkungswerte Ersetzt einen beliebigen 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 „Dezimalzahl“): Mindest- oder Höchstwert.
    • Val2 (Datentyp „Dezimalzahl“): Mindest- oder Höchstwert.
    count Fasst die Zeitreihe in einer Serie zusammen. Die neue Serie enthält die Anzahl der Werte, die nicht NaN (keine Zahl) sind, für jeden entsprechenden Zeitstempel in der Serie.
    Ableitung Bestimmt die Änderungsrate 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 Serie.
    Div. Teilt den Wert in jedem Zeitstempel durch die angegebene Zahl (Argument).

    Argument: Arg (Dezimalzahl: Die Zahl, durch die der Wert jedes Zeitstempels geteilt werden soll.

    Umschlag Gibt zwei Zeitreihen zurück, wobei eine zu einem beliebigen Zeitpunkt 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.
    exp Erhöht den Wert der angegebenen Basis auf die Stärke des Werts in jedem Zeitstempel.

    Argument: Arg (Datentyp „Dezimalzahl“): Der Basiswert.

    Filter Wendet einen Aggregator auf den Inhalt eines gleitenden Fensters an, z. B. Erstellung eines gleitenden Durchschnitts.
    Parameter:
    • Aggregator (Aggregator-Datentyp): Typ der auszuführenden Zusammenfassung.
    • Fenster (Datentyp „Dauer“): Die Dauer des gleitenden Fensters.
    floor Rundet den Wert in jedem Zeitstempel auf die angegebene Genauigkeit ab: Stockwerk(Wert/<arg>) * <arg>

    Argument: Argument (Datentyp „Dezimalzahl“): Die Dezimalgenauigkeit, auf die abgerundet werden soll.

    Bruchstücke Gibt eine Zeitreihe für jeden Bruch im angegebenen Array zurück. Jeder Zeitstempelwert ist der Wert, bei dem der angegebene Bruch von Werten für den entsprechenden Zeitstempel in der Eingabereihe unter dem angegebenen Prozentsatz liegt. Wenn der Bruch beispielsweise 0,5 ist, ist der Wert im Zeitstempel der Wert, bei dem die Hälfte der Werte in der Eingabereihe unter 0,5 liegt.

    Argument: Arg (Array von Dezimalstellen): Die für die Eingabeserie zu verwendenden Brüche.

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

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

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

    Argument: Argument (Ganzzahl): Anzahl der Datenbeispiele in jeder Richtung, die auf einen nicht-NaN-Wert überprüft werden sollen. Wenn kein nicht-NaN-Wert gefunden wird, wird NaN verwendet.

    Umgekehrt Berechnet die Invertierung jedes Zeitstempelwerts.
    iqr Führt eine Transformation des interquartilen Bereichs durch und erstellt einen Ergebnissatz, der vier Serien enthält:
    1. -IQR: Der Median aller Einträge unten Q1 – (1,5 * IQR) .
    2. Q1: Der Median der kleinsten Hälfte der Einträge.
    3. Q3: Der Median der größten Hälfte der Einträge.
    4. +IQR: Der Median aller Einträge oben Q3 + (1,5 * IQR) .
    Hinweis:
    IQR = Q3–Q1
    label Bezeichnet eine Transformationskette.
    Hinweis:
    Nachfolgende Transformationen können die Bezeichnung ändern oder ersetzen.
    Argument: Argument (Zeichenfolge): Text der Bezeichnung. Kann die folgenden Formatierungsausdrücke enthalten:
    • %%: Ein „%“-Literal mit Escape-Zeichen versehen.
    • %L: Aktuelle Bezeichnung, die ersetzt wird.
    • %S: Serienbetreff.
    • %G: Wert des Felds „Gruppieren nach“. Wenn dies ein referenzierter Datensatz ist, dann der Wert des Namensfelds des Datensatzes. Wenn mehrere Gruppen in angegeben sind groupByTransformieren, Bezeichnungen sind durch Kommas getrennt.
    • %G: Wert des Felds „Gruppieren nach“. Wenn dies ein referenzierter Datensatz ist, dann die sys_ID des Datensatzes Wenn mehrere Gruppen ausgewählt sind, werden Werte durch Kommas getrennt.
    Zum 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

    • Argument (Datentyp „Dauer“): Dauer, auf die jede Zeitreihe begrenzt werden soll.
    log 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: Arg (Datentyp „Dezimalzahl“) – Basis für die Logarithmus-Berechnung.

    Zuordnungswerte Ersetzt alle Werte innerhalb des angegebenen Bereichs (einschließlich) durch den angegebenen Wert. Wenn beides lowerBoundUnd upperBoundWerden als NaN angegeben, ersetzt er jeden NaN-Wert durch targetValue.
    Parameter:
    • LowerBound (Datentyp „Dezimalzahl“): Der niedrigste Wert im Bereich.
    • Obergrenze (Datentyp „Dezimalzahl“): Der höchste Wert im Bereich.
    • TargetValue (Datentyp „Dezimalzahl“): Ersatzwert.
    Mit der folgenden Option werden beispielsweise alle Werte in der Zeitreihe zwischen .1 und .9 in 1 geändert:
    "transforms": [
      {
        "name": "mapValues",
        "lowerBound": .1,
        "upperBound": .9,
        "targetValue": 1
      }
    ]
    max. Gibt eine Serie zurück, die den Höchstwert für jeden entsprechenden Zeitstempel in der Eingabe enthält.
    Median Erstellt eine Serie, die den Median von Werten für jeden Zeitstempel für einen Satz von Serien enthält.
    Wenn vorhanden n Serie:
    • Wenn n Ist ungerade, der Median ist der (n / 2 + 1) Wert für einen Zeitstempel.
    • Wenn n Ist gerade, der Median ist der Durchschnitt von (n / 2) Und (n / 2 + 1) Werte für einen Zeitstempel.
    min Gibt eine Serie 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 „Dezimalzahl“): Zahl, mit der der Wert jedes Zeitstempels multipliziert werden soll.

    partition

    Erstellt eine neue Serie mit Werten, die gefiltert werden, indem ein angegebener Aggregator auf ein sich nicht überschneidendes Fenster angewendet wird.

    Parameter:
    • Aggregator (Aggregator-Datentyp): Typ der auszuführenden Zusammenfassung.
    • Basis (DateTime-Datentyp): Der Null-Offset, der für die Partitionierung verwendet werden soll. Um beispielsweise nach Tag (24 Stunden) zu partitionieren, legen Sie diesen Wert in Ihrer Zeitzone auf Montag um Mitternacht fest. Um nach einem Zeitraum von 30 Tagen zu partitionieren, legen Sie diesen Wert auf den ersten Tag des letzten Monats fest.

      Standard: Beginn der EPOCH.

    • Fenster (Datentyp „Dauer“): Die Dauer des nicht überlappenden Fensters zum Anwenden des Aggregators.
    pow Erhöht jeden Zeitstempelwert auf die angegebene Leistung.

    Argument: Argument (Datentyp „Dezimalzahl“) – Leistung, auf die die einzelnen Werte erhöht werden sollen.

    Produkt Fasst die ausgewählte Metrikreihe in einer einzelnen Serie zusammen, die das Produkt aller Werte für jeden Zeitstempel enthält. NANS sind ausgeschlossen. Wenn alle Zahlen in der Serie NaN sind, ist die Ausgabe auch NaN.
    Erneute Messung Führt ein erneutes Abstempeln einer Zeitreihe entweder auf eine feste Anzahl von Punkten oder von einer Häufigkeit zur anderen durch.

    Verwenden Sie die Transformation für die Neuberechnung, um die Anzahl der Beispiele im Ergebnissatz zu reduzieren, um der Anzahl der anzuzeigenden Beispiele besser zu entsprechen.

    Argumente: Sie können verschiedene Argumente für diese Transformation übergeben. Nachfolgend finden Sie eine Liste der möglichen Argumentgruppen. Nur eine dieser Argumentgruppen kann innerhalb einer einzelnen Transformation übergeben werden. Die folgenden Argumentgruppen sind durch UND/ODER gekennzeichnet. 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 verfügbare Beispiele kleiner als diese Zahl sind, verwendet der Endpunkt Interpolation, um zusätzliche Beispiele zu erstellen. Wenn mehr Muster als diese Anzahl vorhanden sind, werden sie durch Mittelung reduziert.

      ODER

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

      ODER

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

      UND

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

      ODER

    • Aggregator (Aggregator-Datentyp): Der Aggregator, der beim erneuten Sampling verwendet werden soll.

      UND

    • Werte (Ganzzahl): Die Anzahl der Beispiele, die in den Ergebnissatz aufgenommen werden sollen. Wenn verfügbare Beispiele kleiner als diese Zahl sind, verwendet der Endpunkt Interpolation, um zusätzliche Beispiele zu erstellen. Wenn mehr Beispiele als diese Anzahl vorhanden sind, werden sie durch Anwenden der angegebenen reduziert aggregatorFür sie.

      ODER

    • Aggregator (Aggregator-Datentyp): Der Aggregator, der beim erneuten Sampling verwendet werden soll.

      UND

    • Zeitraum (Datentyp „Dauer“): Die Häufigkeit, mit der eine Neuberechnung durchgeführt werden soll. Wenn verfügbare Beispiele kleiner als diese Zahl sind, verwendet der Endpunkt Interpolation, um zusätzliche Beispiele zu erstellen. Wenn mehr Beispiele als diese Anzahl vorhanden sind, werden sie durch Anwenden der angegebenen reduziert aggregatorFür sie.

      ODER

    • Aggregator (Aggregator-Datentyp): Der Aggregator, der beim erneuten Sampling verwendet werden soll.

      UND

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

      UND

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

    Argument: Arg (Datentyp „Dezimalzahl“): Die Dezimalgenauigkeit, auf die abgerundet werden soll.

    root Berechnet den Stamm jedes Zeitstempelwerts anhand des angegebenen Index.

    Argument: Arg (Datentyp „Dezimalzahl“) – der Index des Stammes.

    Beispiel: Gibt die Quadratwurzel jedes Zeitstempels zurück:
    "transforms": [
      {
        "name": "root",
        "arg": "2"
      },
    ]
    stddev Erstellt eine Serie, die die Standardabweichung von Werten für jeden Zeitstempel über einen Satz von Serien enthält.
    Untergeordnet Subtrahiert die angegebene Zahl vom Wert in jedem Zeitstempel.

    Argument: Argument (Zahl): Die Zahl, die vom Wert in jedem Zeitstempel abgezogen werden soll.

    sum Fasst die ausgewählte Metrikreihe in einer Reihe zusammen, die die Summe aller Werte für jeden Zeitstempel enthält, ohne NaNs. Wenn alle Zahlen in der Serie NaN sind, ist die Ausgabe NaN.
    zeitverschiebung Verschiebt den Zeitbereich, indem der angegebene Offset zum Zeitstempel eines Werts hinzugefügt wird, ohne den Wert zu ändern. Verwenden Sie diese Transformation, um Zeitstempel in eine andere Zeitzone zu verschieben.

    Argument: Argument (Datentyp „Dauer“) – die Zeit, um die verschoben werden soll.

    top Gibt die angegebene Anzahl von Serien mit den höchsten Werten zurück.

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

    Beispiel: Gibt die beiden Zeitreihen zurück, die die höchsten Wertsätze enthalten.
    "transforms": [
      {
         "name": "top",
         "arg": 2
      }
    ]
    Datentyp Beschreibung
    Aggregator Verfügbare Aggregatoren zur Verwendung innerhalb der Transformation.
    • DURCHSCHN.: Berechnet den arithmetischen Mittelwert aller derzeit ausgewählten Serien.
    • CHISQUARE: Zeigt an, wie gut ein statistisches Modell zum Metrikdatensatz passt.
    • LETZTER: 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 für alle derzeit ausgewählten Serien.
    DateTime Absolute Datums-/Uhrzeitwerte werden im ISO 8601-Datums- und Uhrzeitformat angegeben: JJJJ-MM-TTThh:mm:ss . Beispiel: 2020-02-28T13:10:42.

    Wobei:

    • [JJJJ]: Vierstelliges Jahr.
    • [MM]: Monat mit Null aufgefüllt zwischen 01 und 12.
    • [TT]: Tag mit Null aufgefüllt zwischen 01 und 31.
    • T: Stellt die Zeit dar und ist obligatorisch, bevor eine der Zeitkomponenten angegeben wird.
    • [hh]: Null aufgefüllte Stunde zwischen 00 und 23.
    • [Mm]: Null aufgefüllte Minuten zwischen 00 und 59.
    • [ss]: Null aufgefüllte Sekunden zwischen 00 und 59. Beachten Sie, dass Schaltsekunden gleichmäßig über die vorherigen 1.000 Sekunden verteilt sind.

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

    Beispiel: P7D = vor sieben Tagen.

    Dezimal Dezimalwert, der entweder:
    • Eine signierte Dezimalzahl mit beliebiger Genauigkeit, die exponentielle Schreibweise verwenden kann.

      Z. B.:

      • 2
      • 1,7
      • -3.47
      • 1,0E+2
    • Eine Zeichenfolgendarstellung von:
      • Eine signierte Dezimalzahl, die exponentielle Schreibweise verwenden kann und garantiert eine 64-Bit-754 Floating Point-Zahl mit doppelter Genauigkeit ist.
      • „Nan“
      • „-Unendlich“
      • „+Unendlich“
    Dauer Zeit in einem Zeitintervall. 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, bezeichnet als „Zeitraum“ 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.
    Zum 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 von transformierten Zeitreihendaten für eine oder mehrere Metriken zurück, nachdem die angegebene Liste der Transformationen angewendet wurde.

    Durch das Streamen 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 wurden. Wenn große Datenmengen vom Client verarbeitet werden müssen, reduziert diese Art der Verarbeitung die End-to-End-Verarbeitungszeit und reduziert potenziell die Arbeitsspeichernutzung auf dem Client.

    Indem Sie den entsprechenden Accept-Header-Wert in Ihrer Anforderung festlegen, 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 engen CSV-Format zurück an den Client.
    Der Endpunkt streamt die Daten, während Transformationen auf abgeschlossen werden MetricBase Server, ohne Gruppierungen oder eine vordefinierte Reihenfolge. Im Binärformat gestreamte Daten sind kleiner als die von zurückgegebene JSON-Darstellung MetricBase-Zeitreihe – POST /now/clotho/transform Endpunkt.

    URL-Format

    Versionierte URL: /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. 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 bezeichnet werden sollen, wenn keine andere Bezeichnung angegeben ist.
    Gültige Werte:
    • Wahr: Ergebnisdaten werden mit dem Anzeigewert des Betreffdatensatzes gekennzeichnet.
    • Falsch: Ergebnisdaten sind nicht mit dem Anzeigewert des Betreffdatensatzes gekennzeichnet.

    Datentyp: Boolesch

    Standardwert: false

    Tabelle : 28. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Ende Erforderlich. Endzeit des Auswertungszeitraums. Ein leerer oder fehlender Wert wird als aktuelle Zeit behandelt. Zeitwerte sind einschließlich dieser Endzeit.

    Datentyp: Zeichenfolge

    Format: ISO 8601 (UTC), entweder:
    • Absolutes Datumsformat [JJJJ-MM-TTThh: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. P1 M .
    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 in der Transformation verwendet werden sollen. Weitere Informationen zu Metriken finden Sie unter Metriken .

    Datentyp: Array

    "metrics": [
      {
        "label": "String",
        "metric": "String",
        "transforms": [Array]
      }
    ]
    Metriken.Bezeichnung Bezeichnung, die für den Ergebnissatz dieser Metrik verwendet werden soll. Sie ersetzt alle von der Transformationskette generierten Bezeichnungen.

    Datentyp: Zeichenfolge

    Standard: Generierte Standardbezeichnung.

    Metriken.Metrik Erforderlich, wenn metricsObjekt wurde übergeben. Metrikfeld, das in der Transformation verwendet werden soll. Dieses Feld muss sich in der Tabelle befinden, die in angegeben ist tableParameter.

    Datentyp: Zeichenfolge

    Metriken.Transformationen 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 unter Unterstützte Transformationen Unten.

    Datentyp: Array von Objekten

    "transforms": [
      {
        "arg": {Object},
        "name": "String"
      }
    ]
    Metriken.Transforms.arg Abhängig von der Transformation. Parameter, die an die Transformation übergeben werden sollen.
    Allgemeine Richtlinien:
    • Verwenden Sie nicht argParameter, wenn Transformationen angegeben werden, die keinen Parameter verwenden.
    • Verwenden Sie „Zahl“, „Zeichenfolge“ oder „Boolesch“ für Transformationen, die einen einzelnen Parameter verwenden.
    • Verwenden Sie ein JSON-Objekt mit den entsprechenden Name-Wert-Paaren für Transformationen, die mehr als einen Parameter enthalten.

    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 Unten.)

    metrics.transforms.name Erforderlich, wenn transformsObjekt ist angegeben. Name der Transformation.

    Eine Liste der verfügbaren Transformationen finden Sie in der Tabelle Unterstützte Transformationen Unten.

    Datentyp: Zeichenfolge

    query Codierte Abfrage, die zum Filtern des Ergebnissatzes verwendet werden soll.

    Sie können die Abfrage mit dem Filtereditor der angegebenen Tabelle erstellen. Wählen Sie nach der Erstellung aus URL kopieren Über das Breadcrumbs-Kontextmenü des Filters.

    Datentyp: Zeichenfolge

    Standard: Keine

    Start Erforderlich. Startzeit des Auswertungszeitraums. Der Sonderwert Alle Kann verwendet werden, um die Startzeit als aktuelle Zeit abzüglich der maximalen Aufbewahrungsdauer für die angegebenen Metriken festzulegen. Ein leerer oder fehlender Wert wird als implizit behandelt Alle . Zeitwerte sind inklusive dieser Startzeit.

    Datentyp: Zeichenfolge

    Format: ISO 8601 (UTC), entweder:
    • Absolutes Datumsformat [JJJJ-MM-TTThh: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. P1 M .
    table 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 Folgendes:
    • application/json
    • application/octet-stream oder
    • text/csv
    Um das CSV-Format anzugeben, verwenden Sie Text/csv;Format=Narrow Oder Text/csv;Format=breit .
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 30. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine Datenformat des Antworttexts. Verwenden Sie basierend auf den angegebenen Akzeptanzwerten der Anforderung:
    • application/json
    • application/octet-stream oder
    • text/csv

    Wenn mehrere Akzeptanztypen 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 REST API-HTTP-Antwortcodes .

    Tabelle : 31. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet, und das Daten-Streaming wird gestartet.
    Hinweis:
    Eine Antwort von 200 kann weiterhin einen Verarbeitungsfehler im Midstream aufweisen, 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.

    Antworttext-Parameter (Octet-Stream oder JSON)

    Name Beschreibung
    Ausgabestrom (Oktet-Stream) Wenn der Header der Akzeptanz-Anforderung auf festgelegt ist application/octet-stream, Die übereinstimmenden MetricBase-Daten werden als binärer serialisierter Stream zurückgegeben. Clotho-Util für Java-Anwendungen bieten einen Deserialisierer, mit dem Sie diese Daten analysieren können.

    Der Stream besteht aus einer binären Serialisierung jedes Datums, gefolgt von einer Ganzzahl, die seine Länge darstellt. Die folgenden Einträge beschreiben die Daten in der Binärdarstellung und die Reihenfolge dieser Daten.

    CSV-Stream (UTF-8-Stream) Wenn der Header der Akzeptanz-Anforderung auf festgelegt ist text/csv, Die übereinstimmenden MetricBase-Daten werden als UTF-8-codierte CSV-Daten in breiten oder engen Formaten 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-Betreffpaar zurück.

    Betreff Quelle der Daten. Wenn die Metrik für die Daten beispielsweise Drohnen-Höhen ist, kann dieser Wert die ID einer bestimmten Drohne sein. Wenn ein Doppelpunkt im Wert enthalten ist, stellen die Teile nach dem Betreff die Metrik dar, zu der die Daten gehören. Nullwerte werden durch eine codierte leere Zeichenfolge dargestellt.

    Datentyp: Zeichenfolge (von Java geänderte UTF)

    Größe: 2+ Byte

    Maß Metrik, aus der die Daten stammen. Nullwerte werden durch eine codierte leere Zeichenfolge dargestellt.

    Datentyp: Zeichenfolge (von Java geänderte UTF)

    Größe: 2+ Byte

    Bezeichnung Bezeichnung der Daten. Nullwerte werden durch eine codierte leere Zeichenfolge dargestellt.

    Datentyp: Zeichenfolge (von Java geänderte UTF)

    Größe: 2+ Byte

    Typ Typ der in einem Byte codierten Daten.

    Mögliche Werte:

    • Gleitkommamodus
    • Float-Signal
    • Doppeltes Modell
    • Doppeltes Signal

    Datentyp: Byte

    Größe: 1 Byte

    Kennzeichnungen Codiert serializeFlagsVariable. Wenn serializeTagsIst „wahr“, und die Daten enthalten Tags. Der Wert ist 2, andernfalls ist er 0.

    Datentyp: Byte

    Größe: 1 Byte

    Zeitraum Zeitraum, der den Daten zugeordnet ist.

    Datentyp: Zahl (Ganzzahl)

    Größe: 4 Byte

    Anzahl der Tags Wenn serializeTagsIst „wahr“, ist dies die Anzahl der in den Daten gespeicherten Tags.

    Datentyp: Zahl (Ganzzahl)

    Größe: 4 Byte

    Tags Wenn serializeTagsIst „wahr“, wird jedes Tag in den Daten gespeichert.

    Datentyp: Zeichenfolge (von Java geänderte UTF)

    Größe: Abhängig von der Anzahl der Tags (2+ Byte).

    Starten Sie Die Epoche Sekunde UTC-Zeit der Epoche, die die Startzeit dieser Datenreihe darstellt.

    Datentyp: Zahl (lang)

    Größe: 8 Byte

    Anzahl der Werte Anzahl der in diesen Daten gespeicherten Werte.

    Datentyp: Zahl (Ganzzahl)

    Größe: 4 Byte

    Werte Wenn TypeIst Float-Signal , Dann besteht der Rest aus Gleitkommawerten.

    Größe: Number of Values* 4

    Datentyp: Zahl (Gleitkommazahl)

    Werte Wenn TypeIst Doppeltes Signal , Dann besteht der Rest aus doppelten Werten.

    Datentyp: Zahl (doppelt)

    Größe: Number of Values* 4 Byte

    Modell-Json (Modell) Wenn TypeIst Gleitkommamodell Oder Doppeltes Modell , Der Rest ist eine von Java modifizierte UTF-Zeichenfolge, die das Modell als JSON darstellt.

    Datentyp: Zeichenfolge (von Java geänderte UTF)

    Größe: 2+ Byte

    Markierung Für Großes Modell (Großes Modell) Wenn die Länge der JSON des Modells 65.535 Byte überschreitet, wird dieses Feld anstelle von geschrieben Model Json.

    Datentyp: Zeichenfolge (von Java geänderte UTF)

    Größe: 5

    Große Modellgröße (Großes Modell) Länge der JSON-Darstellung des großen Modells.

    Datentyp: Zahl (Ganzzahl)

    Größe: 4 Byte

    Großes Modell – Json (Großes Modell) JSON-Darstellung des Modells als Reihe von UTF-Zeichen, die Größe wird von bestimmt Big Model SizeFeld.

    Datentyp: Zeichenfolge (UTF-Zeichen)

    Größe: 65535-256000 Byte

    JSON-Stream (JSON) Wenn der Header der Akzeptanz-Anforderung auf festgelegt ist application/json, Die übereinstimmenden MetricBase-Daten werden als Stream neuer zeilengetrennter JSON-Objekte 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 in übergebene Wert metrics.labelParameter.

    Datentyp: Zeichenfolge

    Zeitraum Zeit zwischen jedem Wert. Beispielsweise würde ein Zeitraum von 60 bedeuten, dass jeder Wert eine Minute voneinander entfernt ist.

    Datentyp: Zahl

    Einheit: Sekunden

    range Start- und Endzeiten der Daten

    Datentyp: Array

    Format: ISO 8601 (UTC)

    Serie Identifiziert die einzelnen Daten. Wenn vorhanden, wird normalerweise in Form von angezeigt [Glide-Datensatz-ID]:[Metrik] . Dies ist möglicherweise nicht vorhanden, wenn Transformationen verwendet werden.

    Datentyp: Zeichenfolge

    Arten Typ der Rückgabedaten. Für eine Reihe von FLOAT- oder Doppel-Werten ist dies entweder FLOAT_SIGNAL oder DOUBLE_SIGNAL. Bei einem Modell, das zur Analyse von fließenden oder doppelten Daten bestimmt ist, ist dies entweder „FLOAT_MODEL“ oder „DOUBLE_MODEL“.

    Datentyp: Zeichenfolge

    tags Tags, die den Daten zugeordnet sind.

    Datentyp: Array von Zeichenfolgen

    Wert Fließende oder doppelte Werte für die Daten.

    Datentyp: Array von Zahlen

    Fehler Fehlermeldung, wenn die Transformation der angegebenen Datenreihe fehlschlägt.

    Datentyp: Zeichenfolge

    Unterstützte Transformationen

    Tabelle : 32. Transformieren Sie Datentypen
    Umwandeln Beschreibung
    Hinzufügen Fügt jedem Zeitstempelwert die angegebene Zahl hinzu.

    Argument: Argument (Datentyp „Dezimalzahl“) – hinzuzufügende Zahl.

    Zum Beispiel:
    "transforms": [
      {
        "name": "add",
        "arg": 8
      }
    ]
    Automatische Korrelation Berechnet die Korrelation zwischen Zeitstempelwerten, getrennt durch eine steigende Anzahl von Zeiträumen ab 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 von Serien mit den niedrigsten Werten zurück.

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

    Beispiel: Gibt die beiden Zeitreihen zurück, die die niedrigsten Wertsätze enthalten.
    "transforms": [
      {
         "name": "bottom",
         "arg": 2
      }
    ]
    Ceil Rundet den Wert in jedem Zeitstempel auf die angegebene Genauigkeit auf: Ceil(Wert/<arg>) * <arg>)

    Argument: Argument (Datentyp „Dezimalzahl“): Dezimalgenauigkeit, auf die abgerundet werden soll.

    Sammeln Zeigt die Transformationsergebnisse der Transformationskette bis zum Punkt des Erfassungs-Transformationsaufrufs an. Transformierungsergebnisse der Sammlung enthalten eine eindeutige Markierung, Sie möchten jedoch auch eine Bezeichnung definieren.
    Zum 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"
            }
          ]
        }
      ]
    }
    Einschränkungswerte Ersetzt einen beliebigen 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 „Dezimalzahl“): Mindest- oder Höchstwert.
    • Val2 (Datentyp „Dezimalzahl“): Mindest- oder Höchstwert.
    count Fasst die Zeitreihe in einer Serie zusammen. Die neue Serie enthält die Anzahl der Werte, die nicht NaN (keine Zahl) sind, für jeden entsprechenden Zeitstempel in der Serie.
    Ableitung Bestimmt die Änderungsrate 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 Serie.
    Div. Teilt den Wert in jedem Zeitstempel durch die angegebene Zahl (Argument).

    Argument: Arg (Dezimalzahl: Die Zahl, durch die der Wert jedes Zeitstempels geteilt werden soll.

    Umschlag Gibt zwei Zeitreihen zurück, wobei eine zu einem beliebigen Zeitpunkt 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.
    exp Erhöht den Wert der angegebenen Basis auf die Stärke des Werts in jedem Zeitstempel.

    Argument: Arg (Datentyp „Dezimalzahl“): Der Basiswert.

    Filter Wendet einen Aggregator auf den Inhalt eines gleitenden Fensters an, z. B. Erstellung eines gleitenden Durchschnitts.
    Parameter:
    • Aggregator (Aggregator-Datentyp): Typ der auszuführenden Zusammenfassung.
    • Fenster (Datentyp „Dauer“): Die Dauer des gleitenden Fensters.
    floor Rundet den Wert in jedem Zeitstempel auf die angegebene Genauigkeit ab: Stockwerk(Wert/<arg>) * <arg>

    Argument: Argument (Datentyp „Dezimalzahl“): Die Dezimalgenauigkeit, auf die abgerundet werden soll.

    Bruchstücke Gibt eine Zeitreihe für jeden Bruch im angegebenen Array zurück. Jeder Zeitstempelwert ist der Wert, bei dem der angegebene Bruch von Werten für den entsprechenden Zeitstempel in der Eingabereihe unter dem angegebenen Prozentsatz liegt. Wenn der Bruch beispielsweise 0,5 ist, ist der Wert im Zeitstempel der Wert, bei dem die Hälfte der Werte in der Eingabereihe unter 0,5 liegt.

    Argument: Arg (Array von Dezimalstellen): Die für die Eingabeserie zu verwendenden Brüche.

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

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

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

    Argument: Argument (Ganzzahl): Anzahl der Datenbeispiele in jeder Richtung, die auf einen nicht-NaN-Wert überprüft werden sollen. Wenn kein nicht-NaN-Wert gefunden wird, wird NaN verwendet.

    Umgekehrt Berechnet die Invertierung jedes Zeitstempelwerts.
    iqr Führt eine Transformation des interquartilen Bereichs durch und erstellt einen Ergebnissatz, der vier Serien enthält:
    1. -IQR: Der Median aller Einträge unten Q1 – (1,5 * IQR) .
    2. Q1: Der Median der kleinsten Hälfte der Einträge.
    3. Q3: Der Median der größten Hälfte der Einträge.
    4. +IQR: Der Median aller Einträge oben Q3 + (1,5 * IQR) .
    Hinweis:
    IQR = Q3–Q1
    label Bezeichnet eine Transformationskette.
    Hinweis:
    Nachfolgende Transformationen können die Bezeichnung ändern oder ersetzen.
    Argument: Argument (Zeichenfolge): Text der Bezeichnung. Kann die folgenden Formatierungsausdrücke enthalten:
    • %%: Ein „%“-Literal mit Escape-Zeichen versehen.
    • %L: Aktuelle Bezeichnung, die ersetzt wird.
    • %S: Serienbetreff.
    • %G: Wert des Felds „Gruppieren nach“. Wenn dies ein referenzierter Datensatz ist, dann der Wert des Namensfelds des Datensatzes. Wenn mehrere Gruppen in angegeben sind groupByTransformieren, Bezeichnungen sind durch Kommas getrennt.
    • %G: Wert des Felds „Gruppieren nach“. Wenn dies ein referenzierter Datensatz ist, dann die sys_ID des Datensatzes Wenn mehrere Gruppen ausgewählt sind, werden Werte durch Kommas getrennt.
    Zum 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

    • Argument (Datentyp „Dauer“): Dauer, auf die jede Zeitreihe begrenzt werden soll.
    log 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: Arg (Datentyp „Dezimalzahl“) – Basis für die Logarithmus-Berechnung.

    Zuordnungswerte Ersetzt alle Werte innerhalb des angegebenen Bereichs (einschließlich) durch den angegebenen Wert. Wenn beides lowerBoundUnd upperBoundWerden als NaN angegeben, ersetzt er jeden NaN-Wert durch targetValue.
    Parameter:
    • LowerBound (Datentyp „Dezimalzahl“): Der niedrigste Wert im Bereich.
    • Obergrenze (Datentyp „Dezimalzahl“): Der höchste Wert im Bereich.
    • TargetValue (Datentyp „Dezimalzahl“): Ersatzwert.
    Mit der folgenden Option werden beispielsweise alle Werte in der Zeitreihe zwischen .1 und .9 in 1 geändert:
    "transforms": [
      {
        "name": "mapValues",
        "lowerBound": .1,
        "upperBound": .9,
        "targetValue": 1
      }
    ]
    max. Gibt eine Serie zurück, die den Höchstwert für jeden entsprechenden Zeitstempel in der Eingabe enthält.
    Median Erstellt eine Serie, die den Median von Werten für jeden Zeitstempel für einen Satz von Serien enthält.
    Wenn vorhanden n Serie:
    • Wenn n Ist ungerade, der Median ist der (n / 2 + 1) Wert für einen Zeitstempel.
    • Wenn n Ist gerade, der Median ist der Durchschnitt von (n / 2) Und (n / 2 + 1) Werte für einen Zeitstempel.
    min Gibt eine Serie 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 „Dezimalzahl“): Zahl, mit der der Wert jedes Zeitstempels multipliziert werden soll.

    partition

    Erstellt eine neue Serie mit Werten, die gefiltert werden, indem ein angegebener Aggregator auf ein sich nicht überschneidendes Fenster angewendet wird.

    Parameter:
    • Aggregator (Aggregator-Datentyp): Typ der auszuführenden Zusammenfassung.
    • Basis (DateTime-Datentyp): Der Null-Offset, der für die Partitionierung verwendet werden soll. Um beispielsweise nach Tag (24 Stunden) zu partitionieren, legen Sie diesen Wert in Ihrer Zeitzone auf Montag um Mitternacht fest. Um nach einem Zeitraum von 30 Tagen zu partitionieren, legen Sie diesen Wert auf den ersten Tag des letzten Monats fest.

      Standard: Beginn der EPOCH.

    • Fenster (Datentyp „Dauer“): Die Dauer des nicht überlappenden Fensters zum Anwenden des Aggregators.
    pow Erhöht jeden Zeitstempelwert auf die angegebene Leistung.

    Argument: Argument (Datentyp „Dezimalzahl“) – Leistung, auf die die einzelnen Werte erhöht werden sollen.

    Produkt Fasst die ausgewählte Metrikreihe in einer einzelnen Serie zusammen, die das Produkt aller Werte für jeden Zeitstempel enthält. NANS sind ausgeschlossen. Wenn alle Zahlen in der Serie NaN sind, ist die Ausgabe auch NaN.
    Erneute Messung Führt ein erneutes Abstempeln einer Zeitreihe entweder auf eine feste Anzahl von Punkten oder von einer Häufigkeit zur anderen durch.

    Verwenden Sie die Transformation für die Neuberechnung, um die Anzahl der Beispiele im Ergebnissatz zu reduzieren, um der Anzahl der anzuzeigenden Beispiele besser zu entsprechen.

    Argumente: Sie können verschiedene Argumente für diese Transformation übergeben. Nachfolgend finden Sie eine Liste der möglichen Argumentgruppen. Nur eine dieser Argumentgruppen kann innerhalb einer einzelnen Transformation übergeben werden. Die folgenden Argumentgruppen sind durch UND/ODER gekennzeichnet. 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 verfügbare Beispiele kleiner als diese Zahl sind, verwendet der Endpunkt Interpolation, um zusätzliche Beispiele zu erstellen. Wenn mehr Muster als diese Anzahl vorhanden sind, werden sie durch Mittelung reduziert.

      ODER

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

      ODER

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

      UND

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

      ODER

    • Aggregator (Aggregator-Datentyp): Der Aggregator, der beim erneuten Sampling verwendet werden soll.

      UND

    • Werte (Ganzzahl): Die Anzahl der Beispiele, die in den Ergebnissatz aufgenommen werden sollen. Wenn verfügbare Beispiele kleiner als diese Zahl sind, verwendet der Endpunkt Interpolation, um zusätzliche Beispiele zu erstellen. Wenn mehr Beispiele als diese Anzahl vorhanden sind, werden sie durch Anwenden der angegebenen reduziert aggregatorFür sie.

      ODER

    • Aggregator (Aggregator-Datentyp): Der Aggregator, der beim erneuten Sampling verwendet werden soll.

      UND

    • Zeitraum (Datentyp „Dauer“): Die Häufigkeit, mit der eine Neuberechnung durchgeführt werden soll. Wenn verfügbare Beispiele kleiner als diese Zahl sind, verwendet der Endpunkt Interpolation, um zusätzliche Beispiele zu erstellen. Wenn mehr Beispiele als diese Anzahl vorhanden sind, werden sie durch Anwenden der angegebenen reduziert aggregatorFür sie.

      ODER

    • Aggregator (Aggregator-Datentyp): Der Aggregator, der beim erneuten Sampling verwendet werden soll.

      UND

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

      UND

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

    Argument: Arg (Datentyp „Dezimalzahl“): Die Dezimalgenauigkeit, auf die abgerundet werden soll.

    root Berechnet den Stamm jedes Zeitstempelwerts anhand des angegebenen Index.

    Argument: Arg (Datentyp „Dezimalzahl“) – der Index des Stammes.

    Beispiel: Gibt die Quadratwurzel jedes Zeitstempels zurück:
    "transforms": [
      {
        "name": "root",
        "arg": "2"
      },
    ]
    stddev Erstellt eine Serie, die die Standardabweichung von Werten für jeden Zeitstempel über einen Satz von Serien enthält.
    Untergeordnet Subtrahiert die angegebene Zahl vom Wert in jedem Zeitstempel.

    Argument: Argument (Zahl): Die Zahl, die vom Wert in jedem Zeitstempel abgezogen werden soll.

    sum Fasst die ausgewählte Metrikreihe in einer Reihe zusammen, die die Summe aller Werte für jeden Zeitstempel enthält, ohne NaNs. Wenn alle Zahlen in der Serie NaN sind, ist die Ausgabe NaN.
    zeitverschiebung Verschiebt den Zeitbereich, indem der angegebene Offset zum Zeitstempel eines Werts hinzugefügt wird, ohne den Wert zu ändern. Verwenden Sie diese Transformation, um Zeitstempel in eine andere Zeitzone zu verschieben.

    Argument: Argument (Datentyp „Dauer“) – die Zeit, um die verschoben werden soll.

    top Gibt die angegebene Anzahl von Serien mit den höchsten Werten zurück.

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

    Beispiel: Gibt die beiden Zeitreihen zurück, die die höchsten Wertsätze enthalten.
    "transforms": [
      {
         "name": "top",
         "arg": 2
      }
    ]
    Datentyp Beschreibung
    Aggregator Verfügbare Aggregatoren zur Verwendung innerhalb der Transformation.
    • DURCHSCHN.: Berechnet den arithmetischen Mittelwert aller derzeit ausgewählten Serien.
    • CHISQUARE: Zeigt an, wie gut ein statistisches Modell zum Metrikdatensatz passt.
    • LETZTER: 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 für alle derzeit ausgewählten Serien.
    DateTime Absolute Datums-/Uhrzeitwerte werden im ISO 8601-Datums- und Uhrzeitformat angegeben: JJJJ-MM-TTThh:mm:ss . Beispiel: 2020-02-28T13:10:42.

    Wobei:

    • [JJJJ]: Vierstelliges Jahr.
    • [MM]: Monat mit Null aufgefüllt zwischen 01 und 12.
    • [TT]: Tag mit Null aufgefüllt zwischen 01 und 31.
    • T: Stellt die Zeit dar und ist obligatorisch, bevor eine der Zeitkomponenten angegeben wird.
    • [hh]: Null aufgefüllte Stunde zwischen 00 und 23.
    • [Mm]: Null aufgefüllte Minuten zwischen 00 und 59.
    • [ss]: Null aufgefüllte Sekunden zwischen 00 und 59. Beachten Sie, dass Schaltsekunden gleichmäßig über die vorherigen 1.000 Sekunden verteilt sind.

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

    Beispiel: P7D = vor sieben Tagen.

    Dezimal Dezimalwert, der entweder:
    • Eine signierte Dezimalzahl mit beliebiger Genauigkeit, die exponentielle Schreibweise verwenden kann.

      Z. B.:

      • 2
      • 1,7
      • -3.47
      • 1,0E+2
    • Eine Zeichenfolgendarstellung von:
      • Eine signierte Dezimalzahl, die exponentielle Schreibweise verwenden kann und garantiert eine 64-Bit-754 Floating Point-Zahl mit doppelter Genauigkeit ist.
      • „Nan“
      • „-Unendlich“
      • „+Unendlich“
    Dauer Zeit in einem Zeitintervall. 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, bezeichnet als „Zeitraum“ 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.
    Zum 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 zur Lesbarkeit auf mehrere Zeilen erweitert werden, befindet sich jedes zurückgegebene Objekt in einem tatsächlichen Ergebnis in einer eigenen Zeile. Sie können denselben Anruf tätigen und einen Oktett-Stream zurückgeben, indem Sie festlegen --Header „Accept:Application/octet-Stream“ \ .

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

    Das folgende Curl-Beispiel verwendet die CSV-Formatoption, um die Höhenwerte (in der Datenbank als „mb_Demo_mt_Altitude“ gespeichert) des letzten Tages für jede Drohne zurückzustreamen, die in der Tabelle mb_Demo_Drone [Drones] des Metricbase-Demo-Plugins gespeichert ist. Im Beispiel werden die Daten in einem schmalen Tabellenformat mit drei Spalten zurückgegeben: Die SYS_ID des Antragstellers, der die Drohne identifiziert, den Zeitstempel des Werts und den 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 Zeitreihendaten zu hinzu MetricBase Datenbank.

    URL-Format

    Versionierte URL: /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 fortgesetzt werden soll, ohne einen Fehler zurückzugeben.
    Gültige Werte:
    • Wahr: Unbekannte Serie ignorieren.
    • Falsch: Unbekannte Serien nicht ignorieren.

    Standardwert: wahr

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

    Datentyp: Array von Objekten

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

    Datentyp: Zeichenfolge

    SerienRef.Betreff Erforderlich. SYS_ID des Datensatzes, in dem die Daten aktualisiert werden sollen.

    Datentyp: Zeichenfolge

    Tabelle: Angegeben in seriesRef.tableParameter.

    SeriesRef.table Erforderlich. Name der Tabelle, in der die Daten gespeichert werden sollen.

    Datentyp: Zeichenfolge

    Werte Erforderlich. Zu speichernde Serienwerte.

    Datentyp: Array

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

    Datentyp: Zeichenfolge

    Format: JJJJ-MM-TTTHH:mm:DDZ

    Die Endung „Z“, die die UTC-Zeitzone in einem ISO-formatierten Zeitstempel angibt, ist optional.

    Werte.Wert Erforderlich. Metrikwert.

    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 REST API-HTTP-Antwortcodes .

    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.

    Antworttext-Parameter (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"
        }
    }