unpublishedChangesStatus

Categoria	Publicação de administrador
Descrição	Recuperar o número de alterações não publicadas e determinar se a publicação do administrador está desabilitada para a instância.
Permissões obrigatórias para invocar	Devem ser credenciais válidas para a instância. Se a publicação de administrador está desabilitada, nenhuma permissão adicional é necessária. Se a publicação de administrador está habilitada, o usuário deve ter a permissão Publicar alterações administrativas.
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="unpublishedChangesStatus" 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 API chamada será bem-sucedida.
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

Estes são exemplos de respostas para publicações do administrador habilitadas e desabilitadas.

Exemplo de publicação habilitada pelo administrador


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

Exemplo de publicação de administrador desabilitada


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
    <output>
        <unpublishedStatus adminPublishingEnabled="0" />
    </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 unpublishedStatus obrigatório. 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.

unpublishedStatus element
Nome da etiqueta		unpublishedStatus
Descrição		A resposta a uma solicitação unpublishedChangesStatus. Contém informações sobre se a publicação do administrador está habilitada e, em caso afirmativo, quantas alterações não publicadas existem.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
adminPublishingEnabled	S	Se a publicação do administrador está habilitada ou não para esta instância (0 = não habilitada, 1 = habilitada).	1
numberToPublish	N	Quantas alterações não publicadas existem. Aparece somente se a publicação de administrador está habilitada. Se não há alterações não publicadas, o valor é 0.	2
Conteúdo do elemento
(nenhum)