Para automatizar tareas dentro de la plataforma Workiva como parte de una cadena, por ejemplo para habilitar el intercambio de datos con otras fuentes de datos, agregue una Etapa que incluya un comando de conexión a Workiva.
Para Habilitar estos comandos, un administrador de TI primero configura un conector Workiva.
Datos de la Hoja Borrar
Para borrar todos los datos de una hoja, utilice el comando Borrar datos de hoja .
Llamada API equivalente: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatedataasync/
Propiedades
Propiedades | Detalles |
---|---|
ID de hoja de cálculo | Introduzca el identificador único de la hoja de cálculo con la hoja que desea borrar. |
ID de hoja/nombre | Introduzca el nombre o el identificador único de la Hoja que desea borrar. |
Resultados
Ninguno
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Crear archivo
Para cargar un archivo de valores separados por comas (CSV), notación de objetos Javascript (JSON) o ZIP comprimido y listar sus registros, utilice un comando Crear archivo . También puede cargar la URL al archivo, como una URL firmada por Amazon S3® a un archivo en un bucket 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. Si vuelve a descargar el Archivo, se descargará la fuente.
- Si se trata de una URL, el punto final realiza una solicitud para obtener un Archivo mediante una simple solicitud
GET
no autenticada.
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-uploadfile/
Propiedades
Propiedades | Detalles |
---|---|
ID de tabla | Introduzca el ID de la Tabla para listar los archivos de. |
Archivo | Introduzca el Archivo a cargar. Se ignora si se introduce URL de descarga . Nota: El Archivo debe tener una extensión .CSV o .JSON, O ser un archivo ZIP que contenga un archivo con extensión .CSV o .JSON. |
Nombre | Si se introduce URL de descarga , introduzca el nombre del Archivo a cargar; por defecto, el nombre base de URL de descarga. |
Descargar URL | Introduzca la URL que apunta al Archivo a descargar, como una URL firmada por Amazon S3. Opcional si se introduce Archivo . Nota: El comando realiza una petición Básica |
Resultados
Resultado | Tipo de salida |
---|---|
Resultados | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Crear nuevas ediciones de registro.
Para Crear nuevas ediciones de registro dadas las propiedades suministradas, utilice un comando Crear nuevas ediciones de registro . Cada edición requiere al menos una operación y un targetId.
Límites:
- Arriba se pueden procesar hasta 1000 ediciones por solicitud.
Llamada a la API equivalente: https://developers.workiva.com/platform-v1/platform-createedits/
Propiedades
Propiedades | Detalles |
---|---|
Operación |
Seleccione la operación a realizar. Opciones:
|
Etiqueta | Introduzca una etiqueta que describa la relación entre los dos registros. Permite crear o eliminar una relación. |
Propiedades | Introduzca las propiedades relacionadas con el Tipo de registro. Sirve para crear un registro o establecer sus propiedades. |
ID de registro. | Introduzca el ID o el ID de registro temporal de la fuente. Permite crear o eliminar una relación. |
ID de objetivo | Introduzca el ID del registro de destino. Si crea un registro, puede utilizar el ID de registro o el ID de registro temporal; si elimina un registro, debe utilizar el ID de registro real. |
ID de registro temporal. | Introduzca el ID temporal que se utilizará al crear un registro; este ID temporal se sustituye en el momento del tratamiento. Puede utilizar este ID dentro de la misma solicitud para crear relaciones entre registros creados. |
Tipo | Introduzca el Tipo de registro que desea crear. |
Resultados
Resultado | Tipo de salida |
---|---|
Vista pivotante | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Crear vista pivotante
Para crear una nueva vista Wdata dada su consulta y resultado de consulta, utilice un comando Crear vista pivotante .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-createpivotview/
Propiedades
Propiedades | Detalles |
---|---|
Nombre | Introduzca un nombre único para ayudar a identificar la vista. |
ID de la consulta | Introduzca el ID de la consulta a partir de la cual se va a crear la vista. |
ID del resultado de la consulta | Introduzca el ID del resultado de la consulta a partir del cual se va a crear la vista. |
Metadatos adicionales | Introduzca los metadatos definidos por el usuario para adjuntarlos a la vista como un objeto JSON (opcional). |
Resultados
Resultado | Tipo de salida |
---|---|
Vista pivotante | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Crear consulta previa
Para Crear una consulta previa temporal en una tabla que luego pueda ejecutarse, utilice un comando Crear consulta previa .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-previewqueryusingpost/
Propiedades
Propiedades | Detalles |
---|---|
ID de tabla | Introduzca el ID de la Tabla a consultar. |
Límite | Introduzca el número máximo de resultados a devolver. |
Archivo | Si se especifica, introduzca el nombre del Archivo en la Tabla a consultar. |
Resultados
Resultado | Tipo de salida |
---|---|
Consulta | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Crear consulta
Para crear una nueva consulta de Wdata, utilice el comando Crear consulta .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-createquery/
Propiedades
Propiedades | Detalles |
---|---|
Nombre | Introduzca un nombre único para ayudar a identificar la consulta. |
Descripción | Introduzca una descripción de la consulta. |
ID del resultado principal | Si se especifica, introduzca el ID del resultado por defecto que se rellenará con los resultados de la consulta. |
Texto de la consulta | Introduzca la definición de la consulta como sintaxis de Presto SQL, como lo haría en el Editor SQL de la consulta. |
Temporal | Para generar la consulta temporalmente de modo que no aparezca en su área de trabajo, marque esta casilla. |
Parámetros | Introduzca los parámetros necesarios para ejecutar la consulta. |
Resultados
Resultado | Tipo de salida |
---|---|
Consulta | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Crear registro
Este comando sólo está disponible a través de la API de la plataforma. Para crear un nuevo registro, utilice el punto final Crear nuevo registro edita .
Crear lista de selección
Para crear una lista de valores para un parámetro de consulta de selección múltiple, utilice un comando Crear lista de selección .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-createselectlist/
Propiedades
Propiedades | Detalles |
---|---|
Nombre | Introduzca un nombre único para ayudar a identificar la lista de selección. |
Descripción | Para ayudar a identificar mejor la lista seleccionada, introduzca una descripción de sus valores o parámetro. |
Tipo de valor | Seleccione el tipo de datos de los valores de la lista, como cadena o entero. |
Valores | Introduzca los valores de la lista. |
Resultados
Resultado | Tipo de salida |
---|---|
Crear metadatos de listas de selección | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error |
Se ha producido un error |
Crear hoja
Para Agregar una nueva hoja a una hoja de cálculo, utilice un comando Crear hoja .
Llamada API equivalente: https://developers.workiva.com/spreadsheets-v1/spreadsheets-createsheet/
Propiedades
Propiedades | Detalles |
---|---|
ID de hoja de cálculo | Escriba el identificador único de la hoja de cálculo a la que desea agregar la hoja. |
Nombre | Introduzca un nombre único para ayudar a identificar la hoja. |
Índice de Hojas | Introduzca el índice de la nueva hoja dentro de la hoja de cálculo. Nota: Por defecto, el comando agrega la hoja como hoja Arriba. |
ID de hoja de los padres | Introduzca el ID de la hoja padre bajo la que se va a crear la hoja. Para Agregar a la hoja de cálculo raíz, dejar en blanco. |
Resultados
Resultado | Tipo de salida |
---|---|
Metadatos de las Hojas | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Crear hoja de cálculo
Para crear una nueva hoja de cálculo, utilice el comando Crear hoja de cálculo .
Llamada API equivalente: https://developers.workiva.com/spreadsheets-v1/spreadsheets-createspreadsheet/
Propiedades
Propiedades | Detalles |
---|---|
Nombre | Introduzca el nombre único para ayudar a identificar la hoja de cálculo.... |
Resultados
Resultado | Tipo de salida |
---|---|
Metadatos de las Hojas | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Crear tabla
Para crear una nueva Tabla Wdata en su área de trabajo, utilice el comando Crear tabla .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-createtable/
Propiedades
Propiedades | Detalles |
---|---|
Nombre | Introduzca un nombre único para ayudar a identificar la Tabla. |
Descripción | Introduzca una descripción de la nueva Tabla. |
Tipo | Seleccione si desea crear una Tabla de datos (o hecho) o de consulta (o dimensión). |
Columnas | Agregar las Columnas a incluir en la Tabla:
|
Resultados
Resultado | Tipo de salida |
---|---|
Tabla | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Eliminar Archivo
Para Eliminar un Archivo de su espacio de trabajo Wdata, utilice el comando Eliminar archivo .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-deletefile/
Propiedades
Propiedades | Detalles |
---|---|
Archivo ID | Introduzca el ID del Archivo que desea eliminar. |
Resultados
Ninguno
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Eliminar vista pivotante
Para Eliminar una vista Wdata de su espacio de trabajo, utilice el comando Eliminar vista pivotante .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-deletepivotview/
Propiedades
Propiedades | Detalles |
---|---|
id.|Id. | Introduzca el ID de la vista que desea eliminar. |
Resultados
Ninguno
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Eliminar consulta
Para eliminar una consulta de Wdata de su espacio de trabajo, utilice el comando Eliminar consulta .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-deletequery/
Propiedades
Propiedades | Detalles |
---|---|
ID de la consulta | Introduzca el ID de la consulta que desea eliminar. |
Resultados
Ninguno
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Eliminar registro.
Este comando sólo está disponible a través de la API de la plataforma. Para eliminar un registro, Crear nuevo registro edita endpoint.Eliminar hoja
Para eliminar una hoja y sus hojas hijas (recursivamente) de una hoja de cálculo, utilice el comando Eliminar hoja.Propiedades
Propiedades | Detalles |
---|---|
ID de hoja de cálculo | Introduzca el identificador único de la hoja de cálculo con la hoja que desea eliminar. |
ID de hoja/nombre | Introduzca el nombre o el identificador único de la Hoja que desea eliminar. |
Resultados
Ninguno
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Eliminar hoja de cálculo
Para eliminar una hoja de cálculo del área de trabajo, utilice el comando Eliminar hoja de cálculo .
Llamada API equivalente: https://developers.workiva.com/spreadsheets-v1/spreadsheets-deletespreadsheet/
Propiedades
Propiedades | Detalles |
---|---|
ID de hoja de cálculo | Introduzca el identificador único de la hoja de cálculo que desea eliminar. |
Resultados
Ninguno
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Eliminar tabla
Para Eliminar una Tabla Wdata de su área de trabajo, utilice el comando Eliminar tabla .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-deletetable/
Propiedades
Propiedades | Detalles |
---|---|
ID de tabla | Introduzca el identificador único de la Tabla a eliminar |
Resultados
Ninguno
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Descargar Archivo
Para descargar un conjunto de datos de su espacio de trabajo Wdata, utilice 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
Propiedades | Detalles |
---|---|
Archivo ID | Introduzca el ID del Archivo a descargar. |
Resultados
Resultado | Tipo de salida |
---|---|
Archivo | Archivo |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
<!--
Download Pivot View
Downloads the content from a pivot view
Inputs
Input | Detail |
ID | Enter the ID of the pivot view to download |
Outputs
Output | Output Type |
Pivot View Content | File |
Exit Codes
Code | Type | Detail |
0 | Success | Success |
1 | Error | Error |
Download pivot view
To download the contents of a view, use a Download pivot view command.
Properties
Property | Detail |
---|---|
ID | Enter the ID of the view to download. |
Outputs
Output | Output Type |
---|---|
Pivot view content | File |
Exit codes
Code | Type | Detail |
---|---|---|
0 | Success | Success |
1 | Error | Error |
Descargar el resultado de la consulta
Para descargar los resultados de una consulta de Wdata a un archivo, utilice el comando Descargar resultado de consulta .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-downloadqueryresult/
Propiedades
Propiedades | Detalles |
---|---|
ID del resultado de la consulta | Introduzca el ID del resultado de la consulta que desea descargar. |
Resultados
Resultado | Tipo de salida |
---|---|
Resultados de la consulta | Archivo |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Editar
Este comando sólo está disponible a través de la API de la plataforma. Para editar un registro, utilice el punto final Crear nuevo registro edita .
Exportar Archivo a Hoja de cálculo
Para exportar un conjunto de datos de una Tabla Wdata a una hoja de cálculo nueva o existente, utilice el comando Exportar archivo a hoja de cálculo .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-exportfiletospreadsheets/
Propiedades
Propiedades | Detalles |
---|---|
Archivo ID | Introduzca el ID del conjunto de datos de la Tabla a exportar. |
Hoja de cálculo URL | Introduzca la URL de la hoja de cálculo a exportar. Para crear una nueva hoja de cálculo, déjela en blanco. |
Resultados
Resultado | Tipo de salida |
---|---|
Hoja informativa | Archivo |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Exportar resultado de consulta
Para exportar un resultado de consulta de Wdata a una hoja de cálculo nueva o existente, utilice un comando Exportar resultado de consulta .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-exportqueryresulttospreadsheets/
Propiedades
Propiedades | Detalles |
---|---|
ID del resultado de la consulta | Introduzca el ID del resultado de la consulta que desea exportar. |
Hoja de cálculo URL |
Introduzca la URL de la hoja de cálculo a exportar. Para crear una nueva hoja de cálculo, déjela 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 | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Obtener Propiedades de Archivo
Para recuperar las propiedades de un Archivo en su área de trabajo Wdata, utilice el comando Obtener propiedades de archivo .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-getfile/
Propiedades
Propiedades | Detalles |
---|---|
Archivo ID | Introduzca el ID del Archivo del que desea obtener las propiedades. |
Resultados
Resultado | Tipo de salida |
---|---|
Propiedades del Archivo | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Obtener vista pivotante
Para recuperar los metadatos de una vista Wdata, utilice el comando Get pivot view .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-getpivotview/
Propiedades
Propiedades | Detalles |
---|---|
id.|Id. | Introduzca el ID de la vista pivotante de la que desea obtener metadatos. |
Resultados
Resultado | Tipo de salida |
---|---|
Vista pivotante | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Obtener metadatos de consulta
Para recuperar los metadatos de una consulta Wdata, utilice el comando Get query metadata .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-getquery/
Propiedades
Propiedades | Detalles |
---|---|
ID de la consulta | Introduzca el ID de la consulta de la que desea obtener metadatos. |
Resultados
Resultado | Tipo de salida |
---|---|
Consulta | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Obtener registro.
Este comando sólo está disponible a través de la API de la plataforma. Para obtener un registro, utilice el punto final Retrieve a single record .
Obtener registros.
Este comando sólo está disponible a través de la API de la plataforma. Para obtener varios registros, utilice el punto final Recuperar una lista de registros .
Informes
Para recuperar todos los Informes de la cuenta de la base de datos SOX y Auditoría Interna de su organización, utilice el comando Get reports .
Llamada a la API equivalente: https://developers.workiva.com/platform-v1/platform-graphreportexport/
Propiedades
Ninguno
Resultados
Resultado | Tipo de salida |
---|---|
Informes | Archivo |
Recuento de informes | Entero |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un 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, utilice un comando Obtener lista de selección .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-getselectlist/
Propiedades
Propiedades | Detalles |
---|---|
Seleccionar ID de lista | Introduzca el identificador único de la lista de selección que desea recuperar. |
Resultados
Resultado | Tipo de salida |
---|---|
Obtener la carga útil de la lista de selección | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Obtener datos de la Hoja
Para recuperar todos los datos de una región específica de una hoja, utilice el comando Obtener datos de la hoja .
Llamada API equivalente: https://developers.workiva.com/spreadsheets-v1/spreadsheets-getdata/
Propiedades
Propiedades | Detalles |
---|---|
ID de hoja de cálculo | Introduzca el identificador único de la hoja de cálculo con la hoja de la que obtener los datos. |
ID de hoja/nombre | Introduzca el nombre o el identificador único de la hoja de la que desea obtener los datos. |
Región | Introduzca la representación en estilo A1 de una celda o rango, como [Columna de inicio][Fila de inicio]:[Columna de parada][Fila de parada] . Para tener el rango sin límites en alguna o todas las direcciones, omita la columna o fila correspondiente. |
Estilo Hay valores. | Seleccione si desea obtener el valor de la celda en bruto o calculado. Por ejemplo, si el valor de una Celda es =1+:1 , seleccione Raw para =1+1, o Calculated para el valor calculado de 2. |
Revisión | Introduzca la versión de la Hoja de la que desea recuperar los datos. Para la versión actual, introduzca -1. |
Resultados
Resultado | Tipo de salida |
---|---|
Número de Filas | Entero |
Datos | Archivo |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Obtener metadatos de la Hoja
Para recuperar los metadatos de una hoja en una hoja de cálculo, utilice el comando Obtener metadatos de la hoja .
Llamada API equivalente: https://developers.workiva.com/spreadsheets-v1/spreadsheets-getsheet/
Propiedades
Propiedades | Detalles |
---|---|
ID de hoja de cálculo | Introduzca el identificador único de la hoja de cálculo con la hoja de la que obtener los metadatos. |
ID de hoja/nombre | Introduzca el nombre o el identificador único de la hoja de la que desea obtener metadatos. |
Resultados
Resultado | Tipo de salida |
---|---|
Metadatos de las Hojas | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Obtener metadatos de hojas de cálculo
Para recuperar los metadatos de una hoja de cálculo, utilice el comando Get spreadsheet metadata .
Llamada API equivalente: https://developers.workiva.com/spreadsheets-v1/spreadsheets-getspreadsheet/
Propiedades
Propiedades | Detalles |
---|---|
ID de hoja de cálculo | Introduzca el identificador único de la hoja de cálculo de la que desea obtener los metadatos. |
Resultados
Resultado | Tipo de salida |
---|---|
Hoja de cálculo de metadatos | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Obtener metadatos de la Tabla
Para recuperar los metadatos de una tabla Wdata, utilice el comando Get table metadata .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-gettable/
Propiedades
Propiedades | Detalles |
---|---|
ID de tabla | Introduzca el identificador único de la Tabla de la que obtener los metadatos. |
Resultados
Resultado | Tipo de salida |
---|---|
Tabla | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Obtener tipo
Este comando sólo está disponible a través de la API de la plataforma. Para obtener un registro, utilice el punto final Retrieve a single record .
Tipos
Este comando sólo está disponible a través de la API de la plataforma. Para obtener varios tipos de registro, utilice el punto final Recuperar una lista de tipos .
<!-- display page content -->
Chequeo médico
Para comprobar el estado de la API de Wdata, utilice el comando Health check .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-healthcheck/
Propiedades
Ninguno
Resultados
Resultado | Tipo de salida |
---|---|
Respuesta | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Importar Archivo a Tabla
Para importar un Archivo a una Tabla Wdata, utilice el comando Importar Archivo a Tabla .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-importfile/
Propiedades
Propiedades | Detalles |
---|---|
ID de tabla | Introduzca el ID de la Tabla en la que desea importar el Archivo. |
Archivo ID | Introduzca el ID del Archivo a Importar en la Tabla. |
Asignaciones de columnas | Asigne cada columna del Archivo a las columnas de la Tabla. |
Ejecución 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, marque esta casilla. |
Etiquetas | Para incluir metadatos que su organización rastrea sobre los datos, agregue etiquetas y seleccione sus nombres y valores. |
Resultados
Resultado | Tipo de salida |
---|---|
Importar Archivos | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Importar hoja de cálculo a tabla
Para importar una hoja de cálculo en una tabla y que devuelva un meta resultado de archivo, utilice un comando Importar hoja de cálculo en tabla .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-importfromspreadsheets/
Propiedades
Propiedades | Detalles |
---|---|
ID de tabla | Introduzca el identificador único de la Tabla en la que desea importar el archivo. |
Archivo ID | Introduzca el identificador único del archivo al que desea importar la hoja de cálculo (opcional). |
Nombre del archivo | Introduzca el nombre único que se dará al archivo al importarlo a la Tabla. |
Hoja de cálculo URL | Introduzca la URL completa de la hoja de cálculo de la que desea importar los datos. |
Ejecución 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, marque esta casilla. |
Etiquetas | Para incluir metadatos que su organización rastrea sobre los datos, agregue etiquetas y seleccione sus nombres y valores. |
Resultados
Resultado | Tipo de salida |
---|---|
Importar Archivos | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Lista de Conexiones
Para listar datos entre funciones de la plataforma Workiva, utilice el comando List connections .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-listconnections/
Propiedades | Detalles |
---|---|
Tipo de Orígenes | Utilice el menú desplegable para seleccionar el Tipo de Archivo o Elemento del que desea extraer los datos. |
Tipo de destino | Mediante el menú desplegable, seleccione el Tipo de Archivo o Elemento al que desea enviar los datos. |
Origen ID | Introduzca el identificador único del Archivo o ARTÍCULO del que se van a extraer los datos. |
ID de destino | Introduzca el identificador único del Archivo o Elemento al que desea enviar los datos. |
Nota: Su 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 salida |
---|---|
Conexiones | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Lista de errores de Archivo
Para listar los errores asociados a un Archivo, por ejemplo debidos a una importación, utilice el comando Listar errores de Archivo .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-geterrors/
Propiedades
Propiedades | Detalles |
---|---|
Archivo ID | Introduzca el ID del Archivo para el que desea obtener errores. |
Resultados
Resultado | Tipo de salida |
---|---|
Lista de errores | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Lista de Archivos
Para recuperar una Lista de Archivos en una Tabla Wdata y sus metadatos, utilice el comando List files .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-getfiles/
Propiedades
Propiedades | Detalles |
---|---|
ID de tabla | Introduzca el ID de la Tabla de la que obtener los Archivos. |
Resultados
Resultado | Tipo de salida |
---|---|
Lista de Archivos | Archivo |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Vistas dinámicas de listas
Para listar las vistas Wdata en su área de trabajo y recuperar sus metadatos, utilice un comando List pivot views .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-listpivotviews/
Propiedades
Ninguno
Resultados
Resultado | Tipo de salida |
---|---|
Vistas pivotantes | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Listas de consultas
Para listar las consultas Wdata en su área de trabajo y recuperar sus metadatos, utilice el comando List queries .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-listqueries/
Propiedades
Ninguno
Resultados
Resultado | Tipo de salida |
---|---|
Consultas | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Lista de resultados de la consulta
Para listar los resultados disponibles de una consulta Wdata, utilice el comando List query results .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-listqueryresults/
Propiedades
Propiedades | Detalles |
---|---|
ID de la consulta | Introduzca el ID de la consulta de la que desea obtener resultados. |
Resultados
Resultado | Tipo de salida |
---|---|
Resultados de la consulta | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Lista de selección de listas
Para listar todas las listas de valores de los parámetros de consulta de selección múltiple en su espacio de trabajo y recuperar sus metadatos, utilice un comando Listar listas de selección .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-listselectlists/
Propiedades
Ninguno
Resultados
Resultado | Tipo de salida |
---|---|
Lista de selección de listas | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Listas de hojas
Para listar todas las hojas de una hoja de cálculo y recuperar sus metadatos, utilice el comando List sheets .
Llamada API equivalente: https://developers.workiva.com/spreadsheets-v1/spreadsheets-getspreadsheet/
Propiedades
Propiedades | Detalles |
---|---|
ID de hoja de cálculo | Introduzca el identificador único de la hoja de cálculo para listar las hojas de. |
Resultados
Resultado | Tipo de salida |
---|---|
Hojas | JSON |
Nº de Hojas | Entero |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Listas de tablas
Para listar todas las tablas Wdata de su área de trabajo y recuperar sus metadatos, utilice el comando List tables .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-gettables/
Propiedades
Ninguno
Resultados
Resultado | Tipo de salida |
---|---|
Lista de tablas | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Lista de usuarios
Para recuperar una lista de detalles sobre los usuarios de una organización, utilice el comando List users . El usuario de integración asignado debe tener la función Org Admin 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 para mostrar e incluyen los de los usuarios:
- Nombres de usuario
- Direcciones de correo electrónico
- ID SAML
- Últimos inicios de sesión
- Afiliaciones al espacio de trabajo
- Licencias y funciones
Llamada a la API equivalente: https://developers.workiva.com/admin-v1/admin-getorgreportusers/
Propiedades
Propiedades | Detalles |
---|---|
ID de la organización | Introduzca el identificador único de la organización para la que se van a listar los usuarios. |
Resultados
Resultado | Tipo de salida |
---|---|
Informe de los usuarios | Archivo |
Recuento de registros. | Entero |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Sobrescribir datos de la Hoja
Para Borrar todas las celdas de una Hoja y Reemplazarlas por los valores proporcionados en el Archivo, utilice un comando Sobrescribir datos de Hoja .
Llamada API equivalente: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatedata/
Propiedades
Propiedades | Detalles |
---|---|
ID de hoja de cálculo | Introduzca el identificador único de la hoja de cálculo en la que desea sobrescribir los datos de la hoja. |
ID de hoja/nombre | Introduzca el nombre o el identificador único de la hoja en la que desea sobrescribir los datos. |
Archivo de datos | Introduzca el archivo CSV que contiene los datos con los que se rellenará la hoja. |
Delimitador | Introduzca el delimitador utilizado en Archivo de datos. |
Utilizar la API de la plataforma | Para utilizar el formato Introducido en de los valores de las celdas de la hoja de cálculo, marque esta casilla. |
Resultados
Resultado | Tipo de salida |
---|---|
Filas escritas | Entero |
Celdas escritas | Entero |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Publicar hoja de cálculo
Para publicar los vínculos en una hoja de cálculo, utilice el comando Publicar hoja de cálculo .
Llamada API equivalente: https://developers.workiva.com/spreadsheets-v1/spreadsheets-publish/
Propiedades
Propiedades | Detalles |
---|---|
ID de hoja de cálculo | Introduzca el identificador único de la hoja de cálculo a publicar. |
Publicar todos los enlaces | Seleccione qué enlaces de la hoja de cálculo desea publicar:
|
Resultados
Resultado | Tipo de salida |
---|---|
Mensaje | Cadena |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Actualizar conexión
Para Actualizar una conexión específica basándose en su ID, utilice el comando Actualizar conexión .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-refreshconnection/
Propiedades
Propiedades | Detalles |
---|---|
ID de conexión | Introduzca el identificador único de la conexión para actualizar. |
Utilizar los parámetros del Origen Anterior | Marque esta casilla para utilizar los parámetros de origen de la ejecución anterior; esto invalida cualquier otro parámetro de origen que haya especificado. Esta entrada será ignorada por el punto final "Actualizar lote de conexiones". |
Parámetros de Origen |
Introduzca los parámetros que se enviarán a la fuente cuando se actualice correctamente. (Estos parámetros se ignorarán si está habilitada la opción "Utilizar parámetros de origen anteriores"). |
Utilizar parámetros de destino anteriores | Marque esta casilla para utilizar los parámetros de destino de la ejecución anterior; esto invalida cualquier otro parámetro de destino que haya especificado. Esta entrada será ignorada por el punto final "Actualizar lote de conexiones". |
Parámetros de destino* |
Introduzca los parámetros que se enviarán al destino cuando se actualice correctamente. (Estos parámetros se ignorarán si está habilitada la opción "Utilizar parámetros de destino anteriores"). |
Nota: Actualmente no se admiten parámetros de selección múltiple.
Resultados
Resultado | Tipo de salida |
---|---|
Actualizar Estado | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Actualizar lote de conexiones
Para Actualizar varias conexiones a la vez, utilice el comando Actualizar lote de conexiones .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-refreshbatch/
Propiedades
Propiedades | Detalles |
---|---|
Conexiones |
Habilita o deshabilita el uso de variables. Cuando está Habilitado:
|
ID de conexión | Introduzca el identificador único de la conexión para actualizar. |
Utilizar los parámetros del Origen Anterior | Marque esta casilla para utilizar los parámetros de origen de la ejecución anterior; esto invalida cualquier otro parámetro de origen que haya especificado. Esta entrada será ignorada por el punto final "Actualizar lote de conexiones". |
Parámetros de origen |
Introduzca los parámetros que se enviarán a la fuente cuando se actualice correctamente. (Estos parámetros se ignorarán si está habilitada la opción "Utilizar parámetros de origen anteriores"). |
Utilizar parámetros de destino anteriores | Marque esta casilla para utilizar los parámetros de destino de la ejecución anterior; esto invalida cualquier otro parámetro de destino que haya especificado. Esta entrada será ignorada por el punto final "Actualizar lote de conexiones". |
Parámetros de destino |
Introduzca los parámetros que se enviarán al destino cuando se actualice correctamente. (Estos parámetros se ignorarán si está habilitada la opción "Utilizar parámetros de destino anteriores"). |
Resultados
Resultado | Tipo de salida |
---|---|
Estado de Actualizar lotes . | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Quitar el borde
Este comando sólo está disponible a través de la API de la plataforma. Para Quitar un borde, utilice el punto final Crear nuevo registro edita .
Recuperar una Lista de registros.
Para obtener una lista de registros que coincidan con los filtros proporcionados, utilice el comando Recuperar una lista de registros . Siempre se necesita al menos un Filtrar.
Llamada a la API equivalente: https://developers.workiva.com/platform-v1/platform-getrecords/
Propiedades
Propiedades | Detalles |
---|---|
Expandir |
Devuelve los recursos relacionados en línea con el recurso principal. Opciones:
|
Filtrar | Propiedades por las que filtrar los resultados. |
Resultados
Resultado | Tipo de salida |
---|---|
Estado de Actualizar lotes . | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Recuperar una Lista de Tipos
Para obtener una lista de tipos de registro y sus atributos, utilice el comando Recuperar una lista de tipos . Este comando le permite saber qué esperar recuperando registros.
Llamada a la API equivalente: https://developers.workiva.com/platform-v1/platform-gettypes/
Propiedades
Propiedades | Detalles |
---|---|
Expandir |
Devuelve los recursos relacionados en línea con el recurso principal. Opciones:
|
Resultados
Resultado | Tipo de salida |
---|---|
Estado de Actualizar lotes . | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Recuperar un único registro.
Para recuperar un único registro, utilice 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
Propiedades | Detalles |
---|---|
Expandir |
Devuelve los recursos relacionados en línea con el recurso principal. Opciones:
|
ID de registro. | Introduzca el identificador único del registro. |
Resultados
Resultado | Tipo de salida |
---|---|
Estado de Actualizar lotes . | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Recuperar un solo tipo
Para recuperar un único registro, utilice 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
Propiedades | Detalles |
---|---|
Expandir |
Devuelve los recursos relacionados en línea con el recurso principal. Opciones:
|
ID de registro. | Introduzca el identificador único del registro. |
Resultados
Resultado | Tipo de salida |
---|---|
Estado de Actualizar lotes . | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Ejecutar consulta
Para ejecutar una consulta de Wdata y recuperar sus resultados, utilice el comando Ejecutar consulta .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-runquery/
Propiedades
Propiedades | Detalles |
---|---|
ID de la consulta | Introduzca el ID de la consulta a ejecutar. |
Parámetros | Si la consulta tiene parámetros definidos, agregue un mapa con sus nombres y valores. Nota: Introduzca los valores de cualquier parámetro de selección múltiple en Multi-select params. |
Ejecución asíncrona | Para ejecutar la consulta de forma asíncrona, y no esperar hasta que la consulta finalice para completar el comando, marque esta casilla. |
Parámetros de selección múltiple | Si la consulta tiene parámetros de selección múltiple definidos, agregue el nombre y los valores de cada uno. |
Resultados
Resultado | Tipo de salida |
---|---|
Resultados de la consulta | JSON |
Nota: La salida Query Result incluye un ID, que puede utilizarse para descargar y exportar los resultados.
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Ejecutar Informe
Para ejecutar un Informe guardado en la cuenta de la base de datos SOX y Auditoría Interna de su organización y devolver sus resultados como un archivo CSV, utilice un comando Ejecutar informe .
Llamada a la API equivalente: https://developers.workiva.com/platform-v1/platform-getreportascsv/
Propiedades
Propiedades | Detalles |
---|---|
ID del Informe | Introduzca el identificador único del Informe que contiene el Informe guardado. |
Vista previa del contenido | Para incluir una vista previa de los resultados del Informe en el registro del comando, marque esta casilla. |
Resultados
Resultado | Tipo de salida |
---|---|
Informe | Archivo |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Fijar borde
Este comando sólo está disponible a través de la API de la plataforma. Para establecer un borde, utilice el punto final Crear nuevo registro edita .
Establecer propiedades de registro.
Este comando sólo está disponible a través de la API de la plataforma. Para establecer las propiedades del registro, utilice el punto final Crear nuevas ediciones de registro .
Desimportar Archivo de la Tabla
Para Importar y Quitar un Archivo de una Tabla Wdata, utilice el comando Un-import file From table .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-unimportfile/
Propiedades
Propiedades | Detalles |
---|---|
ID de tabla | Introduzca el identificador único de la Tabla de la que desea Quitar el Archivo. |
Archivo ID | Introduzca el identificador único del Archivo a Quitar de la Tabla. |
Resultados
Resultado | Tipo de salida |
---|---|
Importar archivos | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Actualizar vista pivotante
Para actualizar los metadatos de una vista Wdata, utilice el comando Update pivot view .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-updatepivotview/
Propiedades
Propiedades | Detalles |
---|---|
id.|Id. | Introduzca el ID de la vista que desea actualizar. |
Nombre | Introduzca el nombre nuevo de la vista. |
ID de la consulta | Introduzca el ID de la consulta a partir de la cual se va a crear la vista. |
ID del resultado de la consulta | Introduzca el ID del resultado de la consulta a partir del cual se va a crear la vista. |
Metadatos adicionales | Introduzca los metadatos definidos por el usuario para adjuntar a la vista, como objeto JSON (opcional). |
Resultados
Resultado | Tipo de salida |
---|---|
Vista pivotante | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Actualizado definición de consulta
Para actualizar las propiedades de una consulta de Wdata, utilice un comando Actualizar definición de consulta .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-updatequery/
Propiedades
Propiedades | Detalles |
---|---|
ID de la consulta | Introduzca el ID de la consulta que desea actualizar. |
Nombre | Introduzca el nombre nuevo de la consulta. |
Descripción | Introduzca la nueva descripción de la consulta. |
ID del resultado principal | Si se especifica, introduzca el ID del resultado por defecto que se rellenará con los resultados de la consulta. |
Texto de la consulta | Introduzca la definición de la consulta como sintaxis de Presto SQL, como lo haría en en el editor SQL de la consulta. |
Temporal | Para generar la consulta sólo temporalmente de modo que no aparezca en su área de trabajo, marque esta casilla. |
Parámetros | Introduzca los parámetros necesarios para ejecutar la consulta. |
Resultados
Resultado | Tipo de salida |
---|---|
Consulta | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Actualizar lista de selección
Para actualizar las propiedades o Elementos de una lista de valores de un parámetro de consulta de selección múltiple, utilice un comando Actualizar lista de selección .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-updateselectlist/
Propiedades
Propiedades | Detalles |
---|---|
id.|Id. | Introduzca el ID de la Lista a actualizar. |
Nombre | Introduzca el nuevo nombre de la Lista de selección. |
Descripción | Introduzca la nueva descripción de la Lista de selección. |
Tipo de valor | Seleccione el tipo de datos de los valores de la lista, como cadena o entero. |
Valores | Introduzca los valores de la Lista, incluidas las actualizaciones. |
Resultados
Resultado | Tipo de salida |
---|---|
Actualizar lista de selección | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Actualizar metadatos de la Hoja
Para actualizar los metadatos de una hoja en una hoja de cálculo, utilice el comando Actualizar metadatos de hoja .
Llamada API equivalente: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatesheet/
Propiedades
Propiedades | Detalles |
---|---|
ID de hoja de cálculo | Introduzca el identificador único de la hoja de cálculo con la hoja en la que desea actualizar los metadatos. |
ID de hoja/nombre | Introduzca el nombre o el identificador único de la hoja en la que desea actualizar los metadatos. |
Nombre | Introduzca el nuevo nombre de la hoja. |
Índice de Hojas | Introduzca el nuevo índice de la hoja en la hoja de cálculo. Por defecto, los comandos actualizan la hoja como la hoja Arriba. |
ID de hoja de los padres | Introduzca el ID de la hoja padre bajo la que se va a crear la hoja. Para Agregar a la hoja de cálculo raíz, dejar en blanco. |
Resultados
Ninguno
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Actualizar metadatos de la hoja de cálculo
Para actualizar los metadatos de una hoja de cálculo, utilice un comando Actualizar metadatos de hoja de cálculo .
Llamada API equivalente: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatespreadsheet/
Propiedades
Propiedades | Detalles |
---|---|
ID de hoja de cálculo | Introduzca el identificador único de la hoja de cálculo con la hoja en la que desea actualizar los metadatos. |
Nombre | Introducir nombre nuevo de la hoja de cálculo... |
Resultados
Ninguno
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Tabla de actualización
Para actualizar las columnas de una tabla Wdata, utilice el comando Actualizar tabla .
Llamada a la API equivalente: https://developers.workiva.com/wdata-v1/wdata-updatetable/
Propiedades
Propiedades | Detalles |
---|---|
ID de tabla | Introduzca el identificador único de la Tabla a actualizar. |
Nombre | Introduzca el nombre de la Tabla a actualizar. |
Descripción | Introduzca una descripción de la Tabla a actualizar. |
Tipo | Seleccione si desea actualizar un Dato-o hecho-o Lookup-o dimensión-tabla |
Columnas | Agregar las columnas para actualizar la tabla con. Para cada columna, introduzca su nombre, tipo de datos, alias y descripción. Para Mode, deje el valor por defecto de Nullable. |
Resultados
Resultado | Tipo de salida |
---|---|
Tabla | JSON |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |
Escriba los datos de la Hoja
Para escribir los datos de un conjunto de datos CSV en una región específica de una hoja, utilice el comando Escribir datos de hoja .
Llamada API equivalente: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatedata/
Propiedades
Propiedades | Detalles |
---|---|
ID de hoja de cálculo | Introduzca el identificador único de la hoja de cálculo con la hoja en la que se escribirán los datos. |
ID de hoja/nombre | Introduzca el identificador único de la Hoja en la que se escribirán los datos. |
Archivo de datos | Introduzca el Archivo CSV con los datos a escribir en la hoja. El rango de los datos no debe exceder la Región. |
Delimitador | Introduzca el delimitador utilizado en Archivo de datos. |
Región | Introduzca una representación A1 de la celda o rango de celdas de la hoja en la que se escribirán los datos. Para tener el rango sin límites en alguna o todas las direcciones, deje en blanco la columna o fila correspondiente. |
Utilizar async |
Para cargar los datos de forma asíncrona, como en el caso de un gran conjunto de datos, marque esta casilla. Nota: Cuando se utiliza async, debe agregar su propio sondeo para determinar el estado del trabajo. |
Utilizar la API de la plataforma |
Para utilizar el formato entered-in de los valores de celda Region , marque esta casilla. Esto forzará al comando a usar el actualizar valores en un endpoint de rango en lugar del de la API de hoja de cálculo escribir datos en un endpoint de región. Nota: Este comando siempre se ejecutará de forma asíncrona cuando se utilice la API de la plataforma. Debe Agregar su propio sondeo para determinar el Estado del trabajo. |
Resultados
Resultado | Tipo de salida |
---|---|
Filas escritas | Entero |
Celdas escritas | Entero |
Códigos de salida
Código | Tipo | Detalles |
---|---|---|
0 | Éxito | Éxito |
1 | Se ha producido un error | Se ha producido un error |