exportTransactionDefinition

Catégorie	Metadata retrieval
Description	Renvoie la définition (colonnes disponibles) des transactions dans l'instance.
Autorisations requises pour appeler	impl (import des données) ou Manage_TX (gérer la définition du champ de transaction)
Paramètres obligatoires à la demande	Identifiants

La demande de ce mode contient uniquement un marqueur d'identifiant pour identifier et autoriser l'utilisateur appelant. 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 identifiants
Nom du marqueur		identifiants
Description		Tous les appels d'API doivent contenir un seul élément identifiants pour identifier l'utilisateur qui a appelé l'API. L'appel d'API est ensuite effectué en tant qu'utilisateur ( n'importe quelle piste d'audit ou historique d'actions dans le système indique que cet utilisateur a effectué l'action) et, par conséquent, l'utilisateur doit avoir les autorisations requises pour effectuer l'action dans l'ordre pour l'API appelez pour réussir.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
se connecter	O
mot de passe	O	Mot de passe de l'utilisateur appelant la méthode API.	my_password
paramètres régionaux	N	Indiquez les paramètres régionaux à utiliser pour interpréter les chiffres et les dates entrants, et pour formater les chiffres et les dates sortants (en utilisant le séparateur des milliers, les noms de mois et la mise en forme de date appropriés). Les paramètres régionaux sont également utilisés pour indiquer la langue dans laquelle doivent s'afficher les messages système figurant dans la réponse. Si aucune option n'est indiquée, l'expression en_US (anglais américain) est utilisée.	fr_FR
instanceCode	N	Si l'utilisateur spécifié dans les identifiants a accès à plusieurs instances de : Adaptive Planning , cet attribut peut être utilisé pour indiquer que l'utilisateur a l'intention d'accéder à une instance autre que son instance par défaut. Si aucune option n'est indiquée, l'instance par défaut de l'utilisateur sera utilisée. Pour déterminer les codes d'instance disponibles, utilisez l'API exportInstances.	MYINSTANCE1
Contenu de l'élément
(aucun)

Format de la 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)

périmètres (un)

dimension (zéro ou plus)

text-Selector (zéro ou plus)

text (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 champs.

élément champs
Nom du marqueur		fields
Description		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 avoir.

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

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

élément 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 en appelant exportAccounts.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
nom	O	En-tête imprimé de ce champ.	Compte
Contenu de l'élément
(aucun)

élément périmètres
Nom du marqueur		périmètre(s)
Description		Le périmètre auquel cette transaction appartient. Les métadonnées de périmètre, y compris la structure hiérarchique, peuvent être obtenues en appelant exportLevels.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
nom	O	En-tête imprimé de ce champ.	level
Contenu de l'élément
(aucun)

élément de dimension
Nom du marqueur		dimension
Description		Une 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
id	O	Identifiant numérique interne de la dimension.	42
nom	O	En-tête imprimé de ce champ.	Produit
Contenu de l'élément
Un ou plusieurs éléments de valeur.

élément text-Selector
Nom du marqueur		text-Selector
Description		Liste personnalisée des valeurs définies pour marquer les transactions.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	O	Identifiant numérique interne du sélecteur de texte.	42
nom	O	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 d'intégration, la dimension ou le sélecteur de texte.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	O	Identifiant numérique interne pour la valeur.	42
nom	O	Représentation imprimée de la valeur.	Facture
Contenu de l'élément
(aucun)

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

élément numérique
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	O	En-tête imprimé de ce champ	Taxe sur CA
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	O	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		Montant en devise requis pour une transaction.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
nom	O	En-tête imprimé de ce champ.	Montant de la transaction
Contenu de l'élément
(aucun)