Pour permettre la communication avec votre environnement Planful® - anciennement Host Analytics® - via l'interface API REST publiée du service dans le cadre d'une chaîne, ajoutez une étape avec une commande de connexion Planful.
Pour activer ces commandes, un administrateur informatique crée d'abord un connecteur Planful.
Effacer les données
Pour effacer les données de la table de stadification en fonction d'un code de règle, utilisez la commande Clear Data.
Appel API équivalent : https://help.planful.com/v1/docs/clear-data-1
Propriétés
| Propriété |
Détail |
| Règle |
Saisissez le nom ou le code de la règle dans laquelle les données doivent être chargées. |
Sorties
Aucun
Codes de sortie
| Code |
Type |
Détail |
| 0 |
Réussite |
Réussite |
| 1 |
Erreur |
Une erreur s'est produite |
Obtenir la liste des rapports
Pour obtenir une liste des rapports disponibles, utilisez la commande Get Reports List.
Appel API équivalent : N/A
Propriétés
| Propriété |
Détail |
| Dossier de recherche |
Saisissez le dossier à partir duquel vous souhaitez récupérer les rapports. |
| Type de rapport |
Saisissez le type de rapport à filtrer. |
Sorties
| Sortie |
Type de sortie |
| Rapports |
JSON |
Codes de sortie
| Code |
Type |
Détail |
| 0 |
Réussite |
Réussite |
| 1 |
Erreur |
Une erreur s'est produite |
Obtenir la version
Pour récupérer la version de votre instance Planful, utilisez la commande Get Version.
Appel API équivalent : https://help.planful.com/v1/docs/getversion-api
Propriétés
Aucune
Sorties
| Sortie |
Type de sortie |
| Nom de l'application |
Chaîne |
| Version |
Chaîne |
Codes de sortie
| Code |
Type |
Détail |
| 0 |
Réussite |
Réussite |
| 1 |
Erreur |
Une erreur s'est produite |
Données de chargement
Pour charger des données dans les tables de préparation de l'application Planful, utilisez la commande Load Data.
Appel API équivalent : https://help.planful.com/v1/docs/load-data-external-source-models
Propriétés
| Propriété |
Détail |
| Règle |
Saisissez le nom ou le code de la règle dans laquelle les données doivent être chargées. |
| Données |
Saisissez le fichier contenant les données à charger dans Rule. Chaque ligne doit faire l'objet d'une entrée distincte. |
| Séparateur |
Sélectionnez le délimiteur utilisé à l'intérieur de chaque ligne pour séparer les données en colonnes. |
Sorties
| Sortie |
Type de sortie |
| Nombre d'enregistrements |
Entier |
Codes de sortie
| Code |
Type |
Détail |
| 0 |
Réussite |
Réussite |
| 1 |
Erreur |
Une erreur s'est produite |
Récupérer les données des GL
Pour récupérer la collection d'objets GLData en fonction de critères de filtrage, utilisez la commande Retrieve GL Data. Chaque objet renvoyé correspond à une ligne de données GL dans la base de données.
Appel API équivalent : https://help.planful.com/v1/docs/gldata-retrieve-api
Propriétés
| Propriété |
Détail |
| Filtres |
Saisissez les filtres de test. |
Sorties
| Sortie |
Type de sortie |
| GLData (CSV) |
Fichier |
| Nombre d’enregistrements |
Entier |
Codes de sortie
| Code |
Type |
Détail |
| 0 |
Réussite |
Réussite |
| 1 |
Erreur |
Une erreur s'est produite |
Récupérer les données du segment 1
Pour récupérer une collection d'objets Segment1 en fonction de critères de filtrage, utilisez la commande Retrieve Segment1 Data. Chaque objet renvoyé correspond à une ligne de données du segment1 dans la base de données.
Appel API équivalent : https://help.planful.com/v1/docs/segment1-retrieve
Propriétés
| Propriété |
Détail |
| Filtres |
Saisissez les filtres de test. |
Sorties
| Sortie |
Type de sortie |
| Données du segment 1 (CSV) |
Fichier |
| Nombre d’enregistrements |
Entier |
Codes de sortie
| Code |
Type |
Détail |
| 0 |
Réussite |
Réussite |
| 1 |
Erreur |
Une erreur s'est produite |
Récupérer les données du segment 2
Pour récupérer une collection d'objets Segment2 en fonction de critères de filtrage, utilisez la commande Retrieve Segment2 Data. Chaque objet renvoyé correspond à une ligne de données du segment2 dans la base de données.
Appel API équivalent : https://help.planful.com/v1/docs/segment2-retrieve
Propriétés
| Propriété |
Détail |
| Filtres |
Saisissez les filtres de test. |
Sorties
| Sortie |
Type de sortie |
| Données du segment 2 (CSV) |
Fichier |
| Nombre d’enregistrements |
Entier |
Codes de sortie
| Code |
Type |
Détail |
| 0 |
Réussite |
Réussite |
| 1 |
Erreur |
Une erreur s'est produite |
Récupérer les données du segment 3
Pour récupérer une collection d'objets Segment3 en fonction de critères de filtrage, utilisez la commande Retrieve Segment3 Data. Chaque objet renvoyé correspond à une ligne de données du segment3 dans la base de données.
Appel API équivalent : https://help.planful.com/v1/docs/segment3-retrieve
Propriétés
| Propriété |
Détail |
| Filtres |
Saisissez les filtres de test. |
Sorties
| Sortie |
Type de sortie |
| Données du segment3 (CSV) |
Fichier |
| Nombre d’enregistrements |
Entier |
Codes de sortie
| Code |
Type |
Détail |
| 0 |
Réussite |
Réussite |
| 1 |
Erreur |
Une erreur s'est produite |
Récupérer les données du segment 4
Pour récupérer une collection d'objets Segment4 en fonction de critères de filtrage, utilisez la commande Retrieve Segment4 Data. Chaque objet renvoyé correspond à une ligne de données du segment4 dans la base de données.
Appel API équivalent : https://help.planful.com/v1/docs/segment4-retrieve
Propriétés
| Propriété |
Détail |
| Filtres |
Saisissez les filtres de test. |
Sorties
| Sortie |
Type de sortie |
| Données du segment 4 (CSV) |
Fichier |
| Nombre d’enregistrements |
Entier |
Codes de sortie
| Code |
Type |
Détail |
| 0 |
Réussite |
Réussite |
| 1 |
Erreur |
Une erreur s'est produite |
Récupérer les données du segment 5
Pour récupérer une collection d'objets Segment5 en fonction de critères de filtrage, utilisez la commande Retrieve Segment5 Data. Chaque objet renvoyé correspond à une ligne de données du segment5 dans la base de données.
Appel API équivalent : https://help.planful.com/v1/docs/segment5-retrieve
Propriétés
| Propriété |
Détail |
| Filtres |
Saisissez les filtres de test. |
Sorties
| Sortie |
Type de sortie |
| Données du segment5 (CSV) |
Fichier |
| Nombre d’enregistrements |
Entier |
Codes de sortie
| Code |
Type |
Détail |
| 0 |
Réussite |
Réussite |
| 1 |
Erreur |
Une erreur s'est produite |
Récupérer les données du segment 6
Pour récupérer une collection d'objets Segment6 en fonction de critères de filtrage, utilisez la commande Retrieve Segment6 Data. Chaque objet renvoyé correspond à une ligne de données du segment6 dans la base de données.
Appel API équivalent : https://help.planful.com/v1/docs/segment6-retrieve
Propriétés
| Propriété |
Détail |
| Filtres |
Saisissez les filtres de test. |
Sorties
| Sortie |
Type de sortie |
| Données du segment6 (CSV) |
Fichier |
| Nombre d’enregistrements |
Entier |
Codes de sortie
| Code |
Type |
Détail |
| 0 |
Réussite |
Réussite |
| 1 |
Erreur |
Une erreur s'est produite |
Récupérer les données du segment 7
Pour récupérer une collection d'objets Segment7 en fonction de critères de filtrage, utilisez la commande Retrieve Segment7 Data. Chaque objet renvoyé correspond à une ligne de données du segment7 dans la base de données.
Appel API équivalent : https://help.planful.com/v1/docs/segment7-retrieve
Propriétés
| Propriété |
Détail |
| Filtres |
Saisissez les filtres de test. |
Sorties
| Sortie |
Type de sortie |
| Données du segment7 (CSV) |
Fichier |
| Nombre d’enregistrements |
Entier |
Codes de sortie
| Code |
Type |
Détail |
| 0 |
Réussite |
Réussite |
| 1 |
Erreur |
Une erreur s'est produite |
Récupérer les données du segment 8
Pour récupérer une collection d'objets Segment8 en fonction de critères de filtrage, utilisez la commande Retrieve Segment8 Data. Chaque objet renvoyé correspond à une ligne de données du segment8 dans la base de données.
Appel API équivalent : https://help.planful.com/v1/docs/segment8-retrieve
Propriétés
| Propriété |
Détail |
| Filtres |
Saisissez les filtres de test. |
Sorties
| Sortie |
Type de sortie |
| Données du segment8 (CSV) |
Fichier |
| Nombre d’enregistrements |
Entier |
Codes de sortie
| Code |
Type |
Détail |
| 0 |
Réussite |
Réussite |
| 1 |
Erreur |
Une erreur s'est produite |
Exécuter le rapport
Pour exécuter un rapport et renvoyer ses résultats sous forme de JSON, utilisez la commande Run Report.
Appel API équivalent : N/A
Propriétés
| Propriété |
Détail |
| Code du rapport |
Saisissez le nom ou le code du rapport à exécuter. |
| Lignée |
Indiquez l'emplacement du rapport dans Planful. Utilisez // comme séparateurs dans le chemin d'accès. |
| Nom du cube |
Saisissez le nom du cube associé au rapport. |
| Filtres |
Saisissez les filtres à appliquer au rapport. |
| Appliquer les filtres |
Choisissez d'appliquer ou non les filtres. |
Sorties
| Sortie |
Type de sortie |
| Rapport |
JSON |
| Rapport (CSV) |
Fichier |
| Nombre d’enregistrements |
Entier |
Codes de sortie
| Code |
Type |
Détail |
| 0 |
Réussite |
Réussite |
| 1 |
Erreur |
Une erreur s'est produite |
Transfert de données
Pour transférer les données de la table de préparation vers la table de destination dans Planful en fonction d'un code de règle, utilisez la commande Transfer Data.
Appel API équivalent : https://help.planful.com/v1/docs/new-transfer-data-rest-api
Propriétés
| Propriété |
Détail |
| Règle |
Saisir le nom (code) de la règle dans laquelle les données doivent être chargées |
Sorties
Aucune
Codes de sortie
| Code |
Type |
Détail |
| 0 |
Réussite |
Réussite |
| 1 |
Erreur |
Une erreur s'est produite |