Passer au contenu principal
Documentation
Documentation
Adaptive Planning
Dernière mise à jour : 2025-10-03
updateDimensions

updateDimensions

Prise en charge dans API v17 et supérieure
Pour une seule demande, appelez
updateDimensions
 Les demandes sont limitées à la mise à jour de 10 000 valeurs de dimension maximum dans une dimension hiérarchique ou de 40 000 valeurs de dimension dans une dimension plate. Ces limites ne s'appliquent pas à la création de nouvelles valeurs de dimensions au sein d'une demande.
Catégorie
Modification des métadonnées
Description
Mettre à jour un ensemble de dimensions existantes et leurs valeurs de dimension. Plusieurs dimensions et valeurs peuvent être mises à jour en un seul appel. Si elle aboutit, l'API renvoie le détail des dimensions qui viennent d'être mises à jour.
Autorisations requises pour appeler
Modèle et autorisations sur chaque dimension
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 le "Modèle" Concept : ensembles d'autorisations et l'autorisation requise pour gérer les dimensions en cours de mise à jour.
Bonne pratique : Invoquer exportDimensions afin de récupérer les codes de dimensions Planning nécessaires à votre demande updateDimensions. Aucune modification ne doit être apportée aux dimensions Planning via l'interface utilisateur ou les API Planning avant que vous ne soumettiez votre demande updateDimensions.
HTTP
Description
Method
Post
Content-Type
text/xml

Exemple de boucle


curl -H "Content-Type: text/xml" -d @C:/temp/updateDimVal.xml -X POST https://api.adaptiveplanning.com/api/v17
updateDimVal.xml contents

<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimensions" callerName="Steve C">
 <credentials login="sampleuser@company.com" password="my_password"/>
<dimensions>
   <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0">
     <dimensionValue id="32" name="Graduate" description="Modified Graduate degree" />
   </dimension>
</dimensions>
</call>

Joindre un exemple de URL de fichier XML



curl -i -X POST -H "Content-Type: multipart/form-data" -F "request=<C:/temp/requestCreateNewDimVal.xml" -F "content=@C:/temp/createNewDimVal.xml" https://api.adaptiveplanning.com/api/v17
requestCreateNewDimVal.xml content


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimensions" callerName="Steve C">
 <credentials login="sampleuser@company.com" password="my_password"/>
</call>
createNewDimVal.xml


<?xml version='1.0' encoding='UTF-8'?>
<dimensions>
  <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0">
    <dimensionValue id="" name="Graduate" description="Graduate degree" />
  </dimension>
</dimensions>
Pour les données utiles volumineuses, vous pouvez publier des fichiers XML compressés (zip). Voir Mise à jour en bloc des métadonnées.

Format de demande


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimensions" callerName="Steve C">
 <credentials login="sampleuser@company.com" password="my_password"/>
<dimensions>
   <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0">
     <dimensionValue id="32" name="Graduate" description="Graduate degree" shortName="" allVersions="0">
         <attribute name="Education Type" value="Tech1" />
         <version name="Budget 2017" available="1" />
     </dimensionValue>
     <dimensionValue id="33" name="Masters" description="Masters degree" shortName="" allVersions="0">
         <attribute name="Education Type" value="Management" />
         <version name="Budget 2017" available="1" />
     </dimensionValue>
     <dimensionValue id="34" name="Phd" description="Phd" shortName="" />
   </dimension>
   <dimension id="16" name="Geography" property1="Latitude" property2="Longitude">            
     <dimensionValue id="521" name="United States" description="USA" shortName="">                
       <dimensionValue id="555" name="Alabama" description="1" shortName="">                    
         <dimensionValue id="579" name="205" description="1" shortName="">                        
           <dimensionValue id="4718" name="35004" description="33" shortName="">                            
             <properties>                                
               <property name="Latitude" value="33.6015" />                                
               <property name="Longitude" value="86.4895" />                            
             </properties>                        
           </dimensionValue>                        
           <dimensionValue id="4719" name="35005" description="" shortName="" />                    
         </dimensionValue>                    
         <properties>                        
           <property name="Latitude" value="" />                        
           <property name="Longitude" value="86.9023" />                    
         </properties>                
       </dimensionValue>            
     </dimensionValue>        
   </dimension>
