exportRoles

Sem suporte na API v25+. Use exportPermissionSets.

Categoria	Recuperação de metadados
Descrição	Retorna metadados para a lista completa de todas as funções na instância.
Permissões obrigatórias para invocar	Nenhum (devem ser credenciais válidas para a instância)
Parâmetros obrigatórios na solicitação	Credenciais

A solicitação desse método contém apenas uma etiqueta de credenciais para identificar e autorizar o usuário que está fazendo a chamada. Uma vez verificado, o método retorna um documento XML que descreve o conjunto completo de todas as funções encontradas na instância do usuário.

Formato da solicitação


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportRoles" 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 uma função que contenha as permissões necessárias para o método que está sendo invocado.	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


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
 <output>
   <roles>
     <role id="1" name="Standard" permissions="SHT,RPT,SCOREBOARD"/>
     <role id="2" name="Administrative" permissions="SHT,RPT,SCOREBOARD,SAL,MOD,IMP,EXP"/>
   </roles>
 </output>
</response>

As funções e permissões são ordenadas por nome.

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 por Adaptive Planning . 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.

elemento de funções
Nome da etiqueta	funções
Descrição	Contêiner para um ou mais elementos de função.
Atributos do elemento
(nenhum)
Conteúdo do elemento
Um ou mais elementos de função.

elemento de função
Nome da etiqueta		função
Descrição		Descreve uma única função disponível na instância.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	O número da ID do sistema interno para a função. É usado para identificar a função atribuída a um usuário na chamada à API exportUsers.	1
nome	S	O nome da função, conforme visto em Administração de funções.	Padrão
permissões	S	Uma lista de códigos de permissões atribuídas a esta função, separados por vírgulas. Os códigos são abreviações internas, como "SHT" para acesso à planilha e "RPT" para acesso ao relatório.	SHT,RPT,SCIREBOARD
Conteúdo do elemento
(nenhum)