Documentos de API

Obtener grupos

Obtiene información de grupos.

MétodoGET
URLhttps://{subdomain}.kintone.com/v1/groups.json
Autenticación Autenticación mediante token API , Autenticación mediante contraseña , Autenticación mediante sesión
Content-Typeapplication/json (no es necesario si se especifica la consulta con una cadena de consulta)

Contenido

Permisos

Todos los usuarios que no sean usuarios invitados pueden usar esta API.

Parámetros de solicitud

Parámetro Tipo Obligatorio Descripción
ids Arreglo Opcional Una lista de identificadores de grupo, como tipos de identificador.
Se pueden especificar hasta 100 identificadores.
Para obtener más información sobre los tipos de identificación, consulte el siguiente enlace:
Tipo de ID
codes Arreglo Opcional Una lista de códigos de grupo, como cadenas.
Se pueden especificar hasta 100 códigos.
offset Integer Opcional La compensación.
Si se omite, este valor es 0.
size Integer Opcional El número máximo de información de grupo que se va a obtener.
Si se omite, este valor es 100.

Si ids y codes se ignoran, se responderán hasta 100 identificadores en orden ascendente de identificación.

Si ids y codes están ambos configurados, se devolverá un error. Solo se puede configurar uno.

Solicitud de muestra

JavaScript using kintone.api() 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

var body = {
  'ids': [1, 2, 3],
  'offset': 0,
  'size': 100
};
kintone.api(kintone.api.url('/v1/groups.json', true), 'GET', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

XMLHttpRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

var params = '?ids[0]=1&ids[1]=2&ids[2]=3&offset=0&size=100';
var url = 'https://{subdomain}.kintone.com/v1/groups.json' + params;
console.log(url);
var xhr = new XMLHttpRequest();
xhr.open('GET', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.onload = function() {
  if (xhr.status === 200) {
    // success
    console.log(JSON.parse(xhr.responseText));
  } else {
    // error
    console.log(JSON.parse(xhr.responseText));
  }
};
xhr.send();

Parámetros de respuesta

Parámetro Tipo Descripción
groups Arreglo Una lista de información de departamento, como tipos de grupo, en orden ascendente de id.
Para obtener más información sobre los tipos de grupo, consulte la siguiente documentación:
Tipo de grupo

Ejemplo de respuesta

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

{
  "groups": [
    {
      "id": "1",
      "code": "1",
      "name": "Officer",
      "description": ""
    },
    {
      "id": "2",
      "code": "general_manager",
      "name": "General Manager",
      "description": ""
    },
    {
      "id": "7532782697181632513",
      "code": "everyone",
      "name": "Everyone",
      "description": null
    }
  ]
}