Documentos de API

Obtener comentarios

Recupera varios comentarios de un registro en una aplicación.

MétodoGET
URLhttps://{subdomain}.kintone.com/k/v1/record/comments.json
URL (espacio de invitado)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/record/comments.json
Autenticación Autenticación de contraseña , Autenticación de token de API , Autenticación de sesión
Content-Typeapplication/json (no es necesario si se especifica la consulta con una cadena de consulta)

Contenido

Permisos

El usuario o el token de API deben tener permiso para ver el registro y recuperar comentarios.

Parámetros de solicitud

Parámetro Tipo Obligatorio Descripción
app Integer o String Sí El identificador de la aplicación.
record Entero o cadena Sí El ID de registro.
order Cuerda Opcional El criterio de ordenación del identificador de comentario. Si se especifica "asc", se ordenarán los comentarios en orden ascendente y "desc" se ordenarán los comentarios en orden descendente.
Si se ignora, se establecerá "desc".
offset Integer Opcional De este modo, se omite la recuperación del primer número de comentarios.
"offset": 30 omite los primeros 30 comentarios y recupera el comentario 31. No hay un máximo para este valor.
limit Integer Opcional El número de registros que se van a recuperar.
"limit": 5 recuperará los primeros 5 comentarios. El valor predeterminado y máximo es de 10 comentarios.

Solicitud de ejemplo (cadena de consulta)

JavaScript using kintone.api() 

1
2
3
4
5
6
7
8
9

var query = '?app=1&record=1&order=asc&offset=0&limit=10';

kintone.api(kintone.api.url('/k/v1/record/comments.json', true) + query, 'GET', {}, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

Muestra de curl

1
2

curl -X GET 'https://{subdomain}.kintone.com/k/v1/record/comments.json?app=1&record=1&order=desc&offset=0&Limit=10' \
-H 'X-Cybozu-API-Token: L08xCvTh7A1EVm3rZimF98R8VLP3k4lMlzELqyCx'

Solicitud de ejemplo (JSON)

JavaScript usando kintone.api() y JSON 

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

var body = {
  'app': 1,
  'record': 1,
  'order': 'asc',
  'offset': 0,
  'limit': 10
};

kintone.api(kintone.api.url('/k/v1/record/comments.json', true), 'GET', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

Muestra de curl

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


curl -X GET 'https://{subdomain}.kintone.com/k/v1/record/comments.json' \
-H 'X-Cybozu-API-Token: L08xCvTh7A1EVm3rZimF98R8VLP3k4lMlzELqyCx' \
-H 'Content-Type: application/json' \
-d '{
  "app": 1,
  "record": 1,
  "order": "desc",
  "offset": 0,
  "limit": 10
}'

Parámetros de respuesta

Parámetro Tipo Descripción
comments Matriz de objetos Una serie de comentarios. Se devuelve una matriz vacía si no se cumple ninguna condición.
comments[].id String El ID de comentario.
comments[].text Cuerda El comentario incluye los códigos de salto de línea.
Si se menciona a un usuario en un comentario, el símbolo "@" se omitirá de la cadena.
comments[].createdAt Cuerda La fecha y hora de creación del comentario.
comentarios[].creator Objeto Un objeto que incluye información del creador del comentario.
comments[].creator.code Cuerda El código de usuario del creador del comentario (nombre de inicio de sesión).
comments[].creator.name Cuerda El nombre de usuario del creador del comentario (nombre para mostrar).
comments[].mentions Arreglo Una matriz que incluye información de los usuarios mencionados.
comments[].mentions[].code Cuerda El código del usuario, grupo u organización mencionado.
comments[].mentions[].type Cuerda El tipo de mención.
  • USER: Usuario
  • GROUP: Grupo
  • ORGANIZATION: Departamento
older Booleano Información de comentarios más antiguos:
  • true: Existen comentarios más antiguos.
  • false: Los comentarios más antiguos no existen (es decir, el primer comentario)
newer Booleano Información de los comentarios más recientes:
  • true: Existen comentarios más recientes.
  • false: Los comentarios más recientes no existen. (es decir, el último comentario)

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
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

{
  "comments": [
    {
      "id": "3",
      "text": "user14 Thank you! Looks great.",
      "createdAt": "2016-05-09T18:29:05Z",
      "creator": {
        "code": "user13",
        "name": "user13"
      },
      "mentions": [
        {
          "code": "user14",
          "type": "USER"
        }
      ]
    },
    {
      "id": "2",
      "text": "user13 Global Sales APAC Taskforce \nHere is today's report.",
      "createdAt": "2016-05-09T18:27:54Z",
      "creator": {
        "code": "user14",
        "name": "user14"
      },
      "mentions": [
        {
          "code": "user13",
          "type": "USER"
        },
        {
          "code": "Global Sales_1BNZeQ",
          "type": "ORGANIZATION"
        },
        {
          "code": "APAC Taskforce_DJrvzu",
          "type": "GROUP"
        }
      ]
    }
  ],
  "older": false,
  "newer": false
}

Limitaciones

  • El número máximo de registros que se pueden recuperar con la API Get Comments es 10.
  • Se generará un error si la función de comentarios de la aplicación está desactivada.
  • Para conocer otras limitaciones, consulte la sección Limitaciones del siguiente artículo:
    Descripción general de la API REST de Kintone