Internal IDs Reference

You can include internal ids in an API Request to obtain metadata for the create, update, and read methods. When you make requests for these methods, use the associated Export API calls to get the IDs your request requires. The Requests for all the APIs in the table below require a credentials element.

Example

You must pass the Dimension ID to update a dimension in the updateDimensions API Request. You can pass the Dimension ID "7" to update the dimension "Education
".


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

Dimension ID "7" for "Education", is obtained from 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>

Export APIs and Response Ids

API	Adaptive Planning Internal Ids in Response	Metadata Retrieved
exportAccounts	Account ID and Account attribute ID Account Ids can be used to identify accounts in other API calls, such as exportDimensionFamilies. Sheet Element is optional. If you include the sheet element, you must pass the the internal system ID for the sheet in your request. See exportSheets.	List of all accounts, including all account types: Assumptions, Cube Accounts, Custom Accounts, GL Accounts, Metric Accounts, and Modeled Accounts.
exportActiveCurrencies	Currency ID This can be used to uniquely identify the currency, and can be used in customReportValues API.	List of all currencies which have been configured in the system.
exportAttributes	Attribute ID and attributeValue element ID	List of all attributes in the system.
exportDimensions	Dimension ID and its dimensionValue element ID This can be used to identify dimensions in other API calls, such as exportDimensionFamilies.	List of all dimensions in the system.
exportGroups	User group Id and user Id who owns this user group (only set when isGlobal="false").	List of all groups defined for the given instance. This includes those groups defined for global across the whole instance and those groups defined by users.
exportLevels	Level ID	List of all organization levels in the system.
exportPermissionSets Available in API v25+.	Permission Set ID This is used to identify the permission set assigned to a user in the exportUsers API call.	List of all permission sets in the instance.
exportRoles Available in API v25 and earlier. Not available in API v25+.	Role ID This is used to identify the role assigned to a user in the exportUsers API call.	List of all roles in the instance.
exportSheets	Sheet ID (can be standard , cube and modeled sheet elements) This can be used to identify sheets in other API calls, such as exportSheetDefinition.	List of all sheets defined for the given instance. This includes "incomplete" sheets as well as user-assigned sheets.
exportTime	Initial balance time period ID	Time metadata either for a specific version, or for all versions if none is specified.
exportTransactionDefinition	IDs for dimension, text-selector and value elements.	The definition (available columns) of the transactions in the instance.
exportUsers	User ID and the role ID assigned to this user	List of all users in the instance.
exportVersions	Version or folder ID All IDs are unique among all versions, sub-versions, and folders.	An XML document describing the set of all versions defined in the instance which are not hidden from the requesting user after verification.