importGroups

Categoría	Modificación de metadatos
Descripción	Importe los grupos de usuarios que haya creado en el sistema central de Workday o en un sistema externo. Si se realiza correctamente, la API devuelve los detalles de los grupos que ha importado. No puede usar esta API para actualizar grupos de usuarios creados en la interfaz de usuario de Adaptive Planning.
Permisos obligatorios para invocar	Permiso Gestionar grupos de usuarios globales
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. El usuario debe tener el permiso

Acceso de administrador

- Gestión de grupos de usuarios globales

para importar los grupos de usuarios.

Formato de solicitud

<?xml version='1.0' encoding='UTF-8'?>
<call method="importGroups" callerName="a string that identifies your client application"
dataSource="WORKDAY/EXTERNAL" mode="REPLACE_ALL/UPDATE" userIdentifier="userName/userGUID/wid">
  <credentials login="sampleuser@company.com" password="my_pwd" />
    <groups>
        <group
          externalID="userGroup_ID_1"
          name="new user group"
           >
          <users>
              <user userGUID="B9ADBCB81AA2F9BAE040307F02092C2E"
                  userName="user1"
                  wid="A9ADBCB81AA2F9BAE040307F02092C2E" />
              <user userGUID="B9ADBCB81AA2F9BAE040307F02092C2F"
                   userName="user3"
                   wid="A9ADBCB81AA2F9BAE040307F02092C2F" />
          </users>
        </group>
     </groups>
</call>

Atributos de consulta

Nombre	Descripción	Obligatorias
dataSource	El origen de los datos de los grupos de usuarios: WORKDAY. El origen de los datos de los grupos de usuarios es Workday. Estos grupos no se pueden editar en Adaptive Planning. EXTERNO El origen de los datos de los grupos de usuarios es cualquier otro sistema fuera de Workday. Desde la página Configuración general, su administrador puede activar la edición de grupos con un origen de datos EXTERNO. A continuación, puede actualizar estos grupos mediante la interfaz de usuario de Adaptive Planning. Consulte Referencia: configuración general.	Sí
modo	El modo de la llamada API: REPLACE_ALL. El modo sustituye todos los grupos de usuarios de su instancia de Adaptive Planning por los grupos de usuarios que especifique en la carga útil. ACTUALIZAR. El modo solo actualiza los grupos de usuarios que especifique en la carga útil.	Sí
userIdentifier	El identificador de los usuarios especificados en los grupos de usuarios: userName. El nombre de usuario del usuario especificado. userGUID. El ID de usuario global del usuario especificado. ancho El ID de Workday del usuario especificado.	Sí

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 muestra que este usuario ha realizado la acción. Por lo tanto, el usuario debe tener los permisos necesarios para realizar la acción para que la llamada a la API se realice 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 de 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. Además, para dar formato a los números y fechas de salida (utilizando el separador de miles, los nombres de periodo y el formato de fecha adecuados). La configuración regional también especifica el idioma en el que se deben mostrar 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 puede especificar que el usuario desea acceder a una instancia distinta a la instancia por defecto. Si no se especifica, se utiliza la instancia por defecto del usuario. Para determinar los códigos de instancia disponibles, utilice la API exportInstances.	MYINSTANCE1
Contenido del elemento
Ninguno

elemento de grupo
Nombre de etiqueta		grupo
Descripción		Especifica un conjunto de grupos de usuarios para crear o actualizar.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
externalID	Sí	El identificador externo del grupo de usuarios.	user_group_1
nombre	Sí	El nombre del grupo de usuarios.	Administradores de seguridad
Contenido del elemento
Elemento de usuarios

elemento de usuario
Nombre de etiqueta		usuario
Descripción		Especifica un usuario o usuarios para añadir al grupo de usuarios.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
userGUID	Y (siempre que el identificador de usuario especificado por la persona que llama a la API sea userGUID)	El identificador global del usuario.	B9ADBCB81AA2F9BAE040307F02092C2
userName	Y (siempre que el identificador de usuario especificado por la persona que llama a la API sea userName)	El nombre de usuario del usuario.	updateMail@company.com
wid	Y (siempre que el identificador de usuario especificado por la persona que llama a la API sea wid)	El ID de Workday del usuario.	A9ADBCB81AA2F9BAE040307F02092C2E
Contenido del elemento
En el caso de un usuario no válido (es decir, userGUID/userName/wid no válido), se omitirá el usuario no válido específico y se procesará la solicitud para el grupo para el resto de los usuarios válidos. Sin embargo, en las siguientes situaciones hipotéticas relacionadas con el elemento <user>, se rechazará todo el grupo en la carga útil. Falta el identificador de usuario: <user/> <user userName=""/> <user userName/userGUID/wid=" "/> Mensaje de error; Falta el identificador de usuario. Especifique un userName/userGUID/wid válido para todos los usuarios. Formato de WID no válido: Longitud de WID inferior o superior a 32 caracteres. Mensaje de error: especifique un userWID válido para todos los usuarios. El formato userGUID no es válido: Longitud de userGUID inferior o superior a 32 caracteres. userGUID no es alfanumérico. Mensaje de error: especifique un userGUID válido para todos los usuarios.

Formato de respuesta

<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
  <output>
      <result>
          <imported_groups>
              <group success="true" externalID="ID_1" id="33" name="New Group 1" />
          </imported_groups>
      </result>
  </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
En función de si ha realizado la llamada de creación o actualización, un único elemento de resultado con los elementos de estado created_usergroup o update_usergroup.

imported_groups element
Nombre de etiqueta		imported_groups
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
éxito de grupo	Sí	El estado devuelto, verdadero o falso.	"verdadero"
mensaje	Sí	El mensaje de estado.	"el nuevo grupo de usuarios del grupo de usuarios se ha creado correctamente." "La carga útil ha borrado parcialmente las pertenencias de los usuarios. Vuelva a intentarlo y, si el problema persiste, póngase en contacto con el servicio de asistencia técnica".
Contenido del elemento
Ninguno.