Para automatizar tarefas dentro da plataforma Workiva como parte de uma cadeia, por exemplo, para permitir a troca de dados com outras Datasources, adicione uma etapa que inclua um comando de conexão Workiva.
Para habilitar esses comandos, um administrador de TI primeiro configura um conector Workiva.
Limpar dados da planilha
Para limpar todos os dados de uma planilha, use o comando Limpar dados da planilha.
Propriedades
| Propriedade |
Detalhes |
| ID da planilha |
Digite o identificador exclusivo da planilha com a planilha a ser limpa. |
| ID/nome da planilha |
Digite o nome ou o identificador exclusivo da planilha a ser limpa. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Criar arquivo
Para fazer upload de um arquivo CSV (valores separados por vírgula), JSON (notação de objeto Javascript) ou ZIP compactado e listar seus registros, use o comando Criar arquivos. Você também pode carregar o URL do arquivo, como um URL assinado pelo Amazon S3® para um arquivo em um bucket S3.
- Se for um arquivo JSON, ele deverá ter um único registro JSON por linha - um arquivo JSON é uma série de objetos JSON delimitados por um caractere de nova linha.
- Se for um arquivo ZIP, ele deverá conter um único arquivo CSV ou JSON, cujo nome será usado para nomear o arquivo importado. O download do arquivo novamente faz o download da fonte.
- Se for uma URL, o endpoint fará uma solicitação para obter um arquivo usando uma solicitação simples não autenticada
GET.
Propriedades
| Propriedade |
Detalhes |
| ID da tabela |
Digite o ID da tabela para listar os arquivos. |
| Arquivo |
Digite o arquivo a ser carregado. Ignorado se URL de download for inserido. Observação: O arquivo deve ter extensão .CSV ou .JSON, ou ser um arquivo ZIP que contenha um arquivo com extensão .CSV ou .JSON. |
| Nome |
Se Download URL for inserido, digite o nome do arquivo a ser carregado; por padrão, o nome base de Download URL. |
| Baixar URL |
Digite o URL que aponta para o arquivo a ser baixado, como um URL assinado pelo Amazon S3. Opcional se Arquivo for inserido. Observação: O comando faz uma solicitação simples GET para o URL, sem autenticação. |
Saídas
| Saída |
Tipo de saída |
| Resultados |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Criar novas edições de registros
Para criar novas edições de registros com as propriedades fornecidas, use o comando Criar novas edições de registro. Cada edição requer pelo menos uma operação e um targetId.
Limites:
- Até 1.000 edições podem ser processadas por solicitação.
Propriedades
| Propriedade |
Detalhes |
| Operação |
Selecione a operação a ser executada.
Opções:
- Criar registro
- Excluir registro
- Criar relação
- Excluir relação
- Definir propriedades
|
| Etiqueta |
Insira um etiqueta que descreva a relação entre os dois registros. Usado para criar ou excluir um relacionamento. |
| Propriedades |
Insira as propriedades relacionadas ao tipo de registro. Usado para criar um registro ou definir suas propriedades. |
| ID do registro |
Insira o ID ou o ID de registro temporário da fonte. Usado para criar ou excluir um relacionamento. |
| ID do alvo |
Digite o ID do registro de destino. Ao criar um registro, é possível usar o ID do registro ou o ID do registro temporário; ao excluir um registro, é necessário usar o ID do registro real. |
| ID de registro temporário |
Digite a ID temporária que será usada ao criar um registro; essa ID temporária é substituída no momento do processamento. É possível usar esse ID na mesma solicitação para criar relacionamentos entre os registros criados. |
| Tipo |
Digite o tipo de registro a ser criado. |
Saídas
| Saída |
Tipo de saída |
| Visualização de pivô |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Criar exibição dinâmica
Para criar uma nova visualização Wdata com base em sua consulta e no resultado da consulta, use o comando Criar visualização de pivô.
Propriedades
| Propriedade |
Detalhes |
| Nome |
Digite um nome exclusivo para ajudar a identificar a visualização. |
| ID da consulta |
Digite o ID da consulta para criar a visualização. |
| ID do resultado da consulta |
Digite o ID do resultado da consulta para criar a visualização. |
| Metadados adicionais |
Insira os metadados definidos pelo usuário para anexar à visualização como um objeto JSON (opcional). |
Saídas
| Saída |
Tipo de saída |
| Visualização de pivô |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Criar consulta de visualização
Para criar uma consulta de visualização temporária em uma tabela que possa ser executada, use o comando Criar consulta de prévia.
Propriedades
| Propriedade |
Detalhes |
| ID da tabela |
Digite o ID da tabela a ser consultada. |
| Limite |
Digite o número máximo de resultados a serem retornados. |
| Arquivo |
Se especificado, digite o nome do arquivo na tabela a ser consultada. |
Saídas
| Saída |
Tipo de saída |
| Consulta |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Criar consulta
Para criar uma nova consulta Wdata, use o comando Criar consulta.
Propriedades
| Propriedade |
Detalhes |
| Nome |
Digite um nome exclusivo para ajudar a identificar a consulta. |
| Descrição |
Digite uma descrição da consulta. |
| ID do resultado primário |
Se especificado, digite o ID do resultado padrão a ser preenchido com os resultados da consulta. |
| Texto da consulta |
Digite a definição da consulta como sintaxe do Presto SQL, como você faria no SQL Editor da consulta. |
| Temporário |
Para gerar a consulta temporariamente para que ela não apareça em seu espaço de trabalho, marque essa caixa. |
| Parâmetros |
Digite os parâmetros necessários para executar a consulta. |
Saídas
| Saída |
Tipo de saída |
| Consulta |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Criar registro
Esse comando só está disponível por meio da API da plataforma. Para criar um novo registro, use o endpoint Criar novas edições de registros.
Criar lista de seleção
Para criar uma lista de valores para um parâmetro de consulta de seleção múltipla, use o comando Criar lista selecionada.
Propriedades
| Propriedade |
Detalhes |
| Nome |
Digite um nome exclusivo para ajudar a identificar a lista de seleção. |
| Descrição |
Para ajudar a identificar melhor a lista de seleção, insira uma descrição de seus valores ou parâmetros. |
| Tipo de valor |
Selecione o tipo de dados dos valores da lista, como cadeia de caracteres ou número inteiro. |
| Valores |
Digite os valores da lista. |
Saídas
| Saída |
Tipo de saída |
| Criar metadados de lista de seleção |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro
|
Criar planilha
Para adicionar uma nova planilha a uma planilha, use o comando Criar planilha.
Propriedades
| Propriedade |
Detalhes |
| ID da planilha |
Insira o identificador exclusivo da planilha à qual deseja adicionar a planilha. |
| Nome |
Digite um nome exclusivo para ajudar a identificar a planilha. |
| Índice da planilha |
Digite o índice da nova planilha dentro da planilha. Observação: Por padrão, o comando adiciona a planilha como a planilha superior. |
| ID da planilha dos pais |
Insira o ID da planilha pai para criar a planilha. Para adicionar à planilha raiz, deixe em branco. |
Saídas
| Saída |
Tipo de saída |
| Metadados da planilha |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Criar planilha
Para criar uma nova planilha, use o comando Criar planilha.
Propriedades
| Propriedade |
Detalhes |
| Nome |
Digite o nome exclusivo para ajudar a identificar a planilha. |
Saídas
| Saída |
Tipo de saída |
| Metadados da planilha |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Criar tabela
Para criar uma nova tabela Wdata em seu espaço de trabalho, use o comando Criar tabela.
Propriedades
| Propriedade |
Detalhes |
| Nome |
Digite um nome exclusivo para ajudar a identificar a tabela. |
| Descrição |
Digite uma descrição da nova tabela. |
| Tipo |
Selecione se deseja criar uma tabela Dados (ou fato) ou Verificação (ou dimensão ). |
| Colunas |
Adicione as colunas a serem incluídas na tabela:
- Para adicionar colunas manualmente, clique em Adicionar para cada coluna e digite seu nome, tipo de dados, pseudônimo e descrição. Para Modo, deixe o padrão de Nullable.
- Para adicionar os detalhes das colunas como JavaScript Object Notation (JSON), ative Variável e digite o objeto ou a variável JSON.
|
Saídas
| Saída |
Tipo de saída |
| Tabela |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Excluir arquivo
Para excluir um arquivo do seu espaço de trabalho Wdata, use o comando Excluir arquivo.
Propriedades
| Propriedade |
Detalhes |
| ID do arquivo |
Digite o ID do arquivo a ser excluído. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Excluir exibição dinâmica
Para excluir uma visualização Wdata de seu espaço de trabalho, use o comando Excluir visualização de pivô.
Propriedades
| Propriedade |
Detalhes |
| ID |
Digite o ID da visualização a ser excluída. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Excluir consulta
Para excluir uma consulta Wdata de seu espaço de trabalho, use o comando Excluir consulta.
Propriedades
| Propriedade |
Detalhes |
| ID da consulta |
Digite o ID da consulta a ser excluída. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Excluir registro
Esse comando só está disponível por meio da API da plataforma. Para excluir um registro, use o endpoint
Criar new record edits.
Excluir planilha
Para excluir uma planilha e suas planilhas secundárias (recursivamente) de uma planilha, use o comando Excluir planilha. Propriedades
| Propriedade |
Detalhes |
| ID da planilha |
Digite o identificador exclusivo da planilha com a planilha a ser excluída. |
| ID/nome da planilha |
Digite o nome ou o identificador exclusivo da planilha a ser excluída. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Excluir planilha
Para excluir uma planilha do seu espaço de trabalho, use o comando Excluir planilha.
Propriedades
| Propriedade |
Detalhes |
| ID da planilha |
Digite o identificador exclusivo da planilha a ser excluída. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Excluir tabela
Para excluir uma tabela Wdata de seu espaço de trabalho, use o comando Excluir tabela.
Propriedades
| Propriedade |
Detalhes |
| ID da tabela |
Digite o identificador exclusivo da tabela a ser excluída |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Baixar arquivo
Para fazer download de um conjunto de dados do seu espaço de trabalho Wdata, use o comando Download file.
Observação: Esse comando não é compatível com outros tipos de objetos, como planilhas, tabelas ou consultas.
Propriedades
| Propriedade |
Detalhes |
| ID do arquivo |
Digite o ID do arquivo a ser baixado. |
Saídas
| Saída |
Tipo de saída |
| Arquivo |
Arquivo |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
<!--
Download Pivot View
Downloads the content from a pivot view
Inputs
<colgroup>
<col class="col-xs-6">
<col class="col-xs-6">
</colgroup>
| Input |
Detail |
| ID |
Enter the ID of the pivot view to download |
Outputs
<colgroup>
<col class="col-xs-6">
<col class="col-xs-6">
</colgroup>
| Output |
Output Type |
| Pivot View Content |
File |
Exit Codes
<colgroup>
<col class="col-xs-4">
<col class="col-xs-4">
<col class="col-xs-4">
</colgroup>
| 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 |
-->
Baixar o resultado da consulta
Para fazer download dos resultados de uma consulta Wdata em um arquivo, use o comando Baixar resultado da consulta.
Propriedades
| Propriedade |
Detalhes |
| ID do resultado da consulta |
Digite o ID do resultado da consulta a ser baixado. |
Saídas
| Saída |
Tipo de saída |
| Resultado da consulta |
Arquivo |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Editar
Esse comando só está disponível por meio da API da plataforma. Para editar um registro, use o endpoint Criar novas edições de registros.
Exportar arquivo para planilha
Para exportar um conjunto de dados de uma tabela Wdata para uma planilha nova ou existente, use o comando Exportar arquivo para planilha.
Propriedades
| Propriedade |
Detalhes |
| ID do arquivo |
Digite o ID do conjunto de dados da tabela a ser exportado. |
| URL da planilha |
Digite o URL da planilha para a qual exportar. Para criar uma nova planilha, deixe em branco. |
Saídas
| Saída |
Tipo de saída |
| Informações da planilha |
Arquivo |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Exportar resultado da consulta
Para exportar um resultado de consulta Wdata para uma planilha nova ou existente, use o comando Exportar resultado da consulta.
Propriedades
| Propriedade |
Detalhes |
| ID do resultado da consulta |
Digite o ID do resultado da consulta a ser exportado. |
| URL da planilha |
Digite o URL da planilha para a qual exportar. Para criar uma nova planilha, deixe em branco.
|
| Exportar como conjunto de dados |
Quando marcada, os dados serão exportados como um conjunto de dados conectado e as células só poderão ser editadas atualizando-se o conjunto de dados na planilha.
|
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Obter propriedades do arquivo
Para recuperar as propriedades do arquivo em seu espaço de trabalho Wdata, use o comando Obter propriedades do arquivo.
Propriedades
| Propriedade |
Detalhes |
| ID do arquivo |
Digite o ID do arquivo para obter as propriedades. |
Saídas
| Saída |
Tipo de saída |
| Propriedades do arquivo |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Obter exibição dinâmica
Para recuperar os metadados de uma visualização Wdata, use o comando Obter visualização de pivô.
Propriedades
| Propriedade |
Detalhes |
| ID |
Insira a ID da exibição dinâmica da qual obterá os metadados. |
Saídas
| Saída |
Tipo de saída |
| Visualização de pivô |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Obter metadados de consulta
Para recuperar os metadados de uma consulta Wdata, use o comando Obter metadados da consulta.
Propriedades
| Propriedade |
Detalhes |
| ID da consulta |
Digite o ID da consulta para obter metadados. |
Saídas
| Saída |
Tipo de saída |
| Consulta |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Obter registro
Esse comando só está disponível por meio da API da plataforma. Para obter um registro, use o endpoint Recuperar apenas um registro.
Obter registros
Esse comando só está disponível por meio da API da plataforma. Para obter vários registros, use o endpoint Recuperar uma lista de registros.
Obter relatórios
Para recuperar todos os relatórios da conta do banco de dados SOX e de Auditoria Interna de sua organização, use o comando Obter relatórios.
Propriedades
Nenhum
Saídas
| Saída |
Tipo de saída |
| Relatórios |
Arquivo |
| Contagem de relatórios |
Inteiro |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Obter lista de seleção
Para recuperar uma lista de valores para um parâmetro de consulta de seleção múltipla com base na ID da lista, use o comando Obter lista selecionada.
Propriedades
| Propriedade |
Detalhes |
| Selecionar ID da lista |
Digite o identificador exclusivo da lista de seleção a ser recuperada. |
Saídas
| Saída |
Tipo de saída |
| Obter carga útil da lista de seleção |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Obter dados da planilha
Para recuperar todos os dados em uma região específica de uma planilha, use o comando Obter dados da planilha.
Propriedades
| Propriedade |
Detalhes |
| ID da planilha |
Digite o identificador exclusivo da planilha com a planilha da qual obterá os dados. |
| ID/nome da planilha |
Digite o nome ou o identificador exclusivo da planilha da qual obterá os dados. |
| Região |
Digite a representação em estilo A1 de uma célula ou intervalo, como, por exemplo, [Start Column][Start Row]:[Stop Column][Stop Row]. Para que o intervalo não seja limitado em uma ou todas as direções, deixe de fora a coluna ou linha correspondente. |
| Estilo de valor |
Selecione se deseja retornar o valor bruto ou calculado da célula. Por exemplo, se o valor de uma célula for =1+:1, selecione Raw para =1+1 ou Calculated para o valor calculado de 2. |
| Revisão |
Insira a versão da planilha da qual deseja recuperar os dados. Para a versão atual, digite -1. |
Saídas
| Saída |
Tipo de saída |
| Contagem de linhas |
Inteiro |
| Dados |
Arquivo |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Obter metadados da planilha
Para recuperar os metadados de uma planilha em uma planilha, use o comando Obter metadados da planilha.
Propriedades
| Propriedade |
Detalhes |
| ID da planilha |
Insira o identificador exclusivo da planilha com a planilha da qual obterá os metadados. |
| ID/nome da planilha |
Digite o nome ou o identificador exclusivo da planilha da qual deseja obter metadados. |
Saídas
| Saída |
Tipo de saída |
| Metadados da planilha |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Obter metadados da planilha
Para recuperar os metadados de uma planilha, use o comando Obter metadados da planilha.
Propriedades
| Propriedade |
Detalhes |
| ID da planilha |
Insira o identificador exclusivo da planilha da qual deseja obter metadados. |
Saídas
| Saída |
Tipo de saída |
| Metadados da planilha |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Obter metadados da tabela
Para recuperar os metadados de uma tabela Wdata, use o comando Obter metadados da tabela.
Propriedades
| Propriedade |
Detalhes |
| ID da tabela |
Digite o identificador exclusivo da tabela da qual obterá os metadados. |
Saídas
| Saída |
Tipo de saída |
| Tabela |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Obter tipo
Esse comando só está disponível por meio da API da plataforma. Para obter um tipo de registro, use o endpoint Recuperar um único tipo.
Obter tipos
Esse comando só está disponível por meio da API da plataforma. Para obter vários tipos de registro, use o endpoint Recuperar uma lista de tipos.
<!-- display page content -->
Exame de saúde
Para verificar a integridade da API Wdata, use o comando Exame de saúde.
Propriedades
Nenhum
Saídas
| Saída |
Tipo de saída |
| Resposta |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Importar arquivo para a tabela
Para importar um arquivo para uma tabela Wdata, use o comando Importar arquivo para tabela.
Propriedades
| Propriedade |
Detalhes |
| ID da tabela |
Digite o ID da tabela para a qual o arquivo será importado. |
| ID do arquivo |
Digite o ID do arquivo a ser importado para a tabela. |
| Mapeamentos de colunas |
Mapear cada coluna do arquivo para as colunas da tabela. |
| Executar de forma assíncrona |
Para que o comando seja executado de forma assíncrona e não aguarde até que a importação seja concluída antes de continuar com a cadeia, marque essa caixa. |
| Etiquetas |
Para incluir metadados que sua organização rastreia sobre os dados, adicione etiquetas e selecione seus nomes e valores. |
Saídas
| Saída |
Tipo de saída |
| Importação de arquivos |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Importar planilha para a tabela
Para importar uma planilha para uma tabela e retornar um resultado de meta arquivo, use o comando Importar planilha para tabela.
Propriedades
| Propriedade |
Detalhes |
| ID da tabela |
Digite o identificador exclusivo da tabela para a qual o arquivo será importado. |
| ID do arquivo |
Digite o identificador exclusivo do arquivo para o qual a planilha será importada (opcional). |
| Nome do arquivo |
Digite o nome exclusivo a ser dado ao arquivo após a importação para a tabela. |
| URL da planilha |
Digite o URL completo da planilha da qual deseja importar os dados. |
| Executar de forma assíncrona |
Para que o comando seja executado de forma assíncrona e não aguarde até que a importação seja concluída antes de continuar com a cadeia, marque essa caixa. |
| Etiquetas |
Para incluir metadados que sua organização rastreia sobre os dados, adicione etiquetas e selecione seus nomes e valores. |
Saídas
| Saída |
Tipo de saída |
| Importação de arquivos |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Listar conexões
Para listar dados entre os recursos da plataforma Workiva, use o comando List connections.
Propriedades
| Propriedade |
Detalhes |
| Tipo de fonte |
Usando o menu suspenso, selecione o tipo de arquivo ou item do qual extrair dados. |
| Tipo de destino |
Usando o menu suspenso, selecione o tipo de arquivo ou item para o qual enviar dados. |
| ID da fonte |
Insira o identificador exclusivo do arquivo ou item do qual os dados serão extraídos. |
| ID de destino |
Digite o identificador exclusivo do arquivo ou item para o qual os dados serão enviados. |
Observação: Sua solicitação deve conter um Source Type + Source ID ou um Destination Type + Destination ID; a solicitação falhará se um desses pares não estiver presente.
Saídas
| Saída |
Tipo de saída |
| Conexões |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Listar erros de arquivo
Para listar os erros associados a um arquivo, por exemplo, devido a uma importação, use o comando Listar erros de arquivo.
Propriedades
| Propriedade |
Detalhes |
| ID do arquivo |
Insira o ID do arquivo para o qual deseja obter erros. |
Saídas
| Saída |
Tipo de saída |
| Lista de erros |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Listar arquivos
Para recuperar uma lista de arquivos em uma tabela Wdata e seus metadados, use o comando Listar arquivos.
Propriedades
| Propriedade |
Detalhes |
| ID da tabela |
Digite o ID da tabela da qual obterá os arquivos. |
Saídas
| Saída |
Tipo de saída |
| Lista de arquivos |
Arquivo |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Exibições dinâmicas de lista
Para listar as exibições Wdata em seu espaço de trabalho e recuperar seus metadados, use o comando Listar visualizações de pivô.
Propriedades
Nenhum
Saídas
| Saída |
Tipo de saída |
| Exibições dinâmicas |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Consultas de lista
Para listar as consultas Wdata em seu espaço de trabalho e recuperar seus metadados, use o comando Listar consultas.
Propriedades
Nenhum
Saídas
| Saída |
Tipo de saída |
| Consultas |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Listar resultados da consulta
Para listar os resultados disponíveis para uma consulta Wdata, use o comando Listar resultados da consulta.
Propriedades
| Propriedade |
Detalhes |
| ID da consulta |
Digite o ID da consulta para obter os resultados. |
Saídas
| Saída |
Tipo de saída |
| Resultados da consulta |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Listas de seleção de listas
Para listar todas as listas de valores de parâmetros de consulta de seleção múltipla em seu espaço de trabalho e recuperar seus metadados, use o comando Listar listas selecionadas.
Propriedades
Nenhum
Saídas
| Saída |
Tipo de saída |
| Listas de seleção de listas |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Folhas de listagem
Para listar todas as planilhas em uma planilha e recuperar seus metadados, use o comando Listar planilhas.
Propriedades
| Propriedade |
Detalhes |
| ID da planilha |
Digite o identificador exclusivo da planilha para listar as planilhas. |
Saídas
| Saída |
Tipo de saída |
| Folhas |
JSON |
| Número de planilhas |
Inteiro |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Listar tabelas
Para listar todas as tabelas Wdata em seu espaço de trabalho e recuperar seus metadados, use o comando Listar tabelas.
Propriedades
Nenhum
Saídas
| Saída |
Tipo de saída |
| Lista de tabelas |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Listar usuários
Para recuperar uma lista de detalhes sobre os usuários de uma organização, use o comando Listar usuários. O usuário de integração atribuído deve ter a função Org Admin para executar esse comando.
Semelhante à exportação "Visualização de pessoas" de um administrador de organização, os detalhes são classificados por nome de exibição e incluem os nomes dos usuários:
- Nomes de usuário
- Endereços de e-mail
- IDs SAML
- Últimos logins
- Associações de espaço de trabalho
- Licenças e funções
Propriedades
| Propriedade |
Detalhes |
| ID da organização |
Digite o identificador exclusivo da organização para a qual os usuários serão listados. |
Saídas
| Saída |
Tipo de saída |
| Relatório de usuários |
Arquivo |
| Contagem de registros |
Inteiro |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Sobrescrever dados da planilha
Para limpar todas as células de uma planilha e substituí-las pelos valores fornecidos no arquivo, use o comando Substituir dados da planilha.
Propriedades
| Propriedade |
Detalhes |
| ID da planilha |
Digite o identificador exclusivo da planilha em que os dados da planilha serão substituídos. |
| ID/nome da planilha |
Digite o nome ou o identificador exclusivo da planilha em que os dados serão substituídos. |
| Arquivo de dados |
Insira o arquivo CSV que contém os dados para preencher a planilha. |
| Delimitador |
Digite o delimitador usado no arquivo de dados . |
| Usar a API da plataforma |
Para usar o formato Ingressado em dos valores das células da planilha, marque essa caixa. |
Saídas
| Saída |
Tipo de saída |
| Linha escrita |
Inteiro |
| Células escritas |
Inteiro |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Publicar planilha
Para publicar os links em uma planilha, use o comando Publicar planilha.
Propriedades
| Propriedade |
Detalhes |
| ID da planilha |
Digite o identificador exclusivo da planilha a ser publicada. |
| Publicar todos os links |
Selecione qual dos links da planilha será publicado:
- Para publicar todos os links, marque essa caixa.
- Para publicar somente os links que você possui, desmarque essa caixa.
|
Saídas
| Saída |
Tipo de saída |
| Mensagem |
String |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Atualizar conexão
Para atualizar uma conexão específica com base em sua ID, use o comando Atualizar conexão.
Propriedades
| Propriedade |
Detalhes |
| ID da conexão |
Digite o identificador exclusivo da conexão a ser atualizada. |
| Usar parâmetros de origem anteriores |
Marque essa caixa para usar os parâmetros de origem da execução anterior; isso substitui quaisquer outros parâmetros de origem que você tenha especificado.
Essa entrada será ignorada pelo endpoint "Atualizar batch of connections" (Atualizar lote de conexões). |
| Parâmetros de origem* |
Digite os parâmetros a serem enviados à origem em uma atualização bem-sucedida.
(Esses parâmetros serão ignorados se a opção "Usar parâmetros anteriores da fonte" estiver ativada)
|
| Usar parâmetros de destino anteriores |
Marque essa caixa para usar os parâmetros de destino da execução anterior; isso substitui quaisquer outros parâmetros de destino que você tenha especificado.
Essa entrada será ignorada pelo endpoint "Atualizar batch of connections" (Atualizar lote de conexões). |
| Parâmetros de destino* |
Digite os parâmetros a serem enviados ao destino em uma atualização bem-sucedida.
(Esses parâmetros serão ignorados se a opção "Usar parâmetros anteriores do destino" estiver ativada)
|
Observação: Não há suporte para parâmetros de seleção múltipla no momento.
Saídas
| Saída |
Tipo de saída |
| Atualizar status |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Atualizar lote de conexões
Para atualizar várias conexões de uma vez, use o comando Atualizar lote de conexões.
Propriedades
| Propriedade |
Detalhes |
| Conexões |
Alterne para ativar ou desativar o uso de variáveis.
Quando ativado:
- As variáveis disponíveis podem ser selecionadas no menu à esquerda.
- Não é possível adicionar novas conexões.
|
| ID da conexão |
Digite o identificador exclusivo da conexão a ser atualizada. |
| Usar parâmetros de origem anteriores |
Marque essa caixa para usar os parâmetros de origem da execução anterior; isso substitui quaisquer outros parâmetros de origem que você tenha especificado.
Essa entrada será ignorada pelo endpoint "Atualizar batch of connections" (Atualizar lote de conexões). |
| Parâmetros de origem |
Digite os parâmetros a serem enviados à origem em uma atualização bem-sucedida.
(Esses parâmetros serão ignorados se a opção "Usar parâmetros anteriores da fonte" estiver ativada)
|
| Usar parâmetros de destino anteriores |
Marque essa caixa para usar os parâmetros de destino da execução anterior; isso substitui quaisquer outros parâmetros de destino que você tenha especificado.
Essa entrada será ignorada pelo endpoint "Atualizar batch of connections" (Atualizar lote de conexões). |
| Parâmetros de destino |
Digite os parâmetros a serem enviados ao destino em uma atualização bem-sucedida.
(Esses parâmetros serão ignorados se a opção "Usar parâmetros anteriores do destino" estiver ativada)
|
Saídas
| Saída |
Tipo de saída |
| Status de atualização de lote |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Remover borda
Esse comando só está disponível por meio da API da plataforma. Para remover uma borda, use o endpoint Criar novas edições de registros.
Recuperar uma lista de registros
Para retornar uma lista de registros que correspondam aos filtros fornecidos, use o comando Recuperar uma lista de registros. Sempre é necessário pelo menos um filtro.
Propriedades
| Propriedade |
Detalhes |
| Expandir |
Retorna recursos relacionados em linha com o recurso principal.
Opções:
|
| Filtro |
As propriedades pelas quais filtrar os resultados. |
Saídas
| Saída |
Tipo de saída |
| Status de atualização de lote |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Recuperar uma lista de tipos
Para retornar uma lista de tipos de registro e seus atributos, use o comando Recuperar uma lista de tipos. Esse comando permite que você saiba o que esperar ao recuperar registros.
Propriedades
| Propriedade |
Detalhes |
| Expandir |
Retorna recursos relacionados em linha com o recurso principal.
Opções:
- Nenhum (padrão)
- Relacionamentos
|
Saídas
| Saída |
Tipo de saída |
| Status de atualização de lote |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Recuperar um único registro
Para recuperar um único registro, use o comando Retrieve a list of records (Recuperar uma lista de registros). O identificador exclusivo normalmente é um UUID, mas isso pode variar.
Propriedades
| Propriedade |
Detalhes |
| Expandir |
Retorna recursos relacionados em linha com o recurso principal.
Opções:
|
| ID do registro |
Insira o identificador exclusivo do registro. |
Saídas
| Saída |
Tipo de saída |
| Status de atualização de lote |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Recuperar um único tipo
Para recuperar um único registro, use o comando Retrieve a list of records (Recuperar uma lista de registros). O identificador exclusivo normalmente é um UUID, mas isso pode variar.
Propriedades
| Propriedade |
Detalhes |
| Expandir |
Retorna recursos relacionados em linha com o recurso principal.
Opções:
|
| ID do registro |
Insira o identificador exclusivo do registro. |
Saídas
| Saída |
Tipo de saída |
| Status de atualização de lote |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Executar consulta
Para executar uma consulta Wdata e recuperar seus resultados, use o comando Executar consulta.
Propriedades
| Propriedade |
Detalhes |
| ID da consulta |
Digite o ID da consulta a ser executada. |
| Parâmetros |
Se a consulta tiver parâmetros definidos, adicione um mapa de seus nomes e valores. Observação: Insira os valores de quaisquer parâmetros de seleção múltipla em Parâmetros de seleção múltipla. |
| Executar de forma assíncrona |
Para executar a consulta de forma assíncrona e não esperar até que a consulta termine para concluir o comando, marque essa caixa. |
| Parâmetros de seleção múltipla |
Se a consulta tiver parâmetros de seleção múltipla definidos, adicione o nome e os valores de cada um deles. |
Saídas
| Saída |
Tipo de saída |
| Resultado da consulta |
JSON |
Observação: A saída Resultado da consulta inclui um ID, que pode ser usado para fazer download e exportar os resultados.
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Executar relatório
Para executar um relatório salvo na conta do banco de dados SOX e de Auditoria Interna de sua organização e retornar seus resultados como um arquivo CSV, use o comando Executar relatório.
Propriedades
| Propriedade |
Detalhes |
| ID do relatório |
Insira o identificador exclusivo do relatório que contém o relatório salvo. |
| Visualizar conteúdo |
Para incluir uma visualização dos resultados do relatório no registro do comando, marque essa caixa. |
Saídas
| Saída |
Tipo de saída |
| Relatório |
Arquivo |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Definir borda
Esse comando só está disponível por meio da API da plataforma. Para definir uma borda, use o endpoint Criar novas edições de registros.
Definir propriedades do registro
Esse comando só está disponível por meio da API da plataforma. Para definir as propriedades do registro, use o endpoint Criar novas edições de registros.
Desimportação de arquivo da tabela
Para cancelar a importação e remover um arquivo de uma tabela Wdata, use o comando Desimportar arquivo da tabela.
Propriedades
| Propriedade |
Detalhes |
| ID da tabela |
Digite o identificador exclusivo da tabela da qual o arquivo será removido. |
| ID do arquivo |
Digite o identificador exclusivo do arquivo a ser removido da tabela. |
Saídas
| Saída |
Tipo de saída |
| Importação de arquivos |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Atualizar a exibição dinâmica
Para atualizar os metadados de uma exibição Wdata, use um comando Atualizar visualização de pivô.
Propriedades
| Propriedade |
Detalhes |
| ID |
Digite o ID da visualização a ser atualizada. |
| Nome |
Digite o novo nome da visualização. |
| ID da consulta |
Digite o ID da consulta para criar a visualização. |
| ID do resultado da consulta |
Digite o ID do resultado da consulta para criar a visualização. |
| Metadados adicionais |
Insira os metadados definidos pelo usuário para anexar à visualização, como um objeto JSON (opcional). |
Saídas
| Saída |
Tipo de saída |
| Visualização de pivô |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Atualizar a definição da consulta
Para atualizar as propriedades de uma consulta Wdata, use o comando Atualizar definição de consulta.
Propriedades
| Propriedade |
Detalhes |
| ID da consulta |
Digite o ID da consulta a ser atualizada. |
| Nome |
Digite o novo nome da consulta. |
| Descrição |
Digite a nova descrição da consulta. |
| ID do resultado primário |
Se especificado, digite o ID do resultado padrão a ser preenchido com os resultados da consulta. |
| Texto da consulta |
Digite a definição da consulta como sintaxe do Presto SQL, como você faria no SQL Editor da consulta. |
| Temporário |
Para gerar a consulta apenas temporariamente para que ela não apareça em seu espaço de trabalho, marque essa caixa. |
| Parâmetros |
Digite os parâmetros necessários para executar a consulta. |
Saídas
| Saída |
Tipo de saída |
| Consulta |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Atualizar lista de seleção
Para atualizar as propriedades ou os itens de uma lista de valores para um parâmetro de consulta de seleção múltipla, use um comando Atualizar lista de seleção.
Propriedades
| Propriedade |
Detalhes |
| ID |
Digite o ID da lista de seleção a ser atualizada. |
| Nome |
Digite o novo nome da lista de seleção. |
| Descrição |
Digite a nova descrição da lista de seleção. |
| Tipo de valor |
Selecione o tipo de dados dos valores da lista, como cadeia de caracteres ou número inteiro. |
| Valores |
Insira os valores da lista, incluindo quaisquer atualizações. |
Saídas
| Saída |
Tipo de saída |
| Atualizar lista de seleção |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Atualizar metadados da planilha
Para atualizar os metadados de uma planilha em uma planilha, use o comando Atualizar metadados da planilha.
Propriedades
| Propriedade |
Detalhes |
| ID da planilha |
Insira o identificador exclusivo da planilha com a planilha para atualizar os metadados. |
| ID/nome da planilha |
Digite o nome ou o identificador exclusivo da planilha para atualizar os metadados. |
| Nome |
Digite o novo nome da planilha. |
| Índice da planilha |
Digite o novo índice da planilha na planilha. Por padrão, os comandos atualizam a planilha como a planilha superior. |
| ID da planilha dos pais |
Insira o ID da planilha pai para criar a planilha. Para adicionar à planilha raiz, deixe em branco. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Atualizar os metadados da planilha
Para atualizar os metadados de uma planilha, use o comando Atualizar metadados da planilha.
Propriedades
| Propriedade |
Detalhes |
| ID da planilha |
Insira o identificador exclusivo da planilha com a planilha para atualizar os metadados. |
| Nome |
Digite o novo nome da planilha. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Atualizar tabela
Para atualizar as colunas de uma tabela Wdata, use o comando Atualizar tabela.
Propriedades
| Propriedade |
Detalhes |
| ID da tabela |
Digite o identificador exclusivo da tabela a ser atualizada. |
| Nome |
Digite o nome da tabela a ser atualizada. |
| Descrição |
Digite uma descrição da tabela a ser atualizada. |
| Tipo |
Selecione se deseja atualizar uma tabela Dados - ou fato - ou Verificação - ou dimensão - tabela |
| Colunas |
Adicione as colunas para atualizar a tabela. Para cada coluna, digite seu nome, tipo de dados, pseudônimo e descrição. Para Modo, deixe o padrão de Nullable. |
Saídas
| Saída |
Tipo de saída |
| Tabela |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |
Gravar dados da planilha
Para gravar dados em um conjunto de dados CSV em uma região específica de uma planilha, use o comando Digitar dados da planilha.
Propriedades
| Propriedade |
Detalhes |
| ID da planilha |
Insira o identificador exclusivo da planilha com a planilha na qual os dados serão gravados. |
| ID/nome da planilha |
Digite o identificador exclusivo da planilha em que os dados serão gravados. |
| Arquivo de dados |
Insira o arquivo CSV com os dados a serem gravados na planilha. O intervalo dos dados não deve exceder a região . |
| Delimitador |
Digite o delimitador usado no arquivo de dados . |
| Região |
Digite uma representação A1 da célula ou do intervalo de células na planilha em que os dados serão gravados. Para que o intervalo não seja limitado em uma ou todas as direções, deixe a coluna ou linha correspondente em branco. |
| Use async |
Para carregar os dados de forma assíncrona, como em um grande conjunto de dados, marque essa caixa. Observação: Ao usar async, você deve adicionar sua própria sondagem para determinar o status do trabalho. |
| Usar a API da plataforma |
Para usar o formato entered-in dos valores das células da região , marque essa caixa.
Isso forçará o comando a usar os valores de atualização em um endpoint de intervalo em vez dos dados de gravação da API de planilha em um endpoint de região. Observação: Esse comando sempre será executado de forma assíncrona ao usar a API da plataforma. Você deve adicionar sua própria sondagem para determinar o status do trabalho. |
Saídas
| Saída |
Tipo de saída |
| Linhas escritas |
Inteiro |
| Células escritas |
Inteiro |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Erro |