exportTransactionDefinition

Catégorie	Metadata retrieval
Description	Renvoie la définition (colonnes disponibles) des transactions dans l’instance.
Autorisations obligatoires pour pouvoir être appelées	imp (importer les données) ou Manage_Tx (gérer la définition du champ de transaction)
Paramètres requis sur demande	Identifiants

La demande de cette méthode contient uniquement un marqueur d’identification pour désigner et autoriser l’utilisateur qui est auteur de l’appel. Une fois vérifiée, la méthode renvoie un document XML décrivant la définition d’une transaction dans l’instance.

Format de demande


<?xml version="1.0" encoding="UTF-8"?>
<call method="exportTransactionDefinition" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd"/>
</call>

élément de données d'identification
Nom du marqueur		données d'identification
Description		Tous les appels d’API doivent contenir un élément d’identification unique pour identifier l’utilisateur qui invoque l’API. L’appel d’API est alors effectué en tant que cet utilisateur (toute piste d’audit ou tout historique des actions dans le système indiquera que cet utilisateur a effectué l’action). Par conséquent, l’utilisateur doit disposer des autorisations requises pour effectuer l’action dans l’ordre pour l’API. appel pour réussir.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
ouvrir une session	Y
mot de passe	Y	Le mot de passe de l’utilisateur qui invoque la méthode API.	my_password
paramètres régionaux	N	Indiquez les paramètres régionaux à utiliser pour interpréter les numéros et les dates entrants, et pour mettre en forme les numéros et les dates sortants (en utilisant le séparateur des milliers, les noms de mois et le format de date appropriés). Les paramètres régionaux sont également utilisés pour préciser la langue dans laquelle tous les messages de système de la réponse doivent être affichés. Si cette valeur n’est pas précisée, la valeur en_US (rubrique en anglais américain) est utilisée.	fr_FR
instanceCode	N	Si l’utilisateur indiqué dans les données d’identification a accès à plusieurs instances de Adaptive Planning , cet attribut peut être utilisé pour préciser que l’utilisateur a l’intention d’accéder à une instance autre que celle par défaut. Si elle n’est pas précisée, l’instance par défaut de l’utilisateur sera utilisée. Pour déterminer les codes d’instances disponibles, utilisez l’API exportInstances.	MYINSTANCE1
Contenu de l'élément
(aucun)

Format de réponse


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
<output>
   <transaction>
     <fields>
       <posting-date name="Posting Date"/>
       <type name="Transaction Type">
         <value id="178" name="Journal Entry"/>
         <value id="179" name="Purchase Order"/>
         <value id="177" name="Invoice"/>
         <value id="180" name="Transaction"/>
       </type>
       <accounts name="Account"/>
       <levels name="Plan"/>
       <dimension id="4" name="Product">
         <value id="48" name="B-2"/>
         <value id="47" name="B-1"/>
         <value id="14" name="A"/>
         <value id="15" name="B-Ste"/>
       </dimension>
       <text-selector id="4" name="Flavor">
         <value id="123" name="Chocolate"/>
         <value id="122" name="Vanilla"/>
       </text-selector>
       <text name="Description"/>
       <number name="Sales Tax"/>
       <date name="Due Date"/>
       <amount name="Transaction Amount"/>
     </fields>
   </transaction>
</output>
</response>

Chacun des champs d’une transaction est défini par l’un des éléments suivants :

posting-date (un)

type (un)

comptes (un)

niveaux (un)

dimension (zéro ou plus)

text-sélecteur (zéro ou plus)

texte (zéro ou plus)

nombre (zéro ou plus)

date (zéro ou plus)

montant (un)

élément de transaction
Nom du marqueur		transaction
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
(aucun)
Contenu de l'élément
Un élément de champ.

élément de champs
Nom du marqueur		fields
Description		Un conteneur pour tous les champs obligatoires et facultatifs.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
(aucun)
Contenu de l'élément
Un élément pour chacun des champs que chaque transaction doit comporter.

élément de date d'inscription
Nom du marqueur		posting-date
Description		La date requise à laquelle la transaction a été inscrite.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
nom	Y	En-tête imprimé de ce champ.	Date d'inscription
Contenu de l'élément
(aucun)

élément de type
Nom du marqueur		type
Description		Le type de transaction requis
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
nom	Y	En-tête imprimé de ce champ.	Type de transaction
Contenu de l'élément
Un ou plusieurs éléments de valeur.

élément des comptes
Nom du marqueur		comptes
Description		Le compte auquel cette transaction appartient. Les métadonnées de compte, y compris la structure hiérarchique, peuvent être obtenues par un appel à exportAccounts.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
nom	Y	En-tête imprimé de ce champ.	Compte
Contenu de l'élément
(aucun)

élément niveaux
Nom du marqueur		niveaux
Description		Le niveau auquel cette transaction appartient. Les métadonnées de niveau, y compris la structure hiérarchique, peuvent être obtenues par un appel à exportLevels.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
nom	Y	En-tête imprimé de ce champ.	niveau
Contenu de l'élément
(aucun)

élément de dimension
Nom du marqueur		dimension
Description		Dimension affectable à une transaction. Les métadonnées de dimension complètes, y compris leur structure hiérarchique, peuvent être obtenues par un appel distinct à exportDimensions.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
identifiant	Y	Identifiant numérique interne pour la dimension.	42
nom	Y	En-tête imprimé de ce champ.	Produit
Contenu de l'élément
Un ou plusieurs éléments de valeur.

élément de sélecteur de texte
Nom du marqueur		sélecteur de texte
Description		Liste personnalisée de valeurs définies pour marquer des transactions.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
identifiant	Y	Identifiant numérique interne pour le sélecteur de texte.	42
nom	Y	En-tête imprimé de ce champ.	Flavor
Contenu de l'élément
Un ou plusieurs éléments de valeur.

élément de valeur
Nom du marqueur		valeur
Description		L'une des valeurs définies pour le type, la dimension ou le sélecteur de texte.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
identifiant	Y	Identifiant numérique interne pour la valeur.	42
nom	Y	Représentation imprimée de la valeur.	Facture
Contenu de l'élément
(aucun)

élément de texte
Nom du marqueur		texte
Description		Texte générique correspondant à une transaction.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
nom	Y	En-tête imprimé de ce champ.	Description
Contenu de l'élément
(aucun)

élément de nombre
Nom du marqueur		nombre
Description		Numéro générique affecté à une transaction.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
nom	Y	En-tête imprimé de ce champ	Taxe de vente
Contenu de l'élément
(aucun)

élément de date
Nom du marqueur		date
Description		Date générique affectée à une transaction.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
nom	Y	En-tête imprimé de ce champ.	Date d'échéance
Contenu de l'élément
(aucun)

élément de montant
Nom du marqueur		montant
Description		Le montant requis pour une transaction.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
nom	Y	En-tête imprimé de ce champ.	Montant de la transaction
Contenu de l'élément
(aucun)