updateDimension

Non pris en charge dans l'API v20 +. Utilisez updateDimensions.

Catégorie	Modification de métadonnées
Description	Mettez à jour une dimension. En cas d’une mise à jour réussie, l’API renvoie les détails de la dimension qui vient d’être mise à jour.
Autorisations obligatoires pour pouvoir être appelées	Modèle
Paramètres requis sur demande	Identifiants

La demande de cette méthode contient un marqueur d’identifiants pour désigner et autoriser l’utilisateur auteur de l’appel. L'utilisateur doit avoir l'autorisation Modèle pour créer la dimension.

Les conditions suivantes s’appliquent à cette API :

Cette méthode renvoie une erreur s’il existe des modifications non publiées.

Vous ne pouvez pas désactiver listDimension si des attributs de dimension sont définis ou si les valeurs ne sont pas toutes disponibles dans toutes les versions.

Vous ne pouvez pas désactiver listDimension si vous avez une dimensionValeurs hiérarchique.

Vous ne pouvez pas activer à la fois UseOnLevels et listDimension. (il est possible de désactiver l’un et l’autre dans la même commande.)

Format de demande


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimension" callerName="fred">
    <credentials login="sampleuser@company.com" password="my_pwd" />
    <dimension id="34"
       name="Updated Dimension Name"
     />
</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 afin que l’appel d’API puisse être exécuté 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)

é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
identifiant	Y	Identifiant de la dimension mise à jour.	34
nom	N	Le nom de la dimension. Le nom doit être unique.	NewDimensionName
shortName	N	Titre affiché de la colonne, comme on le voit sur la feuille.	NewDimensionShortName
listDimension	N	"1" signifie qu'il s'agit d'une dimension de liste, "0" (ou non précisé) signifie qu'elle n'en est pas une.	0
useOnLevels	N	"1" signifie que cette dimension peut être utilisée dans des niveaux, "0" (ou non précisée) signifie qu’elle ne peut pas être utilisée.	0
autoCreate	N	"1" signifie que les valeurs pour cette dimension peuvent être créées via l'importation, "0" (ou non indiqué) 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 précisé) signifie qu’elles peuvent être triées manuellement.	0
Contenu de l'élément
(aucun)

Format de 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 de 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
identifiant	Y	Le numéro d’identifiant de système interne pour la dimension. Cela peut être utilisé pour désigner des dimensions dans d’autres appels d’API, tels que exportDimensionFamis.	16
nom	Y	Le nom de la dimension, tel qu’il apparaît sur les rapports et les feuilles.	Client
shortName	N	Nom abrégé de la dimension, le cas échéant, tel qu’il est entré dans l’administration des dimensions	client.
autoCreate	Y	1 si la dimension sélectionnée comporte l’ensemble de champs " Importation de données crée automatiquement des valeurs de dimension "; 0 dans le cas contraire.	0
listDimension	Y	1 si la dimension sélectionnée est une dimension de liste; 0 dans le cas contraire.	1
keepSorted	Y	1 si la dimension sélectionnée est conservée et triée, 0 dans le cas contraire.	1
useOnLevels	Y	1 si la dimension sélectionnée peut être utilisée dans les niveaux, 0 dans le cas contraire.	1
Contenu de l'élément
Zéro 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.

Élément dimensionValue
Nom du marqueur		dimensionValue
Description		Représente une valeur de membre unique d'une dimension personnalisée renvoyée en réponse à un appel d'API exportDimensions.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
identifiant	Y	Le numéro d'identifiant de système interne pour cette valeur de membre de la dimension.	34
nom	Y	Étiquette de la valeur membre de la dimension, telle qu'elle est affichée dans les rapports et utilisée dans les formules.	Une entreprise
shortName	N	Nom abrégé de la valeur de dimension, le cas échéant, tel qu'il est entré dans l'administration des dimensions	A
description	N	Description de la valeur de dimension, le cas échéant, telle qu’elle est entrée dans l’administration des dimensions	Une société
Contenu de l'élément
Zéro ou plusieurs éléments dimensionValue facultatifs. Chaque élément dimensionValue inclus représente une "valeur de dimension enfant" de cette valeur de dimension, dont les membres sont implicitement regroupés dans cette valeur.

élément d'attributs
Nom du marqueur		attributs
Description		Conteneur pour un ou plusieurs éléments d'attribut de dimension.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
(aucun)
Contenu de l'élément
Un ou plusieurs éléments d'attribut.

élément d'attribut
Nom du marqueur		attribut
Description		Conteneur pour un élément d'attribut de dimension.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
attributeID	Y	Identifiant de l'attribut de dimension généré par le système.	20
nom	Y	Nom de l'attribut de dimension	Type d'études
valueID	Y	Identifiant unique de la valeur d'attribut de dimension générée par le système.	170
valeur	Y	La valeur de l'attribut de dimension.	Tech1
Contenu de l'élément
(aucun)