Documentos de API

Agregar comentario

Agregar un comentario a un registro en una aplicación.

MétodoPOST
URLhttps://{subdomain}.kintone.com/k/v1/record/comment.json
URL (espacio de invitado)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/record/comment.json
Autenticación Autenticación de contraseña , Autenticación de token de API , Autenticación de sesión
Content-Typeapplication/json

Contenido

Permisos

El usuario o el token de API deben tener permiso para ver el registro y agregar un comentario.

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.
comment Objeto Sí Un objeto que incluye detalles de comentario.
comment.text Cuerda Sí El texto del comentario. El número máximo de caracteres del comentario es 65535.
comment.mentions Matriz de objetos Opcional Una matriz que incluye información para mencionar a otros usuarios.
comment.mentions[].code Cuerda Opcional El código del usuario, grupo u organización que se mencionará. El número máximo de menciones es de 10. Los usuarios mencionados se colocarán delante del texto del comentario cuando la API tenga éxito.
comment.mentions[].type Cuerda Opcional El tipo de objetivo mencionado.
  • USER: Usuario
  • GROUP: Grupo
  • ORGANIZATION: Departamento

Solicitud de muestra

JavaScript using kintone.api() 

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

var body = {
  'app': 1,
  'record': 1,
  'comment': {
    'text': 'sample comment',
    'mentions': [{
      'code': 'Administrator',
      'type': 'USER'
    }],
  }
};

kintone.api(kintone.api.url('/k/v1/record/comment.json', true), 'POST', 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
12
13
14

curl -X POST 'https://{subdomain}.kintone.com/k/v1/record/comment.json' \
  -H 'X-Cybozu-API-Token: L08xCvTh7A1EVm3rZimF98R8VLP3k4lMlzELqyCx' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1,
    "record": 1,
    "comment": {
      "text": "sample comment",
      "mentions": [{
        "code": "Administrator",
        "type": "USER"
      }]
    }
  }'

Parámetros de respuesta

Parámetro Tipo Descripción
id Cuerda El ID de comentario.

Ejemplo de respuesta

Cuerpo

Se devolverá el ID del comentario agregado.

1
2
3

{
  "id": "4"
}

Comentario de ejemplo agregado por API Token.

Limitaciones

  • Si se utiliza un token de API para publicar un comentario, el comentario será publicado por el usuario "Administrador".
  • Si el nombre mencionado tiene una configuración de nombre localizada y el idioma del nombre localizado es el mismo que la configuración de idioma del autor del comentario, el nombre mencionado se publicará como el nombre localizado.
  • No se pueden mencionar usuarios, departamentos y grupos inactivos o eliminados.
  • Se generará un error si la función de comentarios de la aplicación está desactivada.
  • Para conocer otras limitaciones, consulte el siguiente artículo:
    Descripción general de la API REST de Kintone