Referentie interne ID's

U kunt interne ID's in een API-aanvraag opnemen om metagegevens te verkrijgen voor de methoden voor maken, bijwerken en lezen. Wanneer u aanvragen voor deze methoden indient, gebruikt u de bijbehorende export-API-aanroepen om de ID's op te halen die voor uw aanvraag zijn vereist. Voor de aanvragen voor alle API's in de onderstaande tabel is een element Referenties vereist.

Voorbeeld

U moet de dimensie-ID doorgeven om een dimensie bij te werken in de updateDimensions -API-aanvraag. U kunt dimensie-ID 7 doorgeven om de dimensie
Opleiding
bij te werken.


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

Dimensie-ID 7 voor Opleiding wordt opgehaald uit het API-antwoord exportDimensions .


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

API's en antwoord-ID's exporteren

API	Adaptive Planning Interne ID's in antwoord	Metadata Retrieved
exportAccounts	Rekening-ID en rekeningkenmerk-ID Rekening-ID's kunnen worden gebruikt om rekeningen te identificeren in andere API-aanroepen, zoals exportDimensionFamilies. Bladelement is optioneel. Als u het bladelement opneemt, moet u de interne systeem-ID voor het blad in uw aanvraag doorgeven. Zie exportSheets.	Lijst met alle rekeningen, inclusief alle rekeningtypen: aannamen, kubusrekeningen, aangepaste rekeningen, GB-rekeningen, metriekrekeningen en gemodelleerde rekeningen.
exportActiveCurrencies	Valuta-ID Dit kan worden gebruikt om de valuta op unieke wijze te identificeren en kan worden gebruikt in de customReportValues -API.	Lijst met alle valuta's die in het systeem zijn geconfigureerd.
exportAttributes	Kenmerk-ID en ID van element attributeValue	Lijst met alle kenmerken in het systeem.
exportDimensions	Dimensie-ID en de bijbehorende dimensieValue-element-ID Dit kan worden gebruikt om dimensies in andere API-aanroepen te identificeren, zoals exportDimensionFamilies.	Lijst met alle dimensies in het systeem.
exportGroups	Gebruikersgroeps-ID en gebruikers-ID die eigenaar is van deze gebruikersgroep (alleen ingesteld wanneer isGlobal="false").	Lijst met alle groepen die voor de opgegeven instance zijn gedefinieerd. Dit omvat de groepen die zijn gedefinieerd voor algemeen voor de hele instance en de groepen die zijn gedefinieerd door gebruikers.
exportLevels	Niveau-ID	Lijst met alle organisatieniveaus in het systeem.
exportPermissionSets Beschikbaar in API v25+.	Machtigingenset-ID Dit wordt gebruikt om de machtigingenset te identificeren die aan een gebruiker is toegewezen in de API-aanroep exportUsers.	Lijst met alle machtigingensets in de instance.
exportRoles Beschikbaar in API v25 en eerder. Niet beschikbaar in API v25+.	Rol-ID Dit wordt gebruikt om de rol te identificeren die aan een gebruiker is toegewezen in de API-aanroep exportUsers.	Lijst met alle rollen in de instance.
exportSheets	Blad-ID (kan standaard-, kubus- en gemodelleerde bladelementen zijn) Dit kan worden gebruikt om bladen in andere API-aanroepen te identificeren, zoals exportSheetDefinition.	Lijst met alle bladen die voor de opgegeven instance zijn gedefinieerd. Dit omvat zowel onvolledige bladen als aan gebruikers toegewezen bladen.
exportTime	Periode-ID aanvangssaldo	Tijdmetagegevens voor een specifieke versie of voor alle versies als er geen is opgegeven.
exportTransactionDefinition	ID's voor dimensie-, tekstselectie- en waarde-elementen.	De definitie (beschikbare kolommen) van de transacties in de instance.
exportUsers	Gebruikers-ID en rol-ID die aan deze gebruiker zijn toegewezen	Lijst met alle gebruikers in de instance.
exportVersions	Versie- of map-ID Alle ID's zijn uniek voor alle versies, subversies en mappen.	Een XML-document met een beschrijving van de set van alle versies die in de instance zijn gedefinieerd en die na verificatie niet worden verborgen voor de aanvragende gebruiker.