Obtener vistas

Obtiene la configuración de vista de una aplicación.

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

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

Permisos

  • Se necesita permiso para ver registros o agregar registros al obtener información de aplicaciones activas.
  • Los permisos de administración de aplicaciones son necesarios para obtener información de la configuración previa a la transmisión.

Parámetros de solicitud

Parámetro Tipo Obligatorio Descripción
app Integer El ID de la aplicación
lang String El idioma localizado en el que se recuperarán los datos:
  • default: recupera los nombres predeterminados
  • en: recupera los nombres localizados en inglés
  • zh: recupera los nombres chinos localizados
  • ja: recupera los nombres japoneses localizados
  • user: recupera los nombres localizados en el mismo idioma que la configuración de idioma establecida en el usuario utilizado para la autenticación.
Si se ignora, se recuperarán los nombres predeterminados.

Si la configuración de idioma del usuario se establece en Usar la configuración del navegador web, se utilizará la configuración establecida en el encabezado Accept-Language. Si no hay ningún encabezado Accept-Language, el idioma establecido en el Localización en el menú del administrador del sistema.

Solicitud de muestra

JavaScript using kintone.api()

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

kintone.api(kintone.api.url('/k/v1/app/views.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
var url = 'https://{subdomain}.kintone.com/k/v1/app/views.json?app=1&lang=en';
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
revision String El número de revisión de la configuración de la aplicación.
views Object Una lista de objetos Ver información.
views.{viewname}.builtinType String El tipo de vista integrada.
  • ASSIGNEE: La vista "Asignado a mí".
    Esta lista se crea automáticamente si la configuración de Gestión de procesos se ha habilitado en la aplicación.
Actualmente, no hay otros tipos de vistas integradas.
views.{viewname}.date String El código de campo establecido para el campo de fecha.
Respondido para las vistas de calendario.
views.{viewname}.fields Array La lista de códigos de campo para los campos que se muestran en la vista.
Respondido para vistas de lista.
views.{viewname}.filterCond String La condición de filtro como una consulta.
Para obtener más información sobre los formatos de consulta, consulte el siguiente documento:
Cadena de consulta
views.{viewname}.html String El código HTML establecido para la vista.
Respondido para vistas personalizadas.
views.{viewname}.id String El ID de vista.
views.{viewname}.index String El orden de visualización (ascendente) de la vista, cuando aparece con otras vistas.
views.{viewname}.name String El nombre de la vista.
views.{viewname}.pager Boolean La configuración de paginación.
Respondido para vistas personalizadas.
  • true: Habilitado
  • false: Deshabilitado
views.{viewname}.device String Ámbito del lugar en el que se muestra la vista.
  • DESKTOP: Mostrar solo en el escritorio
  • ANY: Visualización tanto en computadoras de escritorio como en dispositivos móviles
views.{viewname}.sort String El criterio de ordenación como una consulta.
Para obtener más información sobre los formatos de consulta, consulte el siguiente documento:
Cadena de consulta
views.{viewname}.title String El código de campo establecido para el campo de título.
Respondido para las vistas de calendario.
views.{viewname}.type String El tipo de View.
  • LISTA: Vista de lista
  • CALENDARIO: Vista de calendario
  • PERSONALIZADA: Vista personalizada

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
41
42
43
44
45
46
47
48
49
50
51
52
{
  "views": {
    "View1": {
      "type": "LIST",
      "name": "View1",
      "id": "20733",
      "filterCond": "Date_2 > LAST_WEEK()",
      "sort": "Record_number asc",
      "index": "1",
      "fields": ["Record_number", "Author"]
    },
    "Calendar View1": {
      "type": "CALENDAR",
      "name": "Calendar View1",
      "id": "20735",
      "filterCond": "",
      "sort": "Record_number asc",
      "index": "2",
      "date": "Updated_datetime",
      "title": "Rich_text"
    },
    "Custom View1": {
      "type": "CUSTOM",
      "name": "Custom View1",
      "id": "20736",
      "filterCond": "Updated_datetime >= LAST_WEEK() and Updated_datetime <= TODAY()",
      "sort": "Updated_datetime desc",
      "index": "3",
      "html": "<div>Custom View HTML</div>",
      "pager": true
    },
    "(Assigned to me)": {
      "type": "LIST",
      "name": "(Assigned to me)",
      "id": "9668",
      "filterCond": "Assignee in (LOGINUSER())",
      "sort": "Date asc",
      "index": "0",
      "fields": [
        "Date",
        "Single_line_text",
        "Drop_down",
        "Single_line_text_2",
        "Total_Expenses",
        "Attachment",
        "Itemized_Expenses"
      ],
      "builtinType": "ASSIGNEE"
    }
  },
  "revision": "19"
}

Limitaciones

Esta API no se puede usar para recuperar la configuración de la vista si hay varias vistas con el mismo nombre.