Actualizar vistas

Documentos de API

Actualizar vistas

Actualiza la configuración de visualización de una aplicación.

Esta API actualiza la configuración previa a la puesta en marcha.
Después de usar esta API, use la siguiente API para implementar la configuración en la aplicación activa:
Implementar la configuración de la aplicación

Método	PUT
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
Autenticación	Autenticación de contraseña, Autenticación de token de API, Autenticación de sesión
Content-Type	application/json

Permisos

Vista de lista/calendario:

Se necesitan permisos de administración de aplicaciones.

Personalizar vista:

Se necesitan permisos de administrador de Kintone.
Los tokens de API no se pueden usar con esta API.

Parámetros de solicitud

Esta API reemplazará todas las vistas actuales por las vistas enumeradas en la solicitud.
Se eliminarán los nombres de vista que no se indiquen en la solicitud.

Parámetro	Valor	Obligatorio	Descripción
app	Integer	Sí	El identificador de la aplicación.
views	Objeto	Sí	Objeto de datos de Views.
views.{viewname}	Objeto	Sí	El nombre de la vista a la que se van a agregar cambios. Si se especifica un nombre de vista que existe, se creará una nueva vista con este nombre.
views.{viewname}.index	Cuerda	Sí	El orden de visualización de la vista, en la lista de vistas, especificado con un número. La lista de vistas se mostrará en orden ascendente.
views.{viewname}.type	Cuerda	Sí	El tipo de View. LIST: Vista de lista CALENDAR: Vista de calendario CUSTOM: Vista personalizada
views.{viewname}.name	Cuerda	Condicional	El nombre de la vista. El límite máximo de caracteres es de 64. Obligatorio, si views. {viewname} es una nueva vista. En este caso, especifique el mismo nombre de vista nuevo para este parámetro.
views.{viewname}.fields	Arreglo	Condicional	Se utiliza para las vistas de lista. La lista de campos que se mostrarán en la lista. Especifique los campos por sus códigos de campo. Este parámetro es obligatorio si se agrega una nueva vista de lista.
views.{viewname}.date	Cuerda		Se utiliza para las vistas de calendario. El campo que se utilizará como "Campo de fecha" de la vista de calendario. Especifique un campo de tipo de fecha por su código de campo. Si se ignora, se establecerá el campo Fecha y hora creada.
views.{viewname}.title	Cuerda		Se utiliza para las vistas de calendario. El campo que se utilizará como "Campo de título" de la vista de calendario. Especifique un campo de tipo de texto por su código de campo. Si se ignora, se establecerá el campo Número de registro.
views.{viewname}.html	Cuerda		Se utiliza para vistas personalizadas. El código HTML que se va a establecer para la vista personalizada.
views.{viewname}.pager	Booleano		La configuración de paginación. Especifique una de las siguientes opciones: `true`: Habilitar (predeterminado) `false`: Inutilizar
views.{viewname}.device	Cuerda		Ámbito del lugar en el que se muestra la vista. Si no se especifica este parámetro, el valor predeterminado es DESKTOP. Si la configuración de la vista se actualiza sin especificar este parámetro, este parámetro no cambia. DESKTOP: Mostrar solo en el escritorio ANY: Visualización tanto en computadoras de escritorio como en dispositivos móviles
views.{viewname}.filterCond	Cuerda		La condición de filtro en un formato de consulta. Para obtener más datos sobre los formatos de consulta, consulte el siguiente documento: Cadena de consulta
views.{viewname}.sort	Cuerda		El criterio de ordenación en un formato de consulta. Para obtener más datos sobre los formatos de consulta, consulte el siguiente documento: Cadena de consulta
revision	Integer		Especifique el número de revisión de la configuración que se implementará. Se producirá un error en la solicitud si el número de revisión no es la última revisión. 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
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


// Adding new views: "My List View", "My Calendar View"
// Updating existing views: "My Custom View", "(Assigned to me)"
// Any other views not mentioned will be deleted

var body = {
  'app': 1,
  'views': {
    'My List View': {
      'index': 0,
      'type': 'LIST',
      'name': 'My List View',
      'fields': [
        'Record_number',
        'Text_single_line'
      ],
      'filterCond': 'Updated_datetime > LAST_WEEK()',
      'sort': 'Record_number asc'
    },
    'My Calendar View': {
      'index': 1,
      'type': 'CALENDAR',
      'name': 'My Calendar View',
      'date': 'Updated_datetime',
      'title': 'Rich_text',
      'filterCond': '',
      'sort': 'Record_number asc'
    },
    'My Custom View': {
      'index': 2,
      'type': 'CUSTOM',
      'html': '<div>Custom View HTML</div>',
      'filterCond': 'Updated_datetime >= LAST_WEEK() and Updated_datetime <= TODAY()',
      'sort': 'Record_number asc'
    },
    '(Assigned to me)': {
      'index': 3,
      'type': 'LIST'
    }
  }
};

kintone.api(kintone.api.url('/k/v1/preview/app/views.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
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
53
54
55
56
57
58


// Adding new views: "My List View", "My Calendar View"
// Updating existing views: "My Custom View", "(Assigned to me)"
// Any other views not mentioned will be deleted

var url = 'https://{subdomain}.kintone.com/k/v1/preview/app/views.json';
var body = {
  'app': 1,
  'views': {
    'My List View': {
      'index': 0,
      'type': 'LIST',
      'name': 'My List View',
      'fields': [
        'Record_number',
        'Text_single_line'
      ],
      'filterCond': 'Updated_datetime > LAST_WEEK()',
      'sort': 'Record_number asc'
    },
    'My Calendar View': {
      'index': 1,
      'type': 'CALENDAR',
      'name': 'My Calendar View',
      'date': 'Updated_datetime',
      'title': 'Rich_text',
      'filterCond': '',
      'sort': 'Record_number asc'
    },
    'My Custom View': {
      'index': 2,
      'type': 'CUSTOM',
      'html': '<div>Custom View HTML</div>',
      'filterCond': 'Updated_datetime >= LAST_WEEK() and Updated_datetime <= TODAY()',
      'sort': 'Record_number asc'
    },
    '(Assigned to me)': {
      'index': 3,
      'type': 'LIST'
    }
  },
  // CSRF TOKEN: used for all APIs that have an HTTP method of POST, PUT and DELETE on Kintone.
  '__REQUEST_TOKEN__': kintone.getRequestToken()
};

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

Parámetro	Tipo	Descripción
revision	Cuerda	El número de revisión de la configuración de la aplicación.
views	Objeto	Objeto que contiene datos de las vistas.
views.{viewname}.id	Cuerda	El ID de vista.

Ejemplo de respuesta

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


{
  "views": {
    "Calendar View1": {
      "id": "1320"
    },
    "View1": {
      "id": "1321"
    },
    "Custom View1": {
      "id": "1322"
    }
  },
  "revision": 2
}

Limitaciones

Esta API no se puede usar para actualizar la configuración de la vista si hay varias vistas con el mismo nombre.
Si la aplicación de destino contiene vistas personalizadas, esta API no puede actualizar las vistas si se autentica con tokens de API, ya que se necesitan permisos de administración de Kintone para actualizar esta configuración. Para obtener más información, consulte la siguiente sección del artículo:
Administrador de Kintone