Référence des identifiants internes

Vous pouvez inclure des identifiants internes dans une demande API pour obtenir des métadonnées pour les méthodes de création, de mise à jour et de lecture. Lorsque vous effectuez des demandes pour ces méthodes, utilisez les appels d'API d'exportation associés pour obtenir les codes requis par votre demande. Les demandes pour toutes les API du tableau ci-dessous nécessitent un élément identifiants.

Exemple

Vous devez transmettre l'identifiant de la dimension pour mettre à jour une dimension dans la demande API updateDimensions . Vous pouvez transmettre le code de dimension "7" pour mettre à jour la dimension "Études
".


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

L'identifiant de dimension "7" pour "Études" est obtenu à partir de la réponse API 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>

Exporter les API et les codes de réponse

API	Adaptive Planning Identifiants internes dans la réponse	Métadonnées extraites
exportAccounts	Identifiant du compte et identifiant de l'attribut de compte Les identifiants de compte peuvent être utilisés pour identifier des comptes dans d'autres appels d'API, tels que exportDimensionFamilies. L'élément de feuille est facultatif. Si vous incluez l'élément de feuille, vous devez transmettre l'identifiant système interne de la feuille dans votre demande. Voir exportSheets.	La liste de tous les comptes, y compris tous les types de compte : Hypothèses, Comptes cubes, Comptes personnalisés, Comptes GL, Comptes métriques et Comptes modèles
exportActiveCurrencies	Code de devise Il peut être utilisé pour identifier de manière unique la devise et peut être utilisé dans l'API customReportValues .	Liste de toutes les devises qui ont été configurées dans le système.
exportAttributes	Identifiant de l'attribut et identifiant de l'élément attributeValue	Liste de tous les attributs du système.
exportDimensions	Identifiant de la dimension et son identifiant d'élément dimensionValue Elle peut être utilisée pour identifier les dimensions dans d'autres appels d'API, tels que exportDimensionFamilies.	Liste de toutes les dimensions du système.
exportGroups	Identifiant du groupe d'utilisateurs et Identifiant de l'utilisateur qui est responsable de ce groupe d'utilisateurs (défini uniquement lorsque isGlobal="faux").	Liste de tous les groupes définis pour l'instance donnée. Cela inclut les groupes définis pour l'ensemble de l'instance et les groupes définis par les utilisateurs.
exportLevels	Code du périmètre	Liste de tous les niveaux d'organisation dans le système.
exportPermissionSets Disponible dans API v25 et supérieure.	Code de l'ensemble d'autorisations Elle permet d'identifier l'ensemble d'autorisations attribué à un utilisateur dans l'appel d'API exportUsers.	Liste de tous les ensembles d'autorisations de l'instance.
exportRoles Disponible dans API v25 et antérieures. Non disponible dans API v25 et supérieure.	Identifiant du rôle Il permet d'identifier le rôle affecté à un utilisateur dans l'appel d'API exportUsers.	Liste de tous les rôles de l'instance.
exportSheets	Identifiant de la feuille (il peut s'agir d'éléments de feuilles standard, cubes et modèles) Cela peut être utilisé pour identifier des feuilles dans d'autres appels d'API, tels que exportSheetdéfinition.	Liste de toutes les feuilles définies pour l'instance donnée. Cela inclut les feuilles "incomplètes" et les feuilles affectées à des utilisateurs.
exportTime	Code de la période du solde initial	Les métadonnées de temps d'une version spécifique ou de toutes les versions si aucune n'est spécifiée.
exportTransactiondéfinition	Identifiants pour les éléments de dimension, de sélecteur de texte et de valeur.	Définition (colonnes disponibles) des transactions dans l'instance.
exportUsers	Le code utilisateur et le code du rôle affecté à cet utilisateur	Liste de tous les utilisateurs de l'instance.
exportVersions	Code de la version ou du dossier Tous les identifiants sont uniques pour toutes les versions, sous-versions et dossiers.	Un document XML décrivant l'ensemble des versions définies dans l'instance qui ne sont pas masquées à l'utilisateur demandeur après vérification.