publicarCambios

Categoría	Publicación de administrador
Descripción	Publique los cambios pendientes.
Permisos obligatorios para invocar	Deben ser credenciales válidas para la instancia y el permiso "Publicar cambios de administrador". La instancia debe tener activada la publicación 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="publishChanges" 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 llamada a la API se lleve a cabo. 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

Si la solicitud se recibe sin cambios por lotes, la respuesta es "Publicación correcta" con "publishedCount" = 0.

El éxito es cuando, dados los n cambios no publicados, los n se publican correctamente.

En una publicación correcta, el resultado contiene un elementopublishResponse que tiene un atributo PublishedCount que indica el número de cambios que se han publicado.

En una publicación incorrecta, el resultado contiene un elementopublishResponse que tiene el mismo atributo PublishedCount y un atributo notPublishedCount que enumera el número de cambios que no se han publicado.

Ejemplo de éxito


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

Ejemplo de error


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

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 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 de cuentas Este contenedor de salida es estándar en todas las respuestas de API e incluye la salida válida de cualquier llamada API correcta.

elementopublishResponsepublicResponse element
Nombre de etiqueta		publicarRespuesta
Descripción		La respuesta a una solicitud de publicación de cambios. Contiene información sobre el estado de los cambios no publicados o el resultado de realizar una publicación.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
PublishedCount	Sí	El número de cambios que se han publicado correctamente.	6
notPublishedCount	No	El número de cambios que NO se han publicado. Incluido con una respuesta de "publicación" incorrecta.	2
Contenido del elemento
(ninguno)