Obtener la configuración del gráfico

Obtiene la configuración de Graph de la aplicación.
Para obtener más información, consulte el siguiente artículo:
Creación de gráficos en la pantalla "Configuración de la aplicación" (External link)

MétodoGET
URLhttps://{subdomain}.kintone.com/k/v1/app/reports.json
URL (espacio de invitado)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/app/reports.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 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/reports.json
URL (espacio de invitado) https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/reports.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.
lang Cuerda 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* 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 un encabezado Accept-Language, se utilizará el idioma establecido en la configuración de "Localización" en el menú del administrador del sistema.

Solicitud de muestra

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

kintone.api(kintone.api.url('/k/v1/app/reports.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 appId = kintone.app.getId();
var url = 'https://{subdomain}.kintone.com/k/v1/app/reports.json?app=' + appId + '&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
reports Objeto Objeto de los datos de configuración de Graph.
La clave del objeto es el identificador único del grafo, que se establece como el nombre del grafo en su configuración de idioma predeterminada (esto es independientemente de la lang valor del parámetro de solicitud).
Los valores de la clave son las distintas configuraciones de gráfico asociadas a ese gráfico.
reports.{graphname}.chartType Cuerda El tipo de gráfico del gráfico. Para obtener más información, consulte el siguiente artículo:
Tipos de gráficos y su uso (External link)
  • BAR: Gráfico de barras
  • COLUMN: Gráfico de columnas
  • PIE: Gráfico circular
  • LINE: Gráfico de líneas
  • PIVOT_TABLE: Tabla dinámica
  • TABLE: Mesa
  • AREA: Gráfico de áreas
  • SPLINE: Gráfico de splines
  • SPLINE_AREA: Gráfico de área spline
reports.{graphname}.chartMode Cuerda El modo de visualización del gráfico. Para obtener más información, consulte el siguiente artículo:
Tipos de gráficos y su uso (External link)
  • NORMAL: Gráfico agrupado o gráfico no apilado
  • STACKED: Gráfico apilado
  • PERCENTAGE: Gráfico 100% apilado
Si el reports.{graphname}.chartType se establece en BAR o COLUMNentonces NORMAL se refiere al modo de visualización "Gráfico agrupado".

Si el reports.{graphname}..chartType se establece en AREA o SPLINE_AREAentonces NORMAL se refiere al modo de visualización "Gráfico no apilado".

Este parámetro solo se devuelve si el parámetro reports.{graphname}..chartType se establece en BAR, COLUMN, AREAo SPLINE_AREA.
reports.{graphname}.id Cuerda El identificador del gráfico.
reports.{graphname}.name Cuerda El nombre del gráfico.
El límite máximo es de 64 caracteres.
Cuando el lang request, se devolverá el nombre del gráfico en ese idioma.
reports.{graphname}.index Cuerda El orden de los gráficos, a partir de 0.
reports.{graphname}.groups Arreglo Matriz de objetos que contiene las opciones "Agrupar por".
El orden de los objetos está en el orden de "Nivel 1", "Nivel 2" y "Nivel 3".
Los niveles que no estén establecidos no se incluirán en la matriz.

Este parámetro solo se devuelve si la opción "Agrupar por" está configurada.
reports.{graphname}.groups[].code Cuerda El código de campo del campo utilizado para determinar la opción "Agrupar por".
reports.{graphname}.groups[].per Cuerda La unidad de tiempo utilizada para la opción "Agrupar por".
  • YEAR: por año
  • QUARTER: por trimestre
  • MONTH: por mes
  • WEEK: por semana
  • DAY: por el día
  • HOUR: por hora
  • MINUTE: por minuto
Este parámetro se devuelve si se especifica uno de los siguientes campos en reports. {graphname}.groups[].code:
  • Fecha y hora creada
  • Fecha y hora actualizada
  • Fecha y hora
  • Fecha (Solo YEAR, QUARTER, MONTH, WEEKo DAY)
  • Tiempo (Solo HOUR o MINUTE)
Si no se especificó ninguna unidad (es decir, se dejó como "--"), se devolverá la unidad de tiempo mínima:
  • Para los campos DateTime u Time: MINUTE
  • Para los campos de fecha: DAY
reports.{graphname}.aggregations Arreglo Una matriz de objetos que contiene las opciones de "Función".
reports.{graphname}.aggregations[].type Cuerda El tipo de la opción "Función".
  • COUNT: Número de registros
  • SUM: Total
  • AVERAGE: Promedio
  • MAX: Máximo
  • MIN: Mínimo
reports.{graphname}.aggregations[].code Cuerda El código de campo del campo utilizado en la opción "Función".

Este parámetro no se devuelve si el parámetro reports. {graphname}.aggregations[].type se establece en COUNT.
reports.{graphname}.filterCond Cuerda La condición de filtro del registro en formato de cadena de consulta que refleja la opción "Filtro".
Para obtener más datos sobre los formatos de consulta, consulte el siguiente documento:
Cadena de consulta

Se producirá un error en la solicitud si se especifica un usuario, grupo u organización eliminados en la condición de filtro.
reports.{graphname}.sorts Arreglo Matriz de objetos que contiene las opciones "Ordenar por".
reports.{graphname}.sorts[].by Cuerda Cómo se ordena el gráfico.
  • TOTAL: Total
  • GROUP1: Nivel 1
  • GROUP2: Nivel 2
  • GROUP3: Nivel 3
reports.{graphname}.sorts[].order Cuerda El orden de clasificación.
  • ASC: Orden ascendente
  • DESC: Orden descendente
reports.{graphname}.periodicReport Objeto Objetos que contienen las opciones de Informes periódicos. Para obtener más información, consulte el siguiente artículo:
¿Qué son los informes periódicos? (External link)
Si la opción "Generar informes periódicamente" nunca se ha configurado, se devolverá null.
reports.{graphname}.periodicReport.active Booleano El estado de activación de la opción "Informes periódicos".
  • true: Activo
  • false: Inactivo
reports.{graphname}.periodicReport.period Objeto Un objeto que contiene las opciones "Período".
reports.{graphname}.periodicReport.period.every Cuerda El tipo de intervalo de tiempo utilizado para determinar cuándo generar los informes periódicos.
  • YEAR: por año
  • QUARTER: por trimestre
  • MONTH: por mes
  • WEEK: por semana
  • DAY: por el día
  • HOUR: por hora
reports.{graphname}.periodicReport.period.month Cuerda El mes en el que se generará el Informe Periódico.
El mes se devuelve como un número entero, que va del 1 (enero) al 12 (diciembre).

Este parámetro solo se devuelve si el parámetro reports. {graphname}.periodicReport.period.every se establece en YEAR.
reports.{graphname}.periodicReport.period.time Cuerda La hora en la que se generará el Informe Periódico.
Formato: HH:MM

Este parámetro solo se devuelve si el parámetro reports. {graphname}.periodicReport.period.every se establece en YEAR, QUARTER, MONTH, WEEKo DAY.
reports.{graphname}.periodicReport.period.pattern Cuerda Los meses en los que se generará el Informe Periódico trimestral.
  • JAN_APR_JUL_OCT: Enero, Abril, Julio, Octubre
  • FEB_MAY_AUG_NOV: Febrero, Mayo, Agosto, Noviembre
  • MAR_JUN_SEP_DEC: Marzo, Junio, Septiembre, Diciembre
Este parámetro solo se devuelve si el parámetro reports. {graphname}.periodicReport.period.every se establece en QUARTER.
reports.{graphname}.periodicReport.period.dayOfMonth Cuerda El día en que se generará el Informe Periódico.
El día se devuelve como un número entero, que va de 1 a 31, o se establece como "END_OF_MONTH"*.
*Solo para gráficos en los que el reports. {graphname}.periodicReport.period.every se establece en QUARTER o MONTH.

Este parámetro solo se devuelve si el parámetro reports. {graphname}.periodicReport.period.every se establece en YEAR, QUARTERo MONTH.
reports.{graphname}.periodicReport.period.dayOfWeek Cuerda El día de la semana en que se generará el Informe Periódico.
  • SUNDAY
  • MONDAY
  • TUESDAY
  • WEDNESDAY
  • THURSDAY
  • FRIDAY
  • SATURDAY
Este parámetro solo se devuelve si el parámetro reports. {graphname}.periodicReport.period.every se establece en WEEK.
reports.{graphname}.periodicReport.period.minute Cuerda El minuto en el que se generará el Informe Periódico por hora.
El minuto se devolverá como "0", "10", "20", "30", "40" o "50".

Este parámetro solo se devuelve si el parámetro reports. {graphname}.periodicReport.period.every se establece en HOUR.
revision Cuerda El número de revisión de la configuración de la aplicación.

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
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
{
  "reports": {
    "Graph1 (Default Settings)": {
      "id": "7319",
      "chartType": "BAR",
      "chartMode": "NORMAL",
      "name": "Graph1 (Default Settings)",
      "index": "0",
      "groups": [
        {
          "code": "Created_by"
        }
      ],
      "aggregations": [
        {
          "type": "COUNT"
        }
      ],
      "filterCond": "",
      "sorts": [
        {
          "by": "TOTAL",
          "order": "DESC"
        }
      ],
      "periodicReport": null
    },
    "Graph2 (Table)": {
      "id": "7321",
      "chartType": "TABLE",
      "name": "Graph2 (Table)",
      "index": "1",
      "groups": [
        {
          "code": "Radio_button"
        },
        {
          "code": "Created_datetime",
          "per": "YEAR"
        },
        {
          "code": "Time",
          "per": "MINUTE"
        }
      ],
      "aggregations": [
        {
          "type": "COUNT"
        },
        {
          "type": "SUM",
          "code": "Number"
        },
        {
          "type": "AVERAGE",
          "code": "Calculated"
        },
        {
          "type": "MAX",
          "code": "Created_datetime"
        },
        {
          "type": "MIN",
          "code": "Time"
        }
      ],
      "filterCond": "Record_number = \"1\" and Rich_text like \"aaa\"",
      "sorts": [
        {
          "by": "TOTAL",
          "order": "DESC"
        },
        {
          "by": "GROUP1",
          "order": "ASC"
        },
        {
          "by": "GROUP2",
          "order": "DESC"
        }
      ],
      "periodicReport": null
    },
    "Graph3 (Periodic report ON)": {
      "id": "7323",
      "chartType": "BAR",
      "chartMode": "NORMAL",
      "name": "Graph3 (Periodic report ON)",
      "index": "2",
      "groups": [
        {
          "code": "Radio_button"
        }
      ],
      "aggregations": [
        {
          "type": "COUNT"
        }
      ],
      "filterCond": "",
      "sorts": [
        {
          "by": "TOTAL",
          "order": "DESC"
        }
      ],
      "periodicReport": {
        "active": true,
        "period": {
          "every": "QUARTER",
          "pattern": "JAN_APR_JUL_OCT",
          "dayOfMonth": "END_OF_MONTH",
          "time": "23:30"
        }
      }
    }
  },
  "revision": "77"
}

Limitaciones

Si varios gráficos tienen el mismo nombre dentro de la misma aplicación, esta API devolverá un error.