exportInstances

Categoría	Metadata retrieval.
Descripción	Devuelve los metadatos de la lista completa de todas las instancias de Adaptive Planning a los que este usuario tiene acceso.
Permisos obligatorios para invocar	Ninguna (deben ser credenciales válidas para la instancia)
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 y una etiqueta de inclusión opcional para indicar qué instancias se deben incluir en la respuesta. Una vez verificadas las credenciales de usuario, el método devuelve un documento XML que describe la instancia especificada en las credenciales o el conjunto completo de todas las instancias a las que este usuario tiene acceso. Si no se ha adquirido la función Varias instancias, esta llamada siempre devuelve un solo elemento para la instancia a la que pertenece el usuario.

Formato de solicitud


<?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 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 API llamada 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)

incluir elemento
Nombre de etiqueta		incluir
Descripción		Representa un conjunto de indicadores que indican qué aspectos de la información de las instancias deben incluirse o excluirse de la respuesta. Este elemento es opcional: si no está presente, el valor por defecto es false para las instancias accesibles.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
accessibleInstances	No	Verdadero o falso. Si la respuesta debe incluir otras instancias además de la instancia única especificada en las credenciales El valor por defecto, si el elemento o su atributo no está presente, es falso. Si se incluye y es verdadero, la API debería devolver la lista de todas las instancias a las que el usuario tiene acceso. Estas instancias no se devuelven de forma anidada o con indicación de elemento principal; simplemente se enumeran con las propiedades que se muestran en la API. La primera instancia devuelta es siempre la instancia por defecto del usuario.	Falso
Contenido del elemento
(ninguno)

Formato de respuesta


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

elemento de instancias
Nombre de etiqueta	instancias
Descripción	Contenedor para uno o varios elementos de instancia.
Atributos del elemento
(ninguno)
Contenido del elemento
Uno o varios elementos de instancia.

elemento de instancia
Nombre de etiqueta		instancia
Descripción		Describe una única instancia a la que este usuario tiene acceso, incluidos varios atributos de esa instancia.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
código	Sí	El código de instancia de la instancia. Esto se puede usar para especificar una instancia alternativa para una llamada API dentro del elemento de credenciales.	INSTANCE1
nombre	Sí	El nombre de la instancia. Esto se configura en Administración > Configuración general para esa instancia.	Globo Industries
sessionTimeout	Sí	Tiempo de espera en minutos de la sesión de usuario.	60
systemCurrency	Sí	El código ISO de la moneda de sistema.	USD
productos	Sí	Lista separada por comas de nombres de productos que están activados para la instancia.	PLANIFICACIÓN, CONSOLIDACIÓN, DISCOVERY, INTEGRACIÓN
opciones	Sí	Lista separada por comas de varios módulos activados para la instancia.	TRANSACTIONS,MULTI_CURRENCY,DISCO_DISABLED,WORKDAY,PLANNING_VISUALIZE_DATA
orígenes de datos	Sí	Lista separada por comas de orígenes de datos activados para la instancia.	WORKDAY, NETSUITE, SALES FORCE
workdayTenantID disponible en API v20+	No	El ID de entorno de cliente de Workday o el nombre de entorno de cliente que identifica de forma exclusiva al entorno de cliente. Requiere la configuración de Adaptive Planning para Workday, activada por el aprovisionamiento.	mitenant
workdayEnvironment disponible en API v20+	No	El entorno de Workday como Prod (producción), Sandbox (sandbox) o Impl (implementación). Requiere la configuración de Adaptive Planning para Workday, activada por el aprovisionamiento.	Prod.
workdayUiUrl disponible en API v20+	No	El nombre de dominio de la URL de la interfaz de usuario de Workday para el entorno de cliente de Workday. Requiere la configuración de Adaptive Planning para Workday, activada por el aprovisionamiento.	www.myworkday.com/mytenant/d/home.html
workdayRestUrl disponible en API v20+	No	El nombre de dominio de la URL de REST para el entorno de cliente de Workday. Requiere la configuración de Adaptive Planning para Workday, activada por el aprovisionamiento.	www.myworkday.com/ccx/service/
tipo de notificación disponible en API v24+	No	El tipo de notificación para el entorno de cliente de Workday. Requiere la configuración de Adaptive Planning para Workday, activada por el aprovisionamiento.	NONE
Contenido del elemento
(ninguno)