Para automatizar tareas dentro de la plataforma Workiva como parte de una cadena, por ejemplo, para permitir el intercambio de datos con otras fuentes de datos, agrega un paso que incluya un comando de conexión a Workiva.
Para habilitar estos comandos, un administrador de TI primero configura un conector de Workiva.
Borrar datos de una hoja
Para borrar todos los datos de una hoja, utiliza el comando Borrar datos de hoja.
Llamada a la API equivalente: https://developers.workiva.com/2022-01-01/updatelegacyspreadsheetdataasync.html
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de hoja de cálculo | Ingresa el identificador único de la hoja de cálculo con la hoja que quieres borrar. |
| ID/nombre de la hoja | Ingresa el nombre o identificador único de la hoja que quieres borrar. |
Resultados
Ninguno
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Crear archivo
Para cargar un archivo de valores separados por comas (CSV), Javascript object notation (JSON) o ZIP comprimido y hacer una lista de sus registros, utiliza el comando Crear archivo. También puedes cargar la URL al archivo, como una URL firmada por Amazon S3® a un archivo en un cubo S3.
- Si es un archivo JSON, debe tener un único registro JSON por línea: un archivo JSON es una serie de objetos JSON delimitados por un carácter de nueva línea.
- Si es un archivo ZIP, debe contener un único archivo CSV o JSON, cuyo nombre se utiliza para nombrar el archivo importado. Al volver a descargar el archivo, se descarga el origen.
- Si se trata de una URL, el punto final realiza una solicitud para obtener un archivo mediante una simple solicitud
GETno autenticada.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-uploadfile/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de tabla | Ingresa el ID de la tabla de la que quieres hacer una lista de los archivos. |
| Archivo |
Ingresa el archivo que quieres cargar. Se ignora si se ingresa URL de descarga. Nota: El archivo debe tener extensión .CSV o .JSON, o ser un archivo ZIP que contenga un archivo con extensión .CSV o .JSON. |
| Nombre | Si se ingresó URL de descarga, ingresa el nombre del archivo que quieres cargar; por defecto, el nombre base de la URL de descarga. |
| URL de descarga |
Ingresa la URL que lleva al archivo que quieres descargar, como una URL firmada por Amazon S3. Opcional si se ingresa Archivo. Nota: El comando realiza una simple petición |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Resultados | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Crear nuevas ediciones de registros
Para crear nuevas ediciones de registros según las propiedades proporcionadas, utiliza un comando Crear nuevas ediciones de registros. Cada edición requiere al menos una operación y un ID de objetivo.
Límite: Se pueden procesar hasta 1000 ediciones por solicitud.
Llamada a la API equivalente: https://developers.workiva.com/platform-v1/platform-createedits/
Propiedades
| Propiedad | Detalle |
|---|---|
| Operación |
Selecciona la operación a realizar. Opciones:
|
| Etiqueta | Ingresa una etiqueta que describa la relación entre los dos registros. Permite crear o eliminar una relación. |
| Propiedades | Ingresa las propiedades relacionadas con el tipo de registro. Se utiliza para crear un registro o establecer sus propiedades. |
| ID de registro | Ingresa el ID o el ID de registro temporal del origen. Permite crear o eliminar una relación. |
| ID de objetivo | Ingresa el ID del registro de objetivo. Si creas un registro, puedes utilizar el ID de registro o el ID de registro temporal; si eliminas un registro, debe utilizar el ID de registro real. |
| ID de registro temporal | Ingresa el ID temporal que se utilizará al crear un registro; este ID temporal se sustituye en el momento del procesamiento. Puedes utilizar este ID dentro de la misma solicitud para crear relaciones entre los registros creados. |
| Tipo | Ingresa el tipo de registro que quieres crear. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Vista dinámica | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Crear vista dinámica
Para crear una nueva vista de Wdata dada su consulta y el resultado de la consulta, utiliza un comando Crear vista dinámica.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-createpivotview/
Propiedades
| Propiedad | Detalle |
|---|---|
| Nombre | Ingresa un nombre único para ayudar a identificar la vista. |
| ID de consulta | Ingresa el ID de la consulta a partir de la cual se creará la vista. |
| ID del resultado de la consulta | Ingresa el ID del resultado de la consulta a partir de la cual se creará la vista. |
| Metadatos adicionales | Ingresa los metadatos definidos por el usuario para adjuntarlos a la vista como objeto JSON (opcional). |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Vista dinámica | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Crear consulta de vista previa (obsoleto)
Este comando ha quedado obsoleto, ya que el punto final ya no es compatible.
Crear consulta
Para crear una nueva consulta de Wdata, utiliza el comando Crear consulta.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-createquery/
Propiedades
| Propiedad | Detalle |
|---|---|
| Nombre | Ingresa un nombre único para ayudar a identificar la consulta. |
| Descripción | Ingresa una descripción de la consulta. |
| ID del resultado principal | Si se especifica, ingresa el ID del resultado por defecto que se rellenará con los resultados de la consulta. |
| Texto de la consulta | Introduce la definición de la consulta como sintaxis de Presto SQL, como lo harías en el Editor SQL de la consulta. |
| Temporal | Para generar la consulta temporalmente de modo que no aparezca en tu espacio de trabajo, marca esta casilla. |
| Parámetros | Ingresa los parámetros necesarios para ejecutar la consulta. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Consulta | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Crear registro
Este comando solo está disponible a través de la API de la plataforma. Para crear un nuevo registro, utiliza el punto final Crear nuevas ediciones de registros.
Crear lista de selección
Para crear una lista de valores para un parámetro de consulta multiselección, utiliza el comando Crear lista de selección.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-createselectlist/
Propiedades
| Propiedad | Detalle |
|---|---|
| Nombre | Ingresa un nombre único para ayudar a identificar la lista de selección. |
| Descripción | Para ayudar a identificar mejor la lista de selección, ingresa una descripción de sus valores o parámetros. |
| Tipo de valor | Selecciona el tipo de datos de los valores de la lista, como cadena o entero. |
| Valores | Ingresa los valores de la lista. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Crear metadatos de lista de selección | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Crear hoja
Para agregar una nueva hoja a una hoja de cálculo, utiliza el comando Crear hoja.
Llamada a la API equivalente: https://developers.workiva.com/spreadsheets-v1/spreadsheets-createsheet/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de hoja de cálculo | Ingresa el identificador único de la hoja de cálculo a la que quieres agregar la hoja. |
| Nombre | Ingresa un nombre único para ayudar a identificar la hoja. |
| Índice de hoja |
Ingresa el índice de la nueva hoja dentro de la hoja de cálculo. Nota: Por defecto, el comando agrega la hoja como hoja superior. |
| ID de la hoja primaria | Ingresa el ID de la hoja primaria bajo la que se creará la hoja. Para agregarla a la hoja de cálculo raíz, déjalo en blanco. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Metadatos de la hoja | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Crear hoja de cálculo
Para crear una nueva hoja de cálculo, utiliza el comando Crear hoja de cálculo.
Llamada a la API equivalente: https://developers.workiva.com/2022-01-01/createlegacyspreadsheet.html
Propiedades
| Propiedad | Detalle |
|---|---|
| Nombre | Ingresa el nombre único para ayudar a identificar la hoja de cálculo. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Metadatos de la hoja | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Crear tabla
Para crear una nueva tabla de Wdata en tu espacio de trabajo, utiliza el comando Crear tabla.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-createtable/
Propiedades
| Propiedad | Detalle |
|---|---|
| Nombre | Ingresa un nombre único para ayudar a identificar la tabla. |
| Descripción | Ingresa una descripción de la nueva tabla. |
| Tipo | Selecciona si quieres crear una tabla de hechos (o Datos) o de búsqueda (o Dimensiones). |
| Columnas |
Agrega las columnas que quieras incluir en la tabla:
|
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Tabla | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Eliminar archivo
Para eliminar un archivo de tu espacio de trabajo de Wdata, utiliza el comando Eliminar archivo.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-deletefile/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID del archivo | Ingresa el ID del archivo que quieres eliminar. |
Resultados
Ninguno
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Eliminar vista dinámica
Para eliminar una vista de Wdata de tu espacio de trabajo, utiliza el comando Eliminar vista dinámica.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-deletepivotview/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID | Ingresa el ID de la vista que quieres eliminar. |
Resultados
Ninguno
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Eliminar consulta
Para eliminar una consulta de Wdata de tu espacio de trabajo, utiliza el comando Eliminar consulta.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-deletequery/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de consulta | Ingresa el ID de la consulta que quieres eliminar. |
Resultados
Ninguno
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Eliminar registro
Este comando solo está disponible a través de la API de la plataforma. Para eliminar un registro, utiliza un comando Crear nuevo registro edita.
Eliminar hoja
Para eliminar una hoja y sus hojas hijas (recursivamente) de una hoja de cálculo, utiliza un comando Eliminar hoja.
Llamada a la API equivalente: https://developers.workiva.com/2022-01-01/deletelegacysheet.html
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de hoja de cálculo | Ingresa el identificador único de la hoja de cálculo de la que quieres eliminar la hoja. |
| ID/nombre de la hoja | Ingresa el nombre o identificador único de la hoja que quieres eliminar. |
Resultados
Ninguno
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Eliminar hoja de cálculo
Para eliminar una hoja de cálculo de tu espacio de trabajo, utiliza el comando Eliminar hoja de cálculo.
Llamada a la API equivalente: https://developers.workiva.com/spreadsheets-v1/spreadsheets-deletespreadsheet/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de hoja de cálculo | Ingresa el identificador único de la hoja de cálculo que quieres eliminar. |
Resultados
Ninguno
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Borrar tabla
Para eliminar una tabla de Wdata de tu espacio de trabajo, utiliza el comando Eliminar tabla.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-deletetable/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de tabla | Ingresa el identificador único de la tabla que quieres eliminar. |
Resultados
Ninguno
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Descargar archivo
Para descargar un conjunto de datos de tu espacio de trabajo de Wdata, utiliza el comando Descargar archivo.
Nota: Este comando no es compatible con otros tipos de objetos, como hojas de cálculo, tablas o consultas.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-downloadfile_1/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID del archivo | Ingresa el ID del archivo que quieres descargar. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Archivo | Archivo |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Descargar Pivot View (obsoleto)
Este comando ha quedado obsoleto, ya que el punto final ya no es compatible.
Descargar resultado de consulta
Para descargar los resultados de una consulta de Wdata a un archivo, utiliza el comando Descargar resultado de consulta.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-downloadqueryresult/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID del resultado de la consulta | Ingresa el ID del resultado de la consulta que quieres descargar. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Resultado de la consulta | Archivo |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Editar
Este comando solo está disponible a través de la API de la plataforma. Para editar un registro, utiliza el punto final Crear nuevas ediciones de registros.
Exportar archivo a hoja de cálculo
Para exportar un conjunto de datos de una tabla de Wdata a una hoja de cálculo nueva o existente, utiliza el comando Exportar archivo a hoja de cálculo.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-exportfiletospreadsheets/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID del archivo | Ingresa el ID del conjunto de datos de la tabla que quieres exportar. |
| URL de la hoja de cálculo | Ingresa la URL de la hoja de cálculo a exportar. Para crear una nueva hoja de cálculo, déjalo en blanco. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Información de hoja | Archivo |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Exportar resultado de consulta
Para exportar el resultado de una consulta de Wdata a una hoja de cálculo nueva o existente, utiliza el comando Exportar resultado de consulta.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-exportqueryresulttospreadsheets/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID del resultado de la consulta | Ingresa el ID del resultado de la consulta que quieres exportar. |
| URL de la hoja de cálculo | Ingresa la URL de la hoja de cálculo a exportar. Para crear una nueva hoja de cálculo, déjalo en blanco. |
| Exportar como conjunto de datos | Si está marcada, los datos se exportarán como un conjunto de datos conectado y las celdas sólo podrán editarse actualizando el conjunto de datos en la hoja de cálculo. |
Resultados
Ninguno
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Obtener propiedades de archivo
Para recuperar las propiedades de un archivo en tu espacio de trabajo de Wdata, utiliza el comando Obtener propiedades de archivo.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-getfile/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID del archivo | Ingresa el ID del archivo del que quieres obtener las propiedades. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Propiedades del archivo | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Obtener vista dinámica
Para recuperar los metadatos de una vista de Wdata, utiliza el comando Obtener vista dinámica.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-getpivotview/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID | Ingresa el ID de la vista dinámica de la que quieres obtener metadatos. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Vista dinámica | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Obtener metadatos de consulta
Para recuperar los metadatos de una consulta de Wdata, utiliza el comando Obtener metadatos de consulta.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-getquery/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de consulta | Ingresa el ID de la consulta de la que quieres obtener metadatos. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Consulta | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Obtener registro
Este comando solo está disponible a través de la API de la plataforma. Para obtener un registro, utiliza el punto final Obtener un único registro.
Obtener registros
Este comando solo está disponible a través de la API de la plataforma. Para obtener varios registros, utiliza el punto final Recuperar una lista de registros.
Obtener informes
Para recuperar todos los informes de la cuenta de la base de datos SOX y Auditoría Interna de tu organización, utiliza el comando Obtener informes.
Llamada a la API equivalente: https://developers.workiva.com/platform-v1/platform-graphreportexport/
Propiedades
Ninguno
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Informes | Archivo |
| Recuento de informes | Entero |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Obtener lista de selección
Para recuperar una lista de valores para un parámetro de consulta de selección múltiple basado en el ID de la lista, utiliza un comando Obtener lista de selección.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-getselectlist/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de lista de selección | Ingresa el identificador único de la lista de selección que quieres recuperar. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Obtener carga útil de lista de selección | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Obtener datos de la hoja
Para recuperar todos los datos de una región específica de una hoja, utiliza el comando Obtener datos de la hoja.
Llamada a la API equivalente: https://developers.workiva.com/spreadsheets-v1/spreadsheets-getdata/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de hoja de cálculo | Ingresa el identificador único de la hoja de cálculo con la hoja de la que se obtendrán los datos. |
| ID/nombre de la hoja | Ingresa el nombre o identificador único de la hoja de la que quieres obtener los datos. |
| Región | Ingresa la representación estilo A1 de una celda o rango, como [Columna de inicio][Fila de inicio]:[Columna de fin][Fila de fin]. Para que el rango no tenga límites en alguna o todas las direcciones, omite la columna o fila correspondiente. |
| Estilo de valor | Selecciona si quieres devolver el valor bruto o calculado de la celda. Por ejemplo, si el valor de una celda es =1+:1, selecciona Bruto para =1+1, o Calculado para el valor calculado de 2. |
| Revisión | Ingresa la versión de la hoja de la que quieres recuperar los datos. Para la versión actual, ingresa -1. |
| Utilizar la API de la plataforma | Cuando esta casilla está marcada, este comando devuelve los datos de la hoja utilizando la notación decimal estándar. Si está en blanco, los datos de la hoja se devuelven utilizando la notación científica. Esto obliga al comando a utilizar la función « » (Recuperar datos de un punto final de hoja), en lugar de la función « » (Devolver datos de un punto final de región) de la API de hojas de cálculo. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Recuento de filas | Entero |
| Datos | Archivo |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Obtener metadatos de la hoja
Para recuperar los metadatos de una hoja en una hoja de cálculo, utiliza el comando Obtener metadatos de la hoja.
Llamada a la API equivalente: https://developers.workiva.com/2022-01-01/getsheetdata.html
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de hoja de cálculo | Ingresa el identificador único de la hoja de cálculo con la hoja de la que se obtendrán los metadatos. |
| ID/nombre de la hoja | Ingresa el nombre o identificador único de la hoja de la que quieres obtener los metadatos. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Metadatos de la hoja | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Obtener metadatos de la hoja de cálculo
Para recuperar los metadatos de una hoja de cálculo, utiliza el comando Obtener metadatos de la hoja de cálculo.
Llamada a la API equivalente: https://developers.workiva.com/2022-01-01/getplatformspreadsheetbyid.html
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de hoja de cálculo | Ingresa el identificador único de la hoja de cálculo de la que quieres obtener los metadatos. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Metadatos de la hoja de cálculo | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Obtener metadatos de la tabla
Para recuperar los metadatos de una tabla de Wdata, utiliza el comando Obtener metadatos de la tabla.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-gettable/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de tabla | Ingresa el identificador único de la tabla de la que quieres obtener los metadatos. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Tabla | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Obtener tipo
Este comando solo está disponible a través de la API de la plataforma. Para obtener un registro, utiliza el punto final Obtener un único registro.
Obtener tipos
Este comando solo está disponible a través de la API de la plataforma. Para obtener varios tipos de registro, utiliza el punto final Recuperar una lista de tipos.
Comprobación de estado
Para comprobar el estado de la API de Wdata, utiliza el comando Comprobación de estado.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-healthcheck/
Propiedades
Ninguno
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Respuesta | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Importar archivo en tabla
Para importar un archivo en una tabla de Wdata, utiliza el comando Importar archivo en tabla.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-importfile/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de tabla | Ingresa el ID de la tabla en la que quieres importar el archivo. |
| ID del archivo | Ingresa el ID del archivo a importar en la tabla. |
| Asignaciones de columnas | Asigna cada columna del archivo a las columnas de la tabla. |
| Ejecutar de forma asíncrona | Para que el comando se ejecute de forma asíncrona y no espere a que se complete la importación antes de continuar con la cadena, marca esta casilla. |
| Etiquetas | Para incluir metadatos de los que tu organización realiza un seguimiento sobre los datos, agrega etiquetas y selecciona sus nombres y valores. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Importación de archivos | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Importar hoja de cálculo en tabla
Para importa una hoja de cálculo en una tabla y obtener un resultado meta de archivo, utiliza un comando Importar hoja de cálculo en tabla.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-importfromspreadsheets/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de tabla | Ingresa el identificador único de la tabla en la que quieres importar el archivo. |
| ID del archivo | Ingresa el identificador único del archivo al que quieres importar la hoja de cálculo (opcional). |
| Nombre del archivo | Ingresa el nombre único que se dará al archivo al importarlo en la tabla. |
| URL de la hoja de cálculo | Ingresa la URL completa de la hoja de cálculo desde la que quieres importar los datos. |
| Ejecutar de forma asíncrona | Para que el comando se ejecute de forma asíncrona y no espere a que se complete la importación antes de continuar con la cadena, marca esta casilla. |
| Etiquetas | Para incluir metadatos de los que tu organización realiza un seguimiento sobre los datos, agrega etiquetas y selecciona sus nombres y valores. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Importación de archivos | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Lista de conexiones
Para hacer una lista de datos entre funciones de la plataforma Workiva, utiliza el comando Lista de conexiones.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-listconnections/
| Propiedad | Detalle |
|---|---|
| Tipo de origen | Utiliza el menú desplegable para seleccionar el tipo de archivo o elemento del que quieres extraer los datos. |
| Tipo de destino | Mediante el menú desplegable, selecciona el tipo de archivo o elemento al que quieres enviar los datos. |
| ID de origen | Ingresa el identificador único del archivo o elemento del que extraer los datos. |
| ID de destino | Ingresa el identificador único del archivo o elemento al que enviar los datos. |
Nota: Tu solicitud debe contener un Tipo de origen + ID de origen o un Tipo de destino + ID de destino; la solicitud fallará si uno de estos pares no está presente.
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Conexiones | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Lista de errores de archivo
Para hacer una lista de los errores asociados a un archivo, por ejemplo, debidos a una importación, utiliza el comando Lista de errores de archivo.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-geterrors/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID del archivo | Ingresa el ID del archivo del que quieres obtener los errores. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Lista de errores | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Lista de archivos
Para recuperar una lista de archivos de una tabla de Wdata y sus metadatos, utiliza el comando Lista de archivos.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-getfiles/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de tabla | Ingresa el ID de la tabla de la que quieres obtener los archivos. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Lista de archivos | Archivo |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Lista de vistas dinámicas
Para hacer una lista de las vistas de Wdata en tu espacio de trabajo y recuperar sus metadatos, utiliza un comando Lista de vistas dinámicas.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-listpivotviews/
Propiedades
Ninguno
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Vistas dinámicas | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Lista de consultas
Para hacer una lista de las consultas de Wdata en tu espacio de trabajo y recuperar sus metadatos, utiliza el comando Lista de consultas.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-listqueries/
Propiedades
Ninguno
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Consultas | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Lista de resultados de consulta
Para listar los resultados disponibles de una consulta de Wdata, utiliza el comando Lista de resultados de consulta.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-listqueryresults/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de consulta | Ingresa el ID de la consulta de la que quieres obtener resultados. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Resultados de la consulta | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Lista de listas de selección
Para hacer una lista de todas las listas de valores de los parámetros de consulta multiselección de tu espacio de trabajo y recuperar sus metadatos, utiliza un comando Lista de listas de selección.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-listselectlists/
Propiedades
Ninguno
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Lista de listas de selección | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Lista de hojas
Para hacer una lista de todas las hojas de una hoja de cálculo y recuperar sus metadatos, utiliza el comando Lista de hojas.
Llamada a la API equivalente: https://developers.workiva.com/2022-01-01/getlegacysheets.html
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de hoja de cálculo | Ingresa el identificador único de la hoja de cálculo de la que quieres hacer una lista de las hojas. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Hojas | JSON |
| N.º de hojas | Entero |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Lista de tablas
Para hacer una lista de todas las tablas de Wdata de tu espacio de trabajo y recuperar sus metadatos, utiliza el comando Lista de tablas.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-gettables/
Propiedades
Ninguno
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Lista de tablas | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Lista de usuarios
Para recuperar una lista de detalles sobre los usuarios de una organización, utiliza el comando Lista de usuarios. El usuario de integración asignado debe tener el rol de Administrador de la organización para ejecutar este comando.
De forma similar a la exportación de la “Vista de personas” del administrador de una organización, los detalles se ordenan por nombre de visualización e incluyen los siguientes datos de los usuarios:
- Nombres de usuario
- Direcciones de correo electrónico
- ID SAML
- Últimos inicios de sesión
- Membresías de espacio de trabajo
- Licencias y roles
Llamada a la API equivalente: https://developers.workiva.com/admin-v1/admin-getorgreportusers/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de la organización | Ingresa el identificador único de la organización para la que se va a hacer una lista de sus usuarios. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Informe de usuarios | Archivo |
| Recuento de registros | Entero |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Sobrescribir datos de la hoja
Para borrar todas las celdas de una hoja y reemplazarlas por los valores proporcionados en el archivo, utiliza un comando Sobrescribir datos de la hoja.
Llamada a la API equivalente: https://developers.workiva.com/2022-01-01/updatesheet.html#
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de hoja de cálculo | Ingresa el identificador único de la hoja de cálculo en la que quieres sobrescribir los datos de la hoja. |
| ID/nombre de la hoja | Ingresa el nombre o identificador único de la hoja en la que quieres sobrescribir los datos. |
| Archivo de datos | Ingresa el archivo CSV que contiene los datos con los que se rellenará la hoja. |
| Delimitador | Ingresa el delimitador utilizado en el Archivo de datos. |
| Utilizar API de la plataforma | Para utilizar el formato Ingresado en de los valores de las celdas de la hoja de cálculo, marca esta casilla. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Fila escrita | Entero |
| Celdas escritas | Entero |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Publicar hoja de cálculo
Para publicar los enlaces en una hoja de cálculo, utiliza el comando Publicar hoja de cálculo.
Llamada a la API equivalente: https://developers.workiva.com/spreadsheets-v1/spreadsheets-publish/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de hoja de cálculo | Ingresa el identificador único de la hoja de cálculo que quieres publicar. |
| Publicar todos los enlaces |
Selecciona qué enlaces de la hoja de cálculo quieres publicar:
|
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Mensaje | Cadena |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Actualizar conexión
Para actualizar una conexión específica en función de su ID, utiliza el comando Actualizar conexión.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-refreshconnection/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de conexión | Ingresa el identificador único de la conexión que quieres actualizar. |
| Utilizar los parámetros anteriores del origen | Marca esta casilla para utilizar los parámetros del origen de la ejecución anterior; esto anula cualquier otro parámetro de origen que hayas especificado. Esta entrada se ignorará por el punto final “Actualizar lote de conexiones”. |
| Parámetros del origen* |
Ingresa los parámetros que se enviarán al origen cuando se actualice correctamente. (Estos parámetros se ignorarán si está activada la opción “Utilizar los parámetros anteriores del origen”) |
| Utilizar los parámetros anteriores del destino | Marca esta casilla para utilizar los parámetros del destino de la ejecución anterior; esto anula cualquier otro parámetro de destino que hayas especificado. Esta entrada se ignorará por el punto final “Actualizar lote de conexiones”. |
| Parámetros de destino* |
Ingresa los parámetros que se enviarán al destino cuando se actualice correctamente. (Estos parámetros se ignorarán si está activada la opción “Utilizar los parámetros anteriores del destino”). |
Nota: Actualmente no se admiten parámetros de selección múltiple.
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Actualizar estado | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Actualizar lote de conexiones
Para actualizar varias conexiones a la vez, utiliza el comando Actualizar lote de conexiones.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-refreshbatch/
Propiedades
| Propiedad | Detalle |
|---|---|
| Conexiones |
Permite habilitar o deshabilitar el uso de variables. Cuando está habilitada:
|
| ID de conexión | Ingresa el identificador único de la conexión que quieres actualizar. |
| Utilizar los parámetros anteriores del origen | Marca esta casilla para utilizar los parámetros del origen de la ejecución anterior; esto anula cualquier otro parámetro de origen que hayas especificado. Esta entrada se ignorará por el punto final “Actualizar lote de conexiones”. |
| Parámetros del origen |
Ingresa los parámetros que se enviarán al origen cuando se actualice correctamente. (Estos parámetros se ignorarán si está activada la opción “Utilizar los parámetros anteriores del origen”) |
| Utilizar los parámetros anteriores del destino | Marca esta casilla para utilizar los parámetros del destino de la ejecución anterior; esto anula cualquier otro parámetro de destino que hayas especificado. Esta entrada se ignorará por el punto final “Actualizar lote de conexiones”. |
| Parámetros del destino |
Ingresa los parámetros que se enviarán al destino cuando se actualice correctamente. (Estos parámetros se ignorarán si está activada la opción “Utilizar los parámetros anteriores del destino”). |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Estado de actualización de lotes | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Eliminar el borde
Este comando solo está disponible a través de la API de la plataforma. Para eliminar un borde, utiliza el punto final Crear nuevas ediciones de registros.
Recuperar una lista de registros
Para obtener una lista de registros que coincidan con los filtros proporcionados, utiliza el comando Recuperar una lista de registros. Siempre se necesita al menos un filtro.
Llamada a la API equivalente: https://developers.workiva.com/platform-v1/platform-getrecords/
Propiedades
| Propiedad | Detalle |
|---|---|
| Expandir |
Devuelve los recursos relacionados en línea con el recurso principal. Opciones:
|
| Filtrar | Las propiedades por las que filtrar los resultados. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Estado de actualización de lotes | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Recuperar una lista de tipos
Para obtener una lista de tipos de registro y sus atributos, utiliza el comando Recuperar una lista de tipos. Este comando te permite saber qué esperar al recuperar registros.
Llamada a la API equivalente: https://developers.workiva.com/platform-v1/platform-gettypes/
Propiedades
| Propiedad | Detalle |
|---|---|
| Expandir |
Devuelve los recursos relacionados en línea con el recurso principal. Opciones:
|
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Estado de actualización de lotes | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Recuperar un único registro
Para recuperar un único registro, utiliza el comando Recuperar una lista de registros. El identificador único suele ser un UUID, pero puede variar.
Llamada a la API equivalente: https://developers.workiva.com/platform-v1/platform-getrecordbyid/
Propiedades
| Propiedad | Detalle |
|---|---|
| Expandir |
Devuelve los recursos relacionados en línea con el recurso principal. Opciones:
|
| ID de registro | Ingresa el identificador único del registro. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Estado de actualización de lotes | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Recuperar un único tipo
Para recuperar un único registro, utiliza el comando Recuperar una lista de registros. El identificador único suele ser un UUID, pero puede variar.
Llamada a la API equivalente: https://developers.workiva.com/platform-v1/platform-gettypebyid/
Propiedades
| Propiedad | Detalle |
|---|---|
| Expandir |
Devuelve los recursos relacionados en línea con el recurso principal. Opciones:
|
| ID de registro | Ingresa el identificador único del registro. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Estado de actualización de lotes | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Ejecutar consulta
Para ejecutar una consulta de Wdata y recuperar sus resultados, utiliza el comando Ejecutar consulta.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-runquery/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de consulta | ingresa el ID de la consulta que quieres ejecutar. |
| Parámetros |
Si la consulta tiene parámetros definidos, agrega un mapa con sus nombres y valores. Nota: Ingresa los valores de cualquier parámetro de selección múltiple en Parámetros de selección múltiple. |
| Ejecutar de forma asíncrona | Para ejecutar la consulta de forma asíncrona, y no esperar hasta que la consulta finalice para completar el comando, marca esta casilla. |
| Parámetros de selección múltiple | Si la consulta tiene parámetros de selección múltiple definidos, agrega el nombre y los valores de cada uno. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Resultado de la consulta | JSON |
Nota: El resultado Resultado de la consulta incluye un ID, que puede utilizarse para descargar y exportar los resultados.
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Ejecutar informe
Para ejecutar un informe guardado en la cuenta de la base de datos SOX y Auditoría interna de tu organización, y devolver sus resultados como un archivo CSV, utiliza un comando Ejecutar informe.
Llamada a la API equivalente: https://developers.workiva.com/platform-v1/platform-getreportascsv/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de informe | Ingresa el identificador único del informe que contiene el informe guardado. |
| Previsualizar contenido | Para incluir una vista previa de los resultados del informe en el registro del comando, marca esta casilla. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Informe | Archivo |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Configurar borde
Este comando solo está disponible a través de la API de la plataforma. Para configurar un borde, utiliza el punto final Crear nuevas ediciones de registros.
Establecer propiedades de registro
Este comando solo está disponible a través de la API de la plataforma. Para configurar las propiedades de registro, utiliza el punto final Crear nuevas ediciones de registros.
Desimportar archivo de la tabla
Para desimportar y eliminar un archivo de una tabla de Wdata, utiliza el comando Desimportar archivo de la tabla.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-unimportfile/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de tabla | Ingresa el identificador único de la tabla de la que quieres eliminar el archivo. |
| ID del archivo | Ingresa el identificador único del archivo que quieres eliminar de la tabla. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Importación de archivos | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Actualizar vista dinámica
Para actualizar los metadatos de una vista de Wdata, utiliza un comando Actualizar vista dinámica.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-updatepivotview/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID | Ingresa el ID de la vista que quieres actualizar. |
| Nombre | Ingresa el nombre nuevo de la vista. |
| ID de consulta | Ingresa el ID de la consulta a partir de la cual se creará la vista. |
| ID del resultado de la consulta | Ingresa el ID del resultado de la consulta a partir de la cual se creará la vista. |
| Metadatos adicionales | Ingresa los metadatos definidos por el usuario para adjuntarlos a la vista como objeto JSON (opcional). |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Vista dinámica | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Actualizar definición de la consulta
Para actualizar las propiedades de una consulta de Wdata, utiliza el comando Actualizar definición de la consulta.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-updatequery/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de consulta | ingresa el ID de la consulta que quieres actualizar. |
| Nombre | Ingresa el nombre nuevo de la consulta. |
| Descripción | Ingresa una descripción nueva de la consulta. |
| ID del resultado principal | Si se especifica, ingresa el ID del resultado por defecto que se rellenará con los resultados de la consulta. |
| Texto de la consulta | Introduce la definición de la consulta como sintaxis de Presto SQL, como lo harías en el Editor SQL de la consulta. |
| Temporal | Para generar la consulta solo temporalmente de modo que no aparezca en tu espacio de trabajo, marca esta casilla. |
| Parámetros | Ingresa los parámetros necesarios para ejecutar la consulta. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Consulta | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Actualizar lista de selección
Para actualizar las propiedades o elementos de una lista de valores de un parámetro de consulta multiselección, utiliza un comando Actualizar lista de selección.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-updateselectlist/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID | Ingresa el ID de la lista de selección que quieres actualizar. |
| Nombre | Ingresa el nombre nuevo de la lista de selección. |
| Descripción | Ingresa la descripción nueva de la lista de selección. |
| Tipo de valor | Selecciona el tipo de datos de los valores de la lista, como cadena o entero. |
| Valores | Ingresa los valores de la lista, incluidas las actualizaciones. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Actualizar lista de selección | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Actualizar metadatos de la hoja
Para actualizar los metadatos de una hoja de cálculo, utiliza el comando Actualizar metadatos de la hoja.
Llamada a la API equivalente: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatesheet/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de hoja de cálculo | Ingresa el identificador único de la hoja de cálculo con la hoja en la que quieres actualizar los metadatos. |
| ID/nombre de la hoja | Ingresa el nombre o el identificador único de la hoja en la que quieres actualizar los metadatos. |
| Nombre | Ingresa el nuevo nombre de la hoja. |
| Índice de hoja | Ingresa el nuevo índice de la hoja en la hoja de cálculo. Por defecto, los comandos actualizan la hoja como hoja superior. |
| ID de la hoja primaria | Ingresa el ID de la hoja primaria bajo la que se creará la hoja. Para agregarla a la hoja de cálculo raíz, déjalo en blanco. |
Resultados
Ninguno
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Actualizar metadatos de la hoja de cálculo
Para actualizar los metadatos de una hoja de cálculo, utiliza el comando Actualizar metadatos de la hoja de cálculo.
Llamada a la API equivalente: https://developers.workiva.com/2022-01-01/updatesheet.html
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de hoja de cálculo | Ingresa el identificador único de la hoja de cálculo con la hoja en la que quieres actualizar los metadatos. |
| Nombre | Ingresa el nuevo nombre de la hoja de cálculo. |
Resultados
Ninguno
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Actualizar tabla
Para actualizar las columnas de una tabla de Wdata, utiliza el comando Actualizar tabla.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-updatetable/
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de tabla | Ingresa el identificador único de la tabla que quieres actualizar. |
| Nombre | Ingresa el nombre de la tabla que quieres actualizar. |
| Descripción | Ingresa una descripción de la tabla que quieres actualizar. |
| Tipo | Selecciona si quieres crear una tabla de hechos (o Datos) o de búsqueda (o Dimensiones). |
| Columnas | Agrega las columnas con las que actualizar la tabla. Para cada columna, ingresa su nombre, tipo de datos, alias y descripción. Para Modo, deja el valor por defecto que admite un valor nulo. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Tabla | JSON |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |
Escribir datos de la hoja
Para escribir los datos de un conjunto de datos CSV en una región específica de una hoja, utiliza el comando Escribir datos de la hoja.
Propiedades
| Propiedad | Detalle |
|---|---|
| ID de hoja de cálculo | Ingresa el identificador único de la hoja de cálculo con la hoja en la que se escribirán los datos. |
| ID/nombre de la hoja | Ingresa el identificador único de la hoja en la que se escribirán los datos. |
| Archivo de datos | Ingresa el archivo CSV con los datos que quieres escribir en la hoja. El rango de los datos no debe superar la Región. |
| Delimitador | Ingresa el delimitador utilizado en el Archivo de datos. |
| Región | Ingresa una representación A1 de la celda o rango de celdas de la hoja en la que se escribirán los datos. Para que el rango no tenga límites en alguna o todas las direcciones, deja en blanco la columna o fila correspondiente. |
| Uso asíncrono |
Para subir los datos de forma asíncrona, como en el caso de un gran conjunto de datos, marca esta casilla. Nota: Cuando utilices async, debes añadir tu propio sondeo para determinar el estado del trabajo. |
| Utilizar API de la plataforma |
Para utilizar el formato introducido en los valores de las celdas de la región «», marca esta casilla. Al hacerlo: el comando utilizará los valores de actualización de en un punto final de rango en lugar de los datos de escritura de la API de hoja de cálculo en un punto final de región. Nota: Este comando siempre se ejecutará de forma asíncrona cuando utilices la API de la plataforma. Debes añadir tu propio sondeo para determinar el estado del trabajo. |
Resultados
| Resultado | Tipo de resultado |
|---|---|
| Filas escritas | Entero |
| Celdas escritas | Entero |
Códigos de salida
| Código | Tipo | Detalle |
|---|---|---|
| 0 | Correcto | Correcto |
| 1 | Error | Error |