exportInstances
Catégorie
| Metadata retrieval. |
Description
| Renvoie les métadonnées pour la liste complète de toutes les instances de Adaptive Planning auxquels cet utilisateur a accès. |
Autorisations obligatoires pour pouvoir être appelées
| Aucun (doit être un identifiant valide pour l’instance) |
Paramètres requis sur demande
| Identifiants |
La demande de cette méthode contient un marqueur d’identification pour désigner et autoriser l’utilisateur appelant et un marqueur inclus facultatif pour indiquer les instances à inclure dans la réponse. Une fois les données d’identification de l’utilisateur vérifiées, la méthode renvoie un document XML décrivant l’instance indiquée dans les données d’identification, ou l’ensemble complet de toutes les instances auxquelles cet utilisateur a accès. Si la fonction Instances multiples n’a pas été achetée, cet appel renvoie toujours un élément unique pour l’instance à laquelle l’utilisateur appartient.
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 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), et 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 | Le nom de connexion de l’utilisateur qui invoque la méthode API. Cet utilisateur doit disposer des autorisations requises pour invoquer la méthode. | sampleuser@company.com |
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 (à l’aide du séparateur des milliers, des noms de mois et du 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) | |||
inclure un élément
| |||
Nom du marqueur
| inclure | ||
Description
| Représente un ensemble d’indicateurs indiquant quels aspects de l’information sur les instances doivent être inclus ou exclus 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 données d’identification La valeur par défaut, si l’élément ou son attribut n’est pas présent, est Faux. Si cette instance est incluse et vraie, l’API doit renvoyer la liste de toutes les instances auxquelles l’utilisateur a accès. Ces instances ne sont pas retournées de manière imbriquée ou indiquant un parent; elles sont simplement énumérées avec les propriétés indiquées dans l’API. La première instance renvoyée est toujours l’instance par défaut de l’utilisateur. | Faux |
Contenu de l'élément
| |||
(aucun) | |||
Format de 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 | Y | Vrai ou faux, indiquant si l’appel d’API a réussi ou non. Même les appels réussis peuvent contenir des messages d’avertissement dans leur réponse. | vrai |
obsolète | N | S’il est présent dans le marqueur de réponse et défini à Vrai, cet attribut indique que la version de la méthode ou de l’API qui est appelée est obsolète et est officiellement dépréciée. Bien qu’elle continue de fonctionner pour le moment, elle pourrait cesser de fonctionner sous peu. En général, cet attribut n’est pas présent. | faux |
Contenu de l'élément
| |||
Un seul élément de message facultatif et un seul é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 élément de comptes unique. Ce filtre de sortie est standard sur toutes les réponses d’API et enveloppe la sortie valide de tout appel d’API réussi. | |
élément d'instance
| |
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 instance unique à laquelle cet utilisateur a accès, y compris un certain nombre d’attributs de cette instance. | ||
Attributs de l'élément
| |||
Nom de l’attribut
| Obligatoire?
| Valeur
| Exemple
|
code | Y | Le code d’instance de l’instance. Cela peut être utilisé pour préciser une autre instance pour un appel d’API dans l’élément lié aux données d’identification. | INSTANCE1 |
nom | Y | Le nom de l'instance. Ceci est configuré dans Administration > Configuration générale pour cette instance. | Globo Secteurs d'activité |
sessionTimeout | Y | Le délai d’expiration en minutes de la session utilisateur. | 60 |
devise du système | Y | Code ISO de la devise du système. | USD |
produits | Y | Liste de noms de produits séparés par des virgules qui sont activés pour l’instance. | PLANIFICATION,CONSOLIDATION,EXPLORATION,INTÉGRATION |
options | Y | Liste de différents modules activés pour l’instance, séparés par des virgules. | TRANSACTIONS,MULTI_CURRENCY,DISCO_DISABLED,WORKDAY,PLANNING_VISUALIZE_DATA |
datasources | Y | Liste de sources de données activées pour l’instance, séparées par des virgules. | WORKDAY, NETSUITE, FORCE DES VENTES |
workdayTenantID disponible dans l'API v20+ | N | L’identifiant du locataire Workday ou le nom du locataire qui identifie de manière unique le locataire. Nécessite que Adaptive Planning soit configuré pour Workday, activé par l'attribution de fournitures. | mytenant |
workdayEnvironment disponible dans l'API v20+ | N | L’environnement Workday en tant que Prod ( production), Sandbox (sable à sable), ou Impl (mise en œuvre). Nécessite que Adaptive Planning soit configuré pour Workday, activé par l'attribution de fournitures. | Prod |
workdayUiUrl disponible dans l'API v20+ | N | Le nom de domaine Workday UI URL pour le locataire Workday. Nécessite que Adaptive Planning soit configuré pour Workday, activé par l'attribution de fournitures. | www.myworkday.com/mytenant/d/home.html |
workdayRestUrl disponible dans l'API v20+ | N | Le nom de domaine de l’URL REST pour le locataire Workday. Nécessite que Adaptive Planning soit configuré pour Workday, activé par l'attribution de fournitures. | www.myworkday.com/ccx/service/ |
notificationType disponible dans l'API v24+ | N | Le type de notification pour le locataire Workday. Nécessite que Adaptive Planning soit configuré pour Workday, activé par l'attribution de fournitures. | AUCUN |
Contenu de l'élément
| |||
(aucun) | |||