Obtener aplicaciones

Documentos de API

Obtener aplicaciones

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

Método	GET
URL	https://{subdomain}.kintone.com/k/v1/apps.json
URL (espacio de invitado)	https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/apps.json
Autenticación	Autenticación de contraseña , Autenticación de sesión
Content-Type	application/json (no es necesario si se especifica la consulta con una cadena de consulta)

Permisos

Se necesita permiso para ver registros o agregar registros.
Los tokens de API no se pueden usar con esta API.

Parámetros de solicitud

Parámetro	Tipo	Valor dentro de la matriz	Descripción
ids	Arreglo	Integer	Los identificadores de la aplicación. Se pueden especificar hasta 100 identificadores.
codes	Arreglo	Cuerda	El código de la aplicación. Se pueden especificar hasta 100 códigos de aplicación. Cada código de aplicación debe tener entre 1 y 64 caracteres. Se utilizará una búsqueda de coincidencia exacta y distinguirá entre mayúsculas y minúsculas.
name	Cuerda		El nombre de la aplicación. Se usará una búsqueda parcial y la búsqueda no distinguirá entre mayúsculas y minúsculas. El nombre localizado de la aplicación en la configuración regional del usuario también se incluirá en la búsqueda.
spaceIds	Arreglo	Integer	El ID de espacio en el que reside la aplicación. Se pueden especificar hasta 100 identificadores.
limit	Integer		El número de aplicaciones que se van a recuperar. Debe estar entre 1 y 100. Si no se especifica nada, el valor predeterminado será 100.
offset	Integer		El número de recuperaciones que se omitirán. Debe estar entre 0 y 2147483647. Si no se especifica nada, el valor predeterminado será 0.

Solicitud de muestra

JavaScript using kintone.api()

1
2
3
4
5
6
7


kintone.api(kintone.api.url('/k/v1/apps.json', true), 'GET', {}, 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/apps.json';
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
apps	Matriz de objetos	Matriz de objetos que contienen información general de las aplicaciones.
apps[].appId	Cuerda	El identificador de la aplicación.
apps[].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.
apps[].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.
apps[].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.
apps[].spaceId	Cuerda	Si la aplicación se creó dentro de un espacio, devolverá el ID del espacio. Si no es así, se devuelve null.
apps[].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.
apps[].createdAt	Cuerda	La fecha de creación de la aplicación.
apps[].creator	Objeto	La información del usuario que creó la App.
apps[].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.
apps[].creator.name	Cuerda	El nombre para mostrar del creador. Se devuelve una cadena vacía para los usuarios inactivos y los usuarios eliminados.
apps[].modifiedAt	Cuerda	La fecha de la última modificación de la aplicación.
apps[].modifier	Objeto	La información del usuario que actualizó por última vez la App.
apps[].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.
apps[].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
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40


{
  "apps": [
    {
      "appId": "1",
      "code": "task",
      "name": "My Test App",
      "description": "Testing this app",
      "spaceId": null,
      "threadId": null,
      "createdAt": "2014-06-02T05:14:05.000Z",
      "creator": {
        "code": "user1",
        "name": "user1"
      },
      "modifiedAt": "2014-06-02T05:14:05.000Z",
      "modifier": {
        "code": "user1",
        "name": "user1"
      }
    },
    {
      "appId": "2",
      "code": "IDEA",
      "name": "test app for ideas",
      "description": "",
      "spaceId": "3",
      "threadId": "4",
      "createdAt": "2014-06-03T05:14:05.000Z",
      "creator": {
        "code": "user2",
        "name": "user2"
      },
      "modifiedAt": "2014-06-03T05:14:05.000Z",
      "modifier": {
        "code": "user2",
        "name": "user2"
      }
    }
  ]
}