Obtener notas del administrador de la aplicación

Obtener notas del administrador de la aplicación

Obtiene notas para los administradores de aplicaciones y su configuración.

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

Contenido

Ajustes previos a la transmisión en vivo

Es posible que las aplicaciones contengan configuraciones previas a la transmisión en vivo que aún no se hayan implementado en la aplicación en vivo.
Acceda a la configuración previa a la transmisión en vivo con la siguiente URL.

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

Permisos

  • Se necesitan permisos de administración de aplicaciones.

Parámetros de solicitud

Parámetro Valor Obligatorio Descripción
app Entero o cadena El identificador de la aplicación.

Solicitud de muestra

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
var body = {
  'app': 1
};

kintone.api(kintone.api.url('/k/v1/app/adminNotes.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
var url = 'https://{subdomain}.kintone.com/k/v1/app/adminNotes.json?app=1';

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
content Cuerda El contenido de las notas. Si no se establece, se devuelve una cadena vacía.
includeInTemplateAndDuplicates Booleano La configuración de permisos para incluir esta nota en plantillas de aplicación o duplicados
  • true:incluír
  • false: no incluir
revision Cuerda El número de revisión de la configuración de la aplicación.

Ejemplo de respuesta

1
2
3
4
5
{
    "content": "Notes for app administrators",
    "includeInTemplateAndDuplicates": true,
    "revision": "2"
}