Os comandos deste artigo são usados com o conector Cadeias Workiva. Para encontrar os IDs de sua cadeia, consulte este artigo em para encontrar IDs na Workiva.
Conector para a API Workiva Rest
Salvo instruções em contrário, defina o valor para corresponder ao seu Appspot.
| Entrada | Tipo | AppSpot | Detalhes |
| URL de base | TextField | Prod (EUA) | https://h.app.wdesk.com/s/wdata/oc/api/ |
| URL de base | TextField | Prod-EU | https://h.eu.wdesk.com/s/wdata/oc/api/ |
| URL de base | TextField | Prod-APAC | https://h.apac.wdesk.com/s/wdata/oc/api/ |
Executar cadeia
Executa uma cadeia e aguarda a sua conclusão.
Chamada de API equivalente: https://developers.workiva.com/chains-v1/chains-startchain/
Observação: Embora esse comando possa ser usado quando uma ID de cadeia dinâmica for necessária, recomendamos o uso de um evento Executar cadeia na maioria dos casos. O evento Executar cadeia está mais intimamente ligado à cadeia que está sendo executada e oferece uma experiência de usuário mais simples.
Entradas
| Entrada | Tipo | Detalhes |
| ID do ambiente | TextField | A ID do ambiente. |
| ID da cadeia | TextField | A ID da cadeia. |
| Variáveis de tempo de execução | GroupField | Os valores das variáveis de tempo de execução usadas na cadeia. |
| Intervalo de pesquisa | NumberField | Opcional: A quantidade de tempo (em segundos) a ser aguardada antes de verificar se a cadeia foi concluída. O padrão é cinco segundos e só deve ser ajustado se você espera que a corrente funcione por um longo período. |
Saídas
| Saída | Tipo de saída |
| Corrida em cadeia | Arquivo |
Códigos de saída
| Código de saída | Tipo | Detalhes |
| 0 | Sucesso | Sucesso |
| 1 | Erro | Falha geral |
| 2 | Erro | Falha na autenticação |
Localizar execuções de cadeia por valor de entrada
Recupera todas as execuções em cadeia que contêm o texto fornecido.
Chamada de API equivalente: https://developers.workiva.com/chains-v1/chains-chaininputssearch/
Entradas
| Entrada | Tipo | Detalhes |
| ID do ambiente | TextField | O ID do ambiente que você está pesquisando. |
| Pesquisar texto | TextField | O valor de entrada a ser pesquisado. |
| Resultados máximos | NumberField | O número máximo de resultados a serem recuperados. Use 0 para recuperar todos os itens. |
Saídas
| Saída | Tipo de saída |
| Corridas em cadeia | Arquivo |
| Número de execuções de corrente | Inteiro |
Códigos de saída
| Código de saída | Tipo | Detalhes |
| 0 | Sucesso | Sucesso |
| 1 | Erro | Falha geral |
| 2 | Erro | Falha na autenticação |
Obter corrente
Recupera as propriedades de uma cadeia.
Chamada de API equivalente: https://developers.workiva.com/chains-v1/chains-getchain/
Entradas
| Entrada | Tipo | Detalhes |
| ID do ambiente | TextField | A ID do ambiente de destino. |
| ID da cadeia | TextField | A ID da cadeia. |
Saídas
| Saída | Tipo de saída |
| Cadeia | Arquivo |
Códigos de saída
| Código de saída | Tipo | Detalhes |
| 0 | Sucesso | Sucesso |
| 1 | Erro | Falha geral |
| 2 | Erro | Falha na autenticação |
Comandos Obter cadeia
Recupera propriedades de todos os comandos em uma cadeia.
Chamada de API equivalente: https://developers.workiva.com/chains-v1/chains-getcommands/
Entradas
| Entrada | Tipo | Detalhes |
| ID do ambiente | TextField | A ID do ambiente de destino. |
| ID da cadeia | TextField | A ID da cadeia. |
Saídas
| Saída | Tipo de saída |
| Comandos | Arquivo |
Códigos de saída
| Código de saída | Tipo | Detalhes |
| 0 | Sucesso | Sucesso |
| 1 | Erro | Falha geral |
| 2 | Erro | Falha na autenticação |
Obter histórico da cadeia
Recupera o histórico de execuções da cadeia para uma cadeia.
Chamada de API equivalente: https://developers.workiva.com/chains-v1/chains-chainrunhistory/
Entradas
| Entrada | Tipo | Detalhes |
| ID do ambiente | TextField | A ID do ambiente de destino. |
| ID da cadeia | TextField | A ID da cadeia. |
| Resultados máximos | NumberField | O número máximo de resultados a serem recuperados. Use 0 para recuperar todos os itens. |
| Data de início | TextField | Filtra as execuções em cadeia que ocorreram após a data de início especificada. Esse valor pode usar o formato ISO8601 ou um carimbo de data/hora Unix. |
| Data final | TextField | Filtra as execuções em cadeia que ocorreram antes da data final especificada. Esse valor pode usar o formato ISO8601 ou um carimbo de data/hora Unix. |
Saídas
| Saída | Tipo de saída |
| Corridas em cadeia | Arquivo |
| Número de execuções de corrente | Inteiro |
Códigos de saída
| Código de saída | Tipo | Detalhes |
| 0 | Sucesso | Sucesso |
| 1 | Erro | Falha geral |
| 2 | Erro | Falha na autenticação |
Obter execução em cadeia
Obtenha os detalhes de uma execução em cadeia.
Chamada de API equivalente: https://developers.workiva.com/chains-v1/chains-getchainrun/
Entradas
| Entrada | Tipo | Detalhes |
| ID da execução da cadeia | TextField | A ID da execução da cadeia. |
Saídas
| Saída | Tipo de saída |
| Corrida em cadeia | Arquivo |
Códigos de saída
| Código de saída | Tipo | Detalhes |
| 0 | Sucesso | Sucesso |
| 1 | Erro | Falha geral |
| 2 | Erro | Falha na autenticação |
Obter execução em cadeia com nós
Obtenha os detalhes de uma execução em cadeia, incluindo os detalhes do nó.
Chamada de API equivalente: https://developers.workiva.com/chains-v1/chains-getchainrunnodes/
Entradas
| Entrada | Tipo | Detalhes |
| ID da execução da cadeia | TextField | A ID da execução da cadeia. |
Saídas
| Saída | Tipo de saída |
| Corrida em cadeia | Arquivo |
Códigos de saída
| Código de saída | Tipo | Detalhes |
| 0 | Sucesso | Sucesso |
| 1 | Erro | Falha geral |
| 2 | Erro | Falha na autenticação |
Obter correntes
Recupera todas as cadeias e suas propriedades em um ambiente específico.
Chamada de API equivalente: https://developers.workiva.com/chains-v1/chains-getchains/
Entradas
| Entrada | Tipo | Detalhes |
| ID do ambiente | TextField | A ID do ambiente de destino. |
Saídas
| Saída | Tipo de saída |
| Correntes | Arquivo |
| Número de correntes | Inteiro |
Códigos de saída
| Código de saída | Tipo | Detalhes |
| 0 | Sucesso | Sucesso |
| 1 | Erro | Falha geral |
| 2 | Erro | Falha na autenticação |
Obter ambiente
Recupera propriedades para um ambiente específico.
Chamada de API equivalente: https://developers.workiva.com/chains-v1/chains-getenvironment/
Entradas
| Entrada | Tipo | Detalhes |
| ID do espaço de trabalho | TextField | A ID do espaço de trabalho onde o ambiente reside. |
| ID do ambiente | TextField | A ID do ambiente de destino. |
Saídas
| Saída | Tipo de saída |
| Meio ambiente | Arquivo |
Códigos de saída
| Código de saída | Tipo | Detalhes |
| 0 | Sucesso | Sucesso |
| 1 | Erro | Falha geral |
| 2 | Erro | Falha na autenticação |
Obter ambientes
Recupera uma lista de ambientes em um espaço de trabalho.
Chamada de API equivalente: https://developers.workiva.com/chains-v1/chains-getenvironments/
Entradas
| Entrada | Tipo | Detalhes |
| ID do espaço de trabalho | TextField | A ID do espaço de trabalho que contém os ambientes. |
Saídas
| Saída | Tipo de saída |
| Ambientes | Arquivo |
| Número de ambientes | Inteiro |
Códigos de saída
| Código de saída | Tipo | Detalhes |
| 0 | Sucesso | Sucesso |
| 1 | Erro | Falha geral |
| 2 | Erro | Falha na autenticação |
Obter espaço de trabalho
Recupera um espaço de trabalho e suas propriedades.
Chamada de API equivalente: https://developers.workiva.com/chains-v1/chains-getworkspace/
Entradas
| Entrada | Tipo | Detalhes |
| ID do espaço de trabalho | TextField | A ID do espaço de trabalho. |
Saídas
| Saída | Tipo de saída |
| Espaço de trabalho | Arquivo |
Códigos de saída
| Código de saída | Tipo | Detalhes |
| 0 | Sucesso | Sucesso |
| 1 | Erro | Falha geral |
| 2 | Erro | Falha na autenticação |
Obter espaços de trabalho
Recupera uma lista de todos os espaços de trabalho de uma empresa.
Chamada de API equivalente: https://developers.workiva.com/chains-v1/chains-getworkspaces/
Entradas
Nenhum
Saídas
| Saída | Tipo de saída |
| Espaços de trabalho | Arquivo |
| Número de espaços de trabalho | Inteiro |
Códigos de saída
| Código de saída | Tipo | Detalhes |
| 0 | Sucesso | Sucesso |
| 1 | Erro | Falha geral |
| 2 | Erro | Falha na autenticação |
Publicar grupo de mapeamento
Publica um grupo de mapeamento, conforme especificado pelo GUID do grupo de mapeamento.
Chamada de API equivalente: https://developers.workiva.com/chains-v1/chains-publish/
Entradas
| Entrada | Tipo | Detalhes |
| GUID do grupo de mapeamento | TextField | O GUID do grupo de mapeamento. |
Saídas
Nenhum
Códigos de saída
| Código de saída | Tipo | Detalhes |
| 0 | Sucesso | Sucesso |
| 1 | Erro | Falha geral |
| 2 | Erro | Falha na autenticação |
Pesquisa de execuções em cadeia
Procura por execuções em cadeia que correspondam aos filtros fornecidos.
Chamada de API equivalente: https://developers.workiva.com/chains-v1/chains-chainfiltersearch/
Observação: O parâmetro environment_id não é necessário para superusuários ou administradores de organizações.
Entradas
| Entrada | Tipo | Detalhes |
| Filtros | GroupField | Os filtros a serem aplicados à pesquisa. |
| Resultados máximos | NumberField | O número máximo de resultados a serem recuperados. Use 0 para recuperar todos os itens. |
Saídas
| Saída | Tipo de saída |
| Corridas em cadeia | Arquivo |
| Número de execuções de corrente | Inteiro |
Códigos de saída
| Código de saída | Tipo | Detalhes |
| 0 | Sucesso | Sucesso |
| 1 | Erro | Falha geral |
| 2 | Erro | Falha na autenticação |
Corrente de parada
Interrompe uma cadeia em execução no momento.
Chamada de API equivalente: https://developers.workiva.com/chains-v1/chains-stopchain/
Entradas
| Entrada | Tipo | Detalhes |
| ID da execução da cadeia | TextField | A ID da execução da corrente para parar. |
Saídas
| Saída | Tipo de saída |
| Corrida em cadeia | Arquivo |
Códigos de saída
| Código de saída | Tipo | Detalhes |
| 0 | Sucesso | Sucesso |
| 1 | Erro | Falha geral |
| 2 | Erro | Falha na autenticação |
Carregar regras de mapeamento
Faz upload de um conjunto de regras de grupo de mapeamento, conforme especificado pelo GUID do grupo de mapeamento.
Chamada de API equivalente: https://developers.workiva.com/chains-v1/chains-updaterules/
Entradas
| Entrada | Tipo | Detalhes |
| GUID do grupo de mapeamento | TextField | O GUID do grupo de mapeamento. |
| Modo de upload | Campo suspenso | O modo de upload. Quando mode=published, a versão atualmente publicada é atualizada e republicada. Quando mode=draft, somente o rascunho é atualizado. Quando mode=both, tanto a versão publicada quanto o rascunho são atualizados. |
| Arquivo de regras de mapeamento | FileField | O arquivo que contém as regras de mapeamento a serem carregadas. |
Saídas
| Saída | Tipo de saída |
| Erros de upload | Arquivo |
| Resultado do upload | Arquivo |
| Número de regras carregadas | Inteiro |
| Número de erros | Inteiro |
Códigos de saída
| Código de saída | Tipo | Detalhes |
| 0 | Sucesso | Sucesso |
| 1 | Erro | Falha geral |
| 2 | Erro | Falha na autenticação |