Versions
Point de terminaison de l'URL
HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/versions
HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/cloneVersion
( POST uniquement)
Version : v1
Catégorie | Soumission, modification et récupération des métadonnées |
Description | Modification des métadonnées |
Autorisations requises pour appeler | |
Paramètres obligatoires dans la demande | Varie pour le point de terminaison :
PATCH, POST, SUPPRESSION : nom de la version. aucun pour GET |
VERB(S) HTTP pris en charge
(Note : les dossiers de version ne sont pas pris en charge pour aucun des points de terminaison ci-dessous)
Version HTTP | Ressource unique | Ressources de recouvrement | Description |
|---|---|---|---|
GET | Non pris en charge | Prise en charge | Récupérez toutes les versions de l'environnement client. |
DELETE | Prise en charge | Non pris en charge | Supprimer la version à supprimer existante. |
PATCH | Prise en charge | Non pris en charge | Créer/mettre à jour des versions de montants réels ou mettre à jour des versions de plan. |
POST | Prise en charge | Non pris en charge | Créez une nouvelle version du plan. |
GET
- URI de la demande
- /api/res/modeling/v1/{tenant}/versions :récupère toutes les versions de l'environnement clientRécupère toutes les versions de l'environnement client dans une liste.Les propriétés non affichées dans l'interface utilisateur pour des versions spécifiques ne sont pas incluses dans les objets de version correspondants de la réponse. Par exemple, startOfVersion pour les sous-versions de montants réels.Possibilité d'utiliser la pagination via les paramètres 'limite' et 'décalage'.Les propriétés de version suivantes ne sont pas prises en charge/ne s'affichent pas dans GET :Version de base (pour les versions virtuelles), activer le reporting en devise constante (pour les versions virtuelles).Calculer les valeurs de formule, Accès administrateur, Accès utilisateur, Accès aux feuilles modifiables, Accès privilégié aux montants réels, Groupe, Périmètre d'accès du groupe.Exemple d'URI de demande :HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/versions?limit=25&offset=1Exemple de corps de la demande :<Laissez un champ vide>Paramètres de la requête :NomDescriptionObligatoirelimitLe nombre maximum d'objets dans une même réponse.NdécalageIndex à base zéro du premier objet dans une collection de réponse. La valeur par défaut est 0.Utilisez le décalage avec le paramètre de limite pour contrôler la pagination d'un ensemble de réponses.NParamètres de chemin :NomDescriptionObligatoiretenantEnvironnement client sur lequel baser les opérations, par exemple GreencoO
- Exemple de réponse
- 200 OKRemarque : le Début de la version pour les versions de montants réels et la Limite de défilement à gauche des versions de plan sont tous deux affichés sous la propriété startOfVersion (pointeur A).De même, la Fin de la version pour les versions de montants réels et la Fin du plan pour les versions de plan sont toutes deux affichées sous la propriété endOfVersion (pointeur D).L'Emplacement de départ du défilement pour les versions de montants réels et le Début du plan des versions de plan sont tous deux affichés sous la propriété de l'Emplacement de défilement (pointeur C).Réponse réussie.Exemple de réponse{ "data": [ { "name": "Test-Actuals-Version", "shortName": "Test-Actuals-Version-Shortname", "versionType": "ACTUALS", ... "lockLeadingCompletion": true }, { "name": "JE Sub under Actuals", "shortName": "JE01", "parent": "Actuals", ... "journalEntryVersion": true, "journalEntryVersionProperties": { "journalEntryNumbering": "N", "startingNumber": 0 }, ... }, ... ], "limit": 12, "offset": 4, "total": 12 }
DELETE
- Demander
- /api/res/modeling/v1/{tenant}/versions :supprimer une version existanteSupprime la version avec le nom de version indiqué.La version des montants réels racine et la version par défaut ne peuvent pas être supprimées.Exemple d'URI de demande :HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/versions?versionName={versionName}Exemple de corps de la demande :<Laissez un champ vide>Paramètres de requêteNomDescriptionObligatoireversionNameNom de la version existante à supprimer.OinstanceCodeinstanceCode à partir de laquelle extraire les valeurs. Par exemple, GLOBO. Si aucun code d'instance n'est spécifié, l'instance par défaut de l'utilisateur est utilisée.NParamètres de cheminNomDescriptionObligatoiretenantEnvironnement client sur lequel baser les opérations, par exemple GreencoO
- Exemple de réponse
- 204 NO_CONTENT
- La réponse réussie est vide avec le code de statut 204.
PATCH
- Demande :
- /api/res/modeling/v1/{tenant}/versions :créer/mettre à jour des versions de montants réels ou mettre à jour des versions de plan.Si l'identifiant de version indiqué existe, met à jour la version de montants réels/plan existante. Si ce n'est pas le cas, crée une nouvelle version de montants réels avec cet identifiant.Il existe actuellement deux ensembles d'identifiants de version pris en charge via des paramètres de requête :-nom de la versionUn et un seul des paramètres de requête ci-dessus doit être indiqué dans l'URL pour chaque appel.Exemple d'URI de demande :HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/versions?versionName={versionName}Corps de la demande-JSON contenant les propriétés de version à mettre à jour pour la version existante ou à spécifier pour la nouvelle version à créer.Mettre à jour :-Pour les mises à jour, aucune propriété spécifique n'est requise dans le corps de la demande (à l'exception de versionType), mais un corps de demande reste nécessaire. La section du corps de la demande dePOSTreprend le plan de la liste des propriétés pour différents types de version du plan.- Les propriétés de l'indicateur (par exemple journalEntryVersion) ne peuvent pas être mises à jour ; mais elles peuvent toujours rester dans le corps de la demande tant que leur valeur reste inchangée.- La mise à jour du parent n'est pas prise en charge actuellement.-Lors de la mise à jour de versions non feuilles (versions avec enfants), les groupes d'utilisateurs de ces versions peuvent uniquement avoir le type d'accès "FULL_ACCESS" ou "HIDEND". "FULL_ACCESS" apparaît sous la forme et correspond à "Visible" dans l'interface utilisateur.- Les données d'accès au groupe (identifiant du groupe et périmètre d'accès du groupe) peuvent être supprimées en indiquant groupId=0 dans le corps de la demande d'un appel de mise à jour.Créez :-Pour les créations, les propriétés suivantes sont disponibles pour spécification dans le corps de la demande :PropriétésDescriptionObligatoire (pour les montants réels)Obligatoire (pour l'écriture)Nom de la propriété dans le corps de la demandeType de valeurValeur par défautNom abrégéNom abrégé de la version.NNshortNameStringchaîne videParentParent de cette version.NNparentChaîne (nom de la version)version de montants réels racineType de versionType de version (ACTUALS ou PLANNING)Y, ACTUALSY, ACTUALSversionTypeStringDescriptionDescriptionNNdescriptionStringchaîne videAccès administrateursPérimètre d'accès à la version pour les administrateurs.NNaccèsadministrateursVersionAccessControlhérité du parentAccès utilisateurPérimètre d'accès à la version pour les utilisateurs.NNuserAccessVersionAccessControlhérité du parentAccès privilégié aux montants réelsPérimètre d'accès à la version pour toute personne disposant de l'autorisation Accès privilégié aux montants réels.NNprivilegedActualsAccessVersionAccessControlhérité du parentCode du groupeUn identifiant de groupe d'utilisateurs spécifiéNNgroupIdIntegerhérité du parentPérimètre d'accès du groupePérimètre d'accès à la version du groupe d'utilisateurs indiqué.O si l'identifiant du groupe est indiqué.O si l'identifiant du groupe est indiqué.groupAccessLevelVersionAccessControlhérité du parentPiste d'auditConserver/supprimer les informations de la piste d'audit.NNaudit finalBooleanfalse (hérité du parent pour les versions des écritures)Version des écrituresSi la version à créer est une écriture.NO, vraijournalEntryVersionBooleanreturnIdRenvoie un identifiant de version s'il est défini sur true (vrai). Identifiant de la nouvelle version si l'opération a créé une nouvelle version. Sinon, il renvoie l'identifiant de la version existante qui a été mise à jour.NNreturnIdBooleanfalse (renvoie 204 Aucun contenu avec la valeur false (faux), elle renvoie 200 OK avec la version dans la réponse si la valeur est définie sur true (vrai)- Le type de valeur VersionAccess Contrôle peut prendre en charge les valeurs de chaîne suivantes : "HIDFD", "LOCKED", "LOCKED_EXUP_NOTATES", "IMport_ AND_NOTE", "FULL_ACCESS"- Les identifiants de groupe peuvent être obtenus via l'API publique exportGroups.- Les versions des écritures ne sont pas prises en charge pour les unités légales avec la consolidation désactivée.Propriétés de la version des écritures :Les propriétés suivantes existent sous l'objet imbriqué journalEntryVersionProperties (voir un exemple de corps de demande) et ne sont utilisées que pour les versions des écritures :PropriétésDescriptionObligatoire (pour les montants réels)Obligatoire (pour les écritures)Nom de la propriété dans le corps de la demandeType de valeurValeur par défautNumérotation des écrituresIndiquez comment les écritures seront numérotées. Elles peuvent être configurées automatiquement (A), manuelles (M) ou aucune (N).InutiliséNjournalEntryNumberingStringaucun (N)PréfixePréfixe de numérotation des écrituresInutiliséO si la numérotation des écritures est automatique (A) ou manuelle (M)préfixeStringNuméro de départNuméro de départ de la numérotation des écrituresInutiliséO si numérotation des écritures (A)startingNumberIntegerPropriétés racines spécifiques aux montants réels :Les propriétés suivantes sont utilisées uniquement lors de la mise à jour des montants réels racines :PropriétésDescriptionObligatoireNom de la propriété dans le corps de la demandeType de valeurDébut de la versionDébut de la versionNstartOfVersionChaîne (code de la période)Fin de la versionFin de la versionNendOfVersionChaîne (code de la période)Emplacement de début du défilementEmplacement de début du défilement de la versionNstartingScrollLocationChaîne (code de la période)Valeurs complètes jusqu'auLorsque la superposition des montants réels sur la version du plan s'arrêteNcompletedValuesThroughChaîne (code de la période)Activer le workflowVous permet de soumettre les montants réels par périmètre dans Workflow.NendableWorkflowBooleanExemple de corps de la demande :Corps de la demande{ "parent": "Parent Version", "versionType": "ACTUALS", ... "administratorsAccess": "FULL_ACCESS", "usersAccess": "IMPORT_AND_NOTES", ... ... "auditTrail": true }Exemple de corps de la demande pour les versions avec propriétés imbriquées (versions des écritures comptables et versions virtuelles) :Corps de la demande{ "parent": "Actuals", "versionType": "ACTUALS", "shortName": "test JE version", "journalEntryVersion": "true", "journalEntryVersionProperties": { "journalEntryNumbering": "A", "prefix": "JE-Prefix", "startingNumber": "25" }, ... "auditTrail": true }Paramètres de la requête :NomDescriptionObligatoireversionNameNom de la nouvelle version à créer ou de la version existante à mettre à jour.OproceedWithWarningsParamètre de requête facultatif utilisé pour ignorer les messages d'avertissement. Si la valeur n'est pas activée, les avertissements potentiels seront renvoyés avant l'exécution de l'appel. Ignorez-les en spécifiant ce paramètre à true (vrai) dans l'URL.NinstanceCodeinstanceCode à partir de laquelle extraire les valeurs. Par exemple, GLOBO. Si aucun code d'instance n'est spécifié, l'instance par défaut de l'utilisateur est utilisée.NParamètres de chemin :NomDescriptionObligatoiretenantEnvironnement client sur lequel baser les opérations, par exemple GreencoOPropriétés de l'accès à la publication :Les propriétés de corps de demande suivantes sont utilisées uniquement lorsque WD est activé :
- Exemple de réponse
- 204 NO_CONTENTLa réponse réussie est vide avec le code de statut 204.
POST
- Demande :
- /api/res/modeling/v1/{tenant}/cloneVersion :créer une nouvelle version du planCrée une nouvelle version de plan ou de prédiction via le clonage d'une version source/par défaut, ou crée une version virtuelle.Il existe actuellement deux ensembles d'identifiants de version pris en charge via des paramètres de requête :-nom de la nouvelle versionL'une et une seule des options ci-dessus doivent être indiquées dans l'URL pour chaque appelExemple d'URI de demande :HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/cloneVersion?newVersionName=Budget 2012& sourceVersionName=Budget 2011& copyAllData=true& copySharedFormulasAndRules=true& copyAllOverrideFormulas=falseCorps de la demande :JSON contenant les propriétés de version à spécifier pour la nouvelle version à créer.NomDescriptionObligatoire (pour le plan)Obligatoire (pour prédictif)Obligatoire (pour virtuel)Nom de la propriété dans le corps de la demandeType de valeurValeur par défautNom abrégéNom abrégé de la version.NNNshortNameStringchaîne videParentDossier parent de cette version.NNNparentChaîne (nom du dossier)Type de versionType de version (ACTUALS ou PLANNING)Y, PLANNINGY, PLANNINGY, PLANNINGversionTypeStringDescriptionDescription.NNNdescriptionStringchaîne videVersion verrouilléePermet de verrouiller la version tout entière pour l'ensemble des utilisateurs, y compris les formules principales et les autres formules de compte.NInutiliséInutilisélockedVersionBooleanhérité de la version sourceCalculer les valeurs de formuleDisponible pour les versions de plan dont l'option Version verrouillée est sélectionnée. Utilisé pour conserver les résultats des formules et les références dans la plupart des comptes, et pour améliorer les performances des versions verrouillées.NInutiliséInutilisécalculateFormulaValuesBooleanfalseAccès administrateursPérimètre d'accès à la version pour les administrateurs.NNNaccèsadministrateursVersionAccessControlhérité de la version source (Plan) ; import_and_notes (prédictif) VERROUILLÉ ( connexion virtuelle)Accès utilisateursPérimètre d'accès à la version pour les utilisateurs.NNNusersAccessVersionAccessControlhérité de la version source (Plan) ; import_and_notes (prédictif) VERROUILLÉ ( connexion virtuelle)Accès en modification aux feuillesPérimètre d'accès à la version pour tous ceux qui ont l'autorisation Accès en modification aux feuilles.NNNeditableSheetAccessVersionAccessControlhérité de la version source (Plan, Prédictif)Code du groupeL'identifiant d'un groupe d'utilisateurs défini.NNNgroupIdIntegerhérité de la version source (Plan, Prédictif)Périmètre d'accèsPérimètre d'accès à la version du groupe d'utilisateurs indiqué.NNNgroupAccessLevelVersionAccessControlhérité de la version source (Plan, Prédictif)Limite de défilement à gaucheLimite de défilement à gauche de la version.NNInutiliséstartOfVersionChaîne (code de la période)hérité de la version sourceFin du planFin du planNNInutiliséendOfPlanChaîne (code de la période)hérité de la version sourceDébut du planDébut du planNNInutiliséstartOfPlanChaîne (code de la période)hérité de la version sourceVerrouiller la période de débutRend des périodes spécifiées de données non modifiables dans la version. Affichage de l'option "Verrouiller le(s) précédent(e)s strate(s) de feuille} jusqu'à" sur l'interface utilisateur.NInutiliséInutilisélockLeadingTimePeriodChaîne (code de la période)hérité de la version sourceVerrouiller le cours de finalisation principalL'option "Paramètres {feuille de strate}" pour la propriété ci-dessus. Cette propriété et "Verrouiller la période de début" ne peuvent pas être indiquées en même temps dans le corps de la demande.NInutiliséInutilisélockLeadingCompletionBooleanhérité de la version sourcePar défautLa version devient celle par défaut pour tous les utilisateurs.NInutiliséInutilisépar défautBooleanfalsePiste d'auditConserver/supprimer les informations de la piste d'audit.NNInutiliséaudit finalBooleanhérité de la version sourceLa superposition des montants réels inclut les périmètres non disponiblesAffiche tous les périmètres, même ceux qui ne sont plus utilisés, dans les superpositions de montants réels.NNInutiliséactualsOverlayIncludesUnavailableLevelsBooleanfalseVersion des montants réels pour superpositionSuperpose les données de la version de montants réels indiquée sur les données du plan.NNInutiliséactualsVersionOverlayChaîne (nom de la version)version de montants réels racineExplorer l'identifiant des transactionsPermet d'explorer les transactions pour la version.NNInutilisédrillIntoTransactionIdIntegerrapport par défautVersion prédictiveSi la version à créer est une version prédictive.InutiliséO, vraiInutilisépredictiveVersionBooleanVersion virtuelleSi la version à créer est une version virtuelle.InutiliséInutiliséO, vraivirtualVersionBooleanreturnIdElle renvoie un identifiant de version s'il est paramétré sur true (vrai). Identifiant de la nouvelle version si l'opération a créé une nouvelle version. Sinon, il renvoie l'identifiant de la version existante qui a été mise à jour.NNNreturnIdBooleanfalse (renvoie 204 Aucun contenu avec la valeur false (faux), elle renvoie 200 OK avec la version dans la réponse si la valeur est définie sur true (vrai)- Le type de valeur VersionAccess Contrôle peut prendre en charge les valeurs de chaîne suivantes : "HIDFD", "LOCKED", "LOCKED_EXUP_NOTATES", "IMport_ AND_NOTE", "FULL_ACCESS"- Les versions de plan verrouillées ne peuvent avoir aucun groupe d'utilisateurs, avec les valeurs "IMport_ AND_NOTE" ou "FULL_ACCESS".- L'option "FULL_ACCESS" peut être définie pour les versions prédictives pour aucun groupe d'utilisateurs.-Les versions virtuelles peuvent seulement avoir les valeurs "MASQUÉ" ou "VERROUILLÉ" pour n'importe quel groupe d'utilisateurs.- Impossible de créer des versions de plan et de prédiction prédictive pour les unités légales pour lesquelles la consolidation est activée sans la planification.Propriétés de la version virtuelleLes propriétés suivantes existent sous l'objet imbriqué VirtualVersionProperties et ne sont utilisées que pour les versions virtuelles :NomDescriptionObligatoire (pour le plan)Obligatoire (pour prédictif)Obligatoire (pour virtuel)Nom de la propriété dans le corps de la demandeType de valeurValeur par défautVersion de baseLa version qui fournira les données de base pour la version virtuelle. Ne peut pas être une version virtuelle ou une sous-version de montants réels.InutiliséInutiliséNbaseVersionChaîne (nom de la version)version par défautVersion du taux de changeLa version qui fournira le taux de change pour la version virtuelle utilisée pour les rapports en devise constante. Ne peut pas être une version virtuelle ou une sous-version de montants réels.InutiliséInutiliséNexchangeRateVersionChaîne (nom de la version)version de montants réels racineActiver les rapports en devise constanteActive/Désactiver le reporting en devise constante.InutiliséInutiliséNenableConstantCurrencyReportingBooleanfalseDécalageMontant du décalage en arrière (entier positif) ou en avant (entier négatif).InutiliséInutiliséNoffsetInteger0Propriétés d'accès à la publicationLes propriétés de corps de demande suivantes sont utilisées uniquement lorsque WD est activé :NomDescriptionObligatoire (pour le plan)Obligatoire (pour prédictif)Obligatoire (pour virtuel)Nom de la propriété dans le corps de la demandeType de valeurValeur par défautPlans financiersActiver/Désactiver les plans financiers pour cette version.Uniquement utilisé lorsque Adaptive Planning for Financial Plans est activé.NInutiliséInutiliséfinancialPlansBooleanfalsePlans d'effectifActiver/Désactiver les plans d'effectif pour cette version.Uniquement utilisé lorsque Adaptive Planning for Financial Plans ou Adaptive Planning for the Workforce est activé.NInutiliséInutiliséheadcountPlansBooleanfalsePlans d'action de personnelActiver/Désactiver les plans d'action de personnel pour cette version.Uniquement utilisé lorsque Adaptive Planning for the Workforce est activé.NInutiliséInutiliséworkforceActionPlansBooleanfalse
- Exemple de corps de demandeCorps de la demande{ "parent": "Parent Folder", "versionType": "PLANNING", "description": "Test Plan Version", ... ... "usersAccess": "LOCKED_EXCEPT_NOTES", "editableSheetAccess": "LOCKED", ... "startOfVersion": "2012", "endOfVersion": "2013", "startingScrollLocation": "01/2012", "lockLeadingTimePeriod": "02/2012", "actualsOverlayIncludesUnavailableLevels": true }Paramètres de requêteNomDescriptionObligatoire (pour le plan)Obligatoire (pour prédictif)Obligatoire (pour virtuel)Nom du paramètre dans l'URLValeur par défautNom de la version sourceNom de la version à cloner. Si aucune option n'est indiquée, clone le compte de la version par défaut.NNInutilisésourceVersionNameNom de la nouvelle versionNom de la nouvelle version à créer.OOOnewVersionNameCopier toutes les donnéesSi la valeur est true (vrai), copie toutes les données.NInutiliséInutilisécopyAllDatafalseCopier les règles et les formules partagéesSi la valeur est true (vrai), copie les règles et les formules partagées.NInutiliséInutilisécopySharedFormulasAndRulesfalseCopier toutes les formules de remplacementSi la valeur est true (vrai), copie toutes les formules de remplacement.NNInutilisécopyAllOverrideFormulasfalseCopier les subdivisions dans les comptes GL et personnalisésSi la valeur est true, copie les subdivisions dans les comptes GL et personnalisés.NInutiliséInutilisécopySplitsInGLAndCustomAccountsfalseCopier les lignes modèlesSi la valeur est true, copie les lignes modèles.NInutiliséInutilisécopyModeledRowsfalseCopier les notes de cellule, de feuille et de workflowSi la valeur est true, copie les notes de cellule, de feuille et de workflow (le cas échéant).NInutiliséInutilisécopyAllNotesfalseRéinitialiser le workflow avec le statut En coursSi la valeur est true, réinitialise le workflow avec le statut En cours.NInutiliséInutiliséresetWorkflowStatusToInProgressfalseCopier l'historique de la piste d'auditSi la valeur est true, s'ajoute comme choix du paramètre de rapport à tous les rapports.InutiliséInutilisécopyAuditTrailHistoryfalseAjouter comme choix de paramètres de rapport dans tous les rapportsSi la valeur est true, s'ajoute comme choix du paramètre de rapport à tous les rapports.NInutiliséInutiliséaddAsReportParameterChoiceToAllReportsfalseCopier les valeurs recalculées des feuillesSi la valeur est true (vrai), copie les valeurs recalculées des feuilles.NInutiliséInutilisécopyRecalculatedValuesOfSheetsfalseContinuer avec des avertissementsParamètre de requête facultatif utilisé pour ignorer les messages d'avertissement. Si la valeur n'est pas activée, les avertissements potentiels seront renvoyés avant l'exécution de l'appel. Ignorez-les en spécifiant ce paramètre à true (vrai) dans l'URL.NNNproceedWithWarningsfalseCode de l'instanceinstanceCode à partir de laquelle extraire les valeurs. Par exemple, GLOBO. Si aucun code d'instance n'est spécifié, l'instance par défaut de l'utilisateur est utilisée.NNNinstanceCodeInstance par défaut de l'utilisateur- l'option Réinitialiser le workflow avec le statut En cours n'est pas prise en charge pour les unités légales avec le workflow désactivé.- L'option "Copier les valeurs recalculées de feuilles" n'est pas prise en charge si l'indicateur de la fonctionnalité INSTRUCTIONS DU MODÉLait est désactivé.Paramètres de chemin :NomDescriptionObligatoiretenantEnvironnement client sur lequel baser les opérations, par exemple GreencoO
- Exemple de réponse :
- 204 NO_CONTENTLa réponse réussie est vide avec le code de statut 204.