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"
Método | GET |
---|---|
URL | https://{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-Type | application/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 | Sí | El identificador de la aplicación. |
lang | Cuerda | El idioma localizado en el que se recuperarán los datos:
|
* 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
|
|
XMLHttpRequest
|
|
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
|
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
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".
|
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".
|
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.
|
reports.{graphname}.sorts[].order | Cuerda | El orden de clasificación.
|
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? 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".
|
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.
|
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.
|
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.
|
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
|
|
Limitaciones
Si varios gráficos tienen el mismo nombre dentro de la misma aplicación, esta API devolverá un error.