Per abilitare la comunicazione con l'ambiente Planful® - ex Host Analytics® - tramite l'interfaccia API REST pubblicata del servizio come parte di una catena, aggiungere un passo con un comando di connessione Planful.
Per abilitare questi comandi, un amministratore IT deve innanzitutto creare un connettore Planful.
Cancella i dati
Per cancellare i dati della tabella di staging in base a un codice regola, utilizzare il comando Clear Data .
Chiamata API equivalente: https://help.planful.com/v1/docs/clear-data-1
Proprietà
Proprietà |
Dettaglio |
Regola |
Inserire il nome o il codice della regola in cui caricare i dati. |
Output
Nessuno
Codici di uscita
Codice |
Tipo |
Dettaglio |
0 |
Operazione completata |
Operazione completata |
1 |
Errore |
Si è verificato un errore |
Ottenere l'elenco dei rapporti
Per recuperare l'elenco dei rapporti disponibili, utilizzare il comando Get Reports List .
Chiamata API equivalente: N/D
Proprietà
Proprietà |
Dettaglio |
Cartella di ricerca |
Immettere la cartella da cui recuperare i rapporti. |
Tipo di rapporto |
Inserire il tipo di rapporto da filtrare. |
Output
Output |
Tipo di output |
Report |
JSON |
Codici di uscita
Codice |
Tipo |
Dettaglio |
0 |
Operazione completata |
Operazione completata |
1 |
Errore |
Si è verificato un errore |
Ottenere la versione
Per recuperare la versione dell'istanza di Planful, utilizzare il comando Get Version .
Chiamata API equivalente: https://help.planful.com/v1/docs/getversion-api
Proprietà
Nessuno
Output
Output |
Tipo di output |
Nome dell'applicazione |
Stringa |
Versione |
Stringa |
Codici di uscita
Codice |
Tipo |
Dettaglio |
0 |
Operazione completata |
Operazione completata |
1 |
Errore |
Si è verificato un errore |
Dati di carico
Per caricare i dati nelle tabelle di staging dell'applicazione Planful, utilizzare il comando Load Data .
Chiamata API equivalente: https://help.planful.com/v1/docs/load-data-external-source-models
Proprietà
Proprietà |
Dettaglio |
Regola |
Inserire il nome o il codice della regola in cui caricare i dati. |
Dati |
Inserire il file contenente i dati da caricare in Rule. Ogni riga deve essere una voce separata. |
Delimitatore |
Selezionare il delimitatore utilizzato all'interno di ogni riga per separare i dati in colonne. |
Output
Output |
Tipo di output |
Conteggio dei record |
Numero intero |
Codici di uscita
Codice |
Tipo |
Dettaglio |
0 |
Operazione completata |
Operazione completata |
1 |
Errore |
Si è verificato un errore |
Recuperare i dati GL
Per recuperare l'insieme di oggetti GLData in base a criteri di filtro, utilizzare il comando Retrieve GL Data . Ogni oggetto restituito corrisponde a una riga di Dati GL nel database.
Chiamata API equivalente: https://help.planful.com/v1/docs/gldata-retrieve-api
Proprietà
Proprietà |
Dettaglio |
Filtri |
Inserire i filtri di prova. |
Output
Output |
Tipo di output |
Dati GLD (CSV) |
File |
Conteggio dei record |
Numero intero |
Codici di uscita
Codice |
Tipo |
Dettaglio |
0 |
Operazione completata |
Operazione completata |
1 |
Errore |
Si è verificato un errore |
Recuperare i dati del segmento1
Per recuperare una raccolta di oggetti Segmento1 in base a criteri di filtro, utilizzare il comando Retrieve Segment1 Data . Ogni oggetto restituito corrisponde a una riga di dati del segmento1 nel database.
Chiamata API equivalente: https://help.planful.com/v1/docs/segment1-retrieve
Proprietà
Proprietà |
Dettaglio |
Filtri |
Inserire i filtri di prova. |
Output
Output |
Tipo di output |
Dati del segmento1 (CSV) |
File |
Conteggio dei record |
Numero intero |
Codici di uscita
Codice |
Tipo |
Dettaglio |
0 |
Operazione completata |
Operazione completata |
1 |
Errore |
Si è verificato un errore |
Recuperare i dati del segmento2
Per recuperare una collezione di oggetti Segment2 in base a criteri di filtro, utilizzare il comando Retrieve Segment2 Data . Ogni oggetto restituito corrisponde a una riga di dati del segmento2 nel database.
Chiamata API equivalente: https://help.planful.com/v1/docs/segment2-retrieve
Proprietà
Proprietà |
Dettaglio |
Filtri |
Inserire i filtri di prova. |
Output
Output |
Tipo di output |
Dati del segmento2 (CSV) |
File |
Conteggio dei record |
Numero intero |
Codici di uscita
Codice |
Tipo |
Dettaglio |
0 |
Operazione completata |
Operazione completata |
1 |
Errore |
Si è verificato un errore |
Recuperare i dati del segmento3
Per recuperare un insieme di oggetti Segment3 in base a criteri di filtro, utilizzare il comando Retrieve Segment3 Data . Ogni oggetto restituito corrisponde a una riga di dati del segmento3 nel database.
Chiamata API equivalente: https://help.planful.com/v1/docs/segment3-retrieve
Proprietà
Proprietà |
Dettaglio |
Filtri |
Inserire i filtri di prova. |
Output
Output |
Tipo di output |
Dati del segmento3 (CSV) |
File |
Conteggio dei record |
Numero intero |
Codici di uscita
Codice |
Tipo |
Dettaglio |
0 |
Operazione completata |
Operazione completata |
1 |
Errore |
Si è verificato un errore |
Recuperare i dati del segmento4
Per recuperare una collezione di oggetti Segment4 in base a criteri di filtro, utilizzare il comando Retrieve Segment4 Data . Ogni oggetto restituito corrisponde a una riga di dati del segmento4 nel database.
Chiamata API equivalente: https://help.planful.com/v1/docs/segment4-retrieve
Proprietà
Proprietà |
Dettaglio |
Filtri |
Inserire i filtri di prova. |
Output
Output |
Tipo di output |
Dati del segmento4 (CSV) |
File |
Conteggio dei record |
Numero intero |
Codici di uscita
Codice |
Tipo |
Dettaglio |
0 |
Operazione completata |
Operazione completata |
1 |
Errore |
Si è verificato un errore |
Recuperare i dati del segmento5
Per recuperare una raccolta di oggetti Segment5 in base a criteri di filtro, utilizzare il comando Retrieve Segment5 Data . Ogni oggetto restituito corrisponde a una riga di dati del segmento5 nel database.
Chiamata API equivalente: https://help.planful.com/v1/docs/segment5-retrieve
Proprietà
Proprietà |
Dettaglio |
Filtri |
Inserire i filtri di prova. |
Output
Output |
Tipo di output |
Dati del segmento5 (CSV) |
File |
Conteggio dei record |
Numero intero |
Codici di uscita
Codice |
Tipo |
Dettaglio |
0 |
Operazione completata |
Operazione completata |
1 |
Errore |
Si è verificato un errore |
Recuperare i dati del segmento6
Per recuperare un insieme di oggetti Segment6 in base a criteri di filtro, utilizzare il comando Retrieve Segment6 Data . Ogni oggetto restituito corrisponde a una riga di dati del segmento6 nel database.
Chiamata API equivalente: https://help.planful.com/v1/docs/segment6-retrieve
Proprietà
Proprietà |
Dettaglio |
Filtri |
Inserire i filtri di prova. |
Output
Output |
Tipo di output |
Dati del segmento6 (CSV) |
File |
Conteggio dei record |
Numero intero |
Codici di uscita
Codice |
Tipo |
Dettaglio |
0 |
Operazione completata |
Operazione completata |
1 |
Errore |
Si è verificato un errore |
Recuperare i dati del segmento7
Per recuperare una raccolta di oggetti Segment7 in base a criteri di filtro, utilizzare il comando Retrieve Segment7 Data . Ogni oggetto restituito corrisponde a una riga di dati del segmento7 nel database.
Chiamata API equivalente: https://help.planful.com/v1/docs/segment7-retrieve
Proprietà
Proprietà |
Dettaglio |
Filtri |
Inserire i filtri di prova. |
Output
Output |
Tipo di output |
Dati del segmento7 (CSV) |
File |
Conteggio dei record |
Numero intero |
Codici di uscita
Codice |
Tipo |
Dettaglio |
0 |
Operazione completata |
Operazione completata |
1 |
Errore |
Si è verificato un errore |
Recuperare i dati del segmento8
Per recuperare una raccolta di oggetti Segment8 in base a criteri di filtro, utilizzare il comando Retrieve Segment8 Data . Ogni oggetto restituito corrisponde a una riga di dati del segmento8 nel database.
Chiamata API equivalente: https://help.planful.com/v1/docs/segment8-retrieve
Proprietà
Proprietà |
Dettaglio |
Filtri |
Inserire i filtri di prova. |
Output
Output |
Tipo di output |
Dati del segmento8 (CSV) |
File |
Conteggio dei record |
Numero intero |
Codici di uscita
Codice |
Tipo |
Dettaglio |
0 |
Operazione completata |
Operazione completata |
1 |
Errore |
Si è verificato un errore |
Esegui report
Per eseguire un report e restituirne i risultati come JSON, utilizzare il comando Run Report .
Chiamata API equivalente: N/D
Proprietà
Proprietà |
Dettaglio |
Codice rapporto |
Inserire il nome o il codice del report da eseguire. |
Stirpe |
Inserire la posizione del report in Planful. Utilizzare // come separatori nel percorso. |
Nome del cubo |
Inserire il nome del cubo associato al report. |
Filtri |
Inserire i filtri da applicare al report. |
Applica i filtri |
Selezionare se applicare i filtri. |
Output
Output |
Tipo di output |
Report |
JSON |
Rapporto (CSV) |
File |
Conteggio dei record |
Numero intero |
Codici di uscita
Codice |
Tipo |
Dettaglio |
0 |
Operazione completata |
Operazione completata |
1 |
Errore |
Si è verificato un errore |
Trasferimento dei dati
Per trasferire i dati della tabella di staging alla tabella di destinazione in Planful in base a un codice regola, utilizzare il comando Transfer Data .
Chiamata API equivalente: https://help.planful.com/v1/docs/new-transfer-data-rest-api
Proprietà
Proprietà |
Dettaglio |
Regola |
Immettere il nome (codice) della regola in cui caricare i dati |
Output
Nessuno
Codici di uscita
Codice |
Tipo |
Dettaglio |
0 |
Operazione completata |
Operazione completata |
1 |
Errore |
Si è verificato un errore |