</dimensions>
</call>
Les conditions suivantes s'appliquent à updateDimensions :
  • Les dimensions et valeurs de dimension sont toutes deux identifiées pour être mises à jour via leur numéro d'identifiant interne.
  • Devise, une dimension système, ne peut pas être mise à jour via l'API.
  • Pour créer de nouvelles dimensions et valeurs de dimension, attribuez-leur une propriété d'identifiant vide ou manquante.
    • Dans une dimension existante, vous pouvez déplacer une dimensionValue existante (non nouvelle) sous une nouvelle dimensionValue. Ainsi, la nouvelle dimensionValue est créée et la valeur de dimension existante est déplacée sous celle-ci en tant qu'enfant.
  • Toutes les valeurs de dimension créées pour les dimensions plates sont visibles par défaut dans toutes les versions du plan. Pour spécifier la visibilité, vous devez la mentionner explicitement en utilisant l'un des éléments suivants :
    • Le
      allVersions
       attribut dans
      dimensionValue
       marqueur
    • Ou en fournissant aux enfants
      version
       marqueurs sous
      dimensionValue
       pour personnaliser la visibilité
    updateDimensions met uniquement à jour la disponibilité des versions pour les versions du plan. Vous ne pouvez pas mettre à jour la disponibilité des versions pour les versions de montants réels, même lorsque allVersions=1.

Format de la demande pour créer une nouvelle valeur de dimension

Pour créer une nouvelle valeur de dimension, incluez son parent avec son identifiant. Par exemple, pour ajouter une nouvelle valeur enfant sous le
Engr
 valeur qui a
id 7
, vous pouvez utiliser :

<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimensions" callerName="Steve C">
 <credentials login="sampleuser@company.com" password="my_password"/>
 <dimensions>
   <dimension id="7">
     <dimensionValue id="" name="Documentation" description="docs" shortName="" >
       <properties>                                
         <property name="OwnerID" value="58371998"/>                                                            
       </properties>        
     </dimensionValue>
   </dimension>
 </dimensions>  
</call>
Cette méthode ne modifie rien au niveau de la valeur
id 7
. Elle crée un nouvel enfant nommé
Docs
 pour
id 7
. Tous les enfants non mentionnés sont transférés en fin de liste. C'est l'équivalent de "définir le parent" pour la nouvelle valeur, mais il faut inclure ce parent comme élément.

Format de la demande pour créer une nouvelle valeur de dimension avec un code et un nom

Pour créer une nouvelle valeur de dimension, incluez son parent avec son identifiant. Par exemple, pour ajouter une nouvelle valeur enfant sous la valeur Engr qui a l'identifiant 7, vous pouvez utiliser :
<?xml version="1.0" encoding="UTF-8"?>
<call method="updateDimensions" callerName="Steve C">
<credentials login="sampleuser@company.com" password="my_pwd" />
<dimensions displayNameEnabled="1">
   <dimension id="7">
      <dimensionValue id="" code ="Doc" name="Documentation" description="docs" shortName="">
         <properties>
            <property name="OwnerID" value="58371998" />      
         </properties>
      </dimensionValue>
   </dimension>
</dimensions>
</call>

Format d'entrée 1 : les données utiles comprennent une arborescence de dimension entière

L'API updateDimensions fonctionne mieux lorsqu'un appelant souhaite fournir le nouvel état de l'arborescence sans se concentrer sur les modifications.
L'API updateDimensions détecte les modifications apportées à la structure de dimensions, et seules les valeurs de dimension/dimension modifiées ou nouvelles sont mises à jour. Le
dimensions
 l'élément contient un seul enfant direct
dimension
 ou
dimensionValue
 élément.
<?xml version="1.0" encoding="UTF-8"?>
<call method="updateDimensions" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<dimensions>
   <dimension id="16" name="Geography" property1="Latitude" property2="Longitude">
      <dimensionValue id="521" name="United States" description="USA" shortName="">
         <dimensionValue id="555" name="Alabama" description="1" shortName="">
            <dimensionValue id="579" name="205" description="1" shortName="">
               <dimensionValue id="4718" name="35004" description="33" shortName="">
                  <properties>
                     <property name="Latitude" value="33.6015" />
                     <property name="Longitude" value="86.4895" />
                  </properties>
               </dimensionValue>
               <dimensionValue id="4719" name="35005" description="" shortName="" />
            </dimensionValue>
            <properties>
               <property name="Latitude" value="" />
               <property name="Longitude" value="86.9023" />
            </properties>
         </dimensionValue>
      </dimensionValue>
   </dimension>
</dimensions>
</call>

Format de saisie 2 : les données utiles incluent la structure de sous-arbre de dimension

Ce format prend en charge les cas d'utilisation lorsque les modifications sont limitées à une seule partie de la structure d'arbre de dimension.
L'API updateDimensions détecte les modifications apportées à la structure de dimensions, et seules les valeurs de dimension/dimension modifiées ou nouvelles sont mises à jour. Le
dimensions
 l'élément contient un seul enfant direct
dimensionValue
 élément.
Par exemple, les changements se trouvent dans l'Alabama :
<?xml version="1.0" encoding="UTF-8"?>
<call method="updateDimensions" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<dimensions>
   <dimensionValue id="555" name="Alabama" description="1" shortName="">
      <dimensionValue id="579" name="205" description="1" shortName="">
         <dimensionValue id="4718" name="35004" description="33" shortName="">
            <properties>
               <property name="Latitude" value="33.6015" />
               <property name="Longitude" value="86.4895" />
            </properties>
         </dimensionValue>
         <dimensionValue id="4719" name="35005" description="" shortName="" />
      </dimensionValue>
   </dimensionValue>
</dimensions>
</call>
Pour les dimensions plates, vous devez indiquer le parent
dimension
 marquer sous le
dimensions
 le marqueur, suivi d'une ou plusieurs valeurs de dimension. Le
dimensions
 l'élément contient un seul enfant direct
dimension
 élément.
<?xml version="1.0" encoding="UTF-8"?>
<call method="updateDimensions" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<dimensions>
   <dimension id="16" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0">
      <dimensionValue id="521" name="Graduate" shortName="" description="Graduate degree" />
      <dimensionValue id="522" name="Masters" shortName="" description="Masters degree" />
   </dimension>
</dimensions>
</call>

Format de saisie 3 : Mettre à jour une valeur de dimension unique

Ce format prend en charge les cas d'utilisation lorsque les modifications sont limitées à une seule valeur de dimension.
Le
dimensions
 l'élément contient un seul enfant direct
dimensionValue
 élément.
Utilisez uniquement le format de saisie 3 lors de la mise à jour d'une valeur de dimension unique. Le format de saisie 3 n'est pas le format privilégié pour la mise à jour de plusieurs valeurs de dimension. Vous ne pouvez pas créer de nouvelles dimensions/valeurs de dimension avec ce format. Utilisez le format d'entrée 2 pour ajouter de nouvelles dimensions/valeurs de dimension.
<?xml version="1.0" encoding="UTF-8"?>
<call method="updateDimensions" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<dimensions>
   <dimensionValue id="555" name="Alabama" description="1" shortName=""/>
</dimensions>
</call>

Gestion de plusieurs changements de nom dans un seul appel updateDimensions

Plusieurs changements de nom de la même entité peuvent avoir lieu dans un système distant entre
updateDimensions
 des appels. Les noms des entités sur le système distant peuvent être remplacés par ceux des mêmes identifiants d'entité. Période
updateDimensions
 Les appels ont lieu après l'échange de noms, les
updateDimensions
 L'appel gère ces modifications en effectuant le suivi des identifiants dans les changements de nom. L'appel peut également gérer l'introduction d'un nouvel identifiant qui utilise un nom existant.
Pour garantir la réussite de chacun des exemples, l'échange complet des identifiants doit avoir lieu avec les valeurs uniques.
Exemple 1 : un échange de noms simple dans le système distant.

ID     Unique Value   New Unique Value
1      AA             BB
2      BB             AA
Exemple 2 : une séquence de 3 noms dans le système distant.

ID     Unique Value   New Unique Value
1      AA             BB
2      BB             CC
3      CC             AA
Exemple 3 : une nouvelle entité utilisant une valeur unique existante.

ID     Unique Value   New Unique Value
4                     AA
1      AA             BB
2      BB             Old BB
é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
login
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
locale
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 indiqué dans les identifiants a accès à plusieurs instances Adaptive Planning, cet attribut peut être utilisé pour indiquer qu'il a l'intention d'accéder à une instance différente de 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
dimensions
Description
Contient une ou plusieurs dimensions ou valeurs de dimension.
Attributs de l'élément
Nom de l'attribut
Obligatoire ?
Valeur
Exemple
retainExistingOrder
Disponible dans API v27 et supérieure
N
confidenceExistingOrder="1" indique que l'API updateDimensions doit ignorer l'ordre des éléments dans la charge de données XML et que l'ordre défini existant sera conservé.
Rapport de mise à jour des éléments ou de la position du marqueur par rapport aux autres frères/sœurs de la charge de travail XML.
L'indicateur retainExistingOrder est ignoré lorsque l'indicateur moveSorted est activé pour la dimension.
La valeur par défaut de retainExistingOrder est "1".
1
displayNameEnabled
Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage.
N
displayNameEnabled=1 indique que updateDimensions doit respecter les propriétés du nom d'affichage de
code
,
displayNameType
, et
description
 lorsque l'option Activer le nom d'affichage est activée pour l'instance.
displayNameEnabled=0 indique que l'API updateDimensions doit continuer à suivre le contrat de l'API pré-v30, même lorsque l'option Activer le nom d'affichage est activée pour l'instance. L'API updateDimensions ignore les propriétés du nom d'affichage
code
,
displayNameType
 et
description
.
La valeur par défaut pour displayNameEnabled est "0".
Contenu de l'élément
Contient une ou plusieurs dimensions ou valeurs de dimension.
é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
id
O
Identifiant de la dimension en cours de mise à jour.
34
nom
N
Nom de la dimension. Le nom doit être unique.
NewDimensionName
code
Disponible dans API v39 et supérieure.
Le code de la dimension. Le code doit être unique.
NewDimensionCode
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.
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.
Tout changement apporté aux composants d'un nom d'affichage modifie l'ordre de tri des éléments, même lorsque l'option Conserver le tri est activée.
0
displayNameType
Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage.
N
Contrôle l'affichage des valeurs de dimension. Les valeurs possibles sont NAME, CODE, NAME_CODE ou CODE_NAME.
Nomme par défaut s'il est laissé vierge ou non renseigné.
Cette propriété est uniquement disponible lorsque l'option Activer le nom d'affichage est activée pour l'instance.
"CODE_NAME"
description
Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage.
N
Description de la dimension.
Cette propriété est uniquement disponible lorsque l'option Activer le nom d'affichage est activée pour l'instance.
"Décroissant pour la dimension"
propriété1, propriété2, ...
N
Les propriétés de la dimension, le cas échéant, telles qu'elles ont été saisies dans l'onglet Administration des dimensions. Chaque dimension peut avoir jusqu'à 5 propriétés.
"Latitude"
Contenu de l'élément
Éléments dimensionValue facultatifs.
élément dimensionValue
Nom du marqueur
dimensionValue
Description
Indique une valeur de dimension à mettre à jour.
Attributs de l'élément
Nom de l'attribut
Obligatoire ?
Valeur
Exemple
id
O
Identifiant de la valeur de dimension.
34
code
Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage.
N
Le code unique de la valeur de dimension.
NewDimensionValue
nom
O
Nom de la valeur de dimension. Lorsque l'option Activer le nom d'affichage est activée pour une instance avec API v30 ou ultérieure, le nom autorise les valeurs en double. Lorsque l'option Activer le nom d'affichage est désactivée pour une instance, le code n'est pas disponible et le nom doit être unique.
Caractères de nouvelle ligne (
&#10;)
 Les éléments trouvés entre deux mots sont remplacés par un seul espace lors du traitement des données utiles.
Les caractères de nouvelle ligne figurant en début ou en fin de nom sont également remplacés par des espaces uniques. Ces espaces n'apparaissent pas dans l'interface utilisateur en raison d'un ajustement d'espace blanc pendant le traitement des données utiles.
NewDimensionValue
shortName
N
Nom abrégé de la valeur de dimension.
NewDimensionValueShortName
description
N
Description de la valeur de dimension.
Il s'agit d'une valeur NewDimensionValue
allVersions
N
"1" signifie que la valeur de dimension est disponible dans toutes les versions de plan, "0" signifie qu'elle ne l'est pas. Si allVersions est manquant, la valeur par défaut est 1.
updateDimensions met uniquement à jour la disponibilité des versions pour les versions du plan. Vous ne pouvez pas mettre à jour la disponibilité des versions pour les versions de montants réels, même lorsque allVersions=1.
Pour indiquer la disponibilité d'une version spécifique, définissez allVersions sur 0 et indiquez la disponibilité de la valeur de dimension pour chaque version.
Exemple : s'il existe des versions 2018a, 2018b, 2018c, 2018d. Pour inclure une valeur de dimension uniquement dans la version 2018b :
<dimensionValue .... allVersions="0"> <version name="2018a" disponible="0"> <nom de version="2018c" disponible="0"> <nom de version="2018d" disponible="0" >
Dans l'exemple ci-dessus, si allVersions="1", les éléments de version enfant en dessous sont ignorés.
0
Contenu de l'élément
Peut contenir l'élément de propriétés facultatifs.
élément d'attribut
Nom du marqueur
attribut
Description
Conteneur pour un élément d'attribut de dimension. Nécessite un nom et une valeur d'attribut préexistants.
Attributs de l'élément
Nom de l'attribut
Obligatoire ?
Valeur
Exemple
nom
O
Le nom de l'attribut de dimension
Location
valeur
mis à jour dans l'API v34
O
Valeur de l'attribut de dimension.
Si l'option L'importation de dimensions crée automatiquement des valeurs d'attribut est activée dans l'IU de l'administrateur des attributs de dimensions, toute valeur d'attribut qui n'existe pas encore devient une nouvelle valeur d'attribut dans la dimension racine.
Pour les API v32 et v33, cet attribut n'a de sens que lorsque le paramètre Nom d'affichage est désactivé pour l'instance.
Pour l'API v34 et les versions ultérieures :
  • Prise en charge lorsque le paramètre Nom d'affichage d'effet est activé.
  • La présence de valueCode et valueName va s'afficher.
  • Lorsque l'option Importation de dimensions crée automatiquement des valeurs d'attribut est activée dans l'interface utilisateur de l'administrateur d'attributs, la chaîne de valeur devient le code et le nom si la valeur n'existe pas déjà.
Définissez value="" pour retirer le marquage de cet attribut.
SFO
valueCode
Disponible uniquement dans API v32 et API v33 pour les instances qui activent le nom d'affichage.
Non pris en charge dans l'API v34.
O
Le code de la valeur d'attribut pour cet attribut.
L'entrée valueCode est explicite uniquement lorsque displayNameEnabled=1 et que le paramètre Nom d'affichage est activé pour l'instance dans API v32 et API v33.
Définissez valueCode="" pour retirer le marquage de cet attribut.
SFO
valueName
Disponible uniquement dans API v32 et API v33 pour les instances qui activent le nom d'affichage.
Non pris en charge dans l'API v34.
N
Le nom d'une valeur d'attribut nouvellement créée automatiquement.
L'attribut n'a de sens que dans les cas suivants :
  • valueCode contient une valeur d'attribut non existante.
  • Le paramètre Nom d'affichage est activé pour l'instance.
  • displayNameEnabled=1
  • Appelez l'API v32 et l'API v33.
valueName est ignoré lorsque valueCode contient une valeur d'attribut existante.
San Francisco
Contenu de l'élément
(aucun)
élément de version
Nom du marqueur
version
Description
Indique la disponibilité d'une valeur de dimension pour la version du plan. Nécessite une version de plan préexistante. La disponibilité de la version ne peut pas être modifiée pour les versions virtuelles, masquées, de montants réels, verrouillées ou archivées.
Attributs de l'élément
Nom de l'attribut
Obligatoire ?
Valeur
Exemple
nom
O
Le nom de la version, tel qu'il apparaît dans Administration des versions.
Budget 2015
disponible
O
Si 1, cette valeur de dimension est disponible dans cette version.
1
Contenu de l'élément
Un ou plusieurs éléments de version pour chaque valeur de dimension.
élément des propriétés
Prise en charge dans l'API v22
Nom du marqueur
propriétés
Description
Élément facultatif contenant des éléments de propriété.
Attributs de l'élément
(aucun)
Contenu de l'élément
Contient jusqu'à cinq éléments de propriété.
élément de propriété
Prise en charge dans l'API v22
Nom du marqueur
propriété
Description
Indique une propriété personnalisée à mettre à jour. Les valeurs d'élément de propriété ne peuvent contenir que des caractères numériques.
Attributs de l'élément
Nom de l'attribut
Obligatoire ?
Valeur
Exemple
nom
O
Nom de la propriété.
Latitude
valeur
O
Valeur de la propriété. Une valeur vide effacera la valeur de la propriété pour la valeur de dimension.
33,6 015
Contenu de l'élément
(aucun)

Format de la réponse


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<messages>
 <message type="INFO">Dimension was saved successfully.</message>
</messages>
<output>
 <dimensions>
   <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0" status="">
     <dimensionValue id="44" name="Documentation" description="docs" shortName="" status="created">
     </dimensionValue>
   </dimension>
   <dimension id="16" name="Geography" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="0" property1="Latitude" property2="Longitude" status="">                
     <dimensionValue id="521" name="United States" shortName="" description="USA" status="">                    
       <dimensionValue id="555" name="Alabama" shortName="" description="1" status="">                        
         <dimensionValue id="579" name="205" shortName="" description="1" status="">                            
           <dimensionValue id="4718" name="35004" shortName="" description="33" status="">                                
             <properties>                                    
               <property name="Latitude" value="33.6015" status="created" />                                    
               <property name="Longitude" value="86.4895" status="" />                                
             </properties>                            
           </dimensionValue>                            
           <dimensionValue id="4719" name="35005" shortName="" description="" status="" />                        
         </dimensionValue>                        
         <properties>                            
           <property name="Latitude" value="" status="deleted" />                            
           <property name="Longitude" value="86.9023" status="updated" />                        
         </properties>                    
       </dimensionValue>                
     </dimensionValue>            
   </dimension>
 </dimensions>
</output>
</response>
élément de dimension
Nom du marqueur
dimensions
Description
Contient une ou plusieurs dimensions ou valeurs de dimension.
Attributs de l'élément
(aucun)
Contenu de l'élément
Contient une ou plusieurs dimensions ou valeurs de dimension.
retainExistingOrder
N
Si la valeur est 0, l'API updateDimensions doit mettre à jour l'ordre de tri en fonction du contenu de la charge de travail XML.
Si 1, l'API updateDimensions doit conserver l'ordre de tri existant.
1
displayNameEnabled
Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage.
displayNameEnabled=1 indique que updateDimensions doit respecter les propriétés du nom d'affichage de
code
,
displayNameType
, et
description
 lorsque l'option Activer le nom d'affichage est activée pour l'instance.
displayNameEnabled=0 indique que l'API updateDimensions doit continuer à suivre le contrat API pré-2021.42, même lorsque l'option Activer le nom d'affichage est activée pour l'instance. L'API updateDimensions ignore les propriétés du nom d'affichage
code
,
displayNameType
 et
description
.
La prise en charge de displayNameEnabled depuis 2021.42. La valeur par défaut pour displayNameEnabled est "0".
1
é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
Pour la création, un nouvel identifiant sera fourni.
16
nom
O
Nom de la dimension tel qu'il apparaît sur les rapports et les feuilles.
Customer
code
Disponible dans API v39 et supérieure.
N
Le code de la dimension.
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
displayNameType
Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage.
N
Contrôle l'affichage des valeurs de dimension. Les valeurs possibles sont NAME, CODE, NAME_CODE ou CODE_NAME.
Nomme par défaut s'il est laissé vierge ou non renseigné.
Cette propriété est uniquement disponible lorsque l'option Activer le nom d'affichage est activée pour l'instance.
CODE_NAME
description
Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage.
N
Description de la dimension.
propriété1, propriété2,...
N
Les propriétés personnalisées de la dimension.
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.
é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
id
O
Pour la création, un nouvel identifiant sera fourni.
16
code
Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage.
N
Le code unique de la valeur de dimension.
Entreprise A
nom
O
Libellé de la valeur de membre de la dimension, tel qu'il est affiché sur les rapports et utilisé dans les formules.
Entreprise A
shortName
N
Nom abrégé de la valeur de dimension, le cas échéant, tel que saisi dans Administration des dimensions
A
description
N
Description de la valeur de dimension, le cas échéant, telle qu'elle est saisie dans Administration des dimensions.
Une société
status
O
Le statut de la valeur de dimension après mise à jour. Pour les avertissements et les erreurs, l'élément de message contient le contenu du message. Le statut de mise à jour ne renvoie aucun contenu de message.
  • Erreur : une erreur a été trouvée dans l'entité
  • Avertissement : un avertissement a été trouvé dans l'entité
  • Créé : l'entité a été créée avec succès
  • Mis à jour : l'entité a été mise à jour avec succès
mis à jour
message
N
Message d'erreur pour une entrée dimensionValue non valide.
Le nom de dimension ProductFirst01234567890123456... ne peut pas dépasser 64 caractères.
Contenu de l'élément
Aucun 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 s'agrègent implicitement à cette valeur.
é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
nom
O
Le nom de l'attribut de dimension
Location
valeur
mis à jour dans l'API v32
O
Valeur de l'attribut de dimension.
Pour les API v32 et les versions ultérieures, cet attribut n'a de sens que lorsque le paramètre Nom d'affichage est désactivé pour l'instance.
San Francisco
valueCode
Uniquement disponible dans API v32 et supérieure pour les instances qui activent le nom d'affichage.
O
Le code de la valeur d'attribut pour cet attribut.
Pour les API v32 et les versions ultérieures, valueCode n'a de sens que lorsque :
  • Le paramètre Nom d'affichage est activé pour l'instance.
  • displayNameEnabled=1
SFO
valueName
Uniquement disponible dans API v32 et supérieure pour les instances qui activent le nom d'affichage.
N
Le nom d'une valeur d'attribut nouvellement créée automatiquement.
L'attribut n'a de sens que dans les cas suivants :
  • valueCode contient une valeur d'attribut non existante.
  • Le paramètre Nom d'affichage est activé pour l'instance.
  • displayNameEnabled=1value
Le nom est ignoré lorsque valueCode contient une valeur d'attribut existante.
San Francisco
status
O
Le statut de la valeur de dimension après mise à jour. Pour les avertissements et les erreurs, l'élément de message contient le contenu du message. Le statut de mise à jour ne renvoie aucun contenu de message.
  • Erreur : une erreur a été trouvée dans l'entité
  • Avertissement : un avertissement a été trouvé dans l'entité
  • Créé : l'entité a été créée avec succès
  • Mis à jour : l'entité a été mise à jour avec succès
mis à jour
message
N
Message d'erreur pour une saisie d'attribut non valide.
Contenu de l'élément
(aucun)
élément de version
Nom du marqueur
version
Description
Indique la disponibilité d'une valeur de dimension pour la version du plan.
Attributs de l'élément
Nom de l'attribut
Obligatoire ?
Valeur
Exemple
nom
O
Le nom de la version, tel qu'il apparaît dans Administration des versions.
Budget 2015
disponible
O
Si 1, cette valeur de dimension est disponible dans cette version du plan.
1
status
O
Le statut de la valeur de dimension après mise à jour. Pour les avertissements et les erreurs, l'élément de message contient le contenu du message. Le statut de mise à jour ne renvoie aucun contenu de message.
  • Erreur : une erreur a été trouvée dans l'entité
  • Avertissement : un avertissement a été trouvé dans l'entité
  • Créé : l'entité a été créée avec succès
  • Mis à jour : l'entité a été mise à jour avec succès
mis à jour
message
N
Message d'erreur pour une version non valide.
Contenu de l'élément
Un ou plusieurs éléments de version pour chaque valeur de dimension.
élément des propriétés
Nom du marqueur
propriétés
Description
Contient jusqu'à cinq éléments de propriété.
Attributs de l'élément
(aucun)
Contenu de l'élément
Contient jusqu'à cinq éléments de propriété.
élément de propriété
Nom du marqueur
propriété
Description
Indique une propriété personnalisée à mettre à jour.
Attributs de l'élément
Nom de l'attribut
Valeur
Exemple
nom
Nom de la propriété.
Latitude
valeur
Valeur de la propriété. Une valeur vide effacera la valeur de la propriété pour la valeur de dimension.
33,6 015
Le statut
Statut de la propriété après mise à jour. Pour l'erreur, l'élément de message contient le contenu du message d'erreur. Le statut de mise à jour ne renvoie aucun contenu de message.
  • Erreur : une erreur a été trouvée dans l'entité
  • Créé : l'entité a été créée avec succès
  • Mis à jour : l'entité a été mise à jour avec succès
  • Rien de changé : un statut vide signifie que rien n'a été modifié pour l'entité.
Message
Message d'erreur pour une saisie de propriété non valide.
Le marqueur de la propriété requiert un attribut de nom.