Om communicatie met uw Planful®-voorheen Host Analytics®-omgeving mogelijk te maken via de gepubliceerde REST API-interface van de service als onderdeel van een keten, voegt u een stap toe met een Planful verbindingsopdracht.
Om deze opdrachten in te schakelen, maakt een IT-beheerder eerst een Planful-connector.
Gegevens wissen
Om de gegevens van de stagingtabel op basis van een regelcode te wissen, gebruikt u een opdracht Clear Data .
Equivalente API-oproep: https://help.planful.com/v1/docs/clear-data-1
Eigenschappen
| Eigendom |
Detail |
| Regel |
Voer de naam of code in van de regel waarin u gegevens wilt laden. |
Uitgangen
Geen
Afsluitcodes
| Code |
type |
Detail |
| 0 |
Succes |
Succes |
| 1 |
Fout |
Er is een fout opgetreden |
Lijst met rapporten opvragen
Om een lijst met beschikbare rapporten op te halen, gebruikt u de opdracht Get Reports List .
Gelijkwaardige API-aanroep: N/A
Eigenschappen
| Eigendom |
Detail |
| Zoek map |
Voer de map in waaruit u rapporten wilt ophalen. |
| Type rapport |
Voer het type rapport in waarop gefilterd moet worden. |
Uitgangen
| Uitgang |
Type uitvoer |
| Rapporten |
JSON |
Afsluitcodes
| Code |
type |
Detail |
| 0 |
Succes |
Succes |
| 1 |
Fout |
Er is een fout opgetreden |
Versie krijgen
Om de versie van uw Planful-instantie op te vragen, gebruikt u de opdracht Get Version .
Equivalente API-oproep: https://help.planful.com/v1/docs/getversion-api
Eigenschappen
Geen
Uitgangen
| Uitgang |
Type uitvoer |
| Naam toepassing |
String |
| Versie |
String |
Afsluitcodes
| Code |
type |
Detail |
| 0 |
Succes |
Succes |
| 1 |
Fout |
Er is een fout opgetreden |
Gegevens laden
Om gegevens in de stagingtabellen van de Planful-toepassing te laden, gebruikt u een opdracht Load Data .
Equivalente API-oproep: https://help.planful.com/v1/docs/load-data-external-source-models
Eigenschappen
| Eigendom |
Detail |
| Regel |
Voer de naam of code in van de regel waarin u gegevens wilt laden. |
| Gegevens |
Voer het bestand in dat de gegevens bevat die in Rulegeladen moeten worden. Elke regel moet een aparte vermelding zijn. |
| Scheidingsteken |
Selecteer het scheidingsteken dat binnen elke regel wordt gebruikt om Data in kolommen te scheiden. |
Uitgangen
| Uitgang |
Type uitvoer |
| Aantal records |
Geheel getal |
Afsluitcodes
| Code |
type |
Detail |
| 0 |
Succes |
Succes |
| 1 |
Fout |
Er is een fout opgetreden |
GL-gegevens ophalen
Om de verzameling GLData-objecten op basis van filtercriteria op te halen, gebruikt u een opdracht GL Data ophalen . Elk geretourneerd object komt overeen met een rij GL-gegevens in de database.
Equivalente API-oproep: https://help.planful.com/v1/docs/gldata-retrieve-api
Eigenschappen
| Eigendom |
Detail |
| Filters |
Voer de testfilters in. |
Uitgangen
| Uitgang |
Type uitvoer |
| GLData (CSV) |
Bestand |
| Aantal records |
Geheel getal |
Afsluitcodes
| Code |
type |
Detail |
| 0 |
Succes |
Succes |
| 1 |
Fout |
Er is een fout opgetreden |
Gegevens segment1 ophalen
Om een verzameling Segment1-objecten op te halen op basis van filtercriteria, gebruikt u een opdracht Retrieve Segment1 Data . Elk geretourneerd object komt overeen met een gegevensrij van segment1 in de database.
Equivalente API-oproep: https://help.planful.com/v1/docs/segment1-retrieve
Eigenschappen
| Eigendom |
Detail |
| Filters |
Voer de testfilters in. |
Uitgangen
| Uitgang |
Type uitvoer |
| Segment1 gegevens (CSV) |
Bestand |
| Aantal records |
Geheel getal |
Afsluitcodes
| Code |
type |
Detail |
| 0 |
Succes |
Succes |
| 1 |
Fout |
Er is een fout opgetreden |
Segment2-gegevens ophalen
Om een verzameling Segment2-objecten op te halen op basis van filtercriteria, gebruikt u een opdracht Retrieve Segment2 Data . Elk geretourneerd object komt overeen met een gegevensrij van segment2 in de database.
Equivalente API-oproep: https://help.planful.com/v1/docs/segment2-retrieve
Eigenschappen
| Eigendom |
Detail |
| Filters |
Voer de testfilters in. |
Uitgangen
| Uitgang |
Type uitvoer |
| Segment2-gegevens (CSV) |
Bestand |
| Aantal records |
Geheel getal |
Afsluitcodes
| Code |
type |
Detail |
| 0 |
Succes |
Succes |
| 1 |
Fout |
Er is een fout opgetreden |
Segment3-gegevens ophalen
Om een verzameling Segment3-objecten op te halen op basis van filtercriteria, gebruikt u een opdracht Retrieve Segment3 Data . Elk geretourneerd object komt overeen met een gegevensrij van segment3 in de database.
Equivalente API-oproep: https://help.planful.com/v1/docs/segment3-retrieve
Eigenschappen
| Eigendom |
Detail |
| Filters |
Voer de testfilters in. |
Uitgangen
| Uitgang |
Type uitvoer |
| Segment3-gegevens (CSV) |
Bestand |
| Aantal records |
Geheel getal |
Afsluitcodes
| Code |
type |
Detail |
| 0 |
Succes |
Succes |
| 1 |
Fout |
Er is een fout opgetreden |
Segment4-gegevens ophalen
Om een verzameling Segment4-objecten op te halen op basis van filtercriteria, gebruikt u een opdracht Retrieve Segment4 Data . Elk geretourneerd object komt overeen met een gegevensrij van segment4 in de database.
Equivalente API-oproep: https://help.planful.com/v1/docs/segment4-retrieve
Eigenschappen
| Eigendom |
Detail |
| Filters |
Voer de testfilters in. |
Uitgangen
| Uitgang |
Type uitvoer |
| Segment4 gegevens (CSV) |
Bestand |
| Aantal records |
Geheel getal |
Afsluitcodes
| Code |
type |
Detail |
| 0 |
Succes |
Succes |
| 1 |
Fout |
Er is een fout opgetreden |
Segment5-gegevens ophalen
Als u een verzameling Segment5-objecten wilt ophalen op basis van filtercriteria, gebruikt u de opdracht Retrieve Segment5 Data . Elk geretourneerd object komt overeen met een gegevensrij van segment5 in de database.
Equivalente API-oproep: https://help.planful.com/v1/docs/segment5-retrieve
Eigenschappen
| Eigendom |
Detail |
| Filters |
Voer de testfilters in. |
Uitgangen
| Uitgang |
Type uitvoer |
| Segment5-gegevens (CSV) |
Bestand |
| Aantal records |
Geheel getal |
Afsluitcodes
| Code |
type |
Detail |
| 0 |
Succes |
Succes |
| 1 |
Fout |
Er is een fout opgetreden |
Segment6-gegevens ophalen
Om een verzameling Segment6-objecten op te halen op basis van filtercriteria, gebruikt u een opdracht Retrieve Segment6 Data . Elk geretourneerd object komt overeen met een gegevensrij van segment6 in de database.
Equivalente API-oproep: https://help.planful.com/v1/docs/segment6-retrieve
Eigenschappen
| Eigendom |
Detail |
| Filters |
Voer de testfilters in. |
Uitgangen
| Uitgang |
Type uitvoer |
| Segment6-gegevens (CSV) |
Bestand |
| Aantal records |
Geheel getal |
Afsluitcodes
| Code |
type |
Detail |
| 0 |
Succes |
Succes |
| 1 |
Fout |
Er is een fout opgetreden |
Segment7-gegevens ophalen
Om een verzameling Segment7-objecten op te halen op basis van filtercriteria, gebruikt u een opdracht Retrieve Segment7 Data . Elk geretourneerd object komt overeen met een gegevensrij van segment7 in de database.
Equivalente API-oproep: https://help.planful.com/v1/docs/segment7-retrieve
Eigenschappen
| Eigendom |
Detail |
| Filters |
Voer de testfilters in. |
Uitgangen
| Uitgang |
Type uitvoer |
| Segment7-gegevens (CSV) |
Bestand |
| Aantal records |
Geheel getal |
Afsluitcodes
| Code |
type |
Detail |
| 0 |
Succes |
Succes |
| 1 |
Fout |
Er is een fout opgetreden |
Segment8 gegevens ophalen
Om een verzameling Segment8-objecten op te halen op basis van filtercriteria, gebruikt u een opdracht Retrieve Segment8 Data . Elk geretourneerd object komt overeen met een gegevensrij van segment8 in de database.
Equivalente API-oproep: https://help.planful.com/v1/docs/segment8-retrieve
Eigenschappen
| Eigendom |
Detail |
| Filters |
Voer de testfilters in. |
Uitgangen
| Uitgang |
Type uitvoer |
| Segment8 gegevens (CSV) |
Bestand |
| Aantal records |
Geheel getal |
Afsluitcodes
| Code |
type |
Detail |
| 0 |
Succes |
Succes |
| 1 |
Fout |
Er is een fout opgetreden |
Rapport uitvoeren
Om een rapport uit te voeren en de resultaten als JSON terug te sturen, gebruikt u de opdracht Run Report .
Gelijkwaardige API-aanroep: N/A
Eigenschappen
| Eigendom |
Detail |
| Meld code |
Voer de naam of code in van het rapport dat u wilt uitvoeren. |
| Stamboom |
Voer in waar het rapport zich bevindt in Planful. Gebruik // als scheidingstekens in het pad. |
| Kubusnaam |
Voer de naam in van de kubus die bij het rapport hoort. |
| Filters |
Voer de filters in die u op het rapport wilt toepassen. |
| Filters toepassen |
Selecteer of u de filters wilt toepassen. |
Uitgangen
| Uitgang |
Type uitvoer |
| Rapporteer |
JSON |
| Rapport (CSV) |
Bestand |
| Aantal records |
Geheel getal |
Afsluitcodes
| Code |
type |
Detail |
| 0 |
Succes |
Succes |
| 1 |
Fout |
Er is een fout opgetreden |
Gegevens overbrengen
Om de gegevens van de stagingtabel naar de bestemmingstabel in Planful over te brengen op basis van een regelcode, gebruikt u een opdracht Transfer Data .
Equivalente API-oproep: https://help.planful.com/v1/docs/new-transfer-data-rest-api
Eigenschappen
| Eigendom |
Detail |
| Regel |
Voer de naam (code) in van de regel om gegevens in te laden |
Uitgangen
Geen
Afsluitcodes
| Code |
type |
Detail |
| 0 |
Succes |
Succes |
| 1 |
Fout |
Er is een fout opgetreden |