publishChanges

Catégorie	Publication en masse
Description	Publiez toutes les modifications en attente.
Autorisations requises pour appeler	Des identifiants doivent être valides pour l'instance et l'autorisation "Publier les modifications de l'administrateur". La publication en masse doit être activée sur l'instance.
Paramètres obligatoires à la demande	Identifiants

La demande de ce mode contient un marqueur d'identifiant pour identifier et autoriser l'utilisateur appelant. Une fois vérifiée, cette méthode publiera toutes les modifications par lots. La demande peut également 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 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)

Format de la réponse

Si la demande est reçue sans modifications groupées, la réponse est "Publier le succès" avec 'publié' = 0.

Le succès commence lorsqu'il n'y a pas de modifications non publiées, toutes les n sont publiées avec succès.

Dans une publication réussie, la sortie contient un élément publishResponse avec un attribut PublishedCount indiquant le nombre de modifications qui ont été publiées.

Dans une publication qui échoue, la sortie contient un élément publishResponse qui a le même attribut PublishedCount et un attribut notpublié_count répertoriant le nombre de modifications qui n'ont pas été publiées.

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	O	Vrai ou faux, indiquant si l'appel d'API a réussi ou non. Même les appels traités avec succès peuvent contenir des messages d'avertissement dans leur réponse.	vrai
obsolète	N	S'il figure sur le marqueur de réponse et qu'il est défini sur true (vrai), cet attribut indique que la version de la méthode ou de l'API en cours d'appel est obsolète et qu'elle est officielement dépréciée. Même si elle continue de fonctionner à ce moment, elle peut cesser de fonctionner prochainement. En général, cet attribut n'est pas présent.	false
Contenu de l'élément
Un seul élément de messages facultatifs et exactement un é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 seul élément comptes. 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 publishResponse
Nom du marqueur		publishResponse
Description		Réponse à une demande de modifications de publication. Contient des informations sur le statut des modifications non publiées ou le résultat d'une publication.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
publishedCount	O	Le nombre de modifications qui ont été publiées avec succès.	6
notPublishedCount	N	Le nombre de modifications qui n'ont PAS été publiées. Inclus avec une réponse de publication non réussie.	2
Contenu de l'élément
(aucun)