Riferimento ID interni

È possibile includere ID interni in una richiesta API per ottenere i metadati per i metodi di creazione, aggiornamento e lettura. Quando si effettuano richieste per questi metodi, utilizzare le chiamate Export API associate per ottenere gli ID richiesti dalla richiesta. Le richieste per tutte le API nella tabella seguente richiedono un elemento credenziali.

Esempio

È necessario trasmettere l'ID dimensione per aggiornare una dimensione nella richiesta API updateDimensions . È possibile passare l'ID dimensione "7" per aggiornare la dimensione "Istruzione
".


<dimensions>
      <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0">
      --------------------------
      </dimension>
</dimensions>

L'ID dimensione "7" per "Formazione" è ottenuto da exportDimensions API Response.


<response success="true">
 <output>
   <dimensions>
     <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="1" seqNo="35">
      --------------------------------------------
    </dimension>
  </output>
 </response>

Esportare API e ID risposta

API	Adaptive Planning ID interni in risposta	Metadati recuperati
exportAccounts	ID conto e ID attributo conto Gli ID conto possono essere utilizzati per identificare i conti in altre chiamate API, ad esempio exportDimensionFamilies. L'elemento foglio è facoltativo. Se si include l'elemento del foglio, è necessario trasmettere l'ID di sistema interno per il foglio nella richiesta. Consultare exportSheets.	Elenco di tutti i conti, inclusi tutti i tipi di conto: ipotesi, conti cubo, conti personalizzati, conti CoGe, conti metrica e conti modellati.
exportActiveCurrencies	ID valuta Può essere utilizzato per identificare in modo univoco la valuta e può essere utilizzato nell'API customReportValues .	Elenco di tutte le valute configurate nel sistema.
exportAttributes	ID attributo e ID elemento attributeValue	Elenco di tutti gli attributi nel sistema.
exportDimensions	ID dimensione e il relativo ID elemento dimensionValue Può essere utilizzato per identificare le dimensioni in altre chiamate API, ad esempio exportDimensionFamilies.	Elenco di tutte le dimensioni nel sistema.
exportGroups	ID gruppo di utenti e ID utente proprietario di questo gruppo di utenti (impostati solo quando isGlobal="false").	Elenco di tutti i gruppi definiti per l'istanza specificata. Sono inclusi i gruppi definiti per l'intera istanza e i gruppi definiti dagli utenti.
exportLevels	ID Livello	Elenco di tutti i livelli dell'organizzazione nel sistema.
exportPermissionSets Disponibile nell'API v25+.	ID set di autorizzazioni Viene utilizzato per identificare il set di autorizzazioni assegnato a un utente nella chiamata API exportUsers.	Elenco di tutti gli insiemi di autorizzazioni nell'istanza.
exportRoles Disponibile nell'API v25 e versioni precedenti. Non disponibile nell'API v25+.	ID ruolo Viene utilizzato per identificare il ruolo assegnato a un utente nella chiamata API exportUsers.	Elenco di tutti i ruoli nell'istanza.
exportSheets	ID foglio (possono essere elementi di foglio standard, cubo e modellato) Può essere utilizzato per identificare i fogli in altre chiamate API, ad esempio exportSheetDefinition.	Elenco di tutti i fogli definiti per l'istanza specificata. Sono inclusi i fogli "incompleti" e i fogli assegnati agli utenti.
exportTime	ID periodo di tempo saldo iniziale	Metadati temporali per una versione specifica o per tutte le versioni, se non ne è stata specificata nessuna.
exportTransactionDefinition	ID per elementi dimensione, selettore di testo e valore.	La definizione (colonne disponibili) delle transazioni nell'istanza.
exportUsers	ID utente e ID ruolo assegnati a questo utente	Elenco di tutti gli utenti nell'istanza.
exportVersions	ID versione o cartella Tutti gli ID sono univoci in tutte le versioni, sottoversioni e cartelle.	Un documento XML che descrive l'insieme di tutte le versioni definite nell'istanza che non sono nascoste all'utente richiedente dopo la verifica.