Documentos de API

Estructuras de datos utilizadas con la API de usuario

Contenido

Tipo de ID

Se utiliza para entidades (usuario/grupo/departamentos) en Kintone.
Un número entero entre 1 - Long.MAX.

Tipo de usuario

Llave Tipo Detalles
id Tipo de ID El ID de usuario. Consulte la siguiente sección para obtener más información sobre los tipos de identificación:
Tipo de ID
code Cuerda El nombre de inicio de sesión del Usuario.
ctime Formato de fecha y hora ISO-8601 La fecha y hora creada por el Usuario.
mtime Formato de fecha y hora ISO-8601 La fecha y hora actualizada del Usuario.
valid Booleano Si el estado del usuario es Activo o no.
name Cuerda El nombre para mostrar del usuario.
surName String El apellido del usuario
Si no se especifica, null será devuelto.
givenName Cuerda El nombre del Usuario.
Si no se especifica, null será devuelto.
surNameReading Cuerda La lectura fonética del apellido.
Si no se especifica, null será devuelto.
givenNameReading Cuerda La lectura fonética del Nombre.
Si no se especifica, null será devuelto.
localName Cuerda El nombre para mostrar localizado del usuario.
Si no se especifica, null será devuelto.
localNameLocale Cuerda La configuración regional del nombre para mostrar localizado del usuario.
Si no se especifica, null será devuelto.
timezone Cuerda El identificador de zona horaria de la zona horaria establecida por el usuario. Vea toda la lista de zonas horarias en la Ayuda de Kintone:
Lista de zonas horarias (External link)
locale Cuerda La configuración de idioma del usuario.
Si no se especifica, null será devuelto.
description Cuerda La sección Acerca de mí del perfil del usuario.
Si no se especifica, null será devuelto.
phone Cuerda El número de teléfono del Usuario.
Si no se especifica, null será devuelto.
mobilePhone Cuerda El número de teléfono móvil del Usuario.
Si no se especifica, null será devuelto.
extensionNumber Cuerda El número de extensión del Usuario.
Si no se especifica, null será devuelto.
email Cuerda La dirección de correo electrónico del Usuario.
Si no se especifica, null será devuelto.
callto Cuerda El ID de Skype del usuario.
Si no se especifica, null será devuelto.
url Cuerda La sección URL del perfil del usuario.
Si no se especifica, null será devuelto.
employeeNumber Cuerda El número de empleado del usuario.
Si no se especifica, null será devuelto.
birthDate Formato de fecha ISO-8601 El cumpleaños del usuario.
Si no se especifica, null será devuelto.
joinDate Formato de fecha ISO-8601 La fecha de contratación del usuario.
Si no se especifica, null será devuelto.
primaryOrganization Integer El ID de departamento del departamento prioritario del usuario.
Si no se especifica, null será devuelto.
sortOrder Integer La prioridad del orden de visualización del usuario.
Si no se especifica, null será devuelto.
customItemValues Matrices customItemValue Una lista de pares de nombres de campos personalizados y códigos de campos personalizados. Consulte la siguiente sección para obtener más información sobre customItemValues:
customItemValue tipo

Muestra

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

{
  "birthDate": "2000-05-01",
  "callto": null,
  "code": "a",
  "ctime": "2024-08-22T08:12:18Z",
  "customItemValues": [
    {
      "code": "item1",
      "value": "aitem1"
    },
    {
      "code": "secret",
      "value": "aitem2"
    }
  ],
  "description": null,
  "email": null,
  "employeeNumber": null,
  "extensionNumber": null,
  "givenName": null,
  "givenNameReading": null,
  "id": "1",
  "joinDate": "2024-08-01",
  "localName": null,
  "localNameLocale": "en",
  "locale": null,
  "mobilePhone": null,
  "mtime": "2024-08-22T09:00:45Z",
  "name": "a",
  "phone": null,
  "primaryOrganization": null,
  "sortOrder": 2147483647,
  "surName": "a",
  "surNameReading": null,
  "timezone": "Asia/Tokyo",
  "url": null,
  "valid": true
}

Tipo de departamento

Llave Tipo Detalles
id Tipo de ID La identificación del Departamento. Consulte la siguiente sección para obtener más información sobre los tipos de identificación:
Tipo de ID
code Cuerda El Código del Departamento.
name Cuerda El nombre para mostrar del Departamento.
localName Cuerda El nombre localizado del Departamento.
localNameLocale Cuerda La configuración regional del nombre localizado del Departamento.
parentCode Cuerda El código del Departamento de Padres. null, si el elemento primario es la raíz.
description Cuerda La descripción del Departamento.

