För att möjliggöra kommunikation med din Planful®-miljö (tidigare Host Analytics®-miljö) via tjänstens publicerade REST API-gränssnitt som en del av en kedja, lägg till ett steg med ett Planful-anslutningskommando.
För att aktivera dessa kommandon skapar en IT-administratör först en Planful-anslutning.
Rensa data
Om du vill rensa data i staging-tabellen baserat på en regelkod använder du kommandot Clear Data.
Motsvarande API-anrop: https://help.planful.com/v1/docs/clear-data-1
Egenskaper
| Egenskap |
Detalj |
| Regel |
Ange namn eller kod för den regel som data ska laddas till. |
Utdata
Ingen
Utgångskoder
| Kod |
Typ |
Detalj |
| 0 |
Lyckades |
Lyckades |
| 1 |
Fel |
Det uppstod ett fel |
Hämta rapportlista
Om du vill hämta en lista över tillgängliga rapporter använder du kommandot Get Reports List.
Motsvarande API-anrop: EJ TILLÄMPLIGT
Egenskaper
| Egenskap |
Detalj |
| Sök mapp |
Ange den mapp som rapporterna ska hämtas från. |
| Typ av rapport |
Ange vilken typ av rapport som ska filtreras. |
Utdata
| Utdata |
Typ av utgång |
| Rapporter |
JSON |
Utgångskoder
| Kod |
Typ |
Detalj |
| 0 |
Lyckades |
Lyckades |
| 1 |
Fel |
Det uppstod ett fel |
Hämta version
Om du vill hämta versionen av din Planful-instans använder du kommandot Get Version.
Motsvarande API-anrop: https://help.planful.com/v1/docs/getversion-api
Egenskaper
Ingen
Utdata
| Utdata |
Typ av utgång |
| Applikationens namn |
Sträng |
| Version |
Sträng |
Utgångskoder
| Kod |
Typ |
Detalj |
| 0 |
Lyckades |
Lyckades |
| 1 |
Fel |
Det uppstod ett fel |
Ladda data
För att ladda data till staging-tabeller i Planful-programmet använder du kommandot Load Data.
Motsvarande API-anrop: https://help.planful.com/v1/docs/load-data-external-source-models
Egenskaper
| Egenskap |
Detalj |
| Regel |
Ange namn eller kod för den regel som data ska laddas till. |
| Data |
Ange den arkivering som innehåller de data som ska läsas in i Rule. Varje rad ska vara en separat post. |
| Avgränsare |
Välj den avgränsare som används inom varje rad för att dela upp Data i kolumner. |
Utdata
| Utdata |
Typ av utgång |
| Antal poster |
Heltal |
Utgångskoder
| Kod |
Typ |
Detalj |
| 0 |
Lyckades |
Lyckades |
| 1 |
Fel |
Det uppstod ett fel |
Hämta GL-data
Om du vill hämta en samling GLData-objekt baserat på filterkriterier använder du kommandot Retrieve GL Data. Varje objekt som returneras motsvarar en rad med GL-data i databasen.
Motsvarande API-anrop: https://help.planful.com/v1/docs/gldata-retrieve-api
Egenskaper
| Egenskap |
Detalj |
| Filter |
Ange testfiltren. |
Utdata
| Utdata |
Typ av utgång |
| GLData (CSV) |
Fil |
| Antal poster |
Heltal |
Utgångskoder
| Kod |
Typ |
Detalj |
| 0 |
Lyckades |
Lyckades |
| 1 |
Fel |
Det uppstod ett fel |
Hämta data från Segment1
Om du vill hämta en samling Segment1-objekt baserat på filterkriterier använder du kommandot Retrieve Segment1 Data. Varje objekt som returneras motsvarar en datarad för segment1 i databasen.
Motsvarande API-anrop: https://help.planful.com/v1/docs/segment1-retrieve
Egenskaper
| Egenskap |
Detalj |
| Filter |
Ange testfiltren. |
Utdata
| Utdata |
Typ av utgång |
| Segment1-data (CSV) |
Fil |
| Antal poster |
Heltal |
Utgångskoder
| Kod |
Typ |
Detalj |
| 0 |
Lyckades |
Lyckades |
| 1 |
Fel |
Det uppstod ett fel |
Hämta data från Segment2
Om du vill hämta en samling Segment2-objekt baserat på filterkriterier använder du kommandot Retrieve Segment2 Data. Varje objekt som returneras motsvarar en datarad för segment2 i databasen.
Motsvarande API-anrop: https://help.planful.com/v1/docs/segment2-retrieve
Egenskaper
| Egenskap |
Detalj |
| Filter |
Ange testfiltren. |
Utdata
| Utdata |
Typ av utgång |
| Segment2 data (CSV) |
Fil |
| Antal poster |
Heltal |
Utgångskoder
| Kod |
Typ |
Detalj |
| 0 |
Lyckades |
Lyckades |
| 1 |
Fel |
Det uppstod ett fel |
Hämta data från Segment3
Om du vill hämta en samling Segment3-objekt baserat på filterkriterier använder du kommandot Retrieve Segment3 Data. Varje objekt som returneras motsvarar en datarad för segment3 i databasen.
Motsvarande API-anrop: https://help.planful.com/v1/docs/segment3-retrieve
Egenskaper
| Egenskap |
Detalj |
| Filter |
Ange testfiltren. |
Utdata
| Utdata |
Typ av utgång |
| Segment3-data (CSV) |
Fil |
| Antal poster |
Heltal |
Utgångskoder
| Kod |
Typ |
Detalj |
| 0 |
Lyckades |
Lyckades |
| 1 |
Fel |
Det uppstod ett fel |
Hämta data från Segment4
Om du vill hämta en samling Segment4-objekt baserat på filterkriterier använder du kommandot Retrieve Segment4 Data. Varje objekt som returneras motsvarar en datarad för segment4 i databasen.
Motsvarande API-anrop: https://help.planful.com/v1/docs/segment4-retrieve
Egenskaper
| Egenskap |
Detalj |
| Filter |
Ange testfiltren. |
Utdata
| Utdata |
Typ av utgång |
| Segment4-data (CSV) |
Fil |
| Antal poster |
Heltal |
Utgångskoder
| Kod |
Typ |
Detalj |
| 0 |
Lyckades |
Lyckades |
| 1 |
Fel |
Det uppstod ett fel |
Hämta data från Segment5
Om du vill hämta en samling Segment5-objekt baserat på filterkriterier använder du kommandot Retrieve Segment5 Data. Varje objekt som returneras motsvarar en datarad för segment5 i databasen.
Motsvarande API-anrop: https://help.planful.com/v1/docs/segment5-retrieve
Egenskaper
| Egenskap |
Detalj |
| Filter |
Ange testfiltren. |
Utdata
| Utdata |
Typ av utgång |
| Segment5-data (CSV) |
Fil |
| Antal poster |
Heltal |
Utgångskoder
| Kod |
Typ |
Detalj |
| 0 |
Lyckades |
Lyckades |
| 1 |
Fel |
Det uppstod ett fel |
Hämta data från Segment6
Om du vill hämta en samling Segment6-objekt baserat på filterkriterier använder du kommandot Retrieve Segment6 Data. Varje objekt som returneras motsvarar en datarad för segment6 i databasen.
Motsvarande API-anrop: https://help.planful.com/v1/docs/segment6-retrieve
Egenskaper
| Egenskap |
Detalj |
| Filter |
Ange testfiltren. |
Utdata
| Utdata |
Typ av utgång |
| Segment6-data (CSV) |
Fil |
| Antal poster |
Heltal |
Utgångskoder
| Kod |
Typ |
Detalj |
| 0 |
Lyckades |
Lyckades |
| 1 |
Fel |
Det uppstod ett fel |
Hämta data från Segment7
Om du vill hämta en samling Segment7-objekt baserat på filterkriterier använder du kommandot Retrieve Segment7 Data. Varje objekt som returneras motsvarar en datarad för segment7 i databasen.
Motsvarande API-anrop: https://help.planful.com/v1/docs/segment7-retrieve
Egenskaper
| Egenskap |
Detalj |
| Filter |
Ange testfiltren. |
Utdata
| Utdata |
Typ av utgång |
| Segment7-data (CSV) |
Fil |
| Antal poster |
Heltal |
Utgångskoder
| Kod |
Typ |
Detalj |
| 0 |
Lyckades |
Lyckades |
| 1 |
Fel |
Det uppstod ett fel |
Hämta data från Segment8
Om du vill hämta en samling Segment8-objekt baserat på filterkriterier använder du kommandot Retrieve Segment8 Data. Varje objekt som returneras motsvarar en datarad för segment8 i databasen.
Motsvarande API-anrop: https://help.planful.com/v1/docs/segment8-retrieve
Egenskaper
| Egenskap |
Detalj |
| Filter |
Ange testfiltren. |
Utdata
| Utdata |
Typ av utgång |
| Segment8-data (CSV) |
Fil |
| Antal poster |
Heltal |
Utgångskoder
| Kod |
Typ |
Detalj |
| 0 |
Lyckades |
Lyckades |
| 1 |
Fel |
Det uppstod ett fel |
Kör rapport
Om du vill köra en rapport och returnera resultaten som JSON använder du kommandot Run Report.
Motsvarande API-anrop: EJ TILLÄMPLIGT
Egenskaper
| Egenskap |
Detalj |
| Rapportkod |
Ange namn eller kod för den rapport som ska köras. |
| Härkomst |
Ange var rapporten bor i Planful. Använd // som separatorer i sökvägen. |
| Kubens namn |
Ange namnet på den kub som är kopplad till rapporten. |
| Filter |
Ange de filter som ska tillämpas på rapporten. |
| Tillämpa filter |
Välj om filtren ska tillämpas. |
Utdata
| Utdata |
Typ av utgång |
| Rapport |
JSON |
| Rapport (CSV) |
Fil |
| Antal poster |
Heltal |
Utgångskoder
| Kod |
Typ |
Detalj |
| 0 |
Lyckades |
Lyckades |
| 1 |
Fel |
Det uppstod ett fel |
Överföring av data
Om du vill överföra data från staging-tabellen till måltabellen i Planful baserat på en regelkod använder du kommandot Transfer Data.
Motsvarande API-anrop: https://help.planful.com/v1/docs/new-transfer-data-rest-api
Egenskaper
| Egenskap |
Detalj |
| Regel |
Ange namnet (koden) på den regel som data ska laddas in i |
Utdata
Ingen
Utgångskoder
| Kod |
Typ |
Detalj |
| 0 |
Lyckades |
Lyckades |
| 1 |
Fel |
Det uppstod ett fel |