Passa al contenuto principale
Documentazione
Documentazione
Adaptive Planning
exportTime

exportTime

Questa API supporta solo l'utente Concetto: Regole di accesso nell'API v21 e versioni successive.
Categoria
Recupero dei metadati
Descrizione
Restituisce i metadati temporali per una versione specifica o per tutte le versioni, se non ne viene specificata nessuna.
Autorizzazioni necessarie per richiamare
Nessuno (devono essere credenziali valide per l'istanza)
Parametri obbligatori su richiesta
Credenziali
La richiesta di questo metodo contiene un tag delle credenziali per identificare e autorizzare l'utente chiamante e un tag di versione facoltativo per specificare la versione per cui recuperare le informazioni. Se non viene specificata alcuna versione, il metodo restituisce informazioni temporali per l'intervallo di tempo che include le ore di inizio e di fine di tutte le versioni. Una volta verificato il chiamante, il metodo restituisce un documento XML che descrive l'insieme completo di informazioni temporali per la versione in una struttura ad albero nidificato.

Formato richiesta


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportTime" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" locale="fr_FR" instanceCode="INSTANCE1"/>
<options includeAllLocales="1" includeLegacyInformation="1" />
</call>
elemento credenziali
Nome tag
credenziali
Descrizione
Tutte le chiamate API devono contenere un singolo elemento di credenziali per identificare l'utente che richiama l'API. La chiamata API viene quindi eseguita come utente (qualsiasi audit trail o storico delle azioni nel sistema mostrerà che l'azione è stata eseguita dall'utente) e pertanto l'utente deve disporre delle autorizzazioni necessarie per eseguire l'azione affinché la chiamata API avere esito positivo.
Attributi dell'elemento
Nome attributo
Obbligatorio?
Valore
Esempio
accedere
S
Il nome di accesso dell'utente che richiama il metodo API. L'utente deve disporre delle autorizzazioni necessarie per richiamare il metodo.
sampleuser@company.com
password
S
La password dell'utente che richiama il metodo API.
my_password
impostazioni internazionali
N
Specificare le impostazioni internazionali da utilizzare per interpretare i numeri e le date in entrata e per formattare i numeri e le date in uscita (utilizzando il separatore delle migliaia, i nomi dei mesi e la formattazione della data appropriati). Le impostazioni internazionali vengono utilizzate anche per specificare la lingua in cui devono essere visualizzati i messaggi di sistema nella risposta. Se non viene specificato, viene utilizzato en_US (inglese americano).
fr_FR
instanceCode
N
Se l'utente specificato nelle credenziali ha accesso a più istanze di
Adaptive Planning
, questo attributo può essere utilizzato per specificare che l'utente intende accedere a un'istanza diversa da quella predefinita. Se non viene specificata, verrà utilizzata l'istanza predefinita dell'utente. Per determinare i codici di istanza disponibili, utilizzare l'API exportInstances.
MYINSTANCE1
Contenuto dell'elemento
(nessuno)
Elemento Opzioni
Nome tag
Opzioni
Descrizione
Specifica le opzioni da utilizzare durante l'esportazione delle ore.
Attributi dell'elemento
Nome attributo
Obbligatorio?
Valore
Esempio
includeAllLocales
N
Facoltativamente, fare in modo che l'esportazione esporti tutte le conversioni per ogni strato/periodo di tempo. Se non viene specificato, vengono esportate solo le impostazioni internazionali specificate nel blocco credenziali.
"1"
includeLegacyInformation
N
Facoltativamente, fare in modo che l'esportazione esporti attributi aggiuntivi contenenti informazioni sulle ore preesistenti. Questi attributi aggiuntivi non verranno inclusi se isCustom = 1
"1"
leafStratumId
Supportato nell'API v16 +
N
Facoltativamente, fornire l'ID di uno strato temporale da considerare come foglia. Gli strati temporali più fini dello strato temporale specificato non verranno inclusi nella risposta, né i periodi di tempo appartenenti a strati temporali più fini dello strato temporale specificato.
"5"
calendarId
Supportato nell'API v33 +
N
Facoltativamente, fornire l'ID del calendario o della gerarchia da recuperare. Se non viene specificato, l'API restituirà solo i valori temporali nella gerarchia predefinita.
"1"
Contenuto dell'elemento
(nessuno)
elemento versione
Nome tag
versione
Descrizione
Indica la versione da utilizzare per recuperare i dati richiesti. L'utente deve poter accedere alla versione specificata e non può essere una cartella. Un elemento version non è obbligatorio, ma se ne viene incluso uno, la versione specificata deve essere valida.
Attributi dell'elemento
Nome attributo
Obbligatorio?
Valore
Esempio
opzione
aggiornato nell'API v18
N
Imposta l'intervallo di tempo da esportare. Può essere impostato su "tutti", "single" o omesso. Il valore predefinito è "single". Se single, l'utente deve specificare anche "name" o "id". Restituisce l'intervallo di tempo della singola versione specificata e il saldo iniziale per tale versione. Se sono specificati sia il nome che l'ID, devono fare riferimento alla stessa versione. Se tutto, restituisce l'intervallo di tempo da min a max di tutte le versioni, incluso il periodo saldo iniziale per il primo strato nell'intervallo di tempo min-max. Se tutti, non devono specificare la versione "name" o "id". Se omesso, restituire tutto il tempo definito.
Quando si specifica una singola versione, la chiamata avrà esito positivo solo se l'utente ha accesso alla versione.
singolo
nome
N
Il nome della versione da utilizzare per recuperare i dati. È possibile accedere a una sola versione all'interno di una singola chiamata API. Se non viene fornito un nome, deve esserlo un ID. Se vengono specificati entrambi, devono corrispondere alla stessa versione.
Budget 2014
ID
N
ID della versione da utilizzare per recuperare i dati. È possibile accedere a una sola versione all'interno di una singola chiamata API. Se l'opzione è "single" e non viene fornito un ID, è necessario specificare un nome. Se vengono specificati entrambi, devono corrispondere alla stessa versione.
3
Contenuto dell'elemento
(nessuno)

Formato risposta (con includeAllLocales="0" o non specificato)


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
  <output>
    <time isCustom="1" seqNo="24">
      <stratum code="year" label="Year" shortName="Yr" id="3" inUse="1">
        <stratum code="qtr" label="Quarter" shortName="Qtr" id="2" inUse="1">
          <stratum code="month" label="Month" shortName="Mon" id="1" inUse="1" isDefault="1" />
        </stratum>
      </stratum>
      <period code="2015" label="FY2015" shortName="FY2015" stratumId="3" timeslot="15" encodedTimePeriod="3::15" id="15003" end="2016-01-01">
        <period code="Q1-2015" label="Q1-FY15" shortName="Q1-FY15" stratumId="2" timeslot="60" encodedTimePeriod="2::60" id="60002" end="2015-04-01">
          <period code="01/2015" label="Jan-2015" shortName="Jan-2015" stratumId="1"timeslot="180" encodedTimePeriod="1::180" id="180001" end="2015-02-01" />
          <period code="02/2015" label="Feb-2015" shortName="Feb-2015" stratumId="1" timeslot="181" encodedTimePeriod="1::181" id="181001" end="2015-03-01" />
          <period code="03/2015" label="Mar-2015" shortName="Mar-2015" stratumId="1" timeslot="182" encodedTimePeriod="1::182" id="182001" end="2015-04-01" />
        </period>
        <period code="Q2-2015" label="Q2-FY15" shortName="Q2-FY15" stratumId="2" timeslot="61" encodedTimePeriod="2::61" id="61002" end="2015-07-01">
          <period code="04/2015" label="Apr-2015" shortName="Apr-2015" stratumId="1" timeslot="183" encodedTimePeriod="1::183" id="183001" end="2015-05-01" />
          <period code="05/2015" label="May-2015" shortName="May-2015" stratumId="1" timeslot="184" encodedTimePeriod="1::184" id="184001" end="2015-06-01" />
          <period code="06/2015" label="Jun-2015" shortName="Jun-2015" stratumId="1" timeslot="185" encodedTimePeriod="1::185" id="185001" end="2015-07-01" />
        </period>
        <period code="Q3-2015" label="Q3-FY15" shortName="Q3-FY15" stratumId="2" timeslot="62" encodedTimePeriod="2::62" id="62002" end="2015-10-01">
          <period code="07/2015" label="Jul-2015" shortName="Jul-2015" stratumId="1" timeslot="186" encodedTimePeriod="1::186" id="186001" end="2015-08-01" />
          <period code="08/2015" label="Aug-2015" shortName="Aug-2015" stratumId="1" timeslot="187" encodedTimePeriod="1::187" id="187001" end="2015-09-01" />
          <period code="09/2015" label="Sep-2015" shortName="Sep-2015" stratumId="1" timeslot="188" encodedTimePeriod=""1::188" id="188001" end="2015-10-01" />
        </period>
        <period code="Q4-2015" label="Q4-FY15" shortName="Q4-FY15" stratumId="2" timeslot="63" encodedTimePeriod="2::63" id="63002" end="2016-01-01">
          <period code="10/2015" label="Oct-2015" shortName="Oct-2015" stratumId="1" timeslot="189" encodedTimePeriod="1::189" id="189001" end="2015-11-01" />
          <period code="11/2015" label="Nov-2015" shortName="Nov-2015" stratumId="1" timeslot="190" encodedTimePeriod="1::190" id="190001" end="2015-12-01" />
          <period code="12/2015" label="Dec-2015" shortName="Dec-2015" stratumId="1" timeslot="191" encodedTimePeriod="1::191" id="191001" end="2016-01-01" />
        </period>
      </period>
      <period code="2016" label="FY2016" shortName="FY2016" stratumId="3" timeslot="16" encodedTimePeriod="3::16" id="16003" end="2017-01-01">
        <period code="Q1-2016" label="Q1-FY16" shortName="Q1-FY16" stratumId="2" timeslot="64" encodedTimePeriod="2::64" id="64002" end="2016-04-01">
          <period code="01/2016" label="Jan-2016" shortName="Jan-2016" stratumId="1" timeslot="192" encodedTimePeriod="1::192" id="192001" end="2016-02-01" />
          <period code="02/2016" label="Feb-2016" shortName="Feb-2016" stratumId="1" timeslot="193" encodedTimePeriod="1::193" id="193001" end="2016-03-01" />
          <period code="03/2016" label="Mar-2016" shortName="Mar-2016" stratumId="1" timeslot="194" encodedTimePeriod="1::194" id="194001" end="2016-04-01" />
        </period>
        <period code="Q2-2016" label="Q2-FY16" shortName="Q2-FY16" stratumId="2" timeslot="65" encodedTimePeriod="2::65" id="65002" end="2016-07-01">
          <period code="04/2016" label="Apr-2016" shortName="Apr-2016" stratumId="1" timeslot="195" encodedTimePeriod="1::195" id="195001" end="2016-05-01" />
          <period code="05/2016" label="May-2016" shortName="May-2016" stratumId="1" timeslot="196" encodedTimePeriod="1::196" id="196001" end="2016-06-01" />
          <period code="06/2016" label="Jun-2016" shortName="Jun-2016" stratumId="1" timeslot="197" encodedTimePeriod="1::197" id="197001" end="2016-07-01" />
        </period>
        <period code="Q3-2016" label="Q3-FY16" shortName="Q3-FY16" stratumId="2" timeslot="66" encodedTimePeriod="2::66" id="66002" end="2016-10-01">
          <period code="07/2016" label="Jul-2016" shortName="Jul-2016" stratumId="1" timeslot="198" encodedTimePeriod="1::198" id="198001" end="2016-08-01" />
          <period code="08/2016" label="Aug-2016" shortName="Aug-2016" stratumId="1" timeslot="199" encodedTimePeriod="1::199" id="199001" end="2016-09-01" />
          <period code="09/2016" label="Sep-2016" shortName="Sep-2016" stratumId="1" timeslot="200" encodedTimePeriod="1::200" id="200001" end="2016-10-01" />
        </period>
        <period code="Q4-2016" label="Q4-FY16" shortName="Q4-FY16" stratumId="2" timeslot="67" encodedTimePeriod="2::67" id="67002" end="2017-01-01">
          <period code="10/2016" label="Oct-2016" shortName="Oct-2016" stratumId="1" timeslot="201" encodedTimePeriod="1::201" id="201001" end="2016-11-01" />
          <period code="11/2016" label="Nov-2016" shortName="Nov-2016" stratumId="1" timeslot="202" encodedTimePeriod="1::202" id="202001" end="2016-12-01" />
          <period code="12/2016" label="Dec-2016" shortName="Dec-2016" stratumId="1" timeslot="203" encodedTimePeriod="2::203" id="203001" end="2017-01-01" />
        </period>
      </period>
    </time>
  </output>
</response>

Formato risposta parziale (con includeAllLocales="1")

In genere è presente un blocco delle impostazioni internazionali per ogni periodo di tempo e strato. Di seguito viene mostrata solo la sezione dello strato. Il formato del blocco delle impostazioni internazionali per i periodi di tempo è identico.

          <stratum code="year" label="Year" shortName="Year" id="3">
            <locales>
                <locale locale="en" label="Year" shortName="Year" />
                <locale locale="de" label="Jahr" shortName="Jahr" />
                <locale locale="fr" label="Anne" shortName="Anne" />
                <locale locale="es" label="Ao" shortName="Ao" />
                <locale locale="pt" label="Ano" shortName="Ano" />
                <locale locale="nl" label="Jaar" shortName="Jaar" />
                <locale locale="ja" label="年" shortName="年" />
            </locales>
            <stratum code="qtr" label="Quarter" shortName="Quarter" id="2">
                <locales>
                    <locale locale="en" label="Quarter" shortName="Quarter" />
                    <locale locale="de" label="Quartal" shortName="Quartal" />
                    <locale locale="fr" label="Trimestre" shortName="Trimestre" />
                    <locale locale="es" label="Trimestre" shortName="Trimestre" />
                    <locale locale="pt" label="Trimestre" shortName="Trimestre" />
                    <locale locale="nl" label="Kwartaal" shortName="Kwartaal" />
                    <locale locale="ja" label="四半期" shortName="四半期" />
                </locales>
                <stratum code="month" label="Month" shortName="Month" id="1" isDefault="1">
                    <locales>
                        <locale locale="en" label="Month" shortName="Month" />
                        <locale locale="de" label="Monat" shortName="Monat" />
                        <locale locale="fr" label="Mois" shortName="Mois" />
                        <locale locale="es" label="Mes" shortName="Mes" />
                        <locale locale="pt" label="Ms" shortName="Ms" />
                        <locale locale="nl" label="Maand" shortName="Maand" />
                        <locale locale="ja" label="月" shortName="月" />
                    </locales>
                </stratum>
            </stratum>
        </stratum>
elemento di risposta
Nome tag
risposta
Attributi dell'elemento
Nome attributo
Obbligatorio?
Valore
Esempio
successo
S
Vero o falso, a indicare se la chiamata API è riuscita o meno. Anche le chiamate riuscite possono contenere messaggi di avviso nella risposta.
true
obsoleto
N
Se presente nel tag di risposta e impostato su true, questo attributo indica che la versione del metodo o dell'API richiamata è diventata obsoleta ed è ufficialmente obsoleta. Sebbene continui a funzionare in questo momento, potrebbe cessare di funzionare in breve tempo. In genere, questo attributo non è presente.
falso
Contenuto dell'elemento
Un singolo elemento di messaggi facoltativo ed esattamente un elemento di output obbligatorio.
elemento messaggi
Nome tag
messaggi
Descrizione
Contenitore per uno o più elementi del messaggio.
Attributi dell'elemento
Nome attributo
Obbligatorio?
Valore
Esempio
(nessuno)
Contenuto dell'elemento
Uno o più elementi del messaggio.
elemento messaggio
Nome tag
messaggio
Descrizione
Rappresenta un messaggio inviato dal sistema al chiamante. I messaggi vengono utilizzati per i messaggi di errore quando le richieste non hanno esito positivo, per i messaggi di avviso quando le richieste hanno esito positivo e per i messaggi di conferma in caso di esito positivo.
Attributi dell'elemento
Nome attributo
Obbligatorio?
Valore
Esempio
chiave
N
Quando viene assegnata, una chiave è un modo per identificare un particolare messaggio o tipo di messaggio, utile ai fini della registrazione automatica degli errori e del ripristino nei programmi client. Le chiavi non cambiano nelle diverse impostazioni internazionali delle richieste, anche quando cambia la lingua del messaggio. Inoltre, è improbabile che le chiavi cambino in futuro a causa di rettifiche di testo o modifiche della terminologia.
invalid-attributevalueid
Contenuto dell'elemento
Il testo del messaggio. Questo testo è nella lingua delle impostazioni internazionali specificate nella richiesta (supponendo che le impostazioni internazionali siano supportate). Il testo può anche contenere informazioni variabili come il numero di righe elaborate o la colonna o il valore specifico che ha causato un errore.
elemento di output
Nome tag
output
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Un singolo elemento temporale obbligatorio. Questo wrapper di output è standard in tutte le risposte API e racchiude l'output valido di qualsiasi chiamata API riuscita.
elemento temporale
Nome tag
time
Descrizione
Contenitore per un elemento dello strato radice, zero o un elemento di saldo iniziale e uno o più elementi periodo dello strato radice.
Attributi dell'elemento
Nome attributo
Obbligatorio?
Valore
Esempio
isCustom
S
1 o 0, a indicare se il calendario per questa istanza è stato personalizzato o meno.
1
q1FirstMonth
N
Il mese di inizio dell'esercizio fiscale (a partire da 0). Questo attributo viene visualizzato solo se includeLegacyInformation era 1 nella richiesta e se isCustom è 0.
8
lastMonthIsFY
N
Indica se l'esercizio fiscale è equivalente all'anno di calendario in cui finisce l'esercizio fiscale. Questo attributo viene visualizzato solo includeLegacyInformation era 1 nella richiesta e se isCustom è 0.
0
seqNo
Aggiunto nell'API v17 ma riservato per un utilizzo futuro.
Contenuto dell'elemento
Esattamente un elemento di strato, zero o un elemento di saldo iniziale e uno o più elementi periodo dello strato radice.
elemento strato
Nome tag
strato
Descrizione
Rappresenta uno strato del calendario restituito dalla chiamata all'API exportTime.
Attributi dell'elemento
Nome attributo
Obbligatorio?
Valore
Esempio
codice
S
Identificatore univoco definito dall'utente per lo strato temporale.
Anno
etichetta
S
Un identificatore di testo non univoco definito dall'utente per lo strato temporale.
Esercizio fiscale
shortName
S
Identificatore di testo non univoco, definito dall'utente, utilizzato quando si desidera un nome più breve. Se non è stato definito un nome abbreviato, l'etichetta verrà visualizzata qui.
Year
ID
S
Identificatore intero univoco generato dal sistema per lo strato temporale.
7
inUse
Supportato nell'API v16 +
N
Flag che indica se un foglio cubo o un foglio modellato è associato allo strato temporale o se questo è lo strato temporale predefinito.
1
isDefault
Supportato nell'API v16 +
N
Flag che indica se lo strato temporale è lo strato predefinito o meno.
1
Contenuto dell'elemento
Zero o un elemento delle impostazioni internazionali. Questo valore è incluso solo se è impostato includeAllLocales.
Zero o un elemento strato. Ogni strato, a parte la foglia, ha esattamente un elemento strato. L'elemento strato foglia contiene zero elementi strato.
elemento di saldo iniziale
Nome tag
saldo iniziale
Descrizione
Rappresenta l'ultimo periodo di tempo foglia prima dell'inizio della versione restituita nella risposta a una chiamata API exportTime. Questa opzione è inclusa solo se è richiesta una e una sola versione.
Attributi dell'elemento
Nome attributo
Obbligatorio?
Valore
Esempio
codice
S
Identificatore univoco definito dall'utente per il periodo di tempo del saldo iniziale.
12/2003
etichetta
S
Identificatore di testo non univoco definito dall'utente per il periodo di tempo del saldo iniziale.
Dec-2003
shortname
S
Identificatore di testo breve non univoco, definito dall'utente, per il periodo di tempo del saldo iniziale. Se non è stato definito un nome abbreviato, viene visualizzata l'etichetta.
Dic
stratumId
S
ID dello strato a cui appartiene il saldo di partenza.
1
timeslot
S
La fascia oraria del periodo di tempo a cui appartiene il saldo di partenza.
47
encodedTimePeriod
S
I dati codificati per il periodo di tempo, nel formato strutumId::timeslot.
1::47
ID
S
L'identificatore intero univoco generato dal sistema per il periodo di tempo del saldo iniziale.
47001
inizio
S
La data di inizio (inclusa) del saldo di partenza, nel formato AAAA-MM-GG.
2003-12-01
fine
S
La data finale (esclusa) del saldo di partenza, nel formato AAAA-MM-GG.
2004-01-01
legacyReportTimeId
N
L'ID report che sarebbe stato visualizzato per questo periodo di tempo nelle versioni precedenti di questa API. Questo attributo viene visualizzato solo includeLegacyInformation era 1 nella richiesta e se isCustom è 0.
200312
legacySheetTimeId
N
L'ID ore del foglio che sarebbe stato utilizzato per questo periodo di tempo nelle versioni precedenti di questa API. Questo attributo viene visualizzato solo includeLegacyInformation era 1 nella richiesta e se isCustom è 0.
48, Q63 o Y72
Contenuto dell'elemento
Zero o un elemento
delle impostazioni internazionali
 .
Elemento periodo
Nome tag
periodo
Descrizione
Rappresenta un singolo periodo di tempo del calendario restituito dalla chiamata all'API exportTime.
Attributi dell'elemento
Nome attributo
Obbligatorio?
Valore
Esempio
codice
S
Identificatore univoco definito dall'utente per il periodo di tempo.
Q1-2004
etichetta
S
Un ID di testo non univoco definito dall'utente per il periodo di tempo.
Q1-FY04
shortName
S
Identificatore di testo non univoco, definito dall'utente, utilizzato quando si desidera un nome più breve. Se non è stato definito un nome abbreviato, l'etichetta verrà visualizzata qui.
T1
stratumId
S
ID dello strato a cui appartiene il periodo di tempo .
2
ID
S
Identificatore intero univoco generato dal sistema per il periodo di tempo .
16002
inizio
S
La data di inizio (inclusa) del periodo di tempo, nel formato AAAA-MM-GG.
2004-01-01
fine
S
La data di fine (esclusa) del periodo di tempo, nel formato AAAA-MM-GG.
2004-04-01
legacyReportTimeId
N
L'ID report che sarebbe stato visualizzato per questo periodo di tempo nelle versioni precedenti di questa API. Questo attributo viene visualizzato solo includeLegacyInformation era 1 nella richiesta e se isCustom è 0.
200491
legacySheetTimeId
N
L'ID ore del foglio che sarebbe stato utilizzato per questo periodo di tempo nelle versioni precedenti di questa API. Questo attributo viene visualizzato solo includeLegacyInformation era 1 nella richiesta e se isCustom è 0.
48, Q63 o Y72
Contenuto dell'elemento
Zero o uno degli elementi delle impostazioni internazionali.
Elemento Impostazioni internazionali
Nome tag
impostazioni internazionali
Descrizione
Contenitore per uno o più elementi
delle impostazioni internazionali
 .
Attributi dell'elemento
Nome attributo
Obbligatorio?
Valore
Esempio
(nessuno)
Contenuto dell'elemento
Uno o più elementi delle impostazioni internazionali.
elemento locale
Nome tag
impostazioni internazionali
Descrizione
Descrizione delle impostazioni internazionali. Si noti che il testo seguirà le regole di fallback delle impostazioni internazionali.
Attributi dell'elemento
Nome attributo
Obbligatorio?
Valore
Esempio
impostazioni internazionali
S
Il codice per le impostazioni internazionali.
it
etichetta
S
L'etichetta localizzata per il periodo/strati di tempo.
FY2016
shortName
S
Il nome abbreviato localizzato per il periodo/strati di tempo.
2016
Contenuto dell'elemento
(nessuno)