Muestra

1
2
3
4
5
6
7
8
9

{
  "id": 1,
  "code": "DEV_ba27fP",
  "name": "DEV",
  "localName": "Department of Development Engineering",
  "localNameLocale": "en",
  "parentCode": null,
  "description": "A department dedicated to the company’s development engineering."
}

Tipo de título

Llave Tipo Detalles
id Tipo de ID El identificador del puesto de trabajo. Consulte la siguiente sección para obtener más información sobre los tipos de identificación:
Tipo de ID
code Cuerda El código del puesto de trabajo.
name Cuerda El nombre del puesto de trabajo.
description Cuerda La descripción del puesto de trabajo.

Muestra

1
2
3
4
5
6

{
  "id": 2,
  "code": "Engineer_OLE9N0",
  "name": "Engineer",
  "description": "Engineer"
}

Tipo de grupo

Llave Tipo Detalles
id Tipo de ID El ID del grupo. Consulte la siguiente sección para obtener más información sobre los tipos de identificación:
Tipo de ID
code Cuerda El código del Grupo.
name Cuerda El nombre para mostrar del grupo.
description Cuerda La descripción del Grupo.
Si no se especifica, null será devuelto.

Muestra

1
2
3
4
5
6

{
  "id": 1,
  "code": "MARKETING01",
  "name": "Tokyo Marketing Department",
  "description": null
}

organizationTipo de título

Llave Tipo Detalles
organización Tipo de departamento La información del Departamento.
Consulte la siguiente sección para obtener más información sobre los tipos de departamentos:
Tipo de departamento
title Tipo de título La información del título del puesto.
Si no se especifica, null será devuelto.
Consulte la siguiente sección para obtener más información sobre los tipos de títulos:
Tipo de título

Muestra

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

{
  "organization": {
    "id": 1,
    "code": "DEV_ba27fP",
    "name": "DEV",
    "localName": "Department of Development Engineering",
    "localNameLocale": "en",
    "parentCode": null,
    "description": "A department dedicated to the company’s development engineering."
  },
  "title": {
    "id": 2,
    "code": "Engineer_OLE9N0",
    "name": "Engineer",
    "description": "Engineer"
  }
}

userTipo de título

Llave Tipo Detalles
user Tipo de usuario La información del Usuario.
Consulte la siguiente sección para obtener más información sobre los tipos de usuarios:
Tipo de usuario
title Tipo de título La información del título del puesto.
Si no se especifica, null será devuelto.
Consulte la siguiente sección para obtener más información sobre los tipos de usuarios:
Tipo de título

Muestra

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

{
  "user": {
    "birthDate": "2000-05-01",
    "callto": null,
    "code": "a",
    "ctime": "2024-08-22T08:12:18Z",
    "customItemValues": [
      {
        "code": "item1",
        "value": "aitem1"
      },
      {
        "code": "secret",
        "value": "aitem2"
      }
    ],
    "description": null,
    "email": null,
    "employeeNumber": null,
    "extensionNumber": null,
  " givenName": null,
    "givenNameReading": null,
    "id": "1",
    "joinDate": "2024-08-01",
    "localName": null,
    "localNameLocale": "en",
    "locale": null,
    "mobilePhone": null,
    "mtime": "2024-08-22T09:00:45Z",
    "name": "a",
    "phone": null,
    "primaryOrganization": null,
    "sortOrder": 2147483647,
    "surName": "a",
    "surNameReading": null,
    "timezone": "Asia/Tokyo",
    "url": null,
    "valid": true
  },
  "title": {
    "id": 2,
    "code": "Engineer_OLE9N0",
    "name": "Engineer",
    "description": "Engineer"
  }
}

customItemValue tipo

Llave Tipo Detalles
code Cuerda Código
valor Cuerda Valor

Es posible que los campos personalizados tengan la configuración Hacer público este campo de la opción Visibilidad sin marcar. Solo los usuarios y administradores del sistema pueden obtener datos de campos personalizados que tienen la opción Visibilidad desmarcada.
Para obtener más información sobre los campos personalizados, consulte el siguiente artículo:
Adición de campos personalizados (External link)

Muestra

1
2
3
4

{
  "code": "item",
  "value": "item value"
}