---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Client -- Umfang, Global

# Client -- Umfang, Global {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 Minuten Lesedauer

Die Client Die API stellt Methoden zum Hinzufügen von Daten zu bereit MetricBaseDatenbank, um Transformationen auf auszuführen MetricBaseDatenbank, und zum Empfangen der Ergebnisse der Transformationen.

Sie können verwenden Client Klasse in bereichsbezogenen und globalen Serverskripts. Diese Klasse ist Teil von MetricBaseAnwendung und muss innerhalb von ausgeführt werden `sn_Clotho `Namespace.

## Client -- Client() {#ariaid-title2}

Erstellen Sie eine Instanz der Client-Klasse, um auf zuzugreifen MetricBaseDatenbank.
{#ClientS-Client__table_pzg_hvz_31b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 1. Parameter]

{#ClientS-Client__table_pzg_hvz_31b}  

    var client = new sn_clotho.Client();

## Client -- akkumulieren (GlideRecord Now_GR, Zeichenfolgenmetrik) {#ariaid-title3}

Sammelt Metrikwerte zum angegebenen Zeitstempel an und speichert das Ergebnis in der Datenbank, anstatt den Wert zu überschreiben.
Verwenden Sie diese Methode Zur Verarbeitung von Metriken, die für eine Akkumulation summiert werden können, z. B. Kilowattstunden (kWhs) Strom. „Accumulate" ruft für jede Metrik zum angegebenen Zeitstempel an. Beispielsweise würden gesammelte Kilowatt für eine Heizung, einen elektrischen Wasserkocher und eine Waschmaschine dazu führen, dass drei Anrufe akkumuliert werden.
{#ClientS-accumulate_GR_N__table_zsz_5jd_1db__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Now_GR | GlideRecord | Name der GlideRecord-Serie, aus der der kumulierte Wert abgerufen werden soll. Siehe auch: [GetSeries()](https://servicenow-prod.fluidtopics.net/7OsSuBv0iZtjTmdqxWfgdw#ClientS-getSeries_O_S_O "Ruft alle Serien aus einer bestimmten Dimension ab.") |
| default_value | Nummer | Optional. 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. Der Zeitstempelwert kann mit angegeben werden [Datengenerator](https://servicenow-prod.fluidtopics.net/_PJR7uBDoaIpxVAdsVovpg#DataBuilderScopedAPI "Die Datengenerator Die API bietet Methoden zum Erstellen einer Reihe von Datenpunkten für eine Metrik. Verwenden Sie sn_Clotho.Client.put() Methode zum Speichern der Werte.")API. Standard: 0 |
[Tabelle : 2. Parameter]

{#ClientS-accumulate_GR_N__table_zsz_5jd_1db} {#ClientS-accumulate_GR_N__table_atz_5jd_1db__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 3. Rückgaben]

{#ClientS-accumulate_GR_N__table_atz_5jd_1db}  
Das folgende Beispiel zeigt, wie akkumuliert wird `Total_Power `Metrikwert in einem aufgerufenen Datensatz `Gebäude_A `.

    var time = new GlideDateTime();

    // total_power is the name of a metric within building_a which stores accumulated values

    var dataBuilder1 = new sn_clotho.DataBuilder(building_a, "total_power");
    // values to be accumulated
    dataBuilder1.add(time, 3.5);
    new sn_clotho.Client().accumulate(dataBuilder1, 0);

    var dataBuilder2 = new sn_clotho.DataBuilder(building_a, "total_power");
    // values to be accumulated
    dataBuilder2.add(time, 3.5);
    new sn_clotho.Client().accumulate(dataBuilder2, 0);

    var dataBuilder3 = new sn_clotho.DataBuilder(building_a, "total_power");
    // values to be accumulated
    dataBuilder3.add(time, 3.5);
    new sn_clotho.Client().accumulate(dataBuilder3, 0);

    // As a result of these operations client will save value of
    // 3.5+12+4.3+0(default value) at the timestamp 'time'

## Client -- deleteMetric(Zeichenfolge tableName, Zeichenfolge metricName) {#ariaid-title4}

Entfernen Sie eine angegebene Metrik aus einer angegebenen Tabelle in MetricBaseDatenbank
Hinweis:  
Mit dieser Methode werden Daten aus gelöscht MetricBaseDatenbank. Es gibt keinen Wiederherstellungsmechanismus.
{#ClientS-deleteMetric_S_S__table_zsz_5jd_1db__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| tableName | Zeichenfolge | Der Name der Tabelle, deren angegebene Metrik gelöscht werden soll. |
| metricName | Zeichenfolge | Der Name der Metrik. |
[Tabelle : 4. Parameter]

{#ClientS-deleteMetric_S_S__table_zsz_5jd_1db} {#ClientS-deleteMetric_S_S__table_atz_5jd_1db__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 5. Rückgaben]

{#ClientS-deleteMetric_S_S__table_atz_5jd_1db}  
Das folgende Beispiel zeigt, wie eine Metrik aus einer Tabelle entfernt wird.

    var client = new sn_clotho.Client();

    // delete metric (Speed) from the Drones table
    client.deleteMetric("mb_demo_drone", "mb_demo_mt_speed");

## Client -- deleteSeries(GlideRecord Now_GR, Zeichenfolgenmetrik) {#ariaid-title5}

Entfernen Sie die Daten in MetricBaseDatenbank, die der angegebenen Metrik im angegebenen GlideRecord zugeordnet ist. Verwenden Sie diese Methode zum Entfernen von Testdaten.
Hinweis:  
Mit dieser Methode werden Daten aus gelöscht MetricBaseDatenbank. Es gibt keinen Wiederherstellungsmechanismus.
{#ClientS-deleteSeries_GR_S__table_zsz_5jd_1db__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Now_GR | GlideRecord | Die Datensätze, deren Zeitreihendaten für die angegebene Metrik gelöscht werden sollen. |
| Metrik | Zeichenfolge | Der Name der Metrik. |
[Tabelle : 6. Parameter]

{#ClientS-deleteSeries_GR_S__table_zsz_5jd_1db} {#ClientS-deleteSeries_GR_S__table_atz_5jd_1db__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 7. Rückgaben]

{#ClientS-deleteSeries_GR_S__table_atz_5jd_1db}  

    var client = new sn_clotho.Client();
    //query drones of a specific model
    var drones = new GlideRecord("mb_demo_drone");
    drones.addQuery("model", "Kingfisher Phantom");
    drones.query();

    client.deleteSeries(drones, 'mb_demo_mt_speed');

## Client -- getSeries(GlideRecord Now_GR, ZeichenfolgenmetricName, GlideDateTime lastUpdateBefore) {#ariaid-title6}

Ruft alle Serien aus einer bestimmten Dimension ab.
{#ClientS-getSeries_O_S_O__table_zsz_5jd_1db__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Now_GR | [GlideRecord](https://servicenow-prod.fluidtopics.net/pr75jggqt1vPfwd6tbA7gQ#c_GlideRecordScopedAPI "Der Umfang ist festgelegt GlideRecord API wird für Datenbankvorgänge verwendet.") | Der Datensatz, aus dem die Serie abgerufen werden soll. |
| Metrik | Zeichenfolge | Der Name der Metrik. |
| LastUpdatevor | [GlideDateTime](https://servicenow-prod.fluidtopics.net/3E4k~hw2Yf_nMTVTCjn4Xw#c_GlideDateTimeScoped "Der Umfang ist festgelegt GlideDateTime Die Klasse stellt Methoden zum Ausführen von Vorgängen für GlideDateTime-Objekte bereit.") | Optional. Datum in der Zukunft, das das Ende des auszuwertenden Zeitraums darstellt. |
[Tabelle : 8. Parameter]

{#ClientS-getSeries_O_S_O__table_zsz_5jd_1db} {#ClientS-getSeries_O_S_O__table_atz_5jd_1db__entry__2}

| Typ | Beschreibung |
|-|-|
| Array | Liste der sys_IDs der Zeichenfolge, die die Serie mit Daten für die angegebene Metrik darstellt. Wenn lastUpdateBeforeDer Parameter wird angegeben. Gibt Serien zurück, die keine Daten haben, die aktueller sind als das lastUpdateBefore-Datum (nicht inklusive). |
[Tabelle : 9. Rückgaben]

{#ClientS-getSeries_O_S_O__table_atz_5jd_1db}  
Das folgende Beispiel zeigt, wie die vollständige Liste der Geschwindigkeitswerte abgerufen wird, die in der Tabelle „Drohnen" \[mb_Demo_DRONE\] aufgeführt sind.

    var client = new sn_clotho.Client();

    // query subject records
    var grDrone = new GlideRecord('mb_demo_drone');
    grDrone.query();

    var series = client.getSeries(grDrone,'mb_demo_mt_speed');

## Client -- PUT(Object metricData) {#ariaid-title7}

Speichert Metrikdaten in MetricBaseDatenbank.
{#ClientS-put_DB__table_vxt_wvz_31b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| MetricData | Objekt | Eine der folgenden Optionen: * [Datengenerator](https://servicenow-prod.fluidtopics.net/_PJR7uBDoaIpxVAdsVovpg#DataBuilderScopedAPI "Die Datengenerator Die API bietet Methoden zum Erstellen einer Reihe von Datenpunkten für eine Metrik. Verwenden Sie sn_Clotho.Client.put() Methode zum Speichern der Werte.")Objekt mit Metrikdaten. * Array von Datengenerator-Objekten mit Metrikdaten. {#ClientS-put_DB__ul_ldw_bbh_yjb} |
[Tabelle : 10. Parameter]

{#ClientS-put_DB__table_vxt_wvz_31b} {#ClientS-put_DB__table_wxt_wvz_31b__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 11. Rückgaben]

{#ClientS-put_DB__table_wxt_wvz_31b}  

    var time = new GlideDateTime();
    ​
    // two different GlideRecord instances and metrics
    var dataBuilder = new sn_clotho.DataBuilder(now_GR, 'cpu_percentage');
    dataBuilder.add(time, 0.6);
    ​
    var dataBuilder2 = new sn_clotho.DataBuilder(gr2, 'disk_free_percentage');
    dataBuilder2.add(time, 0.2);
    ​
    new sn_clotho.Client().put([dataBuilder,dataBuilder2]);


