Para interagir com o Tableau® como parte de uma cadeia, adicione uma etapa que inclua um comando de conexão do Tableau. Por exemplo:
- Automatize e conecte o Tableau a uma variedade de fontes de dados, incluindo Anaplan®, Oracle® HFM e IBM Cognos® Planning Analytics Cloud (TM1)
- Atualize relatórios dinamicamente, tanto antigos quanto novos, com gerenciamento integrado de acesso do usuário final e suporte para edições do Tableau na nuvem e no local
Para habilitar esses comandos, um administrador de TI primeiro cria um conector do Tableau. A conexão interage com implantações no local e na nuvem dessas versões do Tableau:
- 8.3
- 9.x
- 10.x
- 2018.x
- 2019.x
- 2020.x
- Tableau Online
Adicionar usuário ao grupo
Para adicionar um usuário a um grupo específico, use o comando Adicionar User to Group.
Propriedades
| Propriedade |
Detalhes |
| ID do grupo |
Digite o ID do grupo ao qual o usuário será adicionado |
| ID do usuário |
Digite o ID - não o nome - do usuário a ser adicionado |
Saídas
| Saída |
Tipo de saída |
| Usuário |
JSON |
| ID do usuário |
String |
| Nome do usuário |
String |
| Função no site do usuário |
String |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 214 |
Erro |
O nome do grupo no corpo da solicitação não corresponde a um grupo existente |
| 240 |
Advertência |
O usuário especificado já é membro do grupo |
Adicionar usuário ao site
Para adicionar um usuário ao Tableau Server e atribuí-lo a um site específico, use um comando Adicionar usuário ao site.
Propriedades
| Propriedade |
Detalhes |
| Nome de usuário |
Digite o nome do usuário. Se o Tableau Server usar a autenticação local, você pode usar qualquer nome; se a autenticação for do Active Directory (AD), use o nome de um usuário existente no AD. Se o nome de usuário não for exclusivo em todos os domínios, inclua o domínio, como domain\Adam ou adam@domain.com. |
| Função |
Selecione a função no site a ser atribuída ao usuário: Creator, Explorer, ExplorerCanPublish, ReadOnly, SiteAdministratorExplorer, SiteAdministratorCreator, Unlicensed, or Viewer |
| Tipo de autenticação |
Selecione se deseja autenticar o usuário via Security Assertion Markup Language (SAML) or ServerDefault. Observação: No Tableau Online, esses valores aparecem na guia Authentication na página Configurações - SAML corresponde a Single Sign-on (SSO); ServerDefault a TableauID. |
Saídas
| Saída |
Tipo de saída |
| Usuário |
JSON |
| ID do usuário |
String |
| Nome do usuário |
String |
| Função no site do usuário |
String |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 204 |
Erro |
O servidor está configurado para usar a autenticação do Active Directory e o nome de usuário especificado no corpo da solicitação não corresponde a um usuário no AD |
| 229 |
Erro |
O usuário especificado já existe no site |
| 234 |
Erro |
A API do Tabeleau Server não permite adicionar um usuário com a função de convidado a um site |
Criar o Hyper Extract
Para criar um Hyper Extract a partir de um arquivo de valores separados por vírgula (CSV), use o comando Build Hyper Extract.
Observação: Para usar esse comando com um GroundRunner, instale o Tableau Extract API em seu servidor e mova seus arquivos de biblioteca de vínculo dinâmico (DLL) para uma pasta usada pelo registro, como C:\Windows\System32.
Propriedades
| Propriedade |
Detalhes |
| Arquivo CSV de origem |
Digite o arquivo usado para criar os dados no arquivo Hyper. |
| Formato do arquivo |
Selecione o formato do arquivo CSV. |
| Tipos de colunas |
Insira o tipo de coluna do Tableau para cada coluna no arquivo CSV: INTEGER, DOUBLE, BOOLEAN, DATE, DATETIME, DURATION, CHAR_STRING, UNICODE_STRING, ou SPATIAL. |
Saídas
| Saída |
Tipo de saída |
| Arquivo Hyper |
Arquivo |
| Tamanho do hiperarquivo |
Inteiro |
| Registros processados |
Inteiro |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 4 |
Erro |
Erro geral ao criar o Extact |
| 5 |
Erro |
Não foi possível encontrar o arquivo de entrada CSV |
| 6 |
Erro |
O arquivo CSV não está formatado corretamente ou o formato de arquivo errado foi especificado |
| 11 |
Erro |
O número de tipos de coluna não corresponde ao número de colunas de cabeçalho no CSV |
| 12 |
Erro |
Tipo de coluna inválido |
Criar extração TDE
Para criar um arquivo do Tableau Desktop (TDE) a partir de um arquivo CSV, use o comando Build TDE Extract.
Observação: Para usar esse comando com um GroundRunner, instale a API Extract do Tableau em seu servidor e mova seus arquivos DLL para uma pasta usada pelo registro, como C:\Windows\System32.
Propriedades
| Propriedade |
Detalhes |
| Arquivo CSV de origem |
Insira o arquivo usado para criar os dados no arquivo TDE. |
| Formato do arquivo |
Selecione o formato do arquivo CSV. |
| Tipos de colunas |
Insira o tipo de coluna do Tableau para cada coluna no arquivo CSV: INTEGER, DOUBLE, BOOLEAN, DATE, DATETIME, DURATION, CHAR_STRING, UNICODE_STRING, ou SPATIAL. |
Saídas
| Saída |
Tipo de saída |
| Arquivo TDE |
Arquivo |
| Tamanho do arquivo TDE |
Inteiro |
| Registros processados |
Inteiro |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 4 |
Erro |
Erro geral ao criar o Extact |
| 5 |
Erro |
Não foi possível encontrar o arquivo de entrada CSV |
| 6 |
Erro |
O arquivo CSV não está formatado corretamente ou o formato de arquivo errado foi especificado |
| 11 |
Erro |
O número de tipos de coluna não corresponde ao número de colunas de cabeçalho no CSV |
| 12 |
Erro |
Tipo de coluna inválido |
Excluir em massa as permissões padrão
Para excluir as permissões padrão de Workbooks ou Datasources de usuários ou grupos com um arquivo CSV como fonte de dados, use o comando Bulk Excluir Default Permissions.
Propriedades
| Propriedade |
Detalhes |
| Dados de origem |
Insira os dados de origem para a atualização em massa, como um arquivo CSV compatível com RFC-4180. |
| Usuário ou grupo |
Selecione se os dados de origem são uma lista de Usuários ou Grupos. |
| Tipo de recurso |
Selecione o tipo de recurso para definir as permissões padrão: Workbook ou Datasource. |
| ID do Project |
Digite o ID do Project a ser atualizado. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 137 |
Erro |
O usuário tentou adicionar permissões a uma fonte de dados, mas o chamador não tem direitos para definir permissões na fonte de dados |
| 204 |
Erro |
O usuário especificado no corpo da solicitação não corresponde a um usuário existente |
| 214 |
Erro |
O grupo especificado no corpo da solicitação não corresponde a um grupo existente |
| 215 |
Erro |
Um recurso especificado no corpo da solicitação não corresponde a um recurso definido. Isso pode se aplicar a um nome de recurso inválido ou a um recurso diferente de Allow ou Deny para qualquer valor de modo. |
Permissões de exclusão em massa
Para excluir as permissões do Datasource, Workbook ou Project de vários usuários ou grupos com um arquivo CSV como fonte de dados, use o comando Bulk Excluir Permissions.
Propriedades
| Propriedade |
Detalhes |
| Dados de origem |
Insira os dados de origem para a atualização em massa, como um arquivo CSV compatível com RFC-4180. |
| Usuário ou grupo |
Selecione se os dados de origem são uma lista de Usuários ou Grupos. |
| Tipo de recurso |
Selecione o tipo de recurso para definir as permissões padrão - Workbook, Datasource ou Project. |
| ID do Project |
Digite o ID do Datasource, dos Workbooks ou do projeto a ser atualizado. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 137 |
Erro |
O usuário tentou adicionar permissões a uma fonte de dados, mas o chamador não tem direitos para definir permissões na fonte de dados |
| 204 |
Erro |
O usuário especificado no corpo da solicitação não corresponde a um usuário existente |
| 206 |
Erro |
A ID do Datasource não corresponde a uma fonte de dados existente |
| 207 |
Erro |
O ID do Project não corresponde a um projeto existente |
| 208 |
Erro |
O ID dos Workbooks não corresponde a uma Workbook existente |
| 214 |
Erro |
O grupo especificado no corpo da solicitação não corresponde a um grupo existente |
| 215 |
Erro |
Um recurso especificado no corpo da solicitação não corresponde a um recurso definido. Isso pode se aplicar a um nome de recurso inválido ou a um recurso diferente de Allow ou Deny para qualquer valor de modo. |
Atualizar em massa as permissões padrão
Para atualizar as permissões padrão para Workbooks ou Datasources de usuários ou grupos com um arquivo CSV como fonte de dados, use o comando Bulk Update Default Permissions.
Propriedades
| Propriedade |
Detalhes |
| Dados de origem |
Insira os dados de origem para a atualização em massa, como um arquivo CSV compatível com RFC-4180. |
| Usuário ou grupo |
Selecione se os dados de origem são uma lista de Usuários ou Grupos. |
| Tipo de recurso |
Selecione o tipo de recurso para definir as permissões padrão: Workbook ou Datasource. |
| ID do Project |
Digite o ID do Project a ser atualizado. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 137 |
Erro |
O usuário tentou adicionar permissões a uma fonte de dados, mas o chamador não tem direitos para definir permissões na fonte de dados |
| 204 |
Erro |
O usuário especificado no corpo da solicitação não corresponde a um usuário existente |
| 214 |
Erro |
O grupo especificado no corpo da solicitação não corresponde a um grupo existente |
| 215 |
Erro |
Um recurso especificado no corpo da solicitação não corresponde a um recurso definido. Isso pode se aplicar a um nome de recurso inválido ou a um recurso diferente de Allow ou Deny para qualquer valor de modo. |
Permissões de atualização em massa
Para atualizar as permissões do Datasource, Workbook ou Project de vários usuários ou grupos com um arquivo CSV como fonte de dados, use o comando Bulk Update Permissions.
Propriedades
| Propriedade |
Detalhes |
| Dados de origem |
Insira os dados de origem para a atualização em massa, como um arquivo CSV compatível com RFC-4180. |
| Usuário ou grupo |
Selecione se os dados de origem são uma lista de Usuários ou Grupos. |
| Tipo de recurso |
Selecione o tipo de recurso para definir as permissões padrão - Workbook, Datasource ou Project |
| ID do Project |
Digite o ID do Datasource, dos Workbooks ou do projeto a ser atualizado. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 137 |
Erro |
O usuário tentou adicionar permissões a uma fonte de dados, mas o chamador não tem direitos para definir permissões na fonte de dados |
| 204 |
Erro |
O usuário especificado no corpo da solicitação não corresponde a um usuário existente |
| 206 |
Erro |
A ID do Datasource não corresponde a uma fonte de dados existente |
| 207 |
Erro |
O ID do Project não corresponde a um projeto existente |
| 208 |
Erro |
O ID dos Workbooks não corresponde a uma Workbook existente |
| 214 |
Erro |
O grupo especificado no corpo da solicitação não corresponde a um grupo existente |
| 215 |
Erro |
Um recurso especificado no corpo da solicitação não corresponde a um recurso definido. Isso pode se aplicar a um nome de recurso inválido ou a um recurso diferente de Allow ou Deny para qualquer valor de modo. |
Criar grupo
Para criar um grupo no Tableau, use o comando Criar Group.
Propriedades
| Propriedade |
Detalhes |
| Nome do grupo |
Digite o nome do novo grupo. |
Saídas
| Saída |
Tipo de saída |
| Grupo |
JSON |
| ID do grupo |
String |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 238 |
Advertência |
Já existe um grupo com o nome especificado |
Criar projeto
Para criar um projeto no Tableau, use o comando Criar projeto.
Propriedades
| Propriedade |
Detalhes |
| Nome do projeto |
Digite o nome do novo projeto. |
| Descrição |
Digite uma descrição do novo projeto (opcional). |
| ID do Project pai |
Para criar hierarquias de projeto, insira o identificador do projeto pai (opcional). |
| Modo de administração |
Selecione o nível de gerenciamento de permissões para os usuários.
- Para bloquear as permissões de modo que os usuários não possam substituir as permissões padrão definidas para o projeto, selecione LockedToProject.
- Para permitir que os usuários gerenciem as permissões do conteúdo que possuem, selecione ManagedByOwner.
|
| Com amostras |
Para publicar as Workbooks de amostra fornecidas pelo Tableau no projeto, marque essa caixa. |
Saídas
| Saída |
Tipo de saída |
| Projeto |
JSON |
| ID do Project |
String |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 141 |
Erro |
As amostras não puderam ser publicadas porque não havia espaço de armazenamento suficiente no servidor |
| 235 |
Erro |
O nome do projeto na solicitação já pertence ao site especificado. Para garantir a exclusividade, os nomes de projetos não diferenciam maiúsculas de minúsculas. |
Criar site
Para criar um site no Tableau, use o comando Criar Site.
Propriedades
| Propriedade |
Detalhes |
| Nome do site |
Digite o nome do novo site. |
| URL de conteúdo |
Digite o URL do site, apenas com caracteres válidos em um URL. |
| Modo de administração |
Selecione o nível de acesso ao site para administradores (opcional):
- Para permitir que os administradores do site usem a interface do servidor e os comandos TABCMD - mas não a API REST - para adicionar e remover usuários, selecione ContentAndUsers.
- Para impedir que os administradores do site adicionem ou removam usuários, selecione ContentOnly.
Observação: os administradores do servidor sempre podem adicionar ou remover usuários. |
| Ativar assinaturas |
Para impedir que os usuários se inscrevam em Workbooks no site, marque essa caixa. |
Saídas
| Saída |
Tipo de saída |
| Local |
JSON |
| ID do site |
String |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 50 |
Erro |
O valor da cota de armazenamento ou de usuário não era um número positivo |
| 63 |
Erro |
O usuário forneceu um modo de administrador que não é ContentOnly ou ContentAndUsers |
| 230 |
Erro |
O nome do site na solicitação já pertence a um site existente |
| 231 |
Erro |
O URI de conteúdo na solicitação já pertence a um site existente |
Excluir fonte de dados
Para excluir um Datasource de um site do Tableau, use o comando Excluir Datasource.
Propriedades
| Propriedade |
Detalhes |
| ID do Datasource |
Insira o ID do Datasource a ser excluída. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 213 |
Advertência |
A fonte de dados não foi encontrada |
Excluir grupo
Para excluir um grupo de um site do Tableau, use o comando Excluir grupo.
Propriedades
| Propriedade |
Detalhes |
| ID do grupo |
Digite o ID do grupo a ser excluído. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 214 |
Advertência |
O grupo não foi encontrado |
Excluir projeto
Para excluir um projeto de um site do Tableau, use o comando Excluir projeto.
Propriedades
| Propriedade |
Detalhes |
| ID do projeto |
Digite o ID do projeto a ser excluído. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 207 |
Advertência |
O projeto não foi encontrado |
Excluir pasta de trabalho
Para excluir uma Workbook de um site do Tableau, use o comando Excluir Workbook.
Propriedades
| Propriedade |
Detalhes |
| ID dos Workbooks |
Digite o ID dos Workbooks a ser excluída. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 208 |
Advertência |
A Workbook não foi encontrada |
Baixar fonte de dados
Para baixar uma fonte de dados do Tableau, use o comando Download Datasource.
Propriedades
| Propriedade |
Detalhes |
| ID da fonte de dados |
Insira o ID da fonte de dados a ser baixada. |
| Incluir extrato |
Para incluir a extração da fonte de dados no arquivo baixado, marque essa caixa. |
Saídas
| Saída |
Tipo de saída |
| Arquivo de fonte de dados |
Arquivo |
| Tamanho do arquivo |
Inteiro |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 206 |
Erro |
A fonte de dados não foi encontrada |
Baixar dados de visualização
Para retornar uma visualização especificada renderizada como dados em um formato CSV, use o comando Download Visualizar Data.
Propriedades
| Propriedade |
Detalhes |
| Exibir ID |
Digite o ID da exibição a ser renderizada como dados. |
Saídas
| Saída |
Tipo de saída |
| Tamanho do arquivo |
Inteiro |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 165 |
Erro |
Um usuário não administrador tentou consultar as exibições dos Workbooks, mas o chamador não tem permissão de leitura |
Download da imagem de visualização
Para retornar uma imagem da visualização especificada renderizada em um formato PNG, use o comando Download Visualizar Image.
Propriedades
| Propriedade |
Detalhes |
| Exibir ID |
Insira o ID da exibição a ser renderizada como uma imagem. |
Saídas
| Saída |
Tipo de saída |
| Exibir imagem |
Arquivo |
| Tamanho do arquivo |
Inteiro |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 201 |
Erro |
O endpoint foi desativado no servidor. Para ativar o endpoint, o administrador do servidor deve usar tabadmin para definir a configuração sheet_image.enabled. |
Baixar visualizar PDF
Para retornar a visualização especificada renderizada em um arquivo Portable Document Format (PDF), use o comando Fazer download de visualização do PDF.
Propriedades
| Propriedade |
Detalhes |
| Exibir ID |
Digite o ID da visualização a ser renderizada como PDF. |
Saídas
| Saída |
Tipo de saída |
| Ver PDF |
Arquivo |
| Tamanho do arquivo |
Inteiro |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 165 |
Erro |
Um usuário não administrador tentou consultar as exibições da pasta de trabalho, mas o chamador não tem permissão de leitura |
Download da apostila
Para baixar uma pasta de trabalho do Tableau, use o comando Fazer download de Workbook.
Propriedades
| Propriedade |
Detalhes |
| ID da pasta de trabalho |
Digite o ID da pasta de trabalho a ser baixada |
| Incluir extrato |
Para incluir a extração da pasta de trabalho no arquivo baixado, marque esta caixa |
Saídas
| Saída |
Tipo de saída |
| Arquivo de pasta de trabalho |
Arquivo |
| Tamanho do arquivo |
Inteiro |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 208 |
Erro |
Não foi possível encontrar a pasta de trabalho especificada |
Obter fonte de dados
Para recuperar detalhes de um Datasource, use o comando Obter Datasource.
Propriedades
| Propriedade |
Detalhes |
| ID da fonte de dados |
Insira o ID do Datasource para recuperar detalhes sobre |
Saídas
| Saída |
Tipo de saída |
| Fonte de dados |
JSON |
| ID da fonte de dados |
String |
| Nome da fonte de dados |
String |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 206 |
Erro |
O ID do Datasource no URI não corresponde a uma fonte de dados existente |
Obter conexões de Datasources
Para recuperar uma lista de conexões associadas a um Datasource, use o comando Obter conexões de Datasource.
Propriedades
| Propriedade |
Detalhes |
| ID da fonte de dados |
Insira o ID da fonte de dados para recuperar as conexões. |
Saídas
| Saída |
Tipo de saída |
| Lista de conexões |
JSON |
| IDs de conexão |
Matriz |
| Nomes de conexões |
Matriz |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 213 |
Erro |
O ID do Datasource no URI não corresponde a uma fonte de dados existente |
Obter Datasources
Para recuperar uma lista de Datasources que o usuário de integração do conector pode acessar, use o comando Obter Datasources.
Propriedades
Nenhum
Saídas
| Saída |
Tipo de saída |
| Lista de Datasources |
JSON |
| IDs de Datasources |
Matriz |
| Nomes de Datasources |
Matriz |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 10 |
Advertência |
Nenhum recurso de dados encontrado |
| 56 |
Erro |
O parâmetro de número de página não é um número inteiro, é menor que 1 ou é maior que o número de página final para recursos de dados no tamanho de página solicitado |
| 57 |
Erro |
O tamanho do número da página não é um número inteiro ou é menor que 1 |
| 147 |
Erro |
O tamanho de página especificado é maior do que o tamanho máximo de página |
Obter grupos
Para recuperar uma lista de grupos que o usuário de integração do conector pode acessar, use o comando Obter grupos.
Propriedades
Nenhum
Saídas
| Saída |
Tipo de saída |
| Lista de grupos |
JSON |
| IDs de grupo |
Matriz |
| Nomes de grupos |
Matriz |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 10 |
Advertência |
Nenhum recurso de dados encontrado |
| 56 |
Erro |
O parâmetro de número de página não é um número inteiro, é menor que 1 ou é maior que o número de página final para recursos de dados no tamanho de página solicitado |
| 57 |
Erro |
O parâmetro de tamanho da página não é um número inteiro ou é menor que 1 |
| 147 |
Erro |
O tamanho de página especificado é maior do que o tamanho máximo de página |
Obter projetos
Para recuperar uma lista de projetos que o usuário de integração do conector pode acessar, use um comando Get Projects.
Propriedades
Nenhum
Saídas
| Saída |
Tipo de saída |
| Lista de projetos |
JSON |
| IDs de projetos |
Matriz |
| Nomes de projetos |
Matriz |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 10 |
Advertência |
Nenhum recurso de dados encontrado |
| 56 |
Erro |
O parâmetro de número de página não é um número inteiro, é menor que 1 ou é maior que o número de página final para recursos de dados no tamanho de página solicitado |
| 57 |
Erro |
O parâmetro de tamanho da página não é um número inteiro ou é menor que 1 |
| 147 |
Erro |
O tamanho de página especificado é maior do que o tamanho máximo de página |
Obter informações do servidor
Para recuperar a versão da API e a compilação do produto do Tableau Server, use o comando Get Server Info.
Propriedades
Nenhum
Saídas
| Saída |
Tipo de saída |
| Versão da API REST |
String |
| Construção do produto |
String |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
Obter informações do site
Para recuperar informações sobre um site, use o comando Obter informações do site.
Propriedades
| Propriedade |
Detalhes |
| ID do site |
Digite o ID do site sobre o qual deseja recuperar informações. |
| Nome do site |
Se não houver ID do site, digite o nome do site sobre o qual deseja recuperar informações. |
| URL de conteúdo |
Se não houver ID do site ou Nome do site, digite o URL do site sobre o qual deseja recuperar informações. |
Saídas
| Saída |
Tipo de saída |
| Local |
JSON |
| ID do site |
String |
| Nome do site |
String |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 202 |
Erro |
O local especificado não corresponde a um site existente |
Obter sites
Para recuperar uma lista de sites que o usuário de integração do conector pode acessar, use um comando Obter sites.
Propriedades
Nenhum
Saídas
| Saída |
Tipo de saída |
| Lista de sites |
JSON |
| IDs de sites |
Matriz |
| Nomes de sites |
Matriz |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 10 |
Advertência |
Nenhum site encontrado |
| 56 |
Erro |
O parâmetro de número de página não é um número inteiro, é menor que 1 ou é maior que o número de página final para recursos de dados no tamanho de página solicitado |
| 57 |
Erro |
O parâmetro de tamanho da página não é um número inteiro ou é menor que 1 |
| 147 |
Erro |
O tamanho de página especificado é maior do que o tamanho máximo de página |
Obter usuário
Para recuperar informações sobre um usuário do Tableau com base em sua ID, use o comando Obter usuário.
Propriedades
| Propriedade |
Detalhes |
| ID do usuário |
Digite o ID do usuário sobre o qual deseja recuperar informações. |
Saídas
| Saída |
Tipo de saída |
| Usuário |
JSON |
| ID do usuário |
String |
| Nome de usuário |
String |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 204 |
Erro |
O ID do usuário no URI não corresponde a um usuário existente |
Obter usuários no grupo
Para recuperar uma lista de usuários em um grupo, use o comando Obter usuários no grupo.
Propriedades
| Propriedade |
Detalhes |
| ID do grupo |
Digite o ID do grupo do qual deseja recuperar os usuários. |
Saídas
| Saída |
Tipo de saída |
| Lista de usuários |
JSON |
| IDs de usuário |
Matriz |
| Nomes de usuário |
Matriz |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 56 |
Erro |
O parâmetro de número de página não é um número inteiro, é menor que 1 ou é maior que o número de página final para recursos de dados no tamanho de página solicitado |
| 57 |
Erro |
O parâmetro de tamanho da página não é um número inteiro ou é menor que 1 |
| 147 |
Erro |
O tamanho de página especificado é maior do que o tamanho máximo de página |
| 214 |
Erro |
O ID do grupo no URI não corresponde a um grupo existente |
Obter usuários no site
Para recuperar uma lista de usuários em um site inteiro, use o comando Obter usuários no site.
Propriedades
Nenhum
Saídas
| Saída |
Tipo de saída |
| Lista de usuários |
JSON |
| IDs de usuário |
Matriz |
| Nomes de usuário |
Matriz |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 56 |
Erro |
O parâmetro de número de página não é um número inteiro, é menor que 1 ou é maior que o número de página final para recursos de dados no tamanho de página solicitado |
| 57 |
Erro |
O parâmetro de tamanho da página não é um número inteiro ou é menor que 1 |
| 147 |
Erro |
O tamanho de página especificado é maior do que o tamanho máximo de página |
Obter visualizações por site
Para recuperar todas as visualizações e estatísticas de uso opcionais de um site inteiro, use o comando Obter visualizações por site.
Propriedades
| Propriedade |
Detalhes |
| Incluir uso |
Para retornar as estatísticas de uso, marque essa caixa. |
Saídas
| Saída |
Tipo de saída |
| Ver lista |
JSON |
| Exibir IDs |
Matriz |
| Ver nomes |
Matriz |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 137 |
Erro |
Um usuário não administrador tentou consultar as exibições da pasta de trabalho, mas o chamador não tem permissão de leitura |
Obter exibições por Workbook
Para retornar todas as exibições e estatísticas de uso opcionais dos Workbooks especificada, use o comando Obter visualizações por Workbook.
Propriedades
| Propriedade |
Detalhes |
| ID da pasta de trabalho |
Digite o ID dos Workbooks para a qual deseja obter exibições. |
| Incluir uso |
Para retornar as estatísticas de uso, marque essa caixa. |
Saídas
| Saída |
Tipo de saída |
| Ver lista |
JSON |
| Exibir IDs |
Matriz |
| Ver nomes |
Matriz |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 137 |
Erro |
Um usuário não administrador tentou consultar as exibições da pasta de trabalho, mas o chamador não tem permissão de leitura |
| 208 |
Erro |
O ID dos Workbooks no URI não corresponde a uma Workbook existente |
Obter Workbook
Para recuperar detalhes de uma Workbook, use o comando Obter Workbook.
Propriedades
| Propriedade |
Detalhes |
| ID da pasta de trabalho |
Digite o ID dos Workbooks para obter detalhes. |
Saídas
| Saída |
Tipo de saída |
| Livro de exercícios |
JSON |
| ID da pasta de trabalho |
String |
| Nome dos Workbooks |
String |
| ID do projeto |
String |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 208 |
Erro |
O ID dos Workbooks no URI não corresponde a uma Workbook existente |
Obter Workbooks
Para recuperar uma lista de Workbooks que o usuário de integração do conector pode acessar, use o comando Obter Workbooks.
Propriedades
Nenhum
Saídas
| Saída |
Tipo de saída |
| Lista de Workbooks |
JSON |
| IDs de Workbooks |
Matriz |
| Nomes de Workbooks |
Matriz |
| ID do Project dos Workbooks |
Matriz |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 10 |
Advertência |
Não foram encontradas Workbooks |
| 56 |
Erro |
O parâmetro de número de página não é um número inteiro, é menor que 1 ou é maior que o número de página final para recursos de dados no tamanho de página solicitado |
| 57 |
Erro |
O parâmetro de tamanho da página não é um número inteiro ou é menor que 1 |
| 147 |
Erro |
O tamanho de página especificado é maior do que o tamanho máximo de página |
Publicar fonte de dados
Para publicar um arquivo de fonte de dados no Tableau Server, use o comando Publicar Datasource.
Propriedades
| Propriedade |
Detalhes |
| Fonte de dados |
Digite a fonte de dados a ser publicada. |
| Tipo de Datasource |
Selecione o tipo de fonte de dados a ser publicada: Hyper, TDS, TDSX ou TDE. |
| Nome da fonte de dados |
Insira o nome da fonte de dados no Tableau Server. |
| ID do projeto |
Digite o ID do Project no qual publicar o recurso de dados. |
| Sobrescrever |
Para substituir uma fonte de dados existente com o mesmo nome, se ela existir, marque essa caixa. |
Saídas
| Saída |
Tipo de saída |
| ID da fonte de dados |
String |
| Nome da fonte de dados |
String |
| ID do projeto |
String |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 5 |
Erro |
O arquivo de fonte de dados não foi encontrado |
| 140 |
Erro |
Um usuário não administrador tentou iniciar um upload de arquivo, mas o autor da chamada não tem direitos de publicação no site |
| 149 |
Erro |
Não foi possível fazer o upload do arquivo por algum outro motivo |
Publicar Workbook
Para publicar um arquivo de Workbook no Tableau Server, use o comando Publicar Workbook.
Propriedades
| Propriedade |
Detalhes |
| Livro de exercícios |
Digite a Workbook a ser publicada. |
| Tipo de Workbook |
Selecione se o tipo de Workbook é TWBX ou TWB. |
| Nome dos Workbooks |
Insira o nome dos Workbooks no Tableau Server. |
| ID do projeto |
Digite o ID do Project no qual a Workbook será publicada. |
| Sobrescrever |
Para substituir uma Workbook existente com o mesmo nome, se ela existir, marque essa caixa. |
Saídas
| Saída |
Tipo de saída |
| ID da pasta de trabalho |
String |
| Nome dos Workbooks |
String |
| ID do projeto |
String |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 5 |
Erro |
O arquivo dos Workbooks não foi encontrado |
| 140 |
Erro |
Um usuário não administrador tentou iniciar um upload de arquivo, mas o autor da chamada não tem direitos de publicação no site |
| 149 |
Erro |
Não foi possível fazer o upload do arquivo por algum outro motivo |
Remover permissões de Datasources
Para remover uma permissão de um grupo ou usuário em um Datasource, use o comando Remover Datasource Permissions.
Propriedades
| Propriedade |
Detalhes |
| ID da fonte de dados |
Insira o ID do Datasource a ser atualizado. |
| Tipo de ID (usuário ou grupo) |
Selecione se deseja atualizar as permissões associadas a um usuário ou grupo. |
| ID |
Digite o ID do usuário ou grupo para o qual deseja atualizar as permissões. |
| Nome do recurso |
Selecione o nome do recurso a ser adicionado. |
| Modo |
Selecione se deseja Permitir ou Negar o recurso. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 137 |
Erro |
Um usuário tentou adicionar permissões a uma fonte de dados, mas o chamador não tem direitos para isso |
| 204 |
Erro |
O usuário especificado não corresponde a um usuário existente |
| 206 |
Erro |
A fonte de dados especificada não corresponde a uma fonte de dados existente |
| 214 |
Erro |
O grupo especificado não corresponde a um grupo existente |
| 215 |
Erro |
O recurso não está atribuído ao usuário ou grupo especificado com o modo especificado |
Remover permissões padrão de Datasources
Para remover a permissão padrão dos recursos de dados de um projeto, use o comando Remover permissões padrão de Datasource.
Propriedades
| Propriedade |
Detalhes |
| ID do projeto |
Digite o ID do Project a ser atualizado. |
| Tipo de ID (usuário ou grupo) |
Selecione se deseja atualizar as permissões associadas a um usuário ou grupo. |
| ID |
Digite o ID do usuário ou grupo para o qual deseja atualizar as permissões. |
| Nome do recurso |
Selecione o nome do recurso a ser adicionado. |
| Modo |
Selecione se deseja Permitir ou Negar o recurso. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 137 |
Erro |
Um usuário tentou adicionar permissões a uma fonte de dados, mas o chamador não tem direitos para isso |
| 204 |
Erro |
O usuário especificado não corresponde a um usuário existente |
| 206 |
Erro |
A fonte de dados especificada não corresponde a uma fonte de dados existente |
| 214 |
Erro |
O grupo especificado não corresponde a um grupo existente |
| 215 |
Erro |
O recurso não está atribuído ao usuário ou grupo especificado com o modo especificado |
Remover as permissões padrão dos Workbooks
Para remover a permissão padrão das Workbooks de um projeto, use o comando Remove Default Workbook Permissions.
Propriedades
| Propriedade |
Detalhes |
| ID do projeto |
Digite o ID do Project a ser atualizado. |
| Tipo de ID (usuário ou grupo) |
Selecione se deseja atualizar as permissões associadas a um usuário ou grupo. |
| ID |
Digite o ID do usuário ou grupo para o qual deseja atualizar as permissões. |
| Nome do recurso |
Selecione o nome do recurso a ser adicionado. |
| Modo |
Selecione se deseja Permitir ou Negar o recurso. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 137 |
Erro |
Um usuário tentou adicionar permissões a uma fonte de dados, mas o chamador não tem direitos para isso |
| 204 |
Erro |
O usuário especificado não corresponde a um usuário existente |
| 206 |
Erro |
A fonte de dados especificada não corresponde a uma fonte de dados existente |
| 214 |
Erro |
O grupo especificado não corresponde a um grupo existente |
| 215 |
Erro |
O recurso não está atribuído ao usuário ou grupo especificado com o modo especificado |
Remover a permissão do projeto
Para remover uma permissão de um grupo ou usuário em um projeto, use o comando Remover permissão do projeto.
Propriedades
| Propriedade |
Detalhes |
| ID do projeto |
Digite o ID do Project a ser atualizado. |
| Tipo de ID (usuário ou grupo) |
Selecione se deseja atualizar as permissões associadas a um usuário ou grupo. |
| ID |
Digite o ID do usuário ou grupo para o qual deseja atualizar as permissões. |
| Nome do recurso |
Selecione o nome do recurso a ser adicionado. |
| Modo |
Selecione se deseja Permitir ou Negar o recurso. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 137 |
Erro |
Um usuário tentou adicionar permissões a uma fonte de dados, mas o chamador não tem direitos para isso |
| 204 |
Erro |
O usuário especificado não corresponde a um usuário existente |
| 206 |
Erro |
A fonte de dados especificada não corresponde a uma fonte de dados existente |
| 214 |
Erro |
O grupo especificado não corresponde a um grupo existente |
| 215 |
Erro |
O recurso não está atribuído ao usuário ou grupo especificado com o modo especificado |
Remover usuário do grupo
Para remover um usuário do grupo especificado, use o comando Remover usuário do grupo.
Propriedades
| Propriedade |
Detalhes |
| ID do grupo |
Digite o ID do grupo do qual deseja remover o usuário. |
| ID do usuário |
Digite o ID do usuário a ser removido do grupo. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 82 |
Erro |
Surgiu um problema que impediu que o usuário fosse removido do site |
| 204 |
Erro |
O usuário especificado não corresponde a um usuário existente |
| 214 |
Erro |
O grupo especificado não corresponde a um grupo existente |
| 224 |
Advertência |
O usuário não é membro do grupo especificado |
Remover usuário do site
Para remover um usuário do site especificado, use o comando Remover usuário do site.
Observação: Se um usuário ainda possuir conteúdo - ou ativos no Tableau Server, eles não poderão ser excluídos, a menos que a propriedade seja reatribuída primeiro. Para excluir um usuário, remova-o de todos os sites dos quais ele é membro.
Propriedades
| Propriedade |
Detalhes |
| ID do usuário |
Digite o ID do usuário a ser removido do site. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 50 |
Erro |
Surgiu um problema que impediu que o usuário fosse removido do site |
| 204 |
Erro |
O usuário especificado não corresponde a um usuário existente |
| 232 |
Erro |
O nome de usuário no URI não corresponde a um usuário existente |
Remover permissões de Workbook
Para remover as permissões de um usuário ou grupo em uma Workbook, use o comando Remove Workbook Permissions.
Propriedades
| Propriedade |
Detalhes |
| ID da pasta de trabalho |
Digite o ID dos Workbooks a ser atualizada. |
| Tipo de ID (grupo ou usuário) |
Selecione se deseja atualizar as permissões associadas a um usuário ou grupo. |
| ID |
Digite o ID do usuário ou grupo para atualizar as permissões. |
| Nome do recurso |
Selecione o nome do recurso a ser adicionado. |
| Modo |
Selecione se deseja Permitir ou Negar o recurso. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 137 |
Erro |
Um usuário tentou adicionar permissões a uma Workbook, mas o chamador não tem direitos para isso |
| 204 |
Erro |
O usuário especificado não corresponde a um usuário existente |
| 208 |
Erro |
O ID dos Workbooks não corresponde a uma Workbook existente |
| 214 |
Erro |
O grupo especificado não corresponde a um grupo existente |
| 215 |
Erro |
O recurso não está atribuído ao grupo ou usuário especificado com o modo especificado |
Mostrar permissões de Datasources
Para visualizar todas as permissões atribuídas a um Datasource, use o comando Exibir permissões do Datasource.
Propriedades
| Propriedade |
Detalhes |
| ID da fonte de dados |
Insira o ID do Datasource a ser atualizado. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 206 |
Erro |
A fonte de dados especificada não corresponde a uma fonte de dados existente |
Mostrar permissões padrão
Para visualizar as permissões padrão atribuídas aos Datasources ou Workbooks de um projeto, use o comando Exibir permissões padrão.
Propriedades
| Propriedade |
Detalhes |
| ID do projeto |
Digite o ID do Project a ser atualizado. |
| Tipo de recurso |
Selecione se deseja mostrar as permissões para uma Workbook ou fonte de dados. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 207 |
Erro |
O ID do Project não corresponde a um projeto existente |
Mostrar permissões de projeto
Para visualizar todas as permissões atribuídas a um projeto, use o comando Exibir permissões do projeto.
Propriedades
| Propriedade |
Detalhes |
| ID do projeto |
Digite o ID do Project para mostrar as permissões. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 207 |
Erro |
O ID do Project não corresponde a um projeto existente |
Mostrar permissões de Workbook
Para visualizar todas as permissões atribuídas a uma Workbook, use o comando Exibir permissões do Workbook.
Propriedades
| Propriedade |
Detalhes |
| ID da pasta de trabalho |
Digite o ID dos Workbooks para mostrar as permissões. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 208 |
Erro |
O ID dos Workbooks não corresponde a uma Workbook existente |
Atualizar fonte de dados
Para atualizar o projeto, o proprietário ou a certificação de um recurso de dados, use o comando Atualizar Datasource.
Propriedades
| Propriedade |
Detalhes |
| ID da fonte de dados |
Insira o ID do Datasource a ser atualizado. |
| ID do projeto |
Para atualizar o projeto, digite o ID do Project ao qual adicionar o recurso de dados (opcional). |
| ID do objeto |
Para atualizar o proprietário, insira o ID do usuário ao qual atribuir a propriedade do recurso de dados (opcional). |
| Certificado |
Se a fonte de dados for certificada, marque essa caixa (opcional). |
| Nota de certificação |
Insira qualquer informação adicional sobre a certificação da fonte de dados, se aplicável (opcional). |
Saídas
| Saída |
Tipo de saída |
| Fonte de dados atualizada |
JSON |
| Nome da fonte de dados |
String |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 160 |
Erro |
Um usuário não administrador tentou alterar o proprietário da fonte de dados |
| 163 |
Erro |
Um usuário não administrador tentou alterar o projeto para a fonte de dados, mas o chamador não tem permissão de gravação para o projeto |
| 165 |
Erro |
Um usuário não administrador tentou atualizar a fonte de dados, mas o chamador não tem permissão de gravação |
| 204 |
Erro |
O ID do proprietário não corresponde a um usuário existente |
| 206 |
Erro |
A ID do Datasource não corresponde a uma fonte de dados existente |
| 207 |
Erro |
O ID do Project não corresponde a um projeto existente |
| 244 |
Erro |
O nome da fonte de dados na solicitação já pertence ao site especificado. Para garantir a exclusividade, os nomes de Datasources não diferenciam maiúsculas de minúsculas. |
Atualizar permissões de Datasources
Para atualizar uma permissão para um grupo ou usuário em um recurso de dados, use o comando Atualizar Datasource Permissions.
Propriedades
| Propriedade |
Detalhes |
| ID da fonte de dados |
Insira o ID do Datasource a ser atualizado. |
| Tipo de ID (grupo ou usuário) |
Selecione se deseja atualizar as permissões de um usuário ou grupo. |
| ID |
Digite o ID do grupo ou use para atualizar as permissões. |
| Nome do recurso |
Selecione o nome do recurso a ser adicionado. |
| Modo |
Selecione se deseja Permitir ou Negar o recurso. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 137 |
Erro |
Um usuário tentou adicionar permissões a uma fonte de dados, mas o chamador não tem direitos para isso |
| 204 |
Erro |
O ID do proprietário não corresponde a um usuário existente |
| 206 |
Erro |
A ID do Datasource não corresponde a uma fonte de dados existente |
| 214 |
Erro |
O ID do grupo não corresponde a um grupo existente |
| 215 |
Erro |
Um recurso especificado no corpo da solicitação não corresponde a um recurso definido, devido a um nome de recurso inválido ou a um recurso diferente de Allow ou Deny para qualquer valor de modo |
Atualizar as permissões padrão da fonte de dados
Para atualizar as permissões padrão dos recursos de dados de um projeto, use o comando Atualizar permissões padrão de Datasource.
Propriedades
| Propriedade |
Detalhes |
| ID do projeto |
Digite o ID do Project a ser atualizado. |
| Tipo de ID (grupo ou usuário) |
Selecione se deseja atualizar as permissões de um usuário ou grupo. |
| ID |
Digite o ID do grupo ou use para atualizar as permissões. |
| Nome do recurso |
Selecione o nome do recurso a ser adicionado. |
| Modo |
Selecione se deseja Permitir ou Negar o recurso. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 137 |
Erro |
Um usuário tentou adicionar permissões a uma fonte de dados, mas o chamador não tem direitos para isso |
| 204 |
Erro |
O ID do proprietário não corresponde a um usuário existente |
| 206 |
Erro |
A ID do Datasource não corresponde a uma fonte de dados existente |
| 214 |
Erro |
O ID do grupo não corresponde a um grupo existente |
| 215 |
Erro |
Um recurso especificado no corpo da solicitação não corresponde a um recurso definido, devido a um nome de recurso inválido ou a um recurso diferente de Allow ou Deny para qualquer valor de modo |
Atualizar as permissões padrão dos Workbooks
Para atualizar as permissões padrão das Workbooks de um projeto, use o comando Atualizar permissões padrão de Workbook.
Propriedades
| Propriedade |
Detalhes |
| ID do projeto |
Digite o ID do Project a ser atualizado. |
| Tipo de ID (grupo ou usuário) |
Selecione se deseja atualizar as permissões de um usuário ou grupo. |
| ID |
Digite o ID do grupo ou use para atualizar as permissões. |
| Nome do recurso |
Selecione o nome do recurso a ser adicionado. |
| Modo |
Selecione se deseja Permitir ou Negar o recurso. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 137 |
Erro |
Um usuário tentou adicionar permissões a uma fonte de dados, mas o chamador não tem direitos para isso |
| 204 |
Erro |
O ID do proprietário não corresponde a um usuário existente |
| 206 |
Erro |
A ID do Datasource não corresponde a uma fonte de dados existente |
| 214 |
Erro |
O ID do grupo não corresponde a um grupo existente |
| 215 |
Erro |
Um recurso especificado no corpo da solicitação não corresponde a um recurso definido, devido a um nome de recurso inválido ou a um recurso diferente de Allow ou Deny para qualquer valor de modo |
Grupo de atualização
Para atualizar o nome de um grupo, use o comando Atualizar grupo.
Propriedades
| Propriedade |
Detalhes |
| ID do grupo |
Digite o ID do grupo a ser atualizado. |
| Nome |
Digite o novo nome do projeto (opcional). |
Saídas
| Saída |
Tipo de saída |
| Grupo atualizado |
JSON |
| ID do grupo |
String |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 207 |
Erro |
O ID do Project no URI não corresponde a um projeto existente |
| 214 |
Erro |
O ID do grupo não corresponde a um grupo existente |
| 235 |
Erro |
O nome do projeto na solicitação já pertence ao site especificado. Para garantir a exclusividade, os nomes de projetos não diferenciam maiúsculas de minúsculas |
| 238 |
Erro |
O nome do grupo na solicitação já está sendo usado no site especificado. Para garantir a exclusividade, os nomes de grupos não diferenciam maiúsculas de minúsculas. |
Atualizar o Hyper Extract
Para adicionar dados adicionais a um Hyper Extract a partir de um arquivo CSV, use o comando Atualizar Hyper Extract.
Propriedades
| Propriedade |
Detalhes |
| Extração do Tableau |
Insira o arquivo Extract para atualizar com novos dados. |
| Arquivo CSV de origem |
Digite o arquivo usado para criar dados no arquivo Hyper. |
| Formato do arquivo |
Selecione o formato do arquivo CSV. |
| Tipos de colunas |
Digite o tipo de cada coluna em Arquivo CSV de origem: INTEGER, DOUBLE, BOOLEAN, DATE, DATETIME, DURATION, CHAR_STRING, UNICODE_STRING, ou SPATIAL. |
Saídas
| Saída |
Tipo de saída |
| Extrair arquivo |
Arquivo |
| Tamanho da extração (Bytes) |
Inteiro |
| Registros processados |
Inteiro |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 4 |
Erro |
Erro geral ao criar o Hyper Extract |
| 5 |
Erro |
Não foi possível encontrar o arquivo de entrada CSV |
| 6 |
Erro |
O CSV não está formatado corretamente ou foi especificado o formato errado para o arquivo |
| 11 |
Erro |
O número dos tipos de coluna não corresponde ao número das colunas de cabeçalho no CSV |
| 12 |
Erro |
Tipo de coluna inválido |
Atualizar projeto
Para atualizar o projeto pai, o nome, as permissões ou a descrição de um projeto, use o comando Atualizar projeto.
Propriedades
| Propriedade |
Detalhes |
| ID do projeto |
Digite o ID do Project a ser atualizado. |
| ID do Project pai |
Para criar hierarquias de projeto, insira o identificador do projeto pai (opcional). |
| Nome |
Digite o novo nome do projeto (opcional). |
| Permissões de conteúdo |
Selecione as novas configurações de permissão para o projeto (opcional):
- Para bloquear as permissões de modo que os usuários não possam substituir as permissões padrão definidas para o projeto, selecione LockedToProject.
- Para permitir que os usuários gerenciem a permissão no conteúdo que possuem, selecione ManagedByOwner.
|
| Descrição |
Digite a nova descrição do projeto (opcional). |
Saídas
| Saída |
Tipo de saída |
| Projeto atualizado |
JSON |
| ID do Project |
String |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 138 |
Erro |
Tentativa de renomear o projeto padrão, que não pode ser renomeado |
| 141 |
Erro |
As amostras não puderam ser publicadas porque não há espaço de armazenamento suficiente no servidor para acomodar as amostras |
| 207 |
Erro |
O ID do Project não corresponde a um projeto existente |
| 235 |
Erro |
O nome do projeto na solicitação já pertence ao site especificado. Para garantir a exclusividade, os nomes de projetos não diferenciam maiúsculas de minúsculas. |
Atualizar as permissões do projeto
Para atualizar uma permissão para um grupo ou usuário em um projeto, use o comando Atualizar permissões do projeto.
Propriedades
| Propriedade |
Detalhes |
| ID do projeto |
Digite o ID do Project a ser atualizado. |
| Tipo de ID (grupo ou usuário) |
Selecione se deseja atualizar as permissões de um usuário ou grupo. |
| ID |
Digite o ID do usuário ou grupo para atualizar as permissões. |
| Nome do recurso |
Selecione o nome do recurso a ser adicionado. |
| Modo |
Selecione se deseja Permitir ou Negar o recurso. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 137 |
Erro |
Um usuário tentou adicionar permissões a um projeto, mas o chamador não tem direitos para isso |
| 204 |
Erro |
O usuário especificado não corresponde a um usuário existente |
| 207 |
Erro |
O ID do Project não corresponde a um projeto existente |
| 214 |
Erro |
O grupo especificado não corresponde a um grupo existente |
| 215 |
Erro |
O recurso especificado não corresponde a um recurso definido, devido a um nome de recurso inválido ou a um recurso diferente de Alllow ou Deny para qualquer valor de modo |
Atualizar extrato TDE
Para adicionar dados adicionais a um arquivo TDE a partir de um arquivo CSV, use o comando Atualizar extração TDE.
Propriedades
| Propriedade |
Detalhes |
| Extração do Tableau |
Insira o arquivo Extract para atualizar com novos dados. |
| Arquivo CSV de origem |
Selecione o arquivo usado para criar os dados no arquivo TDE. |
| Formato do arquivo |
Selecione o formato do arquivo CSV. |
| Tipos de colunas |
Selecione o tipo de cada coluna em Arquivo CSV de origem: INTEGER, DOUBLE, BOOLEAN, DATE, DATETIME, DURATION, CHAR_STRING, UNICODE_STRING, or SPATIAL. |
| Modo |
Selecione se deseja Permitir ou Negar o recurso. |
Saídas
| Saída |
Tipo de saída |
| Extrair arquivo |
Arquivo |
| Tamanho da extração (bytes) |
Inteiro |
| Registros processados |
Inteiro |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 4 |
Erro |
Erro geral ao criar o arquivo TDE |
| 5 |
Erro |
Não foi possível encontrar o arquivo de entrada CSV |
| 6 |
Erro |
O CSV não está formatado corretamente ou foi especificado o formato errado para o arquivo |
| 11 |
Erro |
O número de tipos de coluna não corresponde ao número de colunas de cabeçalho no CSV |
| 12 |
Erro |
Um dos tipos de coluna especificados não é um tipo válido |
Atualizar Workbook
Para atualizar a configuração de Projeto, Proprietário ou Mostrar guias de um Workbook, use o comando Atualizar Workbook.
Propriedades
| Propriedade |
Detalhes |
| ID da pasta de trabalho |
Digite o ID dos Workbooks a ser atualizada. |
| ID do projeto |
Digite o ID do Project ao qual atribuir a Workbook (opcional). |
| ID do proprietário |
Digite o ID do usuário a quem atribuir a Workbook como Proprietário (opcional). |
| Exibir guias |
Para que a Workbook publicada mostre exibições em guias, marque essa caixa (opcional). |
Saídas
| Saída |
Tipo de saída |
| Workbook atualizado |
JSON |
| ID da pasta de trabalho |
String |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 150 |
Erro |
Um não administrador tentou alterar o proprietário dos Workbooks |
| 158 |
Erro |
Um não administrador tentou alterar o projeto dos Workbooks, mas o autor da chamada não tem permissão de gravação para o projeto de destino |
| 160 |
Erro |
Um não administrador tentou alterar o Workbook, mas o autor da chamada não tem permissão de gravação para a Workbook |
| 204 |
Erro |
O ID do proprietário não corresponde a um usuário existente |
| 207 |
Erro |
O ID do Project não corresponde a um projeto existente |
| 208 |
Erro |
O ID dos Workbooks não corresponde a um Workbook existente |
| 244 |
Erro |
O nome da fonte de dados na solicitação já pertence ao site especificado. Para garantir a exclusividade, os nomes de Datasources não diferenciam maiúsculas de minúsculas. |
Atualizar as permissões dos Workbooks
Para atualizar as permissões de um usuário ou grupo em uma Workbook, use o comando Atualizar permissões de Workbook.
Propriedades
| Propriedade |
Detalhes |
| ID da pasta de trabalho |
Digite o ID dos Workbooks a ser atualizada. |
| Tipo de ID (grupo ou usuário) |
Selecione se deseja atualizar as permissões associadas a um grupo ou usuário. |
| ID |
Digite o ID do grupo ou usuário para atualizar as permissões. |
| Nome do recurso |
Selecione o nome do recurso a ser adicionado. |
| Modo |
Selecione se deseja Permitir ou Negar o recurso. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Entradas inválidas |
| 2 |
Erro |
Não foi possível autenticar com o Tableau |
| 137 |
Erro |
Um usuário tentou adicionar permissões a um projeto, mas o chamador não tem direitos para isso |
| 204 |
Erro |
O ID do proprietário não corresponde a um usuário existente |
| 207 |
Erro |
O ID do Project não corresponde a um projeto existente |
| 208 |
Erro |
O ID dos Workbooks não corresponde a um Workbook existente |
| 214 |
Erro |
O grupo especificado não corresponde a um grupo existente |
| 215 |
Erro |
O recurso especificado não corresponde a um recurso definido, devido a um nome de recurso inválido ou a um recurso diferente de Alllow ou Deny para qualquer valor de modo |