unpublishedChangesStatus

Catégorie	Publication en masse
Description	Récupérez le nombre de modifications non publiées et déterminez si la publication en masse est désactivée pour l'instance.
Autorisations requises pour appeler	Des identifiants doivent être valides pour l'instance. Si la publication en masse est désactivée, aucune autorisation supplémentaire n'est requise. Si la publication en masse est activée, l'utilisateur doit avoir l'autorisation Publier les modifications de l'administrateur.
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="unpublishedChangesStatus" 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 (toute la piste d'audit ou l'historique des 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 dans l'ordre pour l'API appelez pour 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

Voici des exemples de réponses pour une publication en masse activée et désactivée.

Exemple d'activation de la publication en masse


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
    <output>
        <unpublishedStatus adminPublishingEnabled="1" numberToPublish="3" />
    </output>
</response>

Exemple de données désactivées sur la publication en masse


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
    <output>
        <unpublishedStatus adminPublishingEnabled="0" />
    </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 dans 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 PublishedStatus 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 unpubliedStatus
Nom du marqueur		statutnon publié
Description		Réponse à une demande ChangesStatus non publiée. Contient des informations indiquant si la publication en masse est activée et, le cas échéant, combien de modifications non publiées il existe.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
adminPublishingEnabled	O	Si la publication en masse est activée ou non pour cette instance (0 = non activé, 1 = activé).	1
numberToPublish	N	Combien y a-t-il de modifications non publiées. Apparaît uniquement si la publication en masse est activée. S'il n'existe aucune modification non publiée, la valeur est 0.	2
Contenu de l'élément
(aucun)