createLevel
Non pris en charge dans API v20 et supérieure. Utilisez updateLevels.
Catégorie | Modification des métadonnées |
Description | Créez un périmètre. Si elle réussit, l'API renvoie le détail du périmètre qui vient d'être créé. |
Autorisations requises pour appeler | Structure d'organisation |
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 Structure d'organisation pour créer le périmètre.
Cette méthode renvoie une erreur s'il existe des modifications non publiées.
Format de demande
<?xml version='1.0' encoding='UTF-8'?> <call method="createLevel" callerName="fred"> <credentials login="sampleuser@company.com" password="my_pwd" /> <level name="New Level Name" shortName="NewLvlName" parentId="2" > <attributes> <attribute attributeId="20" valueId="199" /> </attributes> </level> </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 périmètre | |||
Nom du marqueur | level | ||
Description | Indique un périmètre à créer. | ||
Attributs de l'élément | |||
parentId | O | Identifiant du périmètre pour créer ce périmètre en tant qu'enfant. | 34 |
nom | O | Nom du périmètre. Le nom doit être unique. | Nom du nouveau périmètre |
shortName | N | Le nom abrégé du périmètre. | NewLvName |
proceed- withWarnings | N | Indique si l'utilisateur souhaite ignorer les messages d'avertissement et poursuivre l'opération de création. 0 pour non, 1 pour oui. S'il existe des avertissements et proceedWithWarnings=0, le périmètre ne sera pas créé. Indiquez proceedWithWarnings=1 pour créer le périmètre en cas d'avertissement. | 1 |
Contenu de l'élément | |||
Un élément d'attribut facultatif si vous souhaitez définir un ou plusieurs attributs de périmètre associés au périmètre. | |||
élément attributs | |||
Nom du marqueur | attributs | ||
Description | Conteneur pour un ou plusieurs éléments d'attribut de périmètre. | ||
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 périmètre. | ||
Attributs de l'élément | |||
Nom de l'attribut | Obligatoire ? | Valeur | Exemple |
attributeID | O | Identifiant de l'attribut de périmètre généré par le système. | 20 |
valueID | O | Identifiant unique de la valeur d'attribut de périmètre généré par le système. Si cette valeur est 0, alors cet attribut est supprimé du compte. | 170 |
Contenu de l'élément | |||
(aucun) | |||
Format de la réponse
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <output> <levels> <level="41" name="New Level Name" shortName="NewLvlName" currency="USD"> <attribute attributeId="20" name="Regional Code" valueId="199" value="A-145" /> </level> </levels> </output> </response>
élément de sortie | |
Nom du marqueur | sortie |
Attributs de l'élément | |
(aucun) | |
Contenu de l'élément | |
Un seul élément de périmètre obligatoire. Ce filtre de sortie est standard sur toutes les réponses d'API et contient la sortie valide de tout appel d'API réussi. | |
élément périmètres | |||
Nom du marqueur | périmètre(s) | ||
Description | Conteneur de l'élément de périmètre. | ||
Attributs de l'élément | |||
Nom de l'attribut | Obligatoire ? | Valeur | Exemple |
Contenu de l'élément | |||
Un ou plusieurs éléments de périmètre. Si la demande inclut des périmètres inaccessibles, il n'y aura qu'un seul élément de périmètre qui représente le niveau supérieur de l'organisation. | |||
élément de périmètre | |||
Nom du marqueur | level | ||
Description | Représente un périmètre d'organisation unique renvoyé en réponse à un appel d'API exportLevels. | ||
Attributs de l'élément | |||
Nom de l'attribut | Obligatoire ? | Valeur | Exemple |
id | O | Le numéro d'identifiant système interne du périmètre. | 7 |
nom | O | Le nom du périmètre, tel qu'il apparaît sur les rapports et les feuilles. | Développement |
devise | O | Le code de la devise affectée à ce niveau de l'organisation. La devise sera l'une des devises configurées pour l'instance, trouvées dans l'appel exportActiveCurrencies. | INR |
shortName | N | L'abréviation du périmètre, le cas échéant, telle qu'elle est saisie dans l'administration de l'organisation. | Développeur |
availableStart | N | Date de début de disponibilité du périmètre pour la version de montants réels, applicable uniquement lorsque la version de montants réels est indiquée dans la demande. La valeur peut être un mois spécifique, au format "MM/AAAA", ou la valeur spéciale "START" indiquant le début de la version. | 01/2013 |
availableEnd | N | Date de fin de la disponibilité du périmètre pour la version des montants réels, applicable uniquement lorsque la version des montants réels est indiquée dans la demande. La valeur peut être un mois spécifique, au format "MM/AAAA", ou la valeur spéciale "END" indiquant la fin de la version. | 12/2013 |
isImportable | N | Indique si le périmètre associé peut être importé dans la version spécifiée. '0' signifie qu'il n'est pas importable et '1' qu'il peut être importé. Un périmètre est importable si au moins un créneau horaire dans la version indiquée l'est. L'attribut isImportable est émis uniquement si versionName ou versionID est indiqué dans la demande. Remarque : isImportable indique uniquement qu'un périmètre est disponible pour l'import dans la version spécifiée, et non que l'utilisateur qui a fait l'appel d'API est autorisé à importer dans la version ou le périmètre. Utilisez exportVersions pour voir quelles versions sont disponibles pour l'utilisateur. | 1 |
workflowStatus | N | Émet le statut du workflow pour le périmètre associé. I pour "En cours", S pour "Soumis", R pour "Rejeté", A pour "Approuvé" et L pour "Verrouillé". Inclus dans la réponse uniquement si le workflow est activé pour cette unité légale et qu'un nom de version Planning ou un identifiant de version Planning est indiqué dans la demande. Le workflow n'est pas disponible sur les versions de montants réels. | I |
isLinked | O | Indique si le périmètre est un périmètre lié. 0 pour non, 1 pour oui. | 1 |
isElimination | O | Indique si le périmètre est un périmètre d'élimination. 0 pour non, 1 pour oui. | 0 |
Contenu de l'élément | |||
Un élément de périmètre imbriqué pour chaque périmètre enfant direct de ce périmètre. Un élément d'attribut si ce périmètre est associé à un ou plusieurs attributs. | |||
élément attributs | |||
Nom du marqueur | attributs | ||
Description | Conteneur pour un ou plusieurs éléments d'attribut. | ||
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 | Représente un mappage d'attributs de périmètre unique et non vide auquel un périmètre est associé. | ||
Attributs de l'élément | |||
Nom de l'attribut | Obligatoire ? | Valeur | Exemple |
nom | O | Le nom de l'attribut de périmètre | Escompte d'entreprise |
valeur | O | La valeur de l'attribut de périmètre associé au périmètre. | Oui |
attributeID | O | Le numéro d'identification du système interne de l'attribut de périmètre. | 20 |
valueID | O | Numéro d'identifiant du système interne de la valeur d'attribut de périmètre. | 188 |
Contenu de l'élément | |||
(aucun) | |||