Versions
Point de terminaison de l'adresse URL
HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/versions
HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/cloneVersion
(Poster uniquement)
Version : v1
Catégorie | Soumission, modification et récupération de métadonnées |
Description | Modification de métadonnées |
Autorisations obligatoires pour être appelées | |
Paramètres requis pour la demande | Variations pour le point de terminaison :
PATCH, POST, SUPPRESSION : nom de la version. aucune pour GET |
VERB(s) HTTP pris en charge
(Note : Les dossiers de version ne sont pris en charge pour aucun des points de terminaison ci-dessous)
Configurer HTTP | Ressource unique | Ressource de recouvrement | Description |
|---|---|---|---|
GET | Non pris en charge | Pris en charge | Récupérez toutes les versions du locataire. |
SUPPRIMER | Pris en charge | Non pris en charge | Supprimez la version pouvant être supprimée existante. |
PATCH | Pris en charge | Non pris en charge | Créer/mettre à jour des versions de chiffres réels ou mettre à jour des versions de plans. |
POST | Pris en charge | Non pris en charge | Créez une nouvelle version du plan. |
GET
- URI de la demande
- /api/res/modélisation/v1/{tenant}/versions :récupère toutes les versions du locataireRécupère toutes les versions du locataire dans une liste.Les propriétés qui ne sont pas affichées dans l’interface utilisateur pour des versions précises ne sont pas incluses dans les objets de version correspondants dans la réponse. Par exemple, startOfVersion pour les versions de sous-chiffres réels.Possibilité d'utiliser la pagination via les paramètres 'limite' et 'décalage'.Les propriétés de version suivantes ne sont actuellement pas prises en charge/affichées dans GET :Version de base (pour les versions virtuelles), activez les rapports en devises constantes (pour les versions virtuelles),Calculer les valeurs des formules, accès administrateur, accès utilisateur, accès aux feuilles modifiables, accès privilégié aux chiffres réels, groupe, niveau d’accès de groupe.URI de la demande exemple :HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/versions?limit=25&offset=1Corps de la demande d'exemple :<Laisser en blanc>Paramètres d'interrogation :NomDescriptionObligatoirelimitLe nombre maximum d’objets dans une seule réponse.NoffreL’index de zéro du premier objet dans une collection de réponses. La valeur par défaut est 0.Utilisez la valeur de décalage avec le paramètre de limite pour contrôler la pagination d’une collection de réponses.NParamètres de chemin :NomDescriptionObligatoiretenantLe locataire sur lequel effectuer l’opération, par exemple GreencoY
- Exemple de réponse
- 200 OKRemarque : le début de la version pour les versions des chiffres réels et la limite de défilement à gauche pour les versions de plans sont tous deux affichés sous la propriété startOfVersion (pointeur A).De même, la fin de la version pour les versions des chiffres réels et la fin du plan pour les versions de plans sont toutes deux affichées sous la propriété endOfVersion (pointeur D).L’emplacement de défilement de début pour les versions des chiffres réels et le début du plan pour les versions de plans sont tous deux affichés sous la propriété startScrollLocation (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 }
SUPPRIMER
- Demande
- /api/res/modélisation/v1/{tenant}/versions :supprimer une version existanteSupprime la version avec le nom de version indiqué.La version des chiffres réels racine et la version par défaut ne peuvent pas être supprimées.URI de la demande exemple :HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/versions?versionName={versionName}Corps de la demande d'exemple :<Laisser en blanc>Paramètres d'interrogationNomDescriptionObligatoireversionNameNom de la version existante à supprimer.YinstanceCodeInstanceCode à partir de laquelle extraire des valeurs. Par exemple, GLOBO. Si aucun instanceCode n’est indiquée, l’instance par défaut de l’utilisateur est utilisée.NParamètres de cheminNomDescriptionObligatoiretenantLe locataire sur lequel effectuer l’opération, par exemple GreencoY
- Exemple de réponse
- 204 NO_CONTENT
- La réponse réussie est vide avec le code de statut 204.
PATCH
- Demande :
- /api/res/modélisation/v1/{tenant}/versions :créer/mettre à jour des versions de chiffres réels ou mettre à jour des versions de plans.Si l’identifiant de version indiqué existe, met à jour la version des chiffres réels/du plan existante. Sinon, crée une nouvelle version des chiffres réels à l’aide de cet identifiant.Il existe actuellement deux ensembles d’identifiants de version pris en charge par les paramètres d’interrogation :-nom de versionUn et un seul des paramètres d'interrogation ci-dessus doit être indiqué dans l'adresse URL pour chaque appel.URI de la demande exemple :HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/versions?versionName={versionName}Corps de la demande-JSON contenant les propriétés de la version à mettre à jour pour la version existante ou à préciser 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 est tout de même nécessaire. La section du corps de la demande dePOSTdresse la liste des propriétés pour différents types de versions de Plan.- Les propriétés de l'indicateur (par exemple, journalEntryVersion) ne peuvent pas être mises à jour; Toutefois, ils peuvent toujours rester dans le corps de la demande tant qu’ils ont la bonne valeur inchangée.- La mise à jour des parents n'est pas prise en charge actuellement.Lors de la mise à jour de versions non feuilles (versions qui ont des enfants), les groupes d’utilisateurs de ces versions peuvent uniquement avoir les types d’accès « FULL_ACCESS » ou « HIDDEN » types d’accès. « FULL_accès » s'affiche comme « visible » dans l’interface utilisateur et il équivaut à « visible » dans l’interface utilisateur.-Détails de l’accès au groupe (identifiant du groupe et niveau d’accès du groupe) peuvent être supprimés en spécifiant groupId=0 dans le corps de la demande d’un appel de mise à jour.Créez :-Pour la création, les propriétés suivantes sont disponibles pour des spécifications dans le corps de la demande :PropriétésDescriptionObligatoire (pour les chiffres 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.NNshortNameChaînechaîne videParentParent de cette version.NNparentChaîne (nom de la version)version des chiffres réels racineType de versionType de version (Actuals ou Planning)Y, ACTUALSY, ACTUALSversionTypeChaîneDescriptionDescriptionNNdescriptionChaînechaîne videAccès administrateursNiveau d’accès à la version pour les administrateurs.NNadministrateursaccèsVersionAccessControlhérité du parentAccès utilisateurNiveau d’accès à la version pour les utilisateurs.NNuserAccessVersionAccessControlhérité du parentAccès privilégié aux chiffres réelsNiveau d’accès à la version pour toute personne disposant de l’autorisation Accès privilégié aux chiffres réels.NNprivilegedActualsAccessVersionAccessControlhérité du parentIdentifiant de groupeUn identifiant de groupe d'utilisateurs préciséNNgroupIdEntierhérité du parentNiveau d’accès du groupeNiveau d’accès à la version du groupe d’utilisateurs indiqué.O si l'identifiant de groupe est précisé.O si l'identifiant de groupe est précisé.groupAccessLevelVersionAccessControlhérité du parentPiste d’auditConserver/supprimer les informations de la piste d’audit.NNauditTrailBooléenfaux (hérité du parent pour les versions des écritures)Version d'écritureSi la version à créer est une écriture.NOui, vraijournalEntryVersionBooléenreturnIdRenvoie un identifiant de version si elle est définie à 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.NNreturnIdBooléenvrai-Le type de valeur VersionAccesscontrol peut prendre en compte les valeurs de chaîne suivantes : "HIDDEN", "locked", "locked_except_notes", "IMport_and_notes", "FULL_ACCESS"- Les identifiants de groupe peuvent être obtenus au moyen de l'API publique exportGroups.- Les versions des écritures ne sont pas prises en charge pour les sociétés pour lesquelles la consolidation est 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 de l’écriture :PropriétésDescriptionObligatoire (pour les chiffres 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 numéroter les écritures. Peut être automatique (A), manuel (M), ou aucun (N).InutiliséNjournalEntryNumberingChaîneaucune (N)PréfixePréfixe de numérotation des écrituresInutiliséO si la numérotation des écritures est automatique (A) ou manuelle (M)préfixeChaîneNuméro de départNuméro de départ de la numérotation des écrituresInutiliséY si numérotation des écritures (A)startingNumberEntierPropriétés propres aux chiffres réels racines :Les propriétés suivantes ne sont utilisées que lors de la mise à jour des chiffres réels racine :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 période)Fin de la versionFin de la versionNendOfVersionChaîne (code de période)Emplacement de début du défilementEmplacement de défilement de début de la versionNstartingScrollLocationChaîne (code de période)Valeurs terminées jusqu'auLorsque la superposition des chiffres réels sur la version du plan s’arrêteNcompletedValuesThroughChaîne (code de période)Activer le flux des travauxVous permet de soumettre les chiffres réels par niveau dans le flux des travaux.NendableWorkflowBooléenCorps de la demande d'exemple :Corps de la demande{ "parent": "Parent Version", "versionType": "ACTUALS", ... "administratorsAccess": "FULL_ACCESS", "usersAccess": "IMPORT_AND_NOTES", ... ... "auditTrail": true }Exemple de corps de demande pour les versions avec des propriétés imbriquées (versions d’écriture 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 d'interrogation :NomDescriptionObligatoireversionNameNom de la nouvelle version à créer ou de la version existante à mettre à jour.YpoursuivreAvertirParamètre d’interrogation facultatif utilisé pour faire disparaître des messages d’avertissement. Si cette valeur n’est pas définie à Vrai, des avertissements potentiels seront renvoyés avant l’exécution de l’appel. Ignorer en spécifiant ce paramètre à Vrai dans l’URL.NinstanceCodeInstanceCode à partir de laquelle extraire des valeurs. Par exemple, GLOBO. Si aucun instanceCode n’est indiquée, l’instance par défaut de l’utilisateur est utilisée.NParamètres de chemin :NomDescriptionObligatoiretenantLe locataire sur lequel effectuer l’opération, par exemple GreencoYPropriétés de l'accès pour la publication :Les propriétés du corps de la demande suivantes sont uniquement utilisées 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 de planCrée une nouvelle version de plan ou de prédiction en clonant une version source/par défaut, ou crée une version virtuelle.Il existe actuellement deux ensembles d’identifiants de version pris en charge par les paramètres d’interrogation :-nouveau nom de versionUne et une seule de ces options doivent être précisées dans l'adresse URL pour chaque appelURI de la demande exemple :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 à préciser pour la nouvelle version à créer.NomDescriptionObligatoire (pour le plan)Obligatoire (pour l’horaire 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.NNNshortNameChaînechaîne videParentDossier parent de cette version.NNNparentChaîne (nom du dossier)Type de versionType de version (Actuals ou Planning)O, PLANNINGO, PLANNINGO, PLANNINGversionTypeChaîneDescriptionDescription.NNNdescriptionChaînechaîne videVersion verrouilléeVerrouille l’intégralité de la version pour tous les utilisateurs, y compris les formules principales et les autres formules du compte.NInutiliséInutilisélockedVersionBooléenhérité de la version sourceCalculer les valeurs de formuleDisponible pour les versions de plan pour lesquelles la case Version verrouillée est cochée. Utilisée pour conserver les résultats calculés des formules et des références dans la plupart des comptes et pour améliorer les performances des versions verrouillées.NInutiliséInutilisécalculateFormulaValuesBooléenfauxAccès administrateursNiveau d’accès à la version pour les administrateurs.NNNadministrateursaccèsVersionAccessControlhérité de la version source (plan) Import_and_notes (prédictif) VERROUILLÉ (Virtuel)Accès utilisateursNiveau d’accès à la version pour les utilisateurs.NNNusersAccessVersionAccessControlhérité de la version source (plan) Import_and_notes (prédictif) VERROUILLÉ (Virtuel)Accès en modification aux feuillesNiveau d’accès à la version pour toute personne disposant de l’autorisation Accès à la feuille modifiable.NNNeditableSheetAccessVersionAccessControlhérité de la version source (Plan, Prédictif)Identifiant de groupeL’identifiant d’un groupe d’utilisateurs spécifié.NNNgroupIdEntierhérité de la version source (Plan, Prédictif)Niveau d'accèsNiveau 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 période)hérité de la version sourceFin du planFin du planNNInutiliséendOfPlanChaîne (code de période)hérité de la version sourceDébut du planDébut du planNNInutiliséstartOfPlanChaîne (code de 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. Affiché par l'intermédiaire de l'interface utilisateur - Verrouiller la feuille de début de la {feuille de strate}NInutiliséInutiliséLockLeadingTimePeriodChaîne (code de période)hérité de la version sourceVerrouiller l'achèvement principalL'option "{leach stratum} d’achèvement" pour la propriété ci-dessus. Cette propriété et la propriété « Verrouiller la période de début » ne peuvent pas être précisées dans le corps de la demande.NInutiliséInutilisélockLeadingCompletionBooléenhérité de la version sourcePar défautLa version devient celle par défaut pour tous les utilisateurs.NInutiliséInutilisépar défautBooléenfauxPiste d’auditConserver/supprimer les informations de la piste d’audit.NNInutiliséauditTrailBooléenhérité de la version sourceLa superposition des chiffres réels comprend des niveaux non disponiblesAffiche tous les niveaux, même ceux qui ne sont plus utilisés, dans les superpositions de chiffres réels.NNInutiliséactualsOverlayIncludesUnavailableLevelsBooléenfauxVersion des chiffres réels pour superpositionSuperpose les données du plan aux données de la version des chiffres réels spécifiées.NNInutiliséactualsVersionOverlayChaîne (nom de la version)version des chiffres réels racineExplorer l'identifiant de transactionPermet d’explorer les transactions pour la version.NNInutilisédrillIntoTransactionIdEntierrapport par défautVersion prédictiveSi la version à créer est une version prédictive.InutiliséOui, vraiInutilisépredictiveVersionBooléenVersion virtuelleSi la version à créer est une version virtuelle.InutiliséInutiliséOui, vraivirtualVersionBooléenreturnIdIl renvoie un identifiant de version si la valeur est vraie. 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.NNNreturnIdBooléenvrai-Le type de valeur VersionAccesscontrol peut prendre en compte les valeurs de chaîne suivantes : "HIDDEN", "locked", "locked_except_notes", "IMport_and_notes", "FULL_ACCESS"- Les versions de plans verrouillées ne peuvent pas avoir « IMport_ANCE_NOTES » ni « FULL_AccESS » pour aucun groupe d’utilisateurs.- Les versions prédictives ne peuvent pas avoir « FULL_ACCESS » pour aucun groupe d'utilisateurs.-Les versions virtuelles peuvent uniquement avoir « MASQUÉ » ou « verrouillé » pour tout groupe d’utilisateurs.Les versions de plan et prédictives ne peuvent pas être créées pour des sociétés 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 l’horaire 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 de la version virtuelle. Ne peut être une version virtuelle ou une version de sous-chiffres 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 aux fins de production de rapports en devise constante. Ne peut être une version virtuelle ou une version de sous-chiffres réels.InutiliséInutiliséNexchangeRateVersionChaîne (nom de la version)version des chiffres réels racineActiver la production de rapports en devise constanteActiver/désactiver la production de rapports en devise constante.InutiliséInutiliséNenableConstantCurrencyReportingBooléenfauxDécalageLe montant du décalage vers l’arrière (nombre entier positif) ou vers l’avant (nombre entier négatif).InutiliséInutiliséNoffsetEntier0Propriétés de l'accès pour publicationLes propriétés du corps de la demande suivantes sont uniquement utilisées lorsque WD est activé :NomDescriptionObligatoire (pour le plan)Obligatoire (pour l’horaire prédictif)Obligatoire (pour virtuel)Nom de la propriété dans le corps de la demandeType de valeurValeur par défautPlans financiersActivez/désactivez les plans financiers pour cette version.Uniquement utilisé lorsque Adaptive Planning pour Financial Plans est activé.NInutiliséInutiliséfinancialPlansBooléenfauxPlans d’effectifActivez ou désactivez les plans d’effectif pour cette version.Uniquement utilisée quand Adaptive Planning pour les plans financiers ou Adaptive Planning pour la main-d'œuvre est activé.NInutiliséInutiliséheadcountPlansBooléenfauxPlans d’action de main-d’œuvreActivez/désactivez les plans d’action en matière de main-d’œuvre pour cette version.Uniquement utilisé lorsque Adaptive Planning pour la main-d'œuvre est activé.NInutiliséInutiliséworkforceActionPlansBooléenfaux
- Corps de la demande d'exempleCorps 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 d'interrogationNomDescriptionObligatoire (pour le plan)Obligatoire (pour l’horaire prédictif)Obligatoire (pour virtuel)Nom du paramètre dans l'adresse URLValeur par défautNom de la version sourceNom de la version à partir de laquelle effectuer le clonage. Si elle n’est pas précisée, effectue un clone à partir de la version par défaut.NNInutilisésourceVersionNameNom de la nouvelle versionNom de la nouvelle version à créer.YYYnewVersionNameCopier toutes les donnéesSi la valeur est Vrai, copie toutes les données.NInutiliséInutilisécopyAllDatafauxCopier les règles et les formules partagéesSi Vrai, copie les formules et les règles partagées.NInutiliséInutilisécopySharedFormulasAndRulesfauxCopier toutes les formules de remplacementSi la valeur est Vrai, copie toutes les formules de remplacement.NNInutilisécopyAllOverrideFormulasfauxCopier les subdivisions dans les comptes GL et personnalisésSi la valeur est Vrai, copie les subdivisions dans les comptes GL et personnalisés.NInutiliséInutilisécopySplitsInGLAndCustomAccountsfauxCopier les lignes modéliséesSi cela est vrai, copie les rangées modélisées.NInutiliséInutilisécopyModeledRowsfauxCopier les notes de cellule, de feuille et de flux des travauxSi cela est vrai, copie les notes de cellule, de feuille et de flux des travaux (le cas échéant).NInutiliséInutilisécopyAllNotesfauxRéinitialiser le flux des travaux avec le statut En coursSi Vrai, réinitialise le statut du flux des travaux à En cours.NInutiliséInutiliséresetWorkflowStatusToInProgressfauxCopier l’historique de la piste d’auditSi Vrai, s’ajoute comme choix de paramètre de rapport dans tous les rapports.InutiliséInutiliséCopyAuditTrailHistoryfauxAjouter comme choix de paramètre de rapport dans tous les rapportsSi Vrai, s’ajoute comme choix de paramètre de rapport dans tous les rapports.NInutiliséInutiliséaddAsReportParameterChoiceToAllReportsfauxCopier les valeurs recalculées des feuillesSi la valeur est Vrai, copie les valeurs recalculées des feuilles.NInutiliséInutilisécopyRecalculatedValuesOfSheetsfauxContinuer avec des avertissementsParamètre d’interrogation facultatif utilisé pour faire disparaître des messages d’avertissement. Si cette valeur n’est pas définie à Vrai, des avertissements potentiels seront renvoyés avant l’exécution de l’appel. Ignorer en spécifiant ce paramètre à Vrai dans l’URL.NNNpoursuivreAvertirfauxcode de l'instanceInstanceCode à partir de laquelle extraire des valeurs. Par exemple, GLOBO. Si aucun instanceCode n’est indiquée, l’instance par défaut de l’utilisateur est utilisée.NNNinstanceCodeInstance par défaut de l’utilisateur- L'option « Réinitialiser le statut du flux des travaux au statut En cours » n'est pas prise en charge pour les sociétés pour lesquelles le flux des travaux est désactivé.- "Copier les valeurs recalculées des feuilles" n'est pas pris en charge si l'indicateur de la fonctionnalité Modéliser Isolation est désactivé.Paramètres de chemin :NomDescriptionObligatoiretenantLe locataire sur lequel effectuer l’opération, par exemple GreencoY
- Exemple de réponse :
- 204 NO_CONTENTLa réponse réussie est vide avec le code de statut 204.