Hvis du vil aktivere kommunikasjon med Planful®-miljøet (tidligere Host Analytics®) via tjenestens publiserte REST API-grensesnitt som en del av en kjede, legger du til et trinn med en Planful-tilkoblingskommando.
For å aktivere disse kommandoene må en IT-administrator først opprette en Planful-kontakt.
Tøm data
Hvis du vil tømme mellomlagringstabelldataene basert på en regelkode, bruker du kommandoen Clear Data.
Tilsvarende API-kall: https://help.planful.com/v1/docs/clear-data-1
Egenskaper
| Egenskap |
Detaljer |
| Regel |
Skriv inn navnet eller koden til regelen du vil laste inn data i. |
Utganger
Ingen
Utgangskoder
| Kode |
Type |
Detaljer |
| 0 |
Vellykket |
Vellykket |
| 1 |
Feil |
Det oppsto en feil |
Hent liste over rapporter
For å hente en liste over tilgjengelige rapporter bruker du kommandoen Get Reports List.
Tilsvarende API-kall: N/A
Egenskaper
| Egenskap |
Detaljer |
| Søk i mappen |
Angi mappen som rapportene skal hentes fra. |
| Rapporttype |
Angi hvilken type rapport du vil filtrere på. |
Utganger
| Utdata |
Type utgang |
| Rapporter |
JSON |
Utgangskoder
| Kode |
Type |
Detaljer |
| 0 |
Vellykket |
Vellykket |
| 1 |
Feil |
Det oppsto en feil |
Hent versjon
Hvis du vil hente versjonen av Planful-forekomsten din, bruker du kommandoen Get Version.
Tilsvarende API-kall: https://help.planful.com/v1/docs/getversion-api
Egenskaper
Ingen
Utganger
| Utdata |
Type utgang |
| Navn på applikasjon |
Streng |
| Versjon |
Streng |
Utgangskoder
| Kode |
Type |
Detaljer |
| 0 |
Vellykket |
Vellykket |
| 1 |
Feil |
Det oppsto en feil |
Last inn data
For å laste inn data i staging-tabeller i Planful-applikasjonen bruker du kommandoen Load Data.
Tilsvarende API-kall: https://help.planful.com/v1/docs/load-data-external-source-models
Egenskaper
| Egenskap |
Detaljer |
| Regel |
Skriv inn navnet eller koden til regelen du vil laste inn data i. |
| Data |
Skriv inn filen som inneholder dataene som skal lastes inn i Rule. Hver linje skal være en egen oppføring. |
| Skilletegn |
Velg skilletegnet som brukes i hver linje for å skille Data i kolonner. |
Utganger
| Utdata |
Type utgang |
| Antall poster |
Heltall |
Utgangskoder
| Kode |
Type |
Detaljer |
| 0 |
Vellykket |
Vellykket |
| 1 |
Feil |
Det oppsto en feil |
Hent GL-data
For å hente samlingen av GLData-objekter basert på filterkriterier, bruker du kommandoen Retrieve GL Data. Hvert objekt som returneres, tilsvarer en rad med GL-data i databasen.
Tilsvarende API-kall: https://help.planful.com/v1/docs/gldata-retrieve-api
Egenskaper
| Egenskap |
Detaljer |
| Filtre |
Skriv inn testfiltrene. |
Utganger
| Utdata |
Type utgang |
| GLData (CSV) |
Fil |
| Antall poster |
Heltall |
Utgangskoder
| Kode |
Type |
Detaljer |
| 0 |
Vellykket |
Vellykket |
| 1 |
Feil |
Det oppsto en feil |
Hent data fra Segment1
Hvis du vil hente en samling Segment1-objekter basert på filterkriterier, bruker du kommandoen Retrieve Segment1 Data. Hvert objekt som returneres, tilsvarer en datarad i segment1 i databasen.
Tilsvarende API-kall: https://help.planful.com/v1/docs/segment1-retrieve
Egenskaper
| Egenskap |
Detaljer |
| Filtre |
Skriv inn testfiltrene. |
Utganger
| Utdata |
Type utgang |
| Segment1-data (CSV) |
Fil |
| Antall poster |
Heltall |
Utgangskoder
| Kode |
Type |
Detaljer |
| 0 |
Vellykket |
Vellykket |
| 1 |
Feil |
Det oppsto en feil |
Hent data fra Segment2
Hvis du vil hente en samling Segment2-objekter basert på filterkriterier, bruker du kommandoen Retrieve Segment2 Data. Hvert objekt som returneres, tilsvarer en datarad i segment2 i databasen.
Tilsvarende API-kall: https://help.planful.com/v1/docs/segment2-retrieve
Egenskaper
| Egenskap |
Detaljer |
| Filtre |
Skriv inn testfiltrene. |
Utganger
| Utdata |
Type utgang |
| Segment2-data (CSV) |
Fil |
| Antall poster |
Heltall |
Utgangskoder
| Kode |
Type |
Detaljer |
| 0 |
Vellykket |
Vellykket |
| 1 |
Feil |
Det oppsto en feil |
Hent data fra Segment3
Hvis du vil hente en samling Segment3-objekter basert på filterkriterier, bruker du kommandoen Retrieve Segment3 Data. Hvert objekt som returneres, tilsvarer en datarad i segment3 i databasen.
Tilsvarende API-kall: https://help.planful.com/v1/docs/segment3-retrieve
Egenskaper
| Egenskap |
Detaljer |
| Filtre |
Skriv inn testfiltrene. |
Utganger
| Utdata |
Type utgang |
| Segment3-data (CSV) |
Fil |
| Antall poster |
Heltall |
Utgangskoder
| Kode |
Type |
Detaljer |
| 0 |
Vellykket |
Vellykket |
| 1 |
Feil |
Det oppsto en feil |
Hent segment4-data
Hvis du vil hente en samling Segment4-objekter basert på filterkriterier, bruker du kommandoen Retrieve Segment4 Data. Hvert objekt som returneres, tilsvarer en datarad i segment4 i databasen.
Tilsvarende API-kall: https://help.planful.com/v1/docs/segment4-retrieve
Egenskaper
| Egenskap |
Detaljer |
| Filtre |
Skriv inn testfiltrene. |
Utganger
| Utdata |
Type utgang |
| Segment4-data (CSV) |
Fil |
| Antall poster |
Heltall |
Utgangskoder
| Kode |
Type |
Detaljer |
| 0 |
Vellykket |
Vellykket |
| 1 |
Feil |
Det oppsto en feil |
Hent data fra Segment5
Hvis du vil hente en samling Segment5-objekter basert på filterkriterier, bruker du kommandoen Retrieve Segment5 Data. Hvert objekt som returneres, tilsvarer en datarad i segment5 i databasen.
Tilsvarende API-kall: https://help.planful.com/v1/docs/segment5-retrieve
Egenskaper
| Egenskap |
Detaljer |
| Filtre |
Skriv inn testfiltrene. |
Utganger
| Utdata |
Type utgang |
| Segment5-data (CSV) |
Fil |
| Antall poster |
Heltall |
Utgangskoder
| Kode |
Type |
Detaljer |
| 0 |
Vellykket |
Vellykket |
| 1 |
Feil |
Det oppsto en feil |
Hent data fra Segment6
Hvis du vil hente en samling Segment6-objekter basert på filterkriterier, bruker du kommandoen Retrieve Segment6 Data. Hvert objekt som returneres, tilsvarer en datarad i segment6 i databasen.
Tilsvarende API-kall: https://help.planful.com/v1/docs/segment6-retrieve
Egenskaper
| Egenskap |
Detaljer |
| Filtre |
Skriv inn testfiltrene. |
Utganger
| Utdata |
Type utgang |
| Segment6-data (CSV) |
Fil |
| Antall poster |
Heltall |
Utgangskoder
| Kode |
Type |
Detaljer |
| 0 |
Vellykket |
Vellykket |
| 1 |
Feil |
Det oppsto en feil |
Hent data fra Segment7
Hvis du vil hente en samling Segment7-objekter basert på filterkriterier, bruker du kommandoen Retrieve Segment7 Data. Hvert objekt som returneres, tilsvarer en datarad i segment7 i databasen.
Tilsvarende API-kall: https://help.planful.com/v1/docs/segment7-retrieve
Egenskaper
| Egenskap |
Detaljer |
| Filtre |
Skriv inn testfiltrene. |
Utganger
| Utdata |
Type utgang |
| Segment7-data (CSV) |
Fil |
| Antall poster |
Heltall |
Utgangskoder
| Kode |
Type |
Detaljer |
| 0 |
Vellykket |
Vellykket |
| 1 |
Feil |
Det oppsto en feil |
Hent data fra Segment8
Hvis du vil hente en samling Segment8-objekter basert på filterkriterier, bruker du kommandoen Retrieve Segment8 Data. Hvert objekt som returneres, tilsvarer en datarad i segment8 i databasen.
Tilsvarende API-kall: https://help.planful.com/v1/docs/segment8-retrieve
Egenskaper
| Egenskap |
Detaljer |
| Filtre |
Skriv inn testfiltrene. |
Utganger
| Utdata |
Type utgang |
| Segment8-data (CSV) |
Fil |
| Antall poster |
Heltall |
Utgangskoder
| Kode |
Type |
Detaljer |
| 0 |
Vellykket |
Vellykket |
| 1 |
Feil |
Det oppsto en feil |
Kjør rapport
Hvis du vil kjøre en rapport og returnere resultatene som JSON, bruker du kommandoen Run Report.
Tilsvarende API-kall: N/A
Egenskaper
| Egenskap |
Detaljer |
| Rapportkode |
Skriv inn navnet eller koden på rapporten som skal kjøres. |
| Avstamning |
Angi hvor rapporten ligger i Planful. Bruk // som skilletegn i stien. |
| Navn på kuben |
Skriv inn navnet på kuben som er knyttet til rapporten. |
| Filtre |
Angi filtrene som skal brukes på rapporten. |
| Bruk filtre |
Velg om filtrene skal brukes. |
Utganger
| Utdata |
Type utgang |
| Rapport |
JSON |
| Rapport (CSV) |
Fil |
| Antall poster |
Heltall |
Utgangskoder
| Kode |
Type |
Detaljer |
| 0 |
Vellykket |
Vellykket |
| 1 |
Feil |
Det oppsto en feil |
Overfør data
Hvis du vil overføre data fra mellomlagringstabellen til destinasjonstabellen i Planful basert på en regelkode, bruker du kommandoen Transfer Data.
Tilsvarende API-kall: https://help.planful.com/v1/docs/new-transfer-data-rest-api
Egenskaper
| Egenskap |
Detaljer |
| Regel |
Skriv inn navnet (koden) på regelen som data skal lastes inn i |
Utganger
Ingen
Utgangskoder
| Kode |
Type |
Detaljer |
| 0 |
Vellykket |
Vellykket |
| 1 |
Feil |
Det oppsto en feil |