Los comandos de este artículo se utilizan con el conector Workiva Cadenas. Para encontrar los identificadores de tus cadenas, consulta este artículo sobre encontrar identificadores en Workiva.
Conector a la API Rest de Workiva
A menos que se te indique lo contrario, establece el valor para que coincida con tu Appspot.
| Entrada | Tipo | AppSpot | Detalle |
| URL base | TextField | Prod (US) | https://h.app.wdesk.com/s/wdata/oc/api/ |
| URL base | TextField | Prod-EU | https://h.eu.wdesk.com/s/wdata/oc/api/ |
| URL base | TextField | Prod-APAC | https://h.apac.wdesk.com/s/wdata/oc/api/ |
Ejecutar cadena
Ejecuta una cadena y espera a que se complete.
Llamada equivalente a la API: https://developers.workiva.com/chains-v1/chains-startchain/
Nota: Aunque este comando puede utilizarse cuando se necesita un ID de cadena dinámico, en la mayoría de los casos recomendamos utilizar un evento Ejecutando cadena. El evento Ejecutar cadena está más ligado a la cadena que se está ejecutando y proporciona una experiencia de usuario más sencilla.
Entradas
| Entrada | Tipo | Detalle |
| ID del entorno | TextField | El ID del entorno. |
| ID de cadena | TextField | El ID de la cadena. |
| Variables en tiempo de ejecución | CampoGrupo | Los valores de las variables de tiempo de ejecución utilizadas en la cadena. |
| Intervalo de sondeo | CampoNumérico | Opcional: La cantidad de tiempo (en segundos) que hay que esperar antes de comprobar si la cadena se ha completado. Predeterminado como cinco segundos, solo debe ajustarse si esperas que tu cadena funcione durante mucho tiempo. |
Resultados
| Resultado | Tipo de resultado |
| Ejecución de cadena | Archivo |
Códigos de salida
| Código de salida | Tipo | Detalle |
| 0 | Correcto | Correcto |
| 1 | Se ha producido un error | Fallo general |
| 2 | Se ha producido un error | Se ha producido un error de Autenticación al . |
Buscar ejecuciones de cadena por valor de entrada
Recupera todas las ejecuciones de cadena que contengan el texto proporcionado.
Llamada equivalente a la API: https://developers.workiva.com/chains-v1/chains-chaininputssearch/
Entradas
| Entrada | Tipo | Detalle |
| ID del entorno | TextField | El ID del entorno que estás buscando. |
| Buscar texto | TextField | El valor de entrada que hay que buscar. |
| Resultados máximos | CampoNumérico | El número máximo de resultados a recuperar. Utiliza 0 para recuperar todos los elementos. |
Resultados
| Resultado | Tipo de resultado |
| Ejecuciones de cadena | Archivo |
| Número de ejecuciones de cadena | Entero |
Códigos de salida
| Código de salida | Tipo | Detalle |
| 0 | Correcto | Correcto |
| 1 | Se ha producido un error | Fallo general |
| 2 | Se ha producido un error | Se ha producido un error de Autenticación al . |
Obtener cadena
Recupera las propiedades de una cadena.
Llamada a la API equivalente: https://developers.workiva.com/chains-v1/chains-getchain/
Entradas
| Entrada | Tipo | Detalle |
| ID del entorno | TextField | El ID del entorno de destino. |
| ID de cadena | TextField | El ID de la cadena. |
Resultados
| Resultado | Tipo de resultado |
| Cadena | Archivo |
Códigos de salida
| Código de salida | Tipo | Detalle |
| 0 | Correcto | Correcto |
| 1 | Se ha producido un error | Fallo general |
| 2 | Se ha producido un error | Se ha producido un error de Autenticación al . |
Obtener comandos de cadenas
Recupera las propiedades de todos los comandos de una cadena.
Llamada equivalente a la API: https://developers.workiva.com/chains-v1/chains-getcommands/
Entradas
| Entrada | Tipo | Detalle |
| ID del entorno | TextField | El ID del entorno de destino. |
| ID de cadena | TextField | El ID de la cadena. |
Resultados
| Resultado | Tipo de resultado |
| Comandos | Archivo |
Códigos de salida
| Código de salida | Tipo | Detalle |
| 0 | Correcto | Correcto |
| 1 | Se ha producido un error | Fallo general |
| 2 | Se ha producido un error | Se ha producido un error de Autenticación al . |
Obtener historial de cadenas
Recupera los recorridos históricos de una cadena.
Llamada equivalente a la API: https://developers.workiva.com/chains-v1/chains-chainrunhistory/
Entradas
| Entrada | Tipo | Detalle |
| ID del entorno | TextField | El ID del entorno de destino. |
| ID de cadena | TextField | El ID de la cadena. |
| Resultados máximos | CampoNumérico | El número máximo de resultados a recuperar. Utiliza 0 para recuperar todos los elementos. |
| Fecha de inicio | TextField | Filtra las ejecuciones en cadena que se produjeron después de la fecha de inicio especificada. Este valor puede utilizar el formato ISO8601 o una marca de tiempo Unix. |
| Fecha final | TextField | Filtra las Cadenas que se hayan ejecutado antes de la Fecha de finalización especificada. Este valor puede utilizar el formato ISO8601 o una marca de tiempo Unix. |
Resultados
| Resultado | Tipo de resultado |
| Ejecuciones de cadena | Archivo |
| Número de ejecuciones de cadena | Entero |
Códigos de salida
| Código de salida | Tipo | Detalle |
| 0 | Correcto | Correcto |
| 1 | Se ha producido un error | Fallo general |
| 2 | Se ha producido un error | Se ha producido un error de Autenticación al . |
Obtener ejecución de cadena
Obtén los detalles de la ejecución de una cadena.
Llamada equivalente a la API: https://developers.workiva.com/chains-v1/chains-getchainrun/
Entradas
| Entrada | Tipo | Detalle |
| ID de ejecución de cadena | TextField | El ID de la cadena ejecutada. |
Resultados
| Resultado | Tipo de resultado |
| Ejecución de cadena | Archivo |
Códigos de salida
| Código de salida | Tipo | Detalle |
| 0 | Correcto | Correcto |
| 1 | Se ha producido un error | Fallo general |
| 2 | Se ha producido un error | Se ha producido un error de Autenticación al . |
Obtener ejecución de cadena con nodos
Obtén los detalles de la ejecución de una cadena incluyendo los detalles del nodo.
Llamada equivalente a la API: https://developers.workiva.com/chains-v1/chains-getchainrunnodes/
Entradas
| Entrada | Tipo | Detalle |
| ID de ejecución de cadena | TextField | El ID de la cadena ejecutada. |
Resultados
| Resultado | Tipo de resultado |
| Ejecución de cadena | Archivo |
Códigos de salida
| Código de salida | Tipo | Detalle |
| 0 | Correcto | Correcto |
| 1 | Se ha producido un error | Fallo general |
| 2 | Se ha producido un error | Se ha producido un error de Autenticación al . |
Consigue Cadenas
Recupera todas las cadenas y sus propiedades en un entorno concreto.
Llamada equivalente a la API: https://developers.workiva.com/chains-v1/chains-getchains/
Entradas
| Entrada | Tipo | Detalle |
| ID del entorno | TextField | El ID del entorno de destino. |
Resultados
| Resultado | Tipo de resultado |
| Cadenas | Archivo |
| Número de Cadenas | Entero |
Códigos de salida
| Código de salida | Tipo | Detalle |
| 0 | Correcto | Correcto |
| 1 | Se ha producido un error | Fallo general |
| 2 | Se ha producido un error | Se ha producido un error de Autenticación al . |
Obtener entorno
Recupera las propiedades de un entorno concreto.
Llamada equivalente a la API: https://developers.workiva.com/chains-v1/chains-getenvironment/
Entradas
| Entrada | Tipo | Detalle |
| ID de espacio de trabajo | TextField | El ID del espacio de trabajo donde vive el entorno. |
| ID del entorno | TextField | El ID del entorno de destino. |
Resultados
| Resultado | Tipo de resultado |
| Entorno | Archivo |
Códigos de salida
| Código de salida | Tipo | Detalle |
| 0 | Correcto | Correcto |
| 1 | Se ha producido un error | Fallo general |
| 2 | Se ha producido un error | Se ha producido un error de Autenticación al . |
Obtener entornos
Recupera una lista de Entornos en un espacio de trabajo.
Llamada equivalente a la API: https://developers.workiva.com/chains-v1/chains-getenvironments/
Entradas
| Entrada | Tipo | Detalle |
| ID de espacio de trabajo | TextField | El ID del espacio de trabajo que contiene los entornos. |
Resultados
| Resultado | Tipo de resultado |
| Entornos | Archivo |
| Número de entornos | Entero |
Códigos de salida
| Código de salida | Tipo | Detalle |
| 0 | Correcto | Correcto |
| 1 | Se ha producido un error | Fallo general |
| 2 | Se ha producido un error | Se ha producido un error de Autenticación al . |
Obtener espacio de trabajo
Recupera un espacio de trabajo y sus propiedades.
Llamada equivalente a la API: https://developers.workiva.com/chains-v1/chains-getworkspace/
Entradas
| Entrada | Tipo | Detalle |
| ID de espacio de trabajo | TextField | El ID del espacio de trabajo. |
Resultados
| Resultado | Tipo de resultado |
| Espacio de trabajo | Archivo |
Códigos de salida
| Código de salida | Tipo | Detalle |
| 0 | Correcto | Correcto |
| 1 | Se ha producido un error | Fallo general |
| 2 | Se ha producido un error | Se ha producido un error de Autenticación al . |
Obtener espacios de trabajo
Recupera una lista de todos los espacios de trabajo de una empresa.
Llamada equivalente a la API: https://developers.workiva.com/chains-v1/chains-getworkspaces/
Entradas
Ninguno
Resultados
| Resultado | Tipo de resultado |
| Espacios de trabajo | Archivo |
| Número de espacios de trabajo | Entero |
Códigos de salida
| Código de salida | Tipo | Detalle |
| 0 | Correcto | Correcto |
| 1 | Se ha producido un error | Fallo general |
| 2 | Se ha producido un error | Se ha producido un error de Autenticación al . |
Publicar grupo de asignación
Publica un Grupo de asignación, según lo especificado por el GUID del Grupo de asignación.
Llamada a la API equivalente: https://developers.workiva.com/chains-v1/chains-publish/
Entradas
| Entrada | Tipo | Detalle |
| Asignación GUID de Grupo | TextField | El GUID del grupo de asignación. |
Resultados
Ninguno
Códigos de salida
| Código de salida | Tipo | Detalle |
| 0 | Correcto | Correcto |
| 1 | Se ha producido un error | Fallo general |
| 2 | Se ha producido un error | Se ha producido un error de Autenticación al . |
Buscar ejecuciones de cadenas
Busca las ejecuciones de cadenas que coincidan con los filtros dados.
Llamada equivalente a la API: https://developers.workiva.com/chains-v1/chains-chainfiltersearch/
Nota: El parámetro environment_id no es necesario para superusuarios o administradores de org.
Entradas
| Entrada | Tipo | Detalle |
| Filtros | CampoGrupo | Los filtros para aplicar a la búsqueda. |
| Resultados máximos | CampoNumérico | El número máximo de resultados a recuperar. Utiliza 0 para recuperar todos los elementos. |
Resultados
| Resultado | Tipo de resultado |
| Ejecuciones de cadena | Archivo |
| Número de ejecuciones de cadena | Entero |
Códigos de salida
| Código de salida | Tipo | Detalle |
| 0 | Correcto | Correcto |
| 1 | Se ha producido un error | Fallo general |
| 2 | Se ha producido un error | Se ha producido un error de Autenticación al . |
Cadena de parada
Detiene una Cadena en ejecución.
Llamada equivalente a la API: https://developers.workiva.com/chains-v1/chains-stopchain/
Entradas
| Entrada | Tipo | Detalle |
| ID de ejecución de cadena | TextField | El ID de la ejecución de cadena a detener. |
Resultados
| Resultado | Tipo de resultado |
| Ejecución de cadena | Archivo |
Códigos de salida
| Código de salida | Tipo | Detalle |
| 0 | Correcto | Correcto |
| 1 | Se ha producido un error | Fallo general |
| 2 | Se ha producido un error | Se ha producido un error de Autenticación al . |
Subir reglas de asignación
Subidas de un conjunto de reglas de grupo de asignación, según lo especificado por el GUID del grupo de asignación.
Llamada equivalente a la API: https://developers.workiva.com/chains-v1/chains-updaterules/
Entradas
| Entrada | Tipo | Detalle |
| Asignación GUID de Grupo | TextField | El GUID del grupo de asignación. |
| Modo de subida | Campo desplegable | El modo de subida. Cuando mode=published, la versión publicada actualmente se actualiza y se vuelve a publicar. Cuando mode=draft, solo se actualiza el borrador. Cuando mode=both, se actualizan tanto la versión publicada como el borrador. |
| Archivo de Reglas de Asignación. | CampoArchivo | El archivo que contiene las reglas de asignación a subir. |
Resultados
| Resultado | Tipo de resultado |
| Subir errores | Archivo |
| Subir resultado | Archivo |
| Número de reglas subidas | Entero |
| Número de errores | Entero |
Códigos de salida
| Código de salida | Tipo | Detalle |
| 0 | Correcto | Correcto |
| 1 | Se ha producido un error | Fallo general |
| 2 | Se ha producido un error | Se ha producido un error de Autenticación al . |