exportInstances

Categoria	Recuperação de metadados
Descrição	Retorna metadados para a lista completa de todas as instâncias do Adaptive Planning aos quais este usuário tem acesso.
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 uma etiqueta de credenciais para identificar e autorizar o usuário que faz a chamada e uma etiqueta de inclusão opcional para indicar quais instâncias devem ser incluídas na resposta. Depois que as credenciais do usuário são verificadas, o método retorna um documento XML que descreve a instância especificada nas credenciais ou o conjunto completo de todas as instâncias às quais esse usuário tem acesso. Se a funcionalidade Multiple Instance não foi adquirida, essa chamada sempre retorna um único elemento para a instância à qual o usuário pertence.

Formato da solicitação


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportInstances" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd"/>
 <include accessibleInstances="true"/>
</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, será usada a instância por padrão do usuário. Para determinar os códigos de instância disponíveis, use a API exportInstances.	MYINSTANCE1
Conteúdo do elemento
(nenhum)

incluir elemento
Nome da etiqueta		incluir
Descrição		Representa um conjunto de indicadores que indicam quais aspectos das informações das instâncias devem ser incluídos ou excluídos da resposta. Esse elemento é opcional: se não estiver presente, o valor por padrão será falso para accableInstances.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
accessibleInstances	N	Verdadeiro ou falso. Se a resposta deve incluir outras instâncias além da instância única especificada nas credenciais O valor por padrão, se o elemento ou seu atributo não está presente, é falso. Se incluída e verdadeira, a API deve retornar a lista de todas as instâncias às quais o usuário tem acesso. Essas instâncias não são retornadas de forma aninhada ou com indicação de pai; eles simplesmente são enumerados com as propriedades mostradas na API. A primeira instância retornada é sempre a instância por padrão do usuário.	Falso
Conteúdo do elemento
(nenhum)

Formato da resposta


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<output>
  <instances>
    <instance code="INSTANCE1" name="Globo Industries" sessionTimeout="60" calendarType="G" systemCurrency="USD" products="PLANNING,DISCOVERY" options="TRANSACTIONS,MULTI_CURRENCY,DISCO_DISABLED,WORKDAY,PLANNING_VISUALIZE_DATA" workdayTenantID="mytenant" workdayEnvironment="Prod" workdayUiUrl="www.myworkday.com/mytenant/d/home.html" workdayRestUrl="www.myworkday.com/ccx/service/" datasources="WORKDAY,GREAT PLAINS,INTACCT,SALESFORCE,NETSUITE" notificationType="NONE"/>
  </instances>
</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.

elemento de instâncias
Nome da etiqueta	instâncias
Descrição	Contêiner para um ou mais elementos de instância.
Atributos do elemento
(nenhum)
Conteúdo do elemento
Um ou mais elementos de instância.

elemento da instância
Nome da etiqueta		instância
Descrição		Descreve uma única instância à qual este usuário tem acesso, incluindo vários atributos dessa instância.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
código	S	O código da instância. Isso pode ser usado para especificar uma instância alternativa para uma chamada de API no elemento credenciais.	INSTANCE1
nome	S	O nome da instância. Isso é configurado em Administração > Definição geral para essa instância.	Globo Industries
sessionTimeout	S	Tempo limite em minutos da sessão do usuário.	60
systemCurrency	S	O código ISO da moeda do sistema.	USD
produtos	S	Lista separada por vírgulas de nomes de produtos que estão habilitados para a instância.	PLANNING,CONSOLIDAÇÃO,DISCOVERY, INTEGRAÇÃO
opções	S	Lista separada por vírgulas de vários módulos habilitados para a instância.	TRANSACTIONS,MULTI_CURRENCY,DISCO_DISABLED,WORKDAY,PLANNING_VISUALIZE_DATA
fontes de dados	S	Lista separada por vírgulas de fontes de dados habilitadas para a instância.	WORKDAY, NETSUITE, SALES FORCE
workdayTenantID disponível na API v20+	N	A ID do locatário do Workday ou o nome do locatário que identifica o locatário de forma exclusiva. Requer o Adaptive Planning definido para o Workday, habilitado pelo provisionamento.	mytenant
workdayEnvironment disponível na API v20+	N	O ambiente do Workday como Prod (produção), Sandbox (sandbox) ou Impl (implementação). Requer o Adaptive Planning definido para o Workday, habilitado pelo provisionamento.	Prod
workdayUiUrl disponível na API v20+	N	O nome de domínio do URL de interface de usuário do Workday para o locatário do Workday. Requer o Adaptive Planning definido para o Workday, habilitado pelo provisionamento.	www.myworkday.com/mytenant/d/home.html
workdayRestUrl disponível na API v20+	N	O nome de domínio do URL de REST para o locatário do Workday. Requer o Adaptive Planning definido para o Workday, habilitado pelo provisionamento.	www.myworkday.com/ccx/service/
notificationType disponível na API v24+	N	O tipo de notificação para o locatário do Workday. Requer o Adaptive Planning definido para o Workday, habilitado pelo provisionamento.	NENHUM
Conteúdo do elemento
(nenhum)