Documentos de API

Obtener aplicación

Obtiene información general de una aplicación, incluido el nombre, la descripción, el espacio relacionado, el creador y la información del actualizador.

MétodoGET
URLhttps://{subdomain}.kintone.com/k/v1/app.json
URL (espacio de invitado)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/app.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

  • Se necesita permiso para ver registros o agregar registros.

Parámetros de solicitud

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

Solicitud de muestra

JavaScript using kintone.api() 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

var body = {
  'id': 1
};
kintone.api(kintone.api.url('/k/v1/app.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
16

var params = '?id=1';
var url = 'https://{subdomain}.kintone.com/k/v1/app.json' + params;
console.log(url);
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
appId Cuerda El identificador de la aplicación.
code Cuerda El código de la aplicación.
Se devuelve una cadena vacía si no se establece un código de aplicación en la configuración de la aplicación.
name Cuerda El nombre de la aplicación.
Si la configuración de localización está habilitada, se devolverá el nombre localizado. El idioma de localización dependerá de la configuración de idioma del usuario de Kintone que autentique esta API.
description Cuerda La descripción de la aplicación.
Si la configuración de localización está habilitada, se devolverá el nombre localizado. El idioma de localización dependerá de la configuración de idioma del usuario de Kintone que autentique esta API.
spaceId Cuerda Si la aplicación se creó dentro de un espacio, devolverá el ID del espacio. Si no es así, se devuelve null.
threadId Cuerda Si la aplicación se creó dentro de un espacio, devolverá el ID de hilo del hilo del espacio al que pertenece.
Las aplicaciones que se crean dentro de Spaces mediante la interfaz gráfica de usuario se asignarán automáticamente al Thread predeterminado.
Si la aplicación no se creó en un espacio, se devuelve null.
createdAt Cuerda La fecha de creación de la aplicación.
creator Objeto La información del usuario que creó la App.
creator.code Cuerda El nombre de inicio de sesión del creador.
Se devuelve una cadena vacía para los usuarios inactivos y los usuarios eliminados.
creator.name Cuerda El nombre para mostrar del creador.
Se devuelve una cadena vacía para los usuarios inactivos y los usuarios eliminados.
modifiedAt Cuerda La fecha de la última modificación de la aplicación.
modifier Objeto La información del usuario que actualizó por última vez la App.
modifier.code Cuerda El nombre de inicio de sesión del último actualizador.
Se devuelve una cadena vacía para los usuarios inactivos y los usuarios eliminados.
modifier.name Cuerda El nombre para mostrar del último actualizador.
Se devuelve una cadena vacía para los usuarios inactivos y los usuarios eliminados.

Ejemplo de respuesta 

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

{
  "appId": "1",
  "code": "",
  "name": "ToDo App",
  "description": "This is a great app!",
  "spaceId": "2",
  "threadId": "3",
  "createdAt": "2015-03-06T02:24:03.000Z",
  "creator": {
    "code": "user1",
    "name": "User1"
  },
  "modifiedAt": "2015-03-06T03:06:57.000Z",
  "modifier": {
    "code": "login-name",
    "name": "Display Name"
  }
}