Actualizar las notas del administrador de la aplicación

Documentos de API

Actualizar las notas del administrador de la aplicación

Actualiza las notas para los administradores de aplicaciones y su configuración.
Para obtener más información, consulte el siguiente artículo:
Configuración de notas para administradores de aplicaciones

Método	PUT
URL	https://{subdomain}.kintone.com/k/v1/preview/app/adminNotes.json
URL (espacio de invitado)	https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/adminNotes.json
Autenticación	Autenticación de contraseña , Autenticación de token de API , Autenticación de sesión
Content-Type	application/json

Contenido

Actualizar las notas del administrador de la aplicación
Permisos
Parámetros de solicitud
Solicitud de muestra
Parámetros de respuesta
Ejemplo de respuesta

Permisos

Se necesitan permisos de administración de aplicaciones.

Parámetros de solicitud

Parámetro	Valor	Obligatorio	Descripción
app	Integer o String	Sí	El identificador de la aplicación.
content	Cuerda	Opcional	El contenido de las notas. El contenido debe tener entre 0 y 10000 caracteres. Si se omite el parámetro, el contenido no cambiará.
includeInTemplateAndDuplicates	Booleano o cadena	Opcional	La configuración de permisos para incluir esta nota en plantillas de aplicación o duplicados `true`:incluír `false`: no incluir Si se omite el parámetro, el contenido no cambiará.
revision	Entero o cadena	Opcional	El número de revisión de la configuración de la aplicación. Si el parámetro no coincide con el número de revisión real, se considerará un error y el contenido no se actualizará. La revisión no se comprobará si se ignora este parámetro o si se especifica `-1`.

Solicitud de muestra

JavaScript using kintone.api()

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


var body = {
  'app': 1,
  'content': 'Notes for app administrators',
  'includeInTemplateAndDuplicates': false,
  'revision': 2
};

kintone.api(kintone.api.url('/k/v1/preview/app/adminNotes.json', true), 'PUT', 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
17
18
19
20
21
22
23
24


var body = {
  'app': 1,
  'content': 'Notes for app administrators',
  'includeInTemplateAndDuplicates': false,
  'revision': 2,
  // CSRF TOKEN: used for all APIs that have an HTTP method of POST, PUT and DELETE on Kintone.
  '__REQUEST_TOKEN__': kintone.getRequestToken()
};

var url = 'https://{subdomain}.kintone.com/k/v1/preview/app/adminNotes.json';
var xhr = new XMLHttpRequest();
xhr.open('PUT', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.onload = function() {
  if (xhr.status === 200) {
    // success
    console.log(JSON.parse(xhr.responseText));
  } else {
    // error
    console.log(JSON.parse(xhr.responseText));
  }
};
xhr.send(JSON.stringify(body));

Parámetros de respuesta

Nombre de la propiedad	Tipo	Descripción
revision	Cuerda	El número de revisión después de cambiar la configuración de la aplicación.

Ejemplo de respuesta

1
2
3


{
  "revision": "2"
}