updateDimensions
Non pris en charge dans API v20 et supérieure. Utilisez updateDimensions.
Catégorie | Modification des métadonnées |
Description | Mettez à jour une dimension. Si elle aboutit, l'API renvoie le détail de la dimension qui vient d'être mise à jour. |
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.
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 que les valeurs ne sont pas toutes disponibles dans toutes les versions.
- Vous ne pouvez pas désactiver listDimension si vous avez des valeurs de dimension hiérarchique hiérarchique.
- Vous ne pouvez pas activer à la fois useOnLevels et listDimension. (Vous pouvez désactiver l'un ou 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 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 |
id | O | Identifiant de la dimension en cours de mise à jour. | 34 |
nom | N | 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. | 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 de dimension | |
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. | |||
é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 | Numéro d'identifiant système interne associé à cette valeur de membre de la dimension. | 34 |
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é |
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 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 | O | Identifiant de l'attribut de dimension généré par le système. | 20 |
nom | O | Le nom de l'attribut de dimension | Type d'études |
valueID | O | Identifiant unique de la valeur d'attribut de dimension générée par le système. | 170 |
valeur | O | Valeur de l'attribut de dimension. | Tech1 |
Contenu de l'élément | |||
(aucun) | |||