CreateLevel
Non pris en charge dans l'API v20 +. Utilisez updateLevels.
Catégorie | Modification de métadonnées |
Description | Créez un niveau. En cas de réussite, l’API renvoie les détails du niveau qui vient d’être créé. |
Autorisations obligatoires pour pouvoir être appelées | Structure de l’organisation |
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 Structure d'organisation pour créer le niveau.
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 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 appeler 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 niveau | |||
Nom du marqueur | niveau | ||
Description | Indique un niveau à créer. | ||
Attributs de l'élément | |||
parentId | Y | L'identifiant du niveau pour créer ce niveau en tant qu'enfant de. | 34 |
nom | Y | Le nom du niveau. Le nom doit être unique. | Nom du nouveau niveau |
shortName | N | Le nom abrégé du niveau. | NewLvName |
procéder - AvecAvertissements | 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 y a des avertissements et proceedWithWarnings=0, le niveau ne sera pas créé. Définissez proceedWithWarnings=1 pour créer le niveau en cas d’avertissements. | 1 |
Contenu de l'élément | |||
Un élément d’attributs facultatif si vous souhaitez définir un ou plusieurs attributs de niveau associés au niveau. | |||
élément d'attributs | |||
Nom du marqueur | attributs | ||
Description | Conteneur pour un ou plusieurs éléments d'attribut de niveau. | ||
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 niveau. | ||
Attributs de l'élément | |||
Nom de l’attribut | Obligatoire? | Valeur | Exemple |
attributeID | Y | L'identifiant de l'attribut de niveau généré par le système. | 20 |
valueID | Y | Identifiant unique de la valeur d'attribut de niveau générée par le système. Si cette valeur est 0, cet attribut est supprimé du compte. | 170 |
Contenu de l'élément | |||
(aucun) | |||
Format de 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 niveau requis. Ce filtre de sortie est standard sur toutes les réponses d’API et enveloppe la sortie valide de tout appel d’API réussi. | |
élément niveaux | |||
Nom du marqueur | niveaux | ||
Description | Conteneur pour l'élément de niveau. | ||
Attributs de l'élément | |||
Nom de l’attribut | Obligatoire? | Valeur | Exemple |
Contenu de l'élément | |||
Un ou plusieurs éléments de niveau. Si la demande comprend des niveaux inaccessibles, il n’y aura qu’un élément de niveau, qui représentera le niveau supérieur de l’organisation. | |||
élément de niveau | |||
Nom du marqueur | niveau | ||
Description | Représente un niveau d’organisation unique retourné en réponse à un appel d’API exportLevels. | ||
Attributs de l'élément | |||
Nom de l’attribut | Obligatoire? | Valeur | Exemple |
identifiant | Y | Le numéro d’identifiant de système interne pour le niveau. | 7 |
nom | Y | Le nom du niveau, tel qu’il apparaît sur les rapports et les feuilles. | Développement |
devise | Y | Le code de devise pour la devise affectée à ce niveau de l’organisation. La devise sera l’une des devises configurées pour l’instance, qui se trouve dans l’appel exportActiveDevises. | INR |
shortName | N | L’abréviation du niveau, le cas échéant, telle qu’elle est entrée dans l’administration de l’organisation. | Dév. |
availableStart | N | La date de début de la disponibilité du niveau pour la version des chiffres réels, applicable uniquement lorsque la version des chiffres réels est indiquée dans la demande. La valeur peut être un mois précis, au format « MM/AAAA », ou la valeur spéciale « START » indiquant le début de la version. | 01/2013 |
availableEnd | N | La date de fin de disponibilité du niveau pour la version des chiffres réels, applicable uniquement lorsque la version des chiffres réels est indiquée dans la demande. La valeur peut être un mois précis, au format « MM/AAAA », ou la valeur spéciale « END » indiquant la fin de la version. | 12/2013 |
isImportable | N | Indique si le niveau associé peut être importé dans la version indiquée. '0' signifie qu'il ne peut pas être importé et '1' signifie qu'il est importé. Un niveau peut être importé si au moins un créneau horaire dans la version indiquée est importé. L'attribut isImportable est émis uniquement si versionName ou versionID est indiqué dans la demande. Note : isImportable indique uniquement qu’un niveau est disponible pour l’importation dans la version indiquée, et non que l’utilisateur qui fait l’appel d’API est autorisé à effectuer l’importation dans la version ou le niveau. Utilisez exportVersions pour voir quelles versions sont disponibles pour l’utilisateur à l’importation. | 1 |
workflowStatus | N | Émet le statut du flux des travaux pour le niveau 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 flux des travaux est activé pour cette société et qu’une versionName ou une versionID de planification est indiquée dans la demande. Le flux de travaux n'est pas disponible pour les versions de chiffres réels. | I |
isLinked | Y | Indique si le niveau est un niveau associé. 0 pour non, 1 pour oui. | 1 |
isElimination | Y | Indique si le niveau est un niveau d’élimination. 0 pour non, 1 pour oui. | 0 |
Contenu de l'élément | |||
Un élément de niveau imbriqué pour chaque niveau enfant direct de ce niveau. Un élément d’attributs si ce niveau est associé à un ou à plusieurs attributs. | |||
élément d'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 niveau unique et non vide auquel un niveau est associé. | ||
Attributs de l'élément | |||
Nom de l’attribut | Obligatoire ? | Valeur | Exemple |
nom | Y | Nom de l'attribut de niveau | Escompte d'entreprise |
valeur | Y | La valeur de l'attribut de niveau associé au niveau. | Oui |
attributeID | Y | Le numéro d’identifiant de système interne de l’attribut de niveau. | 20 |
valueID | Y | Le numéro d’identifiant de système interne de la valeur de l’attribut de niveau. | 188 |
Contenu de l'élément | |||
(aucun) | |||