createDimension

Non pris en charge dans API v20 et supérieure. Utilisez updateDimensions.

Catégorie	Modification des métadonnées
Description	Créez une dimension. Si elle réussit, l'API renvoie le détail de la dimension qui vient d'être créée.
Autorisations requises pour appeler	Rapport modèle
Paramètres obligatoires à la demande	Identifiants

La demande de ce mode contient un marqueur d'identifiant pour identifier et autoriser l'utilisateur appelant. L'utilisateur doit avoir l'autorisation Modèle pour créer la dimension.

Format de demande


<?xml version='1.0' encoding='UTF-8'?>
<call method="createDimension" callerName="fred">
<credentials login="sampleuser@company.com" password="my_pwd" />
<dimension
name="New Dimension Name"
/>
</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 afin que l'appel d'API s'appelle 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)

élément de dimension
Nom du marqueur	dimension
Description	Indique une dimension à créer.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
nom	O	Nom de la dimension. Le nom doit être unique.	NewDimensionName
shortName	N	Titre affichable de la colonne, tel qu'il apparaît sur la feuille.	NewDimensionShortName
listDimension	N	"1" signifie qu'il s'agit d'une dimension en liste, "0" (ou non précisé) signifie qu'elle ne l'est pas.	0
useOnLevels	N	"1" signifie que cette dimension peut être utilisée dans des périmètres, "0" (ou non spécifiée) signifie qu'elle ne peut pas être utilisée.	0
autoCreate	N	"1" signifie que les valeurs de cette dimension peuvent être créées via l'import, "0" (ou non spécifié) signifie qu'elles ne peuvent pas.	0
keepSorted	N	"1" signifie que les valeurs de cette dimension sont toujours triées par ordre alphabétique, "0" (ou non spécifiée) signifie qu'elles peuvent être triées manuellement.	0
Contenu de l'élément
(aucun)

Format de la réponse


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<output>
<dimensions>
<dimension id="41" name="New Dimension Name" shortName="" autoCreate="0" listDimension="0"
keepSorted="0" useOnLevels="0">
</dimension>
</dimensions>
</output>
</response>

Élément Dimensions
Nom du marqueur	dimensions
Description	Conteneur pour un ou plusieurs éléments de dimension.
Attributs de l'élément
(aucun)
Contenu de l'élément
Un ou plusieurs éléments de dimension.

élément de dimension
Nom du marqueur	dimension
Description	Représente une dimension personnalisée unique renvoyée en réponse à un appel d'API exportDimensions
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	O	Le numéro d'identification du système interne pour la dimension. Elle peut être utilisée pour identifier les dimensions dans d'autres appels d'API, tels que exportDimensionFamilies.	16
nom	O	Nom de la dimension tel qu'il apparaît sur les rapports et les feuilles.	Customer
shortName	N	Le nom abrégé de la dimension, le cas échéant, tel que saisi dans Administration des dimensions	client.
autoCreate	O	1 si le champ " L'importation de données crée automatiquement des valeurs de dimension" est défini pour la dimension sélectionnée ; 0 autrement.	0
listDimension	O	1 si la dimension sélectionnée est une dimension en liste ; 0 autrement.	1
keepSorted	O	1 si la dimension sélectionnée reste triée, 0 sinon.	1
useOnLevels	O	1 si la dimension sélectionnée peut être utilisée sur les périmètres, 0 sinon.	1
Contenu de l'élément
0 ou plusieurs éléments dimensionValue. Chaque élément dimensionValue inclus représente une "valeur de dimension racine" dans la dimension, une valeur qui n'a pas de valeur parent.