Versioni
URL Endpoint
HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/versions
HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/cloneVersion
(Solo POST)
Versione: v1
Categoria | Inoltro, modifica e recupero dei metadati |
Descrizione | Modifica dei metadati |
Autorizzazioni necessarie per il richiamo | |
Parametri obbligatori su richiesta | Varia per l'endpoint:
PATCH, POST, DELETE: nome versione. nessuno per GET |
VERBI HTTP supportati
(Nota: le cartelle delle versioni non sono supportate per nessuno degli endpoint seguenti)
Verbo HTTP | Risorsa singola | Risorsa raccolta | Descrizione |
|---|---|---|---|
GET | Non supportato | Supportato | Recuperare tutte le versioni del tenant. |
DELETE | Supportato | Non supportato | Eliminare la versione deltabile esistente. |
PATCH | Supportato | Non supportato | Creare/aggiornare le versioni degli importi effettivi o aggiornare le versioni del piano. |
POST | Supportato | Non supportato | Creare una nuova versione del piano. |
GET
- URI della richiesta
- /api/rest/modeling/v1/{tenant}/versions:recupera tutte le versioni del tenantRecupera tutte le versioni del tenant in un elenco.Le proprietà non visualizzate nell'interfaccia utente per versioni specifiche non sono incluse negli oggetti versione corrispondenti nella risposta. Ad esempio, startOfVersion per le versioni importi effettivi secondari.In grado di utilizzare l'impaginazione tramite i parametri "limite" e "spostamento".Le seguenti proprietà della versione non sono attualmente supportate/visualizzate in GET:Versione base (per versioni virtuali), abilitazione report a valuta costante (per versioni virtuali)Calcolare i valori delle formule, l'accesso come amministratore, l'accesso degli utenti, l'accesso ai fogli modificabili, l'accesso agli importi effettivi con privilegi, il gruppo, il livello di accesso al gruppo.URI richiesta di esempio:HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/versions?limit=25&offset=1Corpo richiesta di esempio:<Lasciare vuoto>Parametri query:NomeDescrizioneObbligatoriolimitIl numero massimo di oggetti in una singola risposta.NoffestIndice in base zero del primo oggetto in una raccolta di risposte. Il valore predefinito è 0.Utilizzare l'offset con il parametro limit per controllare il paging di una raccolta di risposte.NParametri percorso:NomeDescrizioneObbligatoriotenantIl tenant su cui operare, ad esempio GREENCOS
- Risposta di esempio
- 200 OKNota: nella proprietà startOfVersion (puntatore A) vengono visualizzati entrambi Inizio versione per le versioni importi effettivi e Limite scorrimento a sinistra per le versioni pianificate.Allo stesso modo, End of Version per le versioni importi effettivi e End of Plan per le versioni pianificate vengono entrambi visualizzati nella proprietà endOfVersion (puntatore D).La posizione di scorrimento iniziale per le versioni degli importi effettivi e l'inizio del piano per le versioni pianificate sono entrambi visualizzati nella proprietà StartingScrollLocation (puntatore C).Risposta riuscita.Risposta di esempio{ "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
- Richiesta
- /api/rest/modeling/v1/{tenant}/versions:elimina una versione esistenteElimina la versione con il nome della versione specificato.Impossibile eliminare la versione degli importi effettivi radice e la versione predefinita.URI richiesta di esempio:HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/versions?versionName={versionName}Corpo richiesta di esempio:<Lasciare vuoto>Parametri queryNomeDescrizioneObbligatorioversionNameNome della versione esistente da eliminare.SinstanceCodeinstanceCode da cui recuperare i valori. Ad esempio, GLOBO. Se non viene specificato instanceCode, viene utilizzata l'istanza predefinita dell'utente.NParametri percorsoNomeDescrizioneObbligatoriotenantIl tenant su cui operare, ad esempio GREENCOS
- Risposta di esempio
- 204 NO_CONTENT
- La risposta corretta è vuota con codice di stato 204.
PATCH
- Richiesta:
- /api/rest/modeling/v1/{tenant}/versions:crea/aggiorna le versioni degli importi effettivi o aggiorna le versioni del piano.Se l'ID versione specificato esiste, aggiorna gli importi effettivi/la versione pianificata esistente. In caso contrario, crea una nuova versione importi effettivi utilizzando tale identificativo.Attualmente sono supportati due insiemi di ID versione tramite i parametri di query:-version namePer ogni chiamata è obbligatorio specificare uno e uno solo dei parametri di query precedenti nell'URL.URI richiesta di esempio:HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/versions?versionName={versionName}Corpo richiesta-JSON contenente le proprietà della versione da aggiornare per la versione esistente o da specificare per la nuova versione da creare.Aggiornamento:-Per gli aggiornamenti, non è richiesta alcuna proprietà specifica nel corpo della richiesta (ad eccezione di versionType), ma è comunque necessario un corpo della richiesta. La sezione del corpo della richiesta diPOSTdelinea l'elenco delle proprietà per i diversi tipi di versioni del piano.-Impossibile aggiornare le proprietà dell'indicatore (ad esempio, journalEntryVersion); tuttavia, possono comunque rimanere nel corpo della richiesta, purché abbiano il valore invariato corretto.-L'aggiornamento padre non è attualmente supportato.-Quando si aggiornano versioni non foglia (versioni con figli), i gruppi di utenti di queste versioni possono avere solo i tipi di accesso "FULL_ACCESS" o "HIDDEN". "FULL_ACCESS" viene visualizzato come ed è equivalente a "VISIBLE" nell'interfaccia utente.-I dettagli di accesso al gruppo (ID gruppo e livello di accesso al gruppo) possono essere rimossi specificando groupId=0 nel corpo della richiesta di una chiamata di aggiornamento.Creare:-Per le creazioni, le seguenti proprietà sono disponibili per la specificazione nel corpo della richiesta:ProprietàDescrizioneObbligatorio (per importi effettivi)Obbligatorio (per registrazione a giornale)Nome della proprietà nel corpo della richiestaTipo valoreValore predefinitoNome abbreviatoNome abbreviato della versioneNNshortNameStringstringa vuotaPadrePadre di questa versione.NNpadreStringa (nome versione)versione importi effettivi radiceTipo di versioneTipo di versione (ACTUALS o PLANNING)S, EFFETTIVIS, EFFETTIVIversionTypeStringDescrizioneDescrizioneNNdescrizioneStringstringa vuotaAccesso amministratoriLivello di accesso alla versione per gli amministratoriNNadministratorsAccessVersionAccessControlereditato dal padreAccesso utentelivello di accesso alla versione per gli utentiNNuserAccessVersionAccessControlereditato dal padreAccesso con privilegi a importi effettiviLivello di accesso alla versione per chiunque disponga dell'autorizzazione Accesso a importi effettivi con privilegi.NNprivilegedActualsAccessVersionAccessControlereditato dal padreID gruppoUn ID gruppo di utenti specificatoNNgroupIdInteroereditato dal padreLivello di accesso di gruppoLivello di accesso alla versione del gruppo di utenti specificato.S se è specificato l'ID gruppo.S se è specificato l'ID gruppo.groupAccessLevelVersionAccessControlereditato dal padreAudit trailConservare/eliminare le informazioni dell'audit trail.NNauditTrailBooleanofalse (ereditato dal padre per le versioni registrazione a giornale)Versione registrazione a giornaleSe la versione da creare è una registrazione a giornale.NS, verojournalEntryVersionBooleanoreturnIdRestituisce un ID versione se è impostato su true. ID nuova versione se l'operazione ha creato una nuova versione. In caso contrario, restituisce l'ID della versione esistente che è stata aggiornata.NNreturnIdBooleanofalse (restituisce 204 Nessun contenuto con valore false, restituisce 200 OK con versione nella risposta se è impostata su true)-Il tipo di valore VersionAccessControl può assumere i seguenti valori stringa: "HIDDEN", "LOCKED", "LOCKED_EXCEPT_NOTES", "IMPORT_AND_NOTES", "FULL_ACCESS"-Gli ID gruppo sono ottenibili tramite l'API pubblica exportGroups.-Le versioni con registrazione a giornale non sono supportate per le aziende con il consolidamento disabilitato.Proprietà versione registrazione a giornale:Le seguenti proprietà sono presenti nell'oggetto nidificato journalEntryVersionProperties (consultare il corpo della richiesta di esempio) e vengono utilizzate solo per le versioni JE:ProprietàDescrizioneObbligatorio (per importi effettivi)Obbligatorio (per registrazioni a giornale)Nome della proprietà nel corpo della richiestaTipo valoreValore predefinitoNumerazione registrazioni a giornaleSpecificare la numerazione delle registrazioni a giornale. Può essere automatico (A), manuale (M) o nessuno (N).Non utilizzatoNjournalEntryNumberingStringnessuno (N)PrefissoPrefisso di numerazione JENon utilizzatoS se la numerazione delle registrazioni a giornale è automatica (A) o manuale (M)prefissoStringNumero inizialeNumero iniziale della numerazione JENon utilizzatoS se numerazione registrazioni a giornale (A)startNumberInteroProprietà specifiche per importi effettivi radice:Le seguenti proprietà vengono utilizzate solo quando si aggiornano gli importi effettivi radice:ProprietàDescrizioneObbligatorioNome della proprietà nel corpo della richiestaTipo valoreInizio versioneInizio versioneNstartOfVersionStringa (codice periodo di tempo)Fine versioneFine versioneNendOfVersionStringa (codice periodo di tempo)Posizione di inizio scorrimentoPercorso di scorrimento iniziale della versioneNstartingScrollLocationStringa (codice periodo di tempo)Valori completati fino aQuando la sovrapposizione degli importi effettivi nella versione pianificata viene interrottaNcompletedValuesThroughStringa (codice periodo di tempo)Abilita workflowConsente di inoltrare gli importi effettivi per livello nel workflow.NendableWorkflowBooleanoCorpo richiesta di esempio:Corpo richiesta{ "parent": "Parent Version", "versionType": "ACTUALS", ... "administratorsAccess": "FULL_ACCESS", "usersAccess": "IMPORT_AND_NOTES", ... ... "auditTrail": true }Corpo richiesta di esempio per versioni con proprietà nidificate (versioni registrazione a giornale e versioni virtuali):Corpo richiesta{ "parent": "Actuals", "versionType": "ACTUALS", "shortName": "test JE version", "journalEntryVersion": "true", "journalEntryVersionProperties": { "journalEntryNumbering": "A", "prefix": "JE-Prefix", "startingNumber": "25" }, ... "auditTrail": true }Parametri query:NomeDescrizioneObbligatorioversionNameNome della nuova versione da creare o della versione esistente da aggiornare.SprocedereWithWarningsUn parametro di query facoltativo utilizzato per ignorare i messaggi di avviso. Se non è impostato su true, i potenziali avvisi verranno restituiti prima dell'esecuzione della chiamata. Ignorali specificando questo parametro su true nell'URL.NinstanceCodeinstanceCode da cui recuperare i valori. Ad esempio, GLOBO. Se non viene specificato instanceCode, viene utilizzata l'istanza predefinita dell'utente.NParametri percorso:NomeDescrizioneObbligatoriotenantIl tenant su cui operare, ad esempio GREENCOSPubblicazione delle proprietà di accesso:Le seguenti proprietà del corpo della richiesta vengono utilizzate solo quando WD è abilitato:
- Risposta di esempio
- 204 NO_CONTENTLa risposta corretta è vuota con codice di stato 204.
POST
- Richiesta:
- /api/rest/modeling/v1/{tenant}/cloneVersion:crea una nuova versione del pianoCrea una nuova versione del piano o della previsione clonando una versione di origine/predefinita oppure crea una versione virtuale.Attualmente sono supportati due insiemi di ID versione tramite i parametri di query:-new nome versioneNell'URL di ogni chiamata è necessario specificare uno solo dei valori precedentiURI richiesta di esempio:HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/cloneVersion?newVersionName=Budget 2012& sourceVersionName=Budget 2011& copyAllData=true& copySharedFormulasAndRules=true& copyAllOverrideFormulas=falseCorpo della richiesta:JSON contenente le proprietà della versione da specificare per la nuova versione da creare.NomeDescrizioneObbligatorio (per piano)Obbligatorio (per previsione)Obbligatorio (per virtuale)Nome della proprietà nel corpo della richiestaTipo valoreValore predefinitoNome abbreviatoNome abbreviato della versioneNNNshortNameStringstringa vuotaPadreCartella padre di questa versione.NNNpadreStringa (nome cartella)Tipo di versioneTipo di versione (ACTUALS o PLANNING)Y, PLANNINGY, PLANNINGY, PLANNINGversionTypeStringDescrizioneDescrizioneNNNdescrizioneStringstringa vuotaVersione bloccataBlocca l'intera versione per tutti gli utenti, comprese le formule master e altre formule dei conti.NNon utilizzatoNon utilizzatoLockedVersionBooleanoereditato dalla versione di origineCalcola valori formulaDisponibile per le versioni del piano in cui è selezionata l'opzione Versione bloccata. Utilizzato per mantenere i risultati calcolati di formule e riferimenti nella maggior parte dei conti e per aumentare le performance delle versioni bloccate.NNon utilizzatoNon utilizzatocalculateFormulaValuesBooleanofalsoAccesso amministratoriLivello di accesso alla versione per gli amministratoriNNNadministratorsAccessVersionAccessControlereditato dalla versione di origine (Piano); IMPORT_AND_NOTES (previsione); BLOCCATO (virtuale)Accesso utentiLivello di accesso alla versione per gli utentiNNNusersAccessVersionAccessControlereditato dalla versione di origine (Piano); IMPORT_AND_NOTES (previsione); BLOCCATO (virtuale)Accesso a fogli modificabiliLivello di accesso alla versione per chiunque disponga dell'autorizzazione Accesso al foglio modificabile.NNNeditableSheetAccessVersionAccessControlereditato dalla versione di origine (Plan, Predictive)ID gruppoL'ID di un gruppo di utenti specificato.NNNgroupIdInteroereditato dalla versione di origine (Plan, Predictive)Livello di accessoLivello di accesso alla versione del gruppo di utenti specificato.NNNgroupAccessLevelVersionAccessControlereditato dalla versione di origine (Plan, Predictive)Limite di scorrimento all'indietroLimite di scorrimento a sinistra della versioneNNNon utilizzatostartOfVersionStringa (codice periodo di tempo)ereditato dalla versione di origineFine pianoFine pianoNNNon utilizzatoendOfPlanStringa (codice periodo di tempo)ereditato dalla versione di origineInizio pianoInizio pianoNNNon utilizzatostartOfPlanStringa (codice periodo di tempo)ereditato dalla versione di origineBloccare il periodo di anticipoRende non modificabili i periodi di dati specificati nella versione. Visualizzato come "Blocca {leaf stratum} through" nell'interfaccia utente.NNon utilizzatoNon utilizzatolockLeadingTimePeriodStringa (codice periodo di tempo)ereditato dalla versione di origineBloccare il completamento anticipatoL'opzione "Completion {leaf stratum}" per la proprietà precedente. Questa proprietà e "Blocca periodo di anticipo" non possono essere specificati nel corpo della richiesta.NNon utilizzatoNon utilizzatolockLeadingCompletionBooleanoereditato dalla versione di originePredefinitaImposta la versione come predefinita per tutti gli utenti.NNon utilizzatoNon utilizzatopredefinitoBooleanofalsoAudit trailConservare/eliminare le informazioni dell'audit trail.NNNon utilizzatoauditTrailBooleanoereditato dalla versione di origineLa sovrapposizione importi effettivi include livelli non disponibiliVisualizza tutti i livelli, anche quelli non più utilizzati, nelle sovrapposizioni di importi effettivi.NNNon utilizzatoactualsOverlayIncludesUnavailableLevelsBooleanofalsoVersione importi effettivi per sovrapposizioneSovrappone i dati del piano con i dati della versione degli importi effettivi specificata.NNNon utilizzatoactualsVersionOverlayStringa (nome versione)versione importi effettivi radiceEseguire il drill-down nell'ID transazioneConsente di eseguire il drill-down delle transazioni per la versione.NNNon utilizzatodrillIntoTransactionIdInteroreport predefinitoVersione predittivaSe la versione da creare è una versione predittiva.Non utilizzatoS, veroNon utilizzatopredictiveVersionBooleanoVersione virtualeSe la versione da creare è una versione virtuale.Non utilizzatoNon utilizzatoS, verovirtualVersionBooleanoreturnIdRestituisce un ID versione se è impostato su true. ID nuova versione se l'operazione ha creato una nuova versione. In caso contrario, restituisce l'ID della versione esistente che è stata aggiornata.NNNreturnIdBooleanofalse (restituisce 204 Nessun contenuto con valore falso, restituisce 200 OK con versione nella risposta se è impostato su true)-Il tipo di valore VersionAccessControl può assumere i seguenti valori stringa: "HIDDEN", "LOCKED", "LOCKED_EXCEPT_NOTES", "IMPORT_AND_NOTES", "FULL_ACCESS"-Le versioni del piano bloccate non possono avere "IMPORT_AND_NOTES" o "FULL_ACCESS" impostato per nessun gruppo di utenti.-Le versioni predittive non possono avere "FULL_ACCESS" impostato per nessun gruppo di utenti.-Le versioni virtuali possono avere solo "NASCOSTO" o "BLOCCATO" impostato per qualsiasi gruppo di utenti.-Non è possibile creare versioni pianificate e predittive per le aziende per cui è abilitato il consolidamento senza pianificazione.Proprietà virtuali versioneLe proprietà seguenti sono presenti nell'oggetto nidificato virtualVersionProperties e vengono utilizzate solo per le versioni virtuali:NomeDescrizioneObbligatorio (per piano)Obbligatorio (per previsione)Obbligatorio (per virtuale)Nome della proprietà nel corpo della richiestaTipo valoreValore predefinitoVersione baseLa versione che fornirà i dati di base per la versione virtuale. Non può essere una versione virtuale o una versione degli importi effettivi secondari.Non utilizzatoNon utilizzatoNbaseVersionStringa (nome versione)versione predefinitaVersione tasso di cambioVersione che fornirà il tasso di cambio per la versione virtuale utilizzata per i report a valuta costante. Non può essere una versione virtuale o una versione degli importi effettivi secondari.Non utilizzatoNon utilizzatoNexchangeRateVersionStringa (nome versione)versione importi effettivi radiceAbilita report valuta costanteAbilitare/disabilitare i report a valuta costante.Non utilizzatoNon utilizzatoNenableConstantCurrencyReportingBooleanofalsoSpostamentoImporto della compensazione all'indietro (numero intero positivo) o in avanti (numero intero negativo).Non utilizzatoNon utilizzatoNoffsetIntero0Pubblicazione delle proprietà di accessoLe seguenti proprietà del corpo della richiesta vengono utilizzate solo quando WD è abilitato:NomeDescrizioneObbligatorio (per piano)Obbligatorio (per previsione)Obbligatorio (per virtuale)Nome della proprietà nel corpo della richiestaTipo valoreValore predefinitoPiani finanziariAbilitare/disabilitare i piani finanziari per questa versione.Utilizzato solo quando è abilitato Adaptive Planning for Financial Plans.NNon utilizzatoNon utilizzatofinancialPlansBooleanofalsoPiani effettiviAbilitare/disabilitare i piani degli effettivi per questa versione.Utilizzato solo quando è abilitato Adaptive Planning for Financial Plans o Adaptive Planning for the Workforce.NNon utilizzatoNon utilizzatoheadcountPlansBooleanofalsoPiani di azione personaleAbilitare/disabilitare i piani d'azione del personale per questa versione.Utilizzato solo quando Adaptive Planning for the Workforce è abilitato.NNon utilizzatoNon utilizzatoworkforceActionPlansBooleanofalso
- Esempio di corpo richiestaCorpo richiesta{ "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 }Parametri queryNomeDescrizioneObbligatorio (per piano)Obbligatorio (per previsione)Obbligatorio (per virtuale)Nome del parametro nell'URLValore predefinitoNome versione di origineIl nome della versione da cui eseguire la clonazione. Se non specificato, clona dalla versione predefinita.NNNon utilizzatosourceVersionNameNome della nuova versioneNome della nuova versione da creare.SSSnewVersionNameCopia tutti i datiSe è vero, copia tutti i dati.NNon utilizzatoNon utilizzatocopyAllDatafalsoCopia formule condivise e regoleSe è vero, copia le formule e le regole condivise.NNon utilizzatoNon utilizzatocopySharedFormulasAndRulesfalsoCopia tutte le formule sostitutiveSe è vero, copia tutte le formule sostitutive.NNNon utilizzatocopyAllOverrideFormulasfalsoCopia suddivisioni in conti CoGe e personalizzatiSe è impostato su true, copia le suddivisioni nei conti CoGe e personalizzati.NNon utilizzatoNon utilizzatocopySplitsInGLAndCustomAccountsfalsoCopia righe modellateSe è vero, copia le righe modellate.NNon utilizzatoNon utilizzatocopyModeledRowsfalsoCopia note di cella, foglio e workflowSe è vero, copia le note di cella, foglio e workflow (se applicabile).NNon utilizzatoNon utilizzatocopyAllNotesfalsoReimposta stato workflow su In corsoSe è vero, reimposta lo stato del workflow su In corso.NNon utilizzatoNon utilizzatoresetWorkflowStatusToInProgressfalsoCopia storico audit trailSe è vero, viene aggiunto come parametro di report a tutti i report.Non utilizzatoNon utilizzatocopyAuditTrailHistoryfalsoAggiungi come opzione di parametro del report a tutti i reportSe è vero, viene aggiunto come parametro di report a tutti i report.NNon utilizzatoNon utilizzatoaddAsReportParameterChoiceToAllReportsfalsoCopia valori ricalcolati dei fogliSe è vero, copia i valori ricalcolati dei fogli.NNon utilizzatoNon utilizzatocopyRecalculatedValuesOfSheetsfalsoProcedere con AvvisiUn parametro di query facoltativo utilizzato per ignorare i messaggi di avviso. Se non è impostato su true, i potenziali avvisi verranno restituiti prima dell'esecuzione della chiamata. Ignorali specificando questo parametro su true nell'URL.NNNprocedereWithWarningsfalsocodice istanzainstanceCode da cui recuperare i valori. Ad esempio, GLOBO. Se non viene specificato instanceCode, viene utilizzata l'istanza predefinita dell'utente.NNNinstanceCodeIstanza predefinita dell'utente-"Reimposta stato workflow su in corso" non è supportato per le aziende con Workflow disabilitato.-"Copia i valori ricalcolati dei fogli" non è supportato se il flag della funzionalità MODEL ISOLATION è disattivato.Parametri percorso:NomeDescrizioneObbligatoriotenantIl tenant su cui operare, ad esempio GREENCOS
- Risposta di esempio:
- 204 NO_CONTENTLa risposta corretta è vuota con codice di stato 204.