publishChanges

Categoria	Publicação de administrador
Descrição	Publique todas as alterações pendentes.
Permissões obrigatórias para invocar	Devem ser credenciais válidas para a instância e a permissão "Publicar alterações administrativas". A instância deve ter a publicação de administrador habilitada.
Parâmetros obrigatórios na solicitação	Credenciais

A solicitação desse método contém uma etiqueta de credenciais para identificar e autorizar o usuário que está fazendo a chamada. Uma vez verificado, esse método publicará todas as alterações em lote. Opcionalmente, a solicitação pode conter uma etiqueta de ação.

Formato da solicitação


<?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 credenciais
Nome da etiqueta		credenciais
Descrição		Todas as chamadas de API devem conter um único elemento de credenciais para identificar o usuário que invoca a API. A chamada à API é então executada como este usuário (qualquer trilha de auditoria ou histórico de ações no sistema mostrará que este usuário executou a ação) e, portanto, o usuário deve ter as permissões necessárias para executar a ação para que a chamada à API funcione. bem-sucedido.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
login	S	O nome de logon do usuário que invoca o método de API. Esse usuário deve ter as permissões necessárias para invocar o método.	sampleuser@company.com
senha	S	A senha do usuário que invoca o método de API.	my_password
parâmetros regionais	N	Especifique os parâmetros regionais a serem usados para interpretar números e datas de entrada e para formatar números e datas de saída (usando o separador de milhares, nomes de meses e formatação de data adequados). Os parâmetros regionais também são usados para especificar o idioma em que as mensagens do sistema na resposta devem ser exibidas. Se não especificado, en_US (inglês americano) é usado.	fr_FR
instanceCode	N	Se o usuário especificado nas credenciais tem acesso a mais de uma instância do Adaptive Planning , esse atributo pode ser usado para especificar que o usuário pretende acessar uma instância diferente da instância por padrão. Se não for especificada, a instância por padrão do usuário será usada. Para determinar os códigos de instância disponíveis, use a API exportInstances.	MYINSTANCE1
Conteúdo do elemento
(nenhum)

Formato da resposta

Se a solicitação é recebida sem alterações em lote, a resposta é "Publicação bem-sucedida" com "publishedCount" = 0.

Êxito é quando, dadas n alterações não publicadas, todas as n são publicadas com êxito.

Em uma publicação bem-sucedida, a saída contém um elemento publishResponse que tem um atributo publishCount que indica o número de alterações que foram publicadas.

Em uma publicação malsucedida, a saída contém um elemento publishResponse que tem o mesmo atributo publishCount e um atributo notPublishedCount listando o número de alterações que não foram publicadas.

Exemplo de êxito


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

Exemplo de erro


 <?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 resposta
Nome da etiqueta		resposta
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
êxito	S	Verdadeiro ou falso, indicando se a chamada à API foi bem-sucedida ou não. Mesmo as chamadas bem-sucedidas podem conter mensagens de aviso na resposta.	verdadeiro
obsoleto	N	Se presente na etiqueta de resposta e definido como verdadeiro, esse atributo indica que a versão do método ou da API que está sendo invocada se tornou obsoleta e está oficialmente obsoleta. Embora continue a funcionar neste momento, pode deixar de funcionar em breve. Normalmente, esse atributo não está presente.	false
Conteúdo do elemento
Um único elemento de mensagens opcional e exatamente um elemento de saída obrigatório.

elemento de saída
Nome da etiqueta	saída
Atributos do elemento
(nenhum)
Conteúdo do elemento
Um único elemento de contas. Esse invólucro de saída é padrão em todas as respostas de API e inclui a saída válida de qualquer chamada de API bem-sucedida.

publishResponse element
Nome da etiqueta		publishResponse
Descrição		A resposta a uma solicitação de publicação de alterações. Contém informações sobre o status de alterações não publicadas ou o resultado de uma publicação.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
publishedCount	S	O número de alterações que foram publicadas com êxito.	6
notPublishedCount	N	O número de alterações que NÃO foram publicadas. Incluído com uma resposta "publicar" malsucedida.	2
Conteúdo do elemento
(nenhum)