publishChanges

Catégorie	Publication en tant qu’administrateur
Description	Publiez tous les changements en attente.
Autorisations obligatoires pour pouvoir être appelées	Il doit s'agir d'identifiants valides pour l'instance et d'une autorisation de type Publier les modifications de l'administrateur. La publication par l’administrateur de l’instance doit être activée.
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. Une fois vérifiée, cette méthode publiera tous les changements par lots. Si vous le souhaitez, la demande peut contenir un marqueur d’action.

Format de demande


<?xml version='1.0' encoding='UTF-8'?>
<call method="publishChanges" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd"/>
</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)

Format de réponse

Si la demande est reçue sans changements par lots, la réponse est la réponse « Publier le succès » avec « publisée » = 0.

Le succès est l’endroit où donnés n changements non publiés, tous n ont été publiés avec succès.

Dans le cas d’une publication réussie, la sortie contient un élément publishResponse associé à un attribut publishCount indiquant le nombre de changements publiés.

Dans une publication qui échoue, la sortie contient un élément publishResponse qui a le même attribut publishCount et un attribut notpubliéCount répertoriant le nombre de changements qui n’ont pas été publiés.

Exemple de réussite


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
    <output>
        <publishResponse publishedCount="3" />
    </output>
</response>

Exemple d'erreur


 <?xml version='1.0' encoding='UTF-8'?>
 <response success="false">
   <messages>
       <message type="ERROR">Publish Error</message>
   </messages>
   <output>
       <publishResponse publishedCount="0" notPublishedCount="2" />
   </output>
 </response>

élément de réponse
Nom du marqueur		réponse
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
réussite	Y	Vrai ou faux, indiquant si l’appel d’API a réussi ou non. Même les appels réussis peuvent contenir des messages d’avertissement dans leur réponse.	vrai
obsolète	N	S’il est présent dans le marqueur de réponse et défini à Vrai, cet attribut indique que la version de la méthode ou de l’API qui est appelée est obsolète et est officiellement dépréciée. Bien qu’elle continue de fonctionner pour le moment, elle pourrait cesser de fonctionner sous peu. En général, cet attribut n’est pas présent.	faux
Contenu de l'élément
Un seul élément de message facultatif et un seul élément de sortie obligatoire.

élément de sortie
Nom du marqueur	sortie
Attributs de l'élément
(aucun)
Contenu de l'élément
Un élément de comptes unique. 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 publishResponse
Nom du marqueur		publishResponse
Description		La réponse à une demande de publication de changements. Contient de l’information sur le statut des changements non publiés ou sur le résultat d’une publication.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
publishedCount	Y	Le nombre de changements qui ont été publiés avec succès.	6
notPublishedCount	N	Le nombre de changements qui n’ont PAS été publiés. Inclus avec une réponse de type 'publier' qui a échoué.	2
Contenu de l'élément
(aucun)