unpublishedChangesStatus

Catégorie	Publication en tant qu’administrateur
Description	Récupérez le nombre de modifications non publiées et déterminez si la publication par l’administrateur est désactivée pour l’instance.
Autorisations obligatoires pour pouvoir être appelées	Doivent être des identifiants valides pour l’instance. Si la publication par l’administrateur est désactivée, aucune autorisation supplémentaire n’est requise. Si la publication par l’administrateur est activée, l’utilisateur doit disposer de l’autorisation Publier les modifications de l’administrateur.
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="unpublishedChangesStatus" 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), et par conséquent, l’utilisateur doit disposer des autorisations requises pour effectuer l’action dans l’ordre pour l’API. appel pour 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

Voici des exemples de réponses pour les publications en tant qu’administrateur activées et désactivées.

Exemple de publication activée


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

Exemple de publication désactivée en tant qu’administrateur


<?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	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 seul élément unpublicatedStatus obligatoire. 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 un publishedStatus
Nom du marqueur		nonpubliéStatus
Description		La réponse à une demande non publiéeChangesStatus. Contient des informations indiquant si la publication par l’administrateur est activée et, le cas échéant, du nombre de modifications non publiées.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
adminPublishingEnabled	Y	Si la publication par l’administrateur est activée ou non pour cette instance (0 = non activée, 1 = activée).	1
numberToPublish	N	Combien de modifications non publiées il y a. S'affiche uniquement si la publication par l'administrateur est activée. S’il n’y a aucune modification non publiée, la valeur est 0.	2
Contenu de l'élément
(aucun)