Saltar al contenido principal
Documentación
Documentación
Adaptive Planning
Última actualización: 2024-03-08
Grupos

Grupos

Punto final de URL

HTTPS://api.adaptiveplanning.com/api/rest/security/<version>/<tenant>/groups/{groupID}
Versión: v1
Categoría
Recuperación de metadatos
Descripción
Devuelve la lista completa de todos los grupos definidos para la instancia determinada. Esto incluye los grupos definidos globalmente en toda la instancia y los grupos definidos por los usuarios.
Permisos obligatorios para invocar
Acceso de administrador > Usuarios
Parámetros obligatorios bajo petición
Credenciales

VERB HTTP admitidos

Verbo HTTP
Recurso único
Recurso de recopilación
Descripción
GET
Compatible
Compatible
Recupera grupos de Planning.

OBTENER:

Solicitud:
/groups/{groupId}
Recupera la lista de todos los grupos y sus usuarios/miembros definidos para la instancia determinada.
URI de solicitud de muestra:
HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=globalsales&offset=2&limit=1
Cabecera de solicitud de muestra:
Accept-Language: es
Cuerpo de solicitud de muestra
Parámetros de consulta
Nombre
Descripción
Obligatorias
groupId
El ID del grupo que desea devolver individualmente
No
includeUsers
Para determinar si se devolverán o no los usuarios de los grupos a los que se llama. Por defecto, la opción Incluir usuarios está activada.
No
limit
El número máximo de objetos en una sola respuesta.
No
offset
Para mostrar una determinada cantidad de grupos por página. Si hay más grupos que el límite, los grupos adicionales pasarán a la página siguiente. Para acceder a una página determinada, debe especificar el valor de compensación.
No
instanceCode
Por defecto, devolverá la instancia por defecto asignada al usuario. Al proporcionar un valor, puede llamar a las instancias a las que su usuario tiene acceso, incluidas las instancias principales/secundarias.
No
Respuesta de muestra
Respuesta de muestra
 
{
   "links": {
       "next": "HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1",
       "previous": "HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=0&limit=1"
   },
   "total": 3,
   "groups": [
       {
           "id": 2,
           "name": "Admins",
           "groupType": "NATIVE",
           "users": [
               {
                   "userGuid": "randomValue",
                   "wid": "",
                   "userName": "test@email.com"
               },
               {
                   "userGuid": "randomValue",
                   "wid": "",
                   "userName": "test2@email.com"
               },
           ]
       },
       {
           "id": 1,
           "name": "Corporate and Operations",
           "groupType": "NATIVE",
           "users": []
       },
       {
           "id": 3,
           "name": "Ops and Admins",
           "groupType": "NATIVE",
           "users": [],
           "groups": [
               {
                   "id": 2,
                   "name": "Admins",
                   "groupType": "NATIVE"
               },
               {
                   "id": 1,
                   "name": "Corporate and Operations",
                   "groupType": "NATIVE"
               }
           ]
       }
   ]
}
Elemento de respuesta
Nombre de etiqueta
respuesta
Atributos del elemento
Nombre de atributo
¿Obligatorio?
Valor
Ejemplo
total
Sí
Número total de grupos
3
grupos
Sí
Información de grupo de todos los grupos o de los grupos especificados. Si un grupo está dentro de otro grupo, también muestra los grupos asociados al grupo indicado.
{
"id": 1,
"name": "Corporate and Operations",
"groupType": "NATIVE",
"users": []
}
groupType
Sí
Muestra el tipo de grupo.
Externo
ID
Sí
ID asociado del grupo.
1
nombre
Sí
Nombre del grupo.
"Admins"
usuarios
No
Si includeUsers = true o includeUsers es el valor por defecto, se proporciona con el GUID, el ID de usuario y el nombre de usuario del usuario. si no, no se devuelve.
"users": [
{
"userGuid": "randomValue",
"wid": "",
"userName": "test@example.com"
},
{
"userGuid": "randomValue",
"wid": "",
"userName": "test2@example.com"
}
vínculos
No
Cuando se proporciona un límite o una compensación y necesita un medio para pasar a distintas páginas de grupos, puede usar vínculos para avanzar y retroceder.
"links": {
"next": "HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1",
"previous": "HTTPS://api.adaptiveinsights.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=0&limit=1"
}
siguiente
No
Si se proporciona un límite y hay una página siguiente disponible, aparece "vínculos" con "siguiente".
"HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1"
anterior
No
Si se proporciona límite y compensación y se encuentra en el medio donde hay una página anterior y otra posterior disponibles, "anterior" estará disponible.
"HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1"
Contenido del elemento
Información relacionada con los elementos indicados.
Respuestas de error
Errores
Causa
Especifique valores de parámetro válidos para el límite y la compensación.
entrada no válida para valores de límite/compensación
GroupAPI: para getGroupByGroupId, no se ha encontrado el grupo para el código de instancia: {TENANT}
groupId no existe para el código de instancia
No tiene todos los permisos para ejecutar esta API: Manage Global User Groups.
las credenciales de usuario no tienen los permisos adecuados para evocar una llamada API
Credencial no válida
las credenciales utilizadas son incorrectas, por ejemplo
HTTP 404 no encontrado
El parámetro groupId no es válido.