exportInstances

Catégorie	Metadata retrieval.
Description	Renvoie les métadonnées de la liste complète de toutes les instances de Adaptive Planning auxquels cet utilisateur a accès.
Autorisations requises pour appeler	Aucun (doit être des identifiants valides pour l'instance)
Paramètres obligatoires à la demande	Identifiants

La demande de cette méthode contient un marqueur identifiants pour identifier et autoriser l'utilisateur appelant, et un marqueur facultatif d'inclure pour indiquer quelles instances inclure dans la réponse. Une fois que les identifiants de l'utilisateur sont vérifiés, la méthode renvoie un document XML décrivant l'instance indiquée dans les identifiants ou l'ensemble complet de toutes les instances auxquelles cet utilisateur a accès. Si la fonctionnalité Instances multiples n'a pas été achetée, cet appel renvoie toujours un seul élément pour l'instance à laquelle appartient l'utilisateur.

Format de demande


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportInstances" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd"/>
 <include accessibleInstances="true"/>
</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 (toute la piste d'audit ou l'historique des 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	Le nom de connexion de l'utilisateur appelant la méthode API. Cet utilisateur doit avoir les autorisations requises pour appeler la méthode.	sampleuser@company.com
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)

inclure l'élément
Nom du marqueur		inclure
Description		Représente un ensemble d'indicateurs indiquant quels aspects des informations des instances doivent être incluses ou exclues de la réponse. Cet élément est facultatif : s'il est absent, la valeur par défaut est fausse pour accessibleInstances.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
accessibleInstances	N	Vrai ou Faux. Si la réponse doit inclure d'autres instances en plus de l'instance unique indiquée dans les identifiants. La valeur par défaut, si l'élément ou son attribut n'est pas présent, est false (faux). Si la règle est incluse et que la valeur est true, l'API doit renvoyer la liste de toutes les instances auxquelles l'utilisateur a accès. Ces instances ne sont renvoyées d'aucune manière imbriquée ou indiquant un parent ; elles sont simplement énumérées avec les propriétés affichées dans l'API. La première instance renvoyée est toujours l'instance par défaut pour l'utilisateur.	Faux
Contenu de l'élément
(aucun)

Format de la réponse


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<output>
  <instances>
    <instance code="INSTANCE1" name="Globo Industries" sessionTimeout="60" calendarType="G" systemCurrency="USD" products="PLANNING,DISCOVERY" options="TRANSACTIONS,MULTI_CURRENCY,DISCO_DISABLED,WORKDAY,PLANNING_VISUALIZE_DATA" workdayTenantID="mytenant" workdayEnvironment="Prod" workdayUiUrl="www.myworkday.com/mytenant/d/home.html" workdayRestUrl="www.myworkday.com/ccx/service/" datasources="WORKDAY,GREAT PLAINS,INTACCT,SALESFORCE,NETSUITE" notificationType="NONE"/>
  </instances>
</output>
</response>

élément de réponse
Nom du marqueur		réponse
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
réussite	O	Vrai ou faux, indiquant si l'appel d'API a réussi ou non. Même les appels traités avec succès peuvent contenir des messages d'avertissement dans leur réponse.	vrai
obsolète	N	S'il figure sur le marqueur de réponse et qu'il est défini sur true (vrai), cet attribut indique que la version de la méthode ou de l'API en cours d'appel est obsolète et qu'elle est officielement dépréciée. Même si elle continue de fonctionner à ce moment, elle peut cesser de fonctionner prochainement. En général, cet attribut n'est pas présent.	false
Contenu de l'élément
Un seul élément de messages facultatifs et exactement un élément de sortie obligatoire.

élément de sortie
Nom du marqueur	sortie
Attributs de l'élément
(aucun)
Contenu de l'élément
Un seul élément comptes. Ce filtre de sortie est standard sur toutes les réponses d'API et contient la sortie valide de tout appel d'API réussi.

élément instances
Nom du marqueur	instances
Description	Conteneur pour un ou plusieurs éléments d'instance.
Attributs de l'élément
(aucun)
Contenu de l'élément
Un ou plusieurs éléments d'instance.

élément d'instance
Nom du marqueur		instance
Description		Décrit une seule instance à laquelle cet utilisateur a accès, y compris un nombre d'attributs de cette instance.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
code	O	Le code de l'instance. Elle peut être utilisée pour indiquer une autre instance d'appel d'API dans l'élément identifiants.	INSTANCE1
nom	O	Nom de l'instance. Il se configure dans Administration > Paramétrage général de cette instance.	Secteurs d'activité Global
sessionTimeout	O	Expiration en minutes de la session utilisateur.	60
systemCurrency	O	Code ISO de la devise système.	USD
produits	O	Liste des noms de produit séparés par des virgules qui sont activés pour l'instance.	PLAN(S)
options	O	Liste des différents modules activés pour l'instance, séparés par une virgule.	TRANSACTIONS,MULTI_CURRENCY,DISCO_DISABLED,WORKDAY,PLANNING_VISUALIZE_DATA
datasources	O	Liste des sources de données activées pour l'instance, séparées par des virgules.	WORKDAY, NETSUITE, FORCE DE VENTE
workdayTenantID disponible dans API v20 et supérieure	N	Identifiant ou nom d'environnement client Workday qui identifie de manière unique l'environnement client. Adaptive Planning configuré pour Workday, activé par le provisionnement.	mytenant
workdayEnvironment disponible dans API v20 et supérieure	N	L'environnement Workday comme Prod (Production), Sandbox (sandbox) ou Impl (implémentation). Adaptive Planning configuré pour Workday, activé par le provisionnement.	Prod
workdayUiUrl disponible dans API v20 et supérieure	N	Nom de domaine de l'URL de l'interface utilisateur Workday pour l'environnement client Workday. Adaptive Planning configuré pour Workday, activé par le provisionnement.	www.myworkday.com/mytenant/d/home.html
workdayRestUrl disponible dans API v20 et supérieure	N	Nom de domaine REST-URL de l'environnement client Workday. Adaptive Planning configuré pour Workday, activé par le provisionnement.	www.myworkday.com/ccx/service/
notificationType disponible dans API v24 et supérieure	N	Type de notification pour l'environnement client Workday. Adaptive Planning configuré pour Workday, activé par le provisionnement.	NONE
Contenu de l'élément
(aucun)