exportSheets

Categoría	Metadata retrieval
Descripción	Devuelve la lista completa de todas las hojas definidas para la instancia determinada. Esto incluye hojas "incompletas", así como hojas asignadas a usuarios.
Permisos obligatorios para invocar	IMP (importar datos) o MOD (crear, editar y eliminar hojas)
Parámetros obligatorios bajo petición	Credenciales

La solicitud de este método solo contiene una etiqueta de credenciales para identificar y autorizar al usuario que llama. Una vez verificado, el método devuelve un documento XML que describe el conjunto completo de todas las hojas que se encuentran en la instancia del usuario.

Formato de solicitud


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportSheets" callerName="a string that identifies your client application">
  <credentials login="sampleuser@company.com" password="my_pwd"/>
</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 para realizarla correctamente.
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 formatear 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)

Formato de respuesta


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
  <output>
    <sheets>
      <modeled-sheet id="1" name="Personnel" prefix="Personnel" description="Personnel Sheet" />
      <modeled-sheet id="2" name="Crossover Personnel" prefix="Crossovers" description="Personnel Sheet" />
      <modeled-sheet id="3" name="Sales" prefix="Sales" description="Sales Sheet" />
      ...
      <standard-sheet id="6" name="Model Summary" prefix="" description="Configurable Model Summary Sheet" />
      <standard-sheet id="8" name="Expenses" prefix="" description="" />
      <standard-sheet id="9" name="Balance" prefix="" description="" />
      <standard-sheet id="10" name="Assumptions" prefix="" description="" />
      ...
      <cube-sheet id="17" name="Expense Cube" prefix="ExpenseCube" description="" />
      <cube-sheet id="19" name="Sale Cube" prefix="SalesCube" description="" />
    </sheets>
  </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 por Adaptive Planning . 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
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
(ninguno)
Contenido del elemento
Un solo elemento de hojas de cubo obligatorio. 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 hojas
Nombre de etiqueta		hoja
Descripción		Contenedor para uno o varios elementos de hoja estándar, hoja modelada y hoja de cubo.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
(ninguno)
Contenido del elemento
Uno o varios elementos de hoja estándar, hoja modelada y hoja de cubo.

elemento de hoja estándar
Nombre de etiqueta		hoja estándar
Descripción		Representa una sola hoja estándar que se devuelve en respuesta a una llamada a la API exportSheets.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	El número de ID de sistema interno de la hoja. Esto se puede usar para identificar hojas en otras llamadas a la API, como exportSheetDefinition.	123
prefijo	Sí	El prefijo de la hoja. En las hojas estándar, siempre está vacío. Otros tipos de hoja tienen valores no vacíos para este atributo.
nombre	Sí	El nombre de la hoja.	Modos de agrupación
descripción	No	La descripción textual de la hoja, si la hay.	Estos son los modos de agrupación...
Contenido del elemento
(ninguno)

elemento de hoja modelada
Nombre de etiqueta		hoja modelada
Descripción		Representa una sola hoja modelada que se devuelve en respuesta a una llamada a la API exportSheets.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	El número de ID de sistema interno de la hoja. Esto se puede usar para identificar hojas en otras llamadas API, como exportSheetDefinition.	234
prefijo (API v38 y anteriores) código (API v39+)	Sí	API v38: el prefijo de la hoja. API v39: el código de la hoja.	Capital
nombre	Sí	El nombre de la hoja.	Modelo de capital
descripción	No	La descripción textual de la hoja, si la hay.	Este es el modelo de capital...
Contenido del elemento
(ninguno)

elemento de hoja de cubo
Nombre de etiqueta		hoja-cúbica
Descripción		Representa una sola hoja de cubo que se devuelve en respuesta a una llamada a la API exportSheets.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID		El número de ID de sistema interno de la hoja. Esto se puede usar para identificar hojas en otras llamadas a la API, como exportSheetDefinition.	34
prefijo		El prefijo de la hoja.	ExpenseCube
nombre		El nombre de la hoja.	Cubo de gastos
descripción		La descripción textual de la hoja, si la hay.

Contenido del elemento

(ninguno)