unpublishedChangesStatus

Categoría	Publicación de administrador
Descripción	Recupere el número de cambios no publicados y determine si la publicación de administrador está desactivada para la instancia.
Permisos obligatorios para invocar	Deben ser credenciales válidas para la instancia. Si la publicación de administrador está desactivada, no se requieren permisos adicionales. Si la publicación de administrador está activada, el usuario debe tener el permiso Publicar cambios de administrador.
Parámetros obligatorios bajo petición	Credenciales

La solicitud de este método contiene una etiqueta de credenciales para identificar y autorizar al usuario que llama. Una vez verificado, este método publicará todos los cambios por lotes. Opcionalmente, la solicitud puede contener una etiqueta de acción.

Formato de solicitud


<?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>

elemento de credenciales
Nombre de etiqueta		credenciales
Descripción		Todas las llamadas a la API deben contener un único elemento de credenciales para identificar al usuario que invoca la API. A continuación, la llamada a la API se realiza como este usuario (cualquier pista de auditoría o historial de acciones en el sistema mostrará que este usuario ha realizado la acción) y, por lo tanto, el usuario debe tener los permisos necesarios para realizar la acción a fin de que la API llamada correcta.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
inicio de sesión	Sí	El nombre de conexión del usuario que invoca el método API. Este usuario debe tener los permisos necesarios para invocar el método.	sampleuser@company.com
contraseña	Sí	La contraseña del usuario que invoca el método API.	my_password
configuración regional	No	Especifique la configuración regional que se utilizará para interpretar los números y las fechas de entrada, y para dar formato a los números y las fechas de salida (utilizando el separador de miles, los nombres de mes y el formato de fecha adecuados). La configuración regional también se utiliza para especificar el idioma en el que deben aparecer los mensajes del sistema en la respuesta. Si no se especifica, se utiliza en_US (inglés americano).	fr_FR
instanceCode	No	Si el usuario especificado en las credenciales tiene acceso a más de una instancia de Adaptive Planning , este atributo se puede utilizar para especificar que el usuario tiene la intención de acceder a una instancia distinta a la instancia por defecto. Si no se especifica, se utilizará la instancia por defecto del usuario. Para determinar los códigos de instancia disponibles, utilice la API exportInstances.	MYINSTANCE1
Contenido del elemento
(ninguno)

Formato de respuesta

Estos son ejemplos de respuestas para la publicación de administrador activada y desactivada.

Ejemplo de publicación de administrador activada


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

Ejemplo de publicación de administrador desactivada


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

elemento de respuesta
Nombre de etiqueta		respuesta
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
éxito	Sí	Verdadero o falso, que indica si la llamada a la API se ha realizado correctamente o no. Incluso las llamadas correctas pueden contener mensajes de aviso en su respuesta.	verdadero
obsoleto	No	Si está presente en la etiqueta de respuesta y se establece en verdadero, este atributo indica que la versión del método o de la API que se está invocando ha quedado obsoleta y está oficialmente desaprobada. Aunque sigue funcionando en este momento, es posible que deje de funcionar en un breve periodo de tiempo. Normalmente, este atributo no está presente.	falso
Contenido del elemento
Un único elemento de mensajes opcional y exactamente un elemento de resultado obligatorio.

elemento de resultado
Nombre de etiqueta	salida
Atributos del elemento
(ninguno)
Contenido del elemento
Un solo elemento unpublishedStatus obligatorio. Este contenedor de salida es estándar en todas las respuestas de API e incluye la salida válida de cualquier llamada API correcta.

elemento unpublishedStatus
Nombre de etiqueta		unpublishedStatus
Descripción		La respuesta a una solicitud de Cambios de estado no publicada. Contiene información sobre si la publicación de administrador está activada y, en caso afirmativo, cuántos cambios no publicados hay.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
adminPublishingEnabled	Sí	Si la publicación de administrador está activada o no para esta instancia (0 = no activada, 1 = activada).	1
numberToPublish	No	Cuántos cambios no publicados hay. Solo aparece si la publicación de administrador está activada. Si no hay cambios no publicados, el valor es 0.	2
Contenido del elemento
(ninguno)