Um mit Pigment zu interagieren, fügen Sie einen Schritt in eine Kette ein, die einen Pigment-Verbindungsbefehl verwendet.
Anforderungen
Um diese Befehle zu aktivieren, muss ein IT-Administrator zunächst den Pigment Connector konfigurieren.
Liste exportieren
Um die Daten einer bestimmten Liste zu exportieren, fügen Sie den Befehl Liste exportieren hinzu.
Äquivalenter API-Aufruf: https://pigment.app/api/swagger/#/Export/post_api_export_list__listId_
Eigenschaften
| Eigenschaft | Einzelheiten |
|---|---|
| ID auflisten | Geben Sie die ID der zu exportierenden Liste ein. |
| Technische Namen von Immobilien |
Geben Sie die technischen Namen der Eigenschaften der Pigmentliste ein, die Sie exportieren möchten. Diese sollten der Reihe nach aufgelistet werden. Wenn keine Namen eingegeben werden, werden alle Eigenschaften exportiert. |
| Filter auflisten |
Geben Sie die Pigmentlistenelemente ein, die Sie exportieren möchten. Wenn keine Listen eingegeben werden, werden alle Eigenschaften exportiert. |
| Eigenschaftsfilter |
Geben Sie die Eigenschaftsfilter der Pigmentliste ein, die Sie exportieren möchten. Wenn keine Filter eingegeben werden, werden alle Eigenschaften exportiert. |
| Freundliche Kopfzeilen |
Wenn diese Option aktiviert ist, werden in der exportierten CSV-Datei "freundliche" Namen in den Kopfzeilen angezeigt. Wenn diese Option nicht markiert ist, werden in der CSV-Datei technische Namen angezeigt. |
Ausgaben
| Ausgabe | Ausgangstyp |
|---|---|
| Liste | CSV-Datei |
Codes beenden
| Code | Typ | Einzelheiten |
|---|---|---|
| 0 | Erfolgreich | Erfolgreich |
| 1 | Fehler | Fehler |
Metrik exportieren
Um die Daten einer bestimmten Metrik zu exportieren, fügen Sie den Befehl Export metric hinzu.
Äquivalenter API-Aufruf: https://pigment.app/api/swagger/#/Export/post_api_export_metric__metricId_
Eigenschaften
| Eigenschaft | Einzelheiten |
|---|---|
| ID der Metrik | Geben Sie die ID der zu exportierenden Metrik ein. |
| Szenarien |
Geben Sie die Szenario-IDs ein, die die zu exportierenden Pigmentmetrikdaten enthalten. Wenn keine Szenarien eingegeben werden, wird das Standardszenario exportiert. |
| Dimensionsfilter |
Geben Sie die Pigmentdimensionsfilter ein, die Sie exportieren möchten. Wenn keine Filter eingegeben werden, werden alle Filter exportiert. |
| Freundliche Kopfzeilen |
Wenn diese Option aktiviert ist, werden in der exportierten CSV-Datei "freundliche" Namen in den Kopfzeilen angezeigt. Wenn diese Option nicht markiert ist, werden in der CSV-Datei technische Namen angezeigt. |
Ausgaben
| Ausgabe | Ausgangstyp |
|---|---|
| Liste | CSV-Datei |
Codes beenden
| Code | Typ | Einzelheiten |
|---|---|---|
| 0 | Erfolgreich | Erfolgreich |
| 1 | Fehler | Fehler |
Tabelle exportieren
Um die Daten einer bestimmten Tabelle zu exportieren, fügen Sie den Befehl Tabelle exportieren hinzu.
Äquivalenter API-Aufruf: https://pigment.app/api/swagger/#/Export/post_api_export_table__tableId_
Eigenschaften
| Eigenschaft | Einzelheiten |
|---|---|
| Tabellen-ID: | Geben Sie die ID der zu exportierenden Tabelle ein. |
| Metriken |
Geben Sie die Metrik-IDs ein, die zu den Daten der Pigmenttabelle gehören, die Sie exportieren möchten. Diese sollten der Reihe nach aufgelistet werden. Wenn keine Metrik-IDs eingegeben werden, werden alle Metriken exportiert. |
| Szenarien |
Geben Sie die Szenario-IDs ein, die die zu exportierenden Pigmentmetrikdaten enthalten. Wenn keine Szenarien eingegeben werden, wird das Standardszenario exportiert. |
| Dimensionsfilter |
Geben Sie die Pigmentdimensionsfilter ein, die Sie exportieren möchten. Wenn keine Filter eingegeben werden, werden alle Filter exportiert. |
| Freundliche Kopfzeilen |
Wenn diese Option aktiviert ist, werden in der exportierten CSV-Datei "freundliche" Namen in den Kopfzeilen angezeigt. Wenn diese Option nicht markiert ist, werden in der CSV-Datei technische Namen angezeigt. |
Ausgaben
| Ausgabe | Ausgangstyp |
|---|---|
| Liste | CSV-Datei |
Codes beenden
| Code | Typ | Einzelheiten |
|---|---|---|
| 0 | Erfolgreich | Erfolgreich |
| 1 | Fehler | Fehler |
Ansicht exportieren
Um die Daten einer bestimmten Ansicht zu exportieren, fügen Sie den Befehl Ansicht exportieren hinzu.
Äquivalenter API-Aufruf: https://pigment.app/api/swagger/#/Export/get_api_export_view__viewId_
Eigenschaften
| Eigenschaft | Einzelheiten |
|---|---|
| Ansichts-ID | Geben Sie die ID der zu exportierenden Ansicht ein. |
Ausgaben
| Ausgabe | Ausgangstyp |
|---|---|
| Liste | CSV-Datei |
Codes beenden
| Code | Typ | Einzelheiten |
|---|---|---|
| 0 | Erfolgreich | Erfolgreich |
| 1 | Fehler | Fehler |
CSV importieren
Um eine CSV-Datei zu importieren, fügen Sie den Befehl Import CSV hinzu.
Äquivalenter API-Aufruf: https://pigment.app/api/swagger/#/ImportApi/post_api_import_push_csv
Eigenschaften
| Eigenschaft | Einzelheiten |
|---|---|
| Konfigurations-ID | Geben Sie die Konfigurations-ID von Pigment ein, die das Ziel der Datei definiert. |
| Dateipfad | Geben Sie den Dateipfad für die CSV-Datei ein, die Sie importieren möchten. |
Ausgaben
| Ausgabe | Ausgangstyp |
|---|---|
| Importieren | JSON |
Codes beenden
| Code | Typ | Einzelheiten |
|---|---|---|
| 0 | Erfolgreich | Erfolgreich |
| 1 | Fehler | Fehler |