netexCloud - API de Web Services | Web services de grupo | Creación de un grupo
Última modificación:
Creación de un grupo
Crear un grupo.
- URL: /integration/ws/management/rest/groups
- Method: POST
- Headers:
- Accept: encabezado de versión/formato
- X-Cloud-Auth-Token*: encabezado de autenticación
- Content-Type*: application/json
- Parameters:
- group*: grupo que se va a crear (el parámetro id se ignora al ser una creación):
- name*: nombre del grupo
- description: descripción del grupo
- codGroup*: código del grupo (identificador externo)
- parentId: identificador (interno o externo) del grupo padre. En caso de no encontrarse un grupo con este identificador, este campo se ignora.
- image: imagen del grupo. Puede ser especificada como:
- url: url en la que se encuentra la imagen ({"url": "image_url"})
- base64: datos de la imagen ({"base64Image": "image_data", "mimeType": "image_mimeType"})
- roles: roles de grupo especificados como un mapa con la sección como clave y la lista de rol como valor. Los valores permitidos son:
- management: user, groupadmin, admin
- training: user, trainer, groupadmin, admin
- social: user, admin
- play: user, author, validator, admin
- talent: admin, employee
- content: author, manager, reviewer, projectowner
- extra:
- isOrganization (*): (Solo para cliente con multiorganización) Habilita que el grupo sea considerado como una organización en el cliente.
- group*: grupo que se va a crear (el parámetro id se ignora al ser una creación):
- Responses:
- 200: OK. Contenido:
- status: estado general
- location: ubicación genérica del recurso resultante (si lo hubiere)
- message: mensaje genérico de “éxtio” o “error” (si lo hubiere)
- responsePlatforms: respuesta para cada plataforma a la que afecta, cada una con el contenido:
- status: estado en la plataforma
- location: ubicación del recurso resultante en la plataforma (si lo hubiere)
- message: mensaje de “éxito” o “error” en la plataforma (si lo hubiere)
- 200: OK. Contenido:
- Ejemplo de petición:
- POST http://<tenant>.pre.learningcloud.me/integration/ws/management/rest/groups
- Payload: {"group":{"codGroup":"teachers","description":"Users included in this group will have LMS trainer role.","isOrgnaization":true,"extra":{},"image":{"url":null},"name":"Teachers group","parentId":"8a80807d5ab3d79f015ab3dcb2110000","roles":{"training":["trainer"]}}}
- Ejemplo de respuesta:
- Header: Location: http://<tenant>.pre.learningcloud.me/integration/ws/management/rest/groups/8a80807d5bcf2ebe015bcf3c9eeb0000
- Payload: {"location":null,"message":"","responsePlatforms":{"management":{"location":null,"message":null,"status":201}},"status":201}
(*) El campo isOrganization solo se permite en los grupos raíz de los clientes con multiorganización activada.