Um die Kommunikation mit Ihrer Planful®-Umgebung - früher Host Analytics® - über die veröffentlichte REST-API-Schnittstelle des Dienstes als Teil einer Kette zu ermöglichen, fügen Sie einen Schritt mit einem Planful-Verbindungsbefehl hinzu.
Um diese Befehle zu aktivieren, erstellt ein IT-Administrator zunächst einen Planful-Konnektor.
Daten löschen
Um die Daten der Staging-Tabelle auf der Grundlage eines Regelcodes zu löschen, verwenden Sie den Befehl Clear Data .
Äquivalenter API-Aufruf: https://help.planful.com/v1/docs/clear-data-1
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Regel |
Geben Sie den Namen oder Code der Regel ein, in die Daten geladen werden sollen. |
Ausgaben
Keine
Exit-Codes
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |
Liste der Berichte abrufen
Um eine Liste der verfügbaren Berichte abzurufen, verwenden Sie den Befehl Get Reports List .
Äquivalenter API-Aufruf: N/A
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Ordner durchsuchen |
Geben Sie den Ordner ein, aus dem Berichte abgerufen werden sollen. |
| Berichtstyp |
Geben Sie die Art des Berichts ein, nach dem gefiltert werden soll. |
Ausgaben
| Ausgabe |
Art der Ausgabe |
| Berichte |
JSON |
Exit-Codes
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |
Version abrufen
Um die Version Ihrer Planful-Instanz abzurufen, verwenden Sie den Befehl Get Version .
Äquivalenter API-Aufruf: https://help.planful.com/v1/docs/getversion-api
Eigenschaften
Keine
Ausgaben
| Ausgabe |
Art der Ausgabe |
| Name der Anwendung |
Zeichenfolge |
| Version |
Zeichenfolge |
Exit-Codes
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |
Daten laden
Um Daten in die Staging-Tabellen der Planful-Anwendung zu laden, verwenden Sie einen Befehl Load Data .
Äquivalenter API-Aufruf: https://help.planful.com/v1/docs/load-data-external-source-models
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Regel |
Geben Sie den Namen oder Code der Regel ein, in die Daten geladen werden sollen. |
| Daten |
Geben Sie die Datei mit den Daten ein, die in Rulegeladen werden sollen. Jede Zeile sollte ein separater Eintrag sein. |
| Trennzeichen |
Wählen Sie das Trennzeichen, das in jeder Zeile verwendet wird, um Daten in Spalten zu trennen. |
Ausgaben
| Ausgabe |
Art der Ausgabe |
| Anzahl der Datensätze |
Ganzzahl |
Exit-Codes
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |
Abrufen von GL-Daten
Um die Sammlung von GLData-Objekten anhand von Filterkriterien abzurufen, verwenden Sie den Befehl Retrieve GL Data . Jedes zurückgegebene Objekt entspricht einer Zeile von GL-Daten in der Datenbank.
Äquivalenter API-Aufruf: https://help.planful.com/v1/docs/gldata-retrieve-api
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Filter |
Geben Sie die Testfilter ein. |
Ausgaben
| Ausgabe |
Art der Ausgabe |
| GLDaten (CSV) |
Datei |
| Anzahl der Datensätze |
Ganzzahl |
Exit-Codes
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |
Abrufen von Segment1-Daten
Um eine Sammlung von Segment1-Objekten anhand von Filterkriterien abzurufen, verwenden Sie den Befehl Retrieve Segment1 Data . Jedes zurückgegebene Objekt entspricht einer Datenzeile des Segments1 in der Datenbank.
Äquivalenter API-Aufruf: https://help.planful.com/v1/docs/segment1-retrieve
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Filter |
Geben Sie die Testfilter ein. |
Ausgaben
| Ausgabe |
Art der Ausgabe |
| Segment1-Daten (CSV) |
Datei |
| Anzahl der Datensätze |
Ganzzahl |
Exit Codes
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |
Abrufen von Segment2-Daten
Um eine Sammlung von Segment2-Objekten anhand von Filterkriterien abzurufen, verwenden Sie den Befehl Retrieve Segment2 Data . Jedes zurückgegebene Objekt entspricht einer Datenzeile des Segments2 in der Datenbank.
Äquivalenter API-Aufruf: https://help.planful.com/v1/docs/segment2-retrieve
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Filter |
Geben Sie die Testfilter ein. |
Ausgaben
| Ausgabe |
Art der Ausgabe |
| Segment2-Daten (CSV) |
Datei |
| Anzahl der Datensätze |
Ganzzahl |
Exit-Codes
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |
Abrufen von Segment3-Daten
Um eine Sammlung von Segment3-Objekten anhand von Filterkriterien abzurufen, verwenden Sie den Befehl Retrieve Segment3 Data . Jedes zurückgegebene Objekt entspricht einer Datenzeile des Segments3 in der Datenbank.
Äquivalenter API-Aufruf: https://help.planful.com/v1/docs/segment3-retrieve
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Filter |
Geben Sie die Testfilter ein. |
Ausgaben
| Ausgabe |
Art der Ausgabe |
| Segment3-Daten (CSV) |
Datei |
| Anzahl der Datensätze |
Ganzzahl |
Exit-Codes
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |
Abrufen von Segment4-Daten
Um eine Sammlung von Segment4-Objekten anhand von Filterkriterien abzurufen, verwenden Sie den Befehl Retrieve Segment4 Data . Jedes zurückgegebene Objekt entspricht einer Datenzeile des Segments4 in der Datenbank.
Äquivalenter API-Aufruf: https://help.planful.com/v1/docs/segment4-retrieve
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Filter |
Geben Sie die Testfilter ein. |
Ausgaben
| Ausgabe |
Art der Ausgabe |
| Segment4-Daten (CSV) |
Datei |
| Anzahl der Datensätze |
Ganzzahl |
Exit-Codes
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |
Abrufen von Segment5-Daten
Um eine Sammlung von Segment5-Objekten anhand von Filterkriterien abzurufen, verwenden Sie den Befehl Retrieve Segment5 Data . Jedes zurückgegebene Objekt entspricht einer Datenzeile des Segments 5 in der Datenbank.
Äquivalenter API-Aufruf: https://help.planful.com/v1/docs/segment5-retrieve
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Filter |
Geben Sie die Testfilter ein. |
Ausgaben
| Ausgabe |
Art der Ausgabe |
| Segment5-Daten (CSV) |
Datei |
| Anzahl der Datensätze |
Ganzzahl |
Exit-Codes
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |
Abrufen von Segment6-Daten
Um eine Sammlung von Segment6-Objekten anhand von Filterkriterien abzurufen, verwenden Sie den Befehl Retrieve Segment6 Data . Jedes zurückgegebene Objekt entspricht einer Datenzeile des Segments6 in der Datenbank.
Äquivalenter API-Aufruf: https://help.planful.com/v1/docs/segment6-retrieve
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Filter |
Geben Sie die Testfilter ein. |
Ausgaben
| Ausgabe |
Art der Ausgabe |
| Segment6-Daten (CSV) |
Datei |
| Anzahl der Datensätze |
Ganzzahl |
Exit-Codes
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |
Abrufen von Segment7-Daten
Um eine Sammlung von Segment7-Objekten anhand von Filterkriterien abzurufen, verwenden Sie den Befehl Retrieve Segment7 Data . Jedes zurückgegebene Objekt entspricht einer Datenzeile des Segments7 in der Datenbank.
Äquivalenter API-Aufruf: https://help.planful.com/v1/docs/segment7-retrieve
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Filter |
Geben Sie die Testfilter ein. |
Ausgaben
| Ausgabe |
Art der Ausgabe |
| Segment7-Daten (CSV) |
Datei |
| Anzahl der Datensätze |
Ganzzahl |
Exit Codes
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |
Abrufen von Segment8-Daten
Um eine Sammlung von Segment8-Objekten anhand von Filterkriterien abzurufen, verwenden Sie den Befehl Retrieve Segment8 Data . Jedes zurückgegebene Objekt entspricht einer Datenzeile des Segments 8 in der Datenbank.
Äquivalenter API-Aufruf: https://help.planful.com/v1/docs/segment8-retrieve
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Filter |
Geben Sie die Testfilter ein. |
Ausgaben
| Ausgabe |
Art der Ausgabe |
| Segment8-Daten (CSV) |
Datei |
| Anzahl der Datensätze |
Ganzzahl |
Exit-Codes
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |
Bericht ausführen
Um einen Bericht auszuführen und seine Ergebnisse als JSON zurückzugeben, verwenden Sie den Befehl Run Report .
Äquivalenter API-Aufruf: N/A
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Code melden |
Geben Sie den Namen oder den Code des auszuführenden Berichts ein. |
| Abstammung |
Geben Sie an, wo sich der Bericht in Planful befindet. Verwenden Sie // als Trennzeichen im Pfad. |
| Name des Würfels |
Geben Sie den Namen des mit dem Bericht verbundenen Würfels ein. |
| Filter |
Geben Sie die Filter ein, die auf den Bericht angewendet werden sollen. |
| Filter anwenden |
Wählen Sie aus, ob die Filter angewendet werden sollen. |
Ausgaben
| Ausgabe |
Art der Ausgabe |
| Bericht |
JSON |
| Bericht (CSV) |
Datei |
| Anzahl der Datensätze |
Ganzzahl |
Exit-Codes
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |
Daten übertragen
Um die Daten der Staging-Tabelle auf der Grundlage eines Regelcodes in die Zieltabelle in Planful zu übertragen, verwenden Sie den Befehl Transfer Data .
Äquivalenter API-Aufruf: https://help.planful.com/v1/docs/new-transfer-data-rest-api
Eigenschaften
| Eigenschaft |
Einzelheiten |
| Regel |
Geben Sie den Namen (Code) der Regel ein, in die Daten geladen werden sollen |
Ausgaben
Keine
Exit Codes
| Code |
Typ |
Einzelheiten |
| 0 |
Erfolg |
Erfolg |
| 1 |
Fehler |
Es ist ein Fehler aufgetreten |