exportCalendar

Esta API es compatible con API v33+.

Actualizado en API v40 (21 de septiembre de 2024).

Categoría	Metadata retrieval
Descripción	Devuelve metadatos de calendario.
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. Una vez verificada la persona que llama, el método devuelve un documento XML que describe la lista completa de información del calendario.

Formato de solicitud

<?xml version='1.0' encoding='UTF-8'?>
<call method="exportCalendar" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/>
</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 llamada a la API se lleve a cabo. 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
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 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>
<calendars>
  <calendar id="1" isDefault="true" name="DefaultTimeHierarchy" />
</calendars>
</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
Contenido del elemento
Exactamente un elemento de resultado obligatorio.

elemento de resultado
Nombre de etiqueta	salida
Atributos del elemento
(ninguno)
Contenido del elemento
Un solo elemento de calendarios 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 calendarios
Nombre de etiqueta		calendarios
Descripción		Contenedor para uno o varios elementos de calendarios.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
(ninguno)
Contenido del elemento
Uno o varios elementos de calendario

elemento de calendario
Nombre de etiqueta		calendario
Descripción		Representa un calendario.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	Contiene el identificador de número entero específico del calendario específico.	1
isDefault	Sí	"Verdadero" o "falso", que indica si ese calendario específico es el calendario por defecto.	verdadero
nombre	Sí	Contiene el nombre del calendario.	DefaultTimeHierarchy
código Disponible en API v40+	No	Contiene el código de calendario cuando hay códigos de calendario.	DefaultTimeHierarchy
Contenido del elemento
(ninguno)