Référence d'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 faites des demandes pour ces méthodes, utilisez les appels d’API Export associés pour obtenir les identifiants dont votre demande a besoin. Les demandes pour toutes les API du tableau ci-dessous nécessitent un élément d’identification.

Exemple

Vous devez transmettre l'identifiant de la dimension pour mettre à jour une dimension dans la demande API updateDimensions . Vous pouvez transmettre l'identifiant de la 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 la dimension "7" pour "Études" est obtenu à partir de la réponse de l'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 des API et des identifiants de réponse

API	Adaptive Planning Identifiants internes dans la réponse	Métadonnées récupérées
exportAccounts	Identifiant de compte et identifiant d'attribut de compte Les identifiants de compte peuvent être utilisés pour désigner des comptes dans d’autres appels d’API, tels que exportDimensionFamis. L'élément de feuille est facultatif. Si vous incluez l’élément de feuille, vous devez transmettre l’identifiant de système interne de la feuille dans votre demande. Voir exportShees.	Liste de tous les comptes, y compris tous les types de comptes : Hypothèses, Comptes cubes, Comptes personnalisés, Comptes GL, Comptes d’indicateurs et Comptes modélisés.
exportActiverDevises	Code de devise Cela peut être utilisé pour identifier de manière unique la devise et être utilisé dans l’API customReportValeurs .	Liste de toutes les devises qui ont été configurées dans le système.
exportAttributes	Identifiant d'attribut et identifiant d'élément attributeValue	Liste de tous les attributs du système.
exportDimensions	Identifiant de la dimension et son identifiant d'élément dimensionValue Cela peut être utilisé pour désigner des dimensions dans d’autres appels d’API, tels que exportDimensionFamis.	Liste de toutes les dimensions du système.
ExportGroups	L’identifiant du groupe d’utilisateurs et l’identifiant de l’utilisateur qui est propriétaire de ce groupe d’utilisateurs (défini uniquement lorsque isGlobal="false")	Liste de tous les groupes définis pour l’instance donnée. Cela inclut les groupes définis pour un niveau global dans l’ensemble de l’instance et les groupes définis par les utilisateurs.
exportLevels	Identifiant de niveau	Liste de tous les niveaux d’organisation du système.
exportPermissionSets Disponible dans API v25+.	Identifiant de l'ensemble d'autorisations Cela permet de désigner l’ensemble d’autorisations affecté à un utilisateur dans l’appel d’API exportUsers.	Liste de tous les ensembles d’autorisations de l’instance.
exportRoles Disponible dans l’API v25 et dans les versions antérieures. Non disponible dans l'API v25+.	Identifiant de rôle Cela est utilisé pour désigner le rôle affecté à un utilisateur dans l’appel d’API exportUsers.	Liste de tous les rôles dans l’instance.
exportShees	Identifiant de la feuille (élément pouvant être un élément de feuille standard, cube ou modélisée) Cela peut être utilisé pour désigner des feuilles dans d’autres appels d’API, tels que exportSheetDefinition.	Liste de toutes les feuilles définies pour l’instance donnée. Cela inclut les feuilles "incomplètes" ainsi que les feuilles affectées à des utilisateurs.
exportTime	Identifiant de période de solde initial	Les métadonnées de temps pour une version précise ou pour toutes les versions si aucune n’est précisée.
exportTransactionDefinition	Identifiants pour les éléments de dimension, de sélecteur de texte et de valeur.	La définition (colonnes disponibles) des transactions dans l’instance.
exportUsers	L’identifiant d’utilisateur et l’identifiant de rôle affecté à cet utilisateur	Liste de tous les utilisateurs de l’instance.
exportVersions	Identifiant de version ou de dossier Tous les identifiants sont uniques parmi toutes les versions, sous-versions et dossiers.	Document XML décrivant l’ensemble de toutes les versions définies dans l’instance qui ne sont pas masquées pour l’utilisateur demandeur après la vérification.