Actualizar la configuración de Graph
Actualiza la configuración de Graph de la aplicación. Para obtener más información, consulte el siguiente artículo:
Configuración/eliminación de gráficos
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/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 |
Contenido
Permisos
- Se necesitan permisos de administración de aplicaciones.
Parámetros de solicitud
Parámetro | Tipo | Obligatorio | Descripción |
---|---|---|---|
app | Entero o cadena | Sí | El identificador de la aplicación. |
reports | Objeto | Sí | Un objeto que enumera la información del gráfico. La clave del objeto es el identificador único del gráfico, que es igual al nombre del gráfico en su configuración de idioma predeterminada. Los valores de la clave son las distintas configuraciones de gráfico asociadas a ese gráfico. |
reports.{graphname} | Objeto | Un objeto que enumera la información del gráfico de 1 gráfico. Si Nombre del gráfico es igual al nombre de un gráfico existente, el gráfico se actualizará con los valores del objeto. Si Nombre del gráfico no es igual a un nombre de un gráfico existente, se creará un nuevo gráfico con los valores del objeto. Se eliminarán todos los gráficos existentes que no estén configurados para este parámetro. |
|
reports.{graphname}.chartType | Cuerda | Condicional | 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 | Condicional | 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_AREA, NORMAL se refiere al modo de visualización "Gráfico no apilado". Requerido cuando el reports. {nombregráfico}.chartType se establece en BAR, COLUMN, AREAo SPLINE_AREA. |
reports.{graphname}.name | Cuerda | Condicional | El nombre del gráfico. Se pueden especificar de 1 a 64 caracteres. Al agregar un nuevo gráfico, se producirá un error en la solicitud si el valor de este parámetro no es el mismo que reports.{graphname}. Obligatorio al agregar un nuevo gráfico. |
reports.{graphname}.index | Entero o cadena | Condicional | El orden de los gráficos. El gráfico se ordena en orden ascendente, empezando por 0. Se producirá un error en la solicitud si hay valores duplicados. Obligatorio al actualizar un gráfico existente o al crear uno nuevo. |
reports.{graphname}.groups | Arreglo | Condicional | 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". Se producirá un error en la solicitud si el reports.{graphname}.chartType se establece en PIVOT_TABLE y reports. {graphname}.groups tiene menos de un objeto. Obligatorio al agregar un nuevo gráfico. |
reports.{graphname}.groups[].code | Cuerda | Condicional | El código de campo del campo utilizado para determinar la opción "Agrupar por". Obligatorio al especificar el parámetro reports. {graphname}.groups parámetro. |
reports.{graphname}.groups[].per | Cuerda | Condicional | La unidad de tiempo utilizada para la opción "Agrupar por".
|
reports.{graphname}.aggregations | Arreglo | Condicional | Una matriz de objetos que contiene las opciones de "Función". El límite máximo es de 10 elementos en la matriz. Si el reports.{graphname}.chartType se establece en PIVOT_TABLE, solo se puede establecer 1 elemento en la matriz. Obligatorio al agregar un nuevo gráfico. |
reports.{graphname}.aggregations[].type | Cuerda | Condicional | El tipo de la opción "Función".
|
reports.{graphname}.aggregations[].code | Cuerda | Condicional | El código de campo del campo que se utilizará en la opción "Función". Elementos con tipo Establézcalo en SUM o AVERAGE puede especificar los siguientes campos:
|
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 información sobre los formatos de consulta, consulte el siguiente documento: Cadena de consulta Si se omite este parámetro para un nuevo gráfico, es el mismo que cuando se especifica "Todos los registros". Si se ignora este parámetro para un gráfico existente, la configuración del filtro no se cambiará. 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 | Condicional | Matriz de objetos que contiene las opciones "Ordenar por". El límite máximo es de 3 elementos en la matriz. Obligatorio al agregar un nuevo gráfico. |
reports.{graphname}.sorts[].by | Cuerda | Condicional | Cómo se ordena el gráfico.
|
reports.{graphname}.sorts[].order | Cuerda | Condicional | El orden de clasificación.
|
reports.{graphname}.periodicReport | Objeto | Un objeto que contiene las opciones de "Informes periódicos". Si la opción "Informes periódicos" está activa, no se puede actualizar la configuración del gráfico, excepto lo siguiente:
|
|
reports.{graphname}.periodicReport.active | Booleano o cadena | El estado de activación de la opción "Informes periódicos".
Si este parámetro se ignora al actualizar un informe periódico existente, este valor no se actualiza. |
|
reports.{graphname}.periodicReport.period | Objeto | Condicional | Un objeto que contiene las opciones "Período". Al actualizar el informe periódico, ignore este parámetro o manténgalo igual. De lo contrario, se devolverá un error. Obligatorio al agregar un nuevo gráfico. |
reports.{graphname}.periodicReport.period.every | Cuerda | Condicional | El tipo de intervalo de tiempo utilizado para determinar cuándo generar los informes periódicos.
|
reports.{graphname}.periodicReport.period.month | Entero o cadena | Condicional | El mes en el que se generará el Informe Periódico. Especifique el mes como un número entero, comprendido entre 1 (enero) y 12 (diciembre). Requerido cuando el reports. {graphname}.periodicReport.period.every se establece en YEAR. |
reports.{graphname}.periodicReport.period.time | Cuerda | Condicional | La hora en la que se generará el Informe Periódico. Introduzca la hora en HH:MM formato. Requerido cuando el reports. {graphname}.periodicReport.period.every se establece en YEAR, QUARTER, MONTH, WEEKo DAY. |
reports.{graphname}.periodicReport.period.pattern | Cuerda | Condicional | Los meses en los que se generará el Informe Periódico trimestral.
|
reports.{graphname}.periodicReport.period.dayOfMonth | Cuerda | Condicional | El día en que se generará el Informe Periódico.
Requerido cuando el reports. {graphname}.periodicReport.period.every se establece en YEAR, QUARTERo MONTH. |
reports.{graphname}.periodicReport.period.dayOfWeek | Cuerda | Condicional | El día de la semana en que se generará el Informe Periódico.
|
reports.{graphname}.periodicReport.period.minute | Entero o cadena | Condicional | El minuto en el que se generará el Informe Periódico por hora. Establézcalo como "0", "10", "20", "30", "40" o "50". Requerido cuando el reports. {graphname}.periodicReport.period.every se establece en HOUR. |
revision | Entero o cadena | 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 se especifica -1. |
Solicitud de muestra
|
|
XMLHttpRequest
|
|
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. |
reports | Objeto | Un objeto que enumera la información del gráfico. |
reports.{graphname}.id | Cuerda | El identificador del gráfico. |
Ejemplo de respuesta
|
|
Limitaciones
Si varios gráficos tienen (o darán como resultado tener) el mismo nombre dentro de la misma aplicación, esta API devolverá un error.