Ir para o conteúdo

Detalhes da Conexão Basecamp

Introdução

Versão do conector

Esta documentação é baseada na versão 21.0.8383 do conector.

Começando

Suporte à versão do Basecamp

O conector modela as contas Basecamp 2 e Basecamp 3 como tabelas bidirecionais.

Estabelecendo uma Conexão

Conectando ao Basecamp

Além da autenticação, defina as seguintes propriedades de conexão para acessar as tabelas do Basecamp.

  • Schema: Defina como "V2" ou "V3" para se conectar a uma conta Basecamp 2 ou Basecamp 3.

  • ProjectId: Este é um parâmetro obrigatório para a maioria das operações de tabela. Você pode consultar a tabela Projetos para obter esse valor.

    Se você não especificar o ProjectId propriedade da conexão, o conector usará o primeiro ID do projeto retornado da tabela Projetos em sua primeira autenticação no Basecamp.

  • AccountId: Você pode encontrar o AccountId na URL depois de fazer login no Basecamp em um navegador da web:

    http://basecamp.com/<AccountId>
    

Autenticação no Basecamp

Basecamp 2 usa autenticação básica ou OAuth 2.0. Você pode usar autenticação básica para se conectar à sua própria conta ou pode usar OAuth para permitir que outros usuários façam login em suas próprias contas.

Basecamp 3 requer OAuth 2.0.

Autenticar Via Autenticação Básica

Na autenticação básica, você usa suas credenciais de login para se conectar. Defina as seguintes propriedades:

  • User: Este é o nome de usuário que você usa para fazer login no Basecamp.
  • Password: Esta é a senha que você usa para entrar no Basecamp.
  • AuthScheme: Defina como Básico.
Autenticar Via Autenticação OAuth

Para usar OAuth, defina o AuthScheme para OAuth.

Você pode se conectar sem definir nenhuma propriedade de conexão para suas credenciais de usuário. Definir InitiateOAuth para GETANDREFRESH para evitar repetir a troca OAuth e definir manualmente o OAuthAccessToken.

Quando você se conecta, o conector abre o endpoint Basecamp OAuth em seu navegador padrão. Faça login e conceda permissões ao conector. O conector conclui o seguinte processo OAuth:

  1. Extrai o token de acesso da URL de retorno de chamada e autentica as solicitações.
  2. Obtém um novo token de acesso quando o antigo expira.
  3. Salva valores OAuth em OAuthSettingsLocation para ser persistido nas conexões.

Consulte Usando autenticação OAuth para outros fluxos de autenticação OAuth.

Usando Autenticação OAuth

OAuth requer que o usuário autenticado interaja com o Basecamp usando o navegador. O conector facilita isso de várias maneiras, conforme descrito abaixo.

Credenciais Incorporadas

Consulte Credenciais incorporadas para se conectar com as credenciais incorporadas do conector e pule a criação de um aplicativo OAuth personalizado.

Credenciais Personalizadas

Em vez de se conectar com as credenciais incorporadas do conector, você pode registrar um aplicativo para obter o OAuthClientId e OAuthClientSecret.

Quando Criar um Aplicativo OAuth Personalizado

A criação de um aplicativo OAuth personalizado é opcional, pois o conector já está registrado no Basecamp e você pode se conectar com suas credenciais incorporadas. Talvez você queira criar um aplicativo OAuth personalizado para alterar as informações exibidas quando os usuários fazem login no endpoint Basecamp OAuth para conceder permissões ao conector.

Criando um Aplicativo OAuth Personalizado

Consulte Criando um aplicativo OAuth personalizado para um procedimento.

Credenciais Incorporadas

Autenticar Usando as Credenciais OAuth Incorporadas
Autenticação de Desktop com o Aplicativo OAuth Integrado

Você pode se conectar sem definir nenhuma propriedade de conexão para suas credenciais de usuário. Depois de definir o seguinte, você está pronto para se conectar:

  • InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente o OAuthAccessToken.

  • AccountId: Copie isso da URL depois de fazer login no Basecamp:

    https://basecamp.com/<AccountId>
    
  • Schema: Defina como "V2" ou "V3" para conectar-se às contas Basecamp 2 ou Basecamp 3.

  • ProjectId: Para a maioria das operações de tabela, um ProjectId é um parâmetro obrigatório. Você pode consultar a tabela Projetos para obter esse valor.

Quando você conecta, o conector abre o endpoint OAuth em seu navegador padrão. Faça login e conceda permissões ao aplicativo. O conector então conclui o processo OAuth.

  1. Extrai o token de acesso do URL de retorno de chamada e autentica as solicitações.
  2. Obtém um novo token de acesso quando o antigo expira.
  3. Salva valores OAuth em OAuthSettingsLocation para ser persistido nas conexões.

Credenciais Personalizadas

Quando Usar um Aplicativo OAuth Personalizado

A criação de um aplicativo OAuth personalizado é opcional, pois o conector já está registrado no Basecamp e você pode se conectar com suas credenciais incorporadas.

Talvez você queira criar um aplicativo OAuth personalizado para alterar as informações exibidas quando os usuários fazem login no Basecamp para conceder permissões ao conector.

Autenticação de Desktop com um Aplicativo OAuth Personalizado

Siga as etapas abaixo para autenticar com as credenciais de um aplicativo OAuth personalizado. Consulte Criando um aplicativo OAuth personalizado Para maiores informações.

Obtenha e Atualize o Token de Acesso OAuth

Depois de definir o seguinte, você está pronto para se conectar:

  • OAuthClientId: Defina isso para o ID do cliente atribuído quando você registrou seu aplicativo.

  • OAuthClientSecret: Defina isso como o segredo do cliente atribuído quando você registrou seu aplicativo.

  • CallbackURL: Defina isso para o URI de redirecionamento definido quando você registrou seu aplicativo.

  • InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente o OAuthAccessToken.

  • AccountId: Copie isso da URL depois de fazer login no Basecamp:

    https://basecamp.com/<AccountId>
    
  • Schema: Defina como "V2" ou "V3" para conectar-se às contas Basecamp 2 ou Basecamp 3.

  • ProjectId: Para a maioria das operações de tabela, um ProjectId é um parâmetro obrigatório. Você pode consultar a tabela Projetos para obter esse valor.

Quando você conecta, o conector abre o endpoint OAuth em seu navegador padrão. Faça login e conceda permissões ao aplicativo. O conector então conclui o processo OAuth:

  1. Extrai o token de acesso do URL de retorno de chamada e autentica as solicitações.
  2. Atualiza o token de acesso quando ele expira.
  3. Salva valores OAuth em OAuthSettingsLocation para ser persistido nas conexões.

Máquinas Sem Cabeça

Usando OAuth em uma Máquina Sem Cabeça

Para criar fontes de dados Basecamp em servidores headless ou outras máquinas nas quais o conector não pode abrir um navegador, você precisa autenticar de outra máquina. A autenticação é um processo de duas etapas.

  1. Ao invés de instalar o conector em outra máquina, você pode seguir os passos abaixo para obter o OAuthVerifier valor. Ou você pode instalar o conector em outra máquina e transferir os valores de autenticação OAuth, depois de autenticar por meio do fluxo normal baseado em navegador.
  2. Em seguida, você pode configurar o conector para atualizar automaticamente o token de acesso da máquina sem periféricos.

Você pode seguir o fluxo de autenticação OAuth headless usando as credenciais OAuth incorporadas do conector ou usando as credenciais OAuth para seu aplicativo OAuth personalizado.

Usando as Credenciais OAuth Incorporadas

Obtenha um código verificador

Siga as etapas abaixo para autenticar em outra máquina e obter o OAuthVerifier propriedade da conexão:

  1. Clique no link a seguir para abrir o endpoint Basecamp OAuth em seu navegador.
  2. Efetue login e conceda permissões ao conector. Você será redirecionado para o URL de retorno de chamada, que contém o código do verificador.
  3. Salve o valor do código do verificador. Você definirá isso no OAuthVerifier propriedade de conexão.

Na máquina sem periféricos, defina as seguintes propriedades de conexão para obter os valores de autenticação OAuth.

  • OAuthVerifier: Defina isso para o código do verificador.

  • InitiateOAuth: Configure para ATUALIZAR.

  • OAuthSettingsLocation: Defina para manter os valores de autenticação OAuth criptografados no arquivo especificado.

  • AccountId: Copie isso da URL depois de fazer login no Basecamp:

    https://basecamp.com/<AccountId>
    

Depois que o arquivo de configurações OAuth for gerado, defina as seguintes propriedades para se conectar aos dados:

  • OAuthSettingsLocation: Defina isso para o arquivo que contém os valores de autenticação OAuth criptografados. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao conector para habilitar a atualização automática do token de acesso.

  • InitiateOAuth: Configure para ATUALIZAR.

  • AccountId: Copie isso da URL depois de fazer login no Basecamp:

    https://basecamp.com/<AccountId>
    
  • Schema: Defina como "V2" ou "V3" para conectar-se às contas Basecamp 2 ou Basecamp 3.

  • ProjectId: Para a maioria das operações de tabela, um ProjectId é um parâmetro obrigatório. Você pode consultar a tabela Projetos para obter esse valor.

Configurações de transferência OAuth

Siga as etapas abaixo para instalar o conector em outra máquina, autenticar e depois transferir os valores OAuth resultantes.

Em uma segunda máquina, instale o conector e conecte-se com o seguinte conjunto de propriedades:

  • OAuthSettingsLocation: Defina isso como um arquivo de texto gravável.

  • InitiateOAuth: Defina como GETANDREFRESH.

  • AccountId: Copie isso da URL depois de fazer login no Basecamp:

    https://basecamp.com/<AccountId>
    

Teste a conexão para autenticar no navegador. Os valores de autenticação resultantes são gravados, criptografados, no caminho especificado por OAuthSettingsLocation. Depois de testar a conexão com sucesso, copie o arquivo de configurações OAuth para sua máquina sem periféricos. Na máquina sem periféricos, defina as seguintes propriedades de conexão para se conectar aos dados:

  • InitiateOAuth: Configure para ATUALIZAR.

  • OAuthSettingsLocation: Defina isso como o caminho para o arquivo de configurações OAuth. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao conector para habilitar a atualização automática do token de acesso.

  • AccountId: Copie isso da URL depois de fazer login no Basecamp:

    https://basecamp.com/<AccountId>
    
  • Schema: Defina como "V2" ou "V3" para conectar-se às contas Basecamp 2 ou Basecamp 3.

  • ProjectId: Para a maioria das operações de tabela, um ProjectId é um parâmetro obrigatório. Você pode consultar a tabela Projetos para obter esse valor.

Usando as Credenciais para um Aplicativo OAuth Personalizado

Crie um aplicativo OAuth personalizado

A criação de um aplicativo OAuth customizado é opcional no fluxo OAuth headless; você pode ignorar a criação de um aplicativo conectando-se com as credenciais OAuth incorporadas do conector. Talvez você queira criar um aplicativo OAuth personalizado para alterar as informações exibidas quando os usuários fazem login no Basecamp para conceder permissões ao conector.

Consulte Criando um aplicativo OAuth personalizado para um procedimento. Você pode seguir os procedimentos abaixo para autenticar e conectar-se aos dados.

Obtenha um código verificador

Defina as seguintes propriedades na máquina sem periféricos:

  • InitiateOAuth: Defina como DESLIGADO.

  • OAuthClientId: Defina isso como o ID do cliente nas configurações do aplicativo.

  • OAuthClientSecret: Defina isso como o segredo do cliente nas configurações do aplicativo.

  • AccountId: Copie isso da URL depois de fazer login no Basecamp:

    https://basecamp.com/<AccountId>
    

Você pode seguir as etapas abaixo para autenticar em outra máquina e obter o OAuthVerifier propriedade de conexão.

  1. Chame o GetOAuthAuthorizationURL procedimento armazenado* com o parâmetro de entrada CallbackURL definido para o URI de redirecionamento exato que você especificou nas configurações do aplicativo.
  2. Abra o URL retornado em um navegador. Faça login e conceda permissões ao conector. Você será redirecionado para o URL de retorno de chamada, que contém o código do verificador.
  3. Salve o valor do código do verificador. Você definirá isso no OAuthVerifier propriedade de conexão.

Na máquina sem periféricos, defina as seguintes propriedades de conexão para obter os valores de autenticação OAuth:

  • OAuthClientId: Defina isso como a chave do consumidor nas configurações do aplicativo.

  • OAuthClientSecret: Defina isso como o segredo do consumidor nas configurações do aplicativo.

  • OAuthVerifier: Defina isso para o código do verificador.

  • OAuthSettingsLocation: Defina para manter os valores de autenticação OAuth criptografados no arquivo especificado.

  • InitiateOAuth: Configure para ATUALIZAR.

  • AccountId: Copie isso da URL depois de fazer login no Basecamp:

    https://basecamp.com/<AccountId>
    

Depois que o arquivo de configurações OAuth for gerado, defina as seguintes propriedades para se conectar aos dados:

  • OAuthClientId: Defina isso como a chave do consumidor nas configurações do aplicativo.

  • OAuthClientSecret: Defina isso como o segredo do consumidor nas configurações do aplicativo.

  • OAuthSettingsLocation: Defina isso para o arquivo que contém os valores de autenticação OAuth criptografados. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao provedor para ativar a atualização automática do token de acesso.

  • InitiateOAuth: Configure para ATUALIZAR.

  • AccountId: Copie isso da URL depois de fazer login no Basecamp:

    https://basecamp.com/<AccountId>
    
  • Schema: Defina como "V2" ou "V3" para conectar-se às contas Basecamp 2 ou Basecamp 3.

  • ProjectId: Para a maioria das operações de tabela, um ProjectId é um parâmetro obrigatório. Você pode consultar a tabela Projetos para obter esse valor.

Configurações de transferência OAuth

Siga as etapas abaixo para instalar o conector em outra máquina, autenticar e depois transferir os valores OAuth resultantes.

Em uma segunda máquina, instale o conector e conecte-se com o seguinte conjunto de propriedades:

  • OAuthSettingsLocation: Defina isso como um arquivo de texto gravável.

  • InitiateOAuth: Defina como GETANDREFRESH.

  • OAuthClientId: Defina isso para o ID do cliente atribuído quando você registrou seu aplicativo.

  • OAuthClientSecret: Defina isso como o segredo do cliente atribuído quando você registrou seu aplicativo.

  • CallbackURL: Defina isso para o URI de redirecionamento que você especificou nas configurações do aplicativo.

  • AccountId: Copie isso da URL depois de fazer login no Basecamp:

    https://basecamp.com/<AccountId>
    

Teste a conexão para autenticar. Os valores de autenticação resultantes são gravados, criptografados, no caminho especificado por OAuthSettingsLocation. Depois de testar a conexão com sucesso, copie o arquivo de configurações OAuth para sua máquina sem periféricos. Na máquina sem periféricos, defina as seguintes propriedades de conexão para se conectar aos dados:

  • InitiateOAuth: Configure para ATUALIZAR.

  • OAuthClientId: Defina isso como a chave do consumidor nas configurações do aplicativo.

  • OAuthClientSecret: Defina isso como o segredo do consumidor nas configurações do aplicativo.

  • OAuthSettingsLocation: Defina isso como o caminho para o arquivo de configurações OAuth. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao conector para habilitar a atualização automática do token de acesso.

  • AccountId: Copie isso da URL depois de fazer login no Basecamp:

    https://basecamp.com/<AccountId>
    
  • Schema: Defina como "V2" ou "V3" para conectar-se às contas Basecamp 2 ou Basecamp 3.

  • ProjectId: Para a maioria das operações de tabela, um ProjectId é um parâmetro obrigatório. Você pode consultar a tabela Projetos para obter esse valor.

Criando um Aplicativo OAuth Personalizado

Quando Criar um Aplicativo OAuth Personalizado

A criação de um aplicativo OAuth personalizado é opcional, pois o conector já está registrado no Basecamp e você pode se conectar com suas credenciais incorporadas.

Talvez você queira criar um aplicativo OAuth personalizado para alterar as informações exibidas quando os usuários fazem login no endpoint Basecamp OAuth para conceder permissões ao conector.

Siga as etapas abaixo para criar um aplicativo OAuth personalizado e obter as propriedades de conexão em um fluxo de autenticação OAuth específico.

Crie um Aplicativo OAuth Personalizado: Área de Trabalho

Registre seu aplicativo Basecamp em integrado.37signals.com para obter as seguintes propriedades de conexão:

  • OAuthClientId
  • OAuthClientSecret
  • CallbackURL

Definir URI de redirecionamento para http://localhost:portnumber E definir CallbackURL a combinar. Você pode especificar qualquer porta disponível.

Características Avançadas

Esta seção detalha uma seleção de recursos avançados do conector Basecamp.

Visualizações definidas pelo usuário

O conector permite definir tabelas virtuais, denominadas visões definidas pelo usuário, cujo conteúdo é decidido por uma consultar pré-configurada. Essas exibições são úteis quando você não pode controlar diretamente as consultas enviadas aos drivers. Consulte Visualizações definidas pelo usuário para obter uma visão geral da criação e configuração de exibições personalizadas.

Configuração SSL

Use Configuração SSL para ajustar como o conector lida com as negociações de certificado TLS/SSL. Você pode escolher entre vários formatos de certificado; Veja o SSLServerCert propriedade em "Opções de cadeia de conexão" para obter mais informações.

Procurador

Para configurar o conector usando configurações de proxy do Agente Privado, selecione os Use Proxy Settings caixa de seleção na tela de configuração da conexão.

Visualizações Definidas pelo Usuário

O Jitterbit Connector for Basecamp permite definir uma tabela virtual cujo conteúdo é decidido por uma consultar pré-configurada. Elas são chamadas de Visualizações definidas pelo usuário, que são úteis em situações em que você não pode controlar diretamente a consultar que está sendo emitida para o driver, por exemplo, ao usar o driver da Jitterbit. As Visualizações Definidas pelo Usuário podem ser usadas para definir predicados que são sempre aplicados. Se você especificar predicados adicionais na consultar para a visualização, eles serão combinados com a consultar já definida como parte da visualização.

Há duas maneiras de criar exibições definidas pelo usuário:

  • Crie um arquivo de configuração em formato JSON definindo as visualizações desejadas.
  • declarações DDL.

Definindo Visualizações Usando um Arquivo de Configuração

As visualizações definidas pelo usuário são definidas em um arquivo de configuração formatado em JSON chamado UserDefinedViews.json. O conector detecta automaticamente as visualizações especificadas neste arquivo.

Você também pode ter várias definições de exibição e controlá-las usando o UserDefinedViews propriedade de conexão. Quando você usa essa propriedade, apenas as exibições especificadas são vistas pelo conector.

Este arquivo de configuração de exibição definida pelo usuário é formatado da seguinte forma:

  • Cada elemento raiz define o nome de uma visualização.
  • Cada elemento raiz contém um elemento filho, chamado query, que contém a consultar SQL personalizada para a exibição.

Por exemplo:

{
    "MyView": {
        "query": "SELECT * FROM Projects WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use o UserDefinedViews propriedade de conexão para especificar a localização do seu arquivo de configuração JSON. Por exemplo:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Esquema para Exibições Definidas pelo Usuário

As visualizações definidas pelo usuário são expostas no UserViews esquema por padrão. Isso é feito para evitar que o nome da exibição entre em conflito com uma entidade real no modelo de dados. Você pode alterar o nome do esquema usado para UserViews definindo o UserViewsSchemaName propriedade.

Trabalhando com Exibições Definidas pelo Usuário

Por exemplo, uma instrução SQL com uma Visualização Definida pelo Usuário chamada UserViews.RCustomers lista apenas clientes em Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

Exemplo de consultar ao driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resultando na consultar efetiva à fonte:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

Esse é um exemplo muito simples de uma consultar a uma exibição definida pelo usuário que é efetivamente uma combinação da consultar de exibição e da definição de exibição. É possível compor essas consultas em padrões muito mais complexos. Todas as operações SQL são permitidas em ambas as consultas e são combinadas quando apropriado.

Configuração SSL

Personalizando a Configuração SSL

Por padrão, o conector tenta negociar SSL/TLS verificando o certificado do servidor em relação ao armazenamento de certificados confiáveis do sistema.

Para especificar outro certificado, consulte o SSLServerCert propriedade para os formatos disponíveis para fazê-lo.

Modelo de Dados

O Jitterbit Connector for Basecamp modela as APIs Basecamp 2 e Basecamp como tabelas relacionais, exibições e procedimentos armazenados. Eles são definidos em arquivos de esquema, que são arquivos de configuração simples baseados em texto.

As entidades disponíveis, bem como quaisquer limitações e requisitos de API para consultar essas entidades, estão documentadas em Basecamp 2 Data Model e Modelo de Dados Basecamp 3. Você pode usar o SupportEnhancedSQL recurso, definido por padrão, para contornar a maioria dessas limitações.

Visão geral

Os Modelos de Dados ilustram um exemplo de como pode ser o seu ambiente Basecamp. O modelo de dados real será obtido dinamicamente com base na sua conta do Basecamp.

Características principais

  • Tabelas e visualizações são definidas dinamicamente para modelar calendários, documentos e projetos no Basecamp.
  • Procedimentos armazenados* permitem que você execute operações no Basecamp, incluindo download e upload de objetos.
  • A conectividade ao vivo com esses objetos significa que quaisquer alterações em sua conta do Basecamp são refletidas imediatamente ao usar o conector.

Modelo de Dados Basecamp 2

Modelo de Dados Basecamp 2 descreve os esquemas disponíveis para se conectar às contas do Basecamp 2. Você pode usar tabelas para trabalhar com dados ao vivo do Basecamp. Você pode usar procedimentos armazenados* fornecido pelo Jitterbit Connector for Basecamp para automatizar o trabalho com dados do Basecamp.

Modelo de Dados Basecamp 3

Modelo de Dados Basecamp 3 descreve os esquemas disponíveis para se conectar às contas do Basecamp 3. Você pode usar tabelas para trabalhar com dados ao vivo do Basecamp. Você pode usar procedimentos armazenados* fornecido pelo Jitterbit Connector for Basecamp para automatizar o trabalho com dados do Basecamp.

Modelo de Dados Basecamp 2

Esta seção documenta as Tabelas, Visualizações e Procedimentos armazenados disponível para conectar-se a contas do Basecamp 2.

Tabelas

O conector modela os dados no Basecamp em uma lista de tabelas que podem ser consultadas usando instruções SQL padrão.

Geralmente, consultar tabelas Basecamp é o mesmo que consultar uma tabela em um banco de dados relacional. Às vezes, há casos especiais, por exemplo, incluir uma determinada coluna na cláusula WHERE pode ser necessário para obter dados para determinadas colunas na tabela. Isso geralmente é necessário para situações em que uma solicitação separada deve ser feita para cada linha para obter determinadas colunas. Esses tipos de situações estão claramente documentados na parte superior da página da tabela vinculada abaixo.

Conector Jitterbit para Tabelas Basecamp
Nome Descrição
Accesses Recupere, conceda e negue permissões de acesso a projetos e calendários no Basecamp.
CalendarEvents Recupere, crie, atualize e exclua eventos do calendário no Basecamp.
Calendars Recupere, crie, atualize e exclua calendários no Basecamp.
Documents Recupere, crie, atualize e exclua documentos no Basecamp.
People Recupere e exclua pessoas no Basecamp.
Projects Recupere, crie, atualize e exclua projetos no Basecamp.
Acessos

Recupere, conceda e negue permissões de acesso a projetos e calendários no Basecamp.

Informações Específicas da Tabela
Selecione

Você precisa especificar um ProjectId ou CalendarId para recuperar acessos. Essas colunas também são as únicas colunas suportadas pelo Basecamp como critérios de filtro; eles podem ser usados com o operador '='.

SELECT * FROM Accesses WHERE ProjectId = '11111111'
SELECT * FROM Accesses WHERE CalendarId = '11111111'
Inserir

Você pode conceder a alguém acesso a um projeto ou calendário usando seus endereços E-mail ou IDs (se já fizerem parte da organização).

INSERT INTO Accesses (ProjectId, EmailAddresses) VALUES ('11111111', 'someone@example.com, someoneelse@example.com')

INSERT INTO Accesses (CalendarId, Ids) VALUES ('11111111', '123456789, 987654321')
Atualizar

A atualização não é uma operação suportada para os acessos à tabela.

Excluir

Para revogar o acesso a alguém de um projeto ou calendário, especifique ProjectId ou CalendarId e o ID da pessoa.

DELETE FROM Accesses WHERE ProjectId = '11111111' AND Id = '123456789'
DELETE FROM Accesses WHERE CalendarId = '11111111' AND ID = '123456789'
Colunas
Nome Tipo Somente leitura Referências Descrição
Id [KEY] String Verdadeiro O identificador exclusivo da pessoa com acesso ao projeto ou calendário.
Admin Boolean Verdadeiro Valor booleano para mostrar se a pessoa atual é administrador ou não.
AppUrl String Verdadeiro O URL do aplicativo.
AvatarUrl String Verdadeiro A URL do avatar da pessoa.
CanCreateProjects Boolean Verdadeiro Se a pessoa pode criar projetos ou não.
CreatedAt Datetime Verdadeiro A data e a hora em que o registro foi criado.
EmailAddress String Verdadeiro O endereço e-mail da pessoa com acesso ao projeto ou calendário.
FullsizeAvatarUrl String Verdadeiro O URL do avatar em tamanho real da pessoa.
IdentityId String Verdadeiro O ID de identidade da pessoa com acesso ao projeto ou calendário.
IsClient Boolean Falso O usuário retornado é um cliente ou não?
Name String Verdadeiro O nome da pessoa com acesso ao projeto ou calendário.
Trashed Boolean Falso Valor booleano para pessoas excluídas.
UpdatedAt Datetime Verdadeiro A data e a hora em que o registro foi atualizado pela última vez.
URL String Verdadeiro A URL da pessoa.
Ids String Falso Uma lista separada por vírgulas de IDs de usuários que terão acesso a um projeto ou calendário.
EmailAddresses String Falso Uma lista separada por vírgulas de endereços e-mail de usuários aos quais será concedido acesso a um projeto ou calendário.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
ProjectId String O ID do projeto associado ao acesso.
CalendarId String O ID do calendário associado ao acesso.
CalendárioEventos

Recupere, crie, atualize e exclua eventos do calendário no Basecamp.

Informações Específicas da Tabela

Selecione

O Basecamp suporta apenas um subconjunto limitado de colunas a serem usadas como critérios de filtro na cláusula WHERE. Todas as colunas booleanas desta tabela podem ser usadas com o operador '='. ProjectId, CalendarId, StartsAt e EndsAt também podem ser usados com o operador "=". Além disso, a coluna StartsAt pode ser usada com o operador '>='.

A consultar a seguir filtra um intervalo de tempo específico.

SELECT * FROM CalendarEvents WHERE StartsAt = '2016-01-01' AND EndsAt = '2016-02-01'

As consultas a seguir obtêm CalendarEvents para um determinado projeto ou calendário.

SELECT * FROM CalendarEvents WHERE ProjectId= '123456768'
SELECT * FROM CalendarEvents WHERE CalendarId = '123456768'

Inserir

Especifique ProjectId ou CalendarId e StartsAt ao criar um novo CalendarEvent.

INSERT INTO CalendarEvents (ProjectId, Summary, Description, AllDay, StartsAt) VALUES ('12345678', 'My single, all-day Project event', 'Details to follow', 'true', 2016-02-01)

Atualizar e Excluir

Especifique ProjectId ou CalendarId e CalendarEvent ID ao atualizar ou excluir CalendarEvents.

UPDATE CalendarEvents SET Summary = 'Updated, two-day Project event', Description = 'Details to follow', AllDay = 'true', StartsAt = '2016-01-01', EndsAt = '2016-01-03' WHERE ProjectId = '12345678' AND Id = '12345678'

DELETE FROM CalendarEvents WHERE ProjectId = '12345678' AND ID = '12345678'
Colunas
Nome Tipo Somente leitura Referências Descrição
Id [KEY] String Verdadeiro O identificador exclusivo do evento de calendário.
AllDay Boolean Falso Se o evento de calendário é um evento de dia inteiro.
AppUrl String Verdadeiro O URL do aplicativo.
BucketAppUrl String Verdadeiro O URL do aplicativo de bucket do evento de calendário.
BucketColor String Verdadeiro A cor do intervalo de eventos do calendário.
BucketId String Verdadeiro O ID do intervalo do evento da agenda.
BucketName String Verdadeiro O nome do intervalo de eventos da agenda.
BucketType String Verdadeiro O tipo de bucket do evento da agenda.
BucketUrl String Verdadeiro O URL do intervalo de eventos da agenda.
CommentsCount Integer Verdadeiro O número de comentários neste evento de calendário.
CreatedAt Datetime Verdadeiro A data e a hora em que o evento de calendário foi criado.
CreatorAvatarUrl String Falso URL do avatar do criador.
CreatorFullsizeAvatarUrl String Falso URL do avatar em tamanho real do criador.
CreatorId String Falso A ID do criador do evento de calendário.
CreatorName String Falso O nome do criador do evento de calendário.
Description String Falso A descrição do evento de calendário.
EndsAt Datetime Falso A data e hora de término do evento de calendário.
Past Boolean Falso Valor booleano para eventos de calendário anteriores.
Private Boolean Falso Se este evento da agenda é privado.
RemindAt Datetime Falso A data e a hora do lembrete de evento do calendário.
StartsAt Datetime Falso A data e hora de início do evento de calendário.
SubscribersId String Falso A ID do assinante do evento de calendário.
SubscribersName String Falso O nome do assinante do evento de calendário.
Summary String Falso O resumo do evento de calendário.
Trashed Boolean Falso Valor booleano para eventos de calendário excluídos.
UpdatedAt Datetime Verdadeiro A data e a hora em que o evento do calendário foi atualizado.
Url String Verdadeiro A URL do evento da agenda.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
ProjectId String A ID do projeto associado ao evento de calendário.
CalendarId String O ID do calendário associado ao evento do calendário.
Calendários

Recupere, crie, atualize e exclua calendários no Basecamp.

Informações Específicas da Tabela
Selecione

Selecione tudo em Calendários ou especifique um ID para recuperar mais detalhes em um determinado Calendário (Id é a única coluna suportada como critério de pesquisa pelo Basecamp).

SELECT * FROM Calendars WHERE ID = '123456789'

Inserir

Especifique (pelo menos) a propriedade Nome para criar um novo Calendário na organização.

INSERT INTO Calendars (Name) VALUES ('New Test Calendar')

Atualizar e Excluir

Especifique uma ID de calendário para atualizar ou excluir calendários. Defina a propriedade Name novamente se estiver atualizando.

UPDATE Calendars SET Name = 'This is a new name for the Test Calendar.' WHERE Id = '123456789'

DELETE FROM Calendars WHERE ID = '123456789'
Colunas
Nome Tipo Somente leitura Referências Descrição
Id [KEY] String Verdadeiro O identificador exclusivo do calendário.
AccessesAppUrl String Verdadeiro O URL do aplicativo de acesso.
AccessesCount Integer Verdadeiro Os acessos contam.
AccessesUpdatedAt Datetime Verdadeiro A hora em que os acessos foram atualizados.
AccessesUrl String Verdadeiro A URL de acesso.
AppUrl String Verdadeiro O URL do aplicativo.
CalendarEventsCount Integer Verdadeiro Número de eventos do calendário.
CalendarEventsUpdatedAt Datetime Verdadeiro A data e a hora em que o evento do calendário foi atualizado pela última vez.
CalendarEventsUrlsPast String Verdadeiro URL do evento de calendário anterior.
CalendarEventsUrlsUpcoming String Verdadeiro A data e a hora em que o calendário foi atualizado pela última vez.
Color String Verdadeiro A cor do calendário.
CreatedAt Datetime Verdadeiro A data e a hora em que o documento foi criado.
CreatorAvatarUrl String Falso URL do avatar do criador.
CreatorFullsizeAvatarUrl String Falso URL do avatar em tamanho real do criador.
CreatorId String Falso A ID do criador do calendário.
CreatorName String Falso O nome do criador do calendário.
Name String Falso O nome do calendário.
UpdatedAt Datetime Verdadeiro A data e a hora em que o calendário foi atualizado pela última vez.
Url String Verdadeiro A URL do calendário.
Documentos

Recupere, crie, atualize e exclua documentos no Basecamp.

Informações Específicas da Tabela

Selecione

Você pode recuperar todos os documentos (para todos os projetos), selecionar documentos pertencentes apenas a um determinado projeto ou especificar um projeto e um determinado documento ao mesmo tempo (ProjectId e ID são as únicas colunas suportadas como critérios de pesquisa pelo Basecamp).

Você também pode classificar documentos por UpdatedAt, CreatedAt ou Title.

SELECT * FROM Documents WHERE ProjectId = '11111111' AND Id = '1234567689'

SELECT * FROM Documents ORDER BY UpdatedAt

SELECT * FROM Documents ORDER BY Title DESC

Inserir

Para adicionar um novo documento a um projeto principal, especifique o ProjectId e forneça o título do documento ou algum conteúdo.

INSERT INTO Documents (ProjectId, Title, Content) VALUES ('11111111', 'Memo', 'This is our document content')

Atualizar e Excluir

Especifique o ProjectId e o ID do documento para atualizar ou excluir um documento.

UPDATE Documents SET Title = 'Updated Memo3', Content = 'Updated Content of Memo.' WHERE ProjectId = '11111111' AND Id = '1234567689'

DELETE FROM Documents WHERE ProjectId = '11111111' AND ID = '12345678'
Colunas
Nome Tipo Somente leitura Referências Descrição
Id [KEY] String Verdadeiro O identificador exclusivo do documento.
AppUrl String Verdadeiro O URL do aplicativo.
BucketAppUrl String Verdadeiro O URL do aplicativo do intervalo de tópicos.
BucketColor String Verdadeiro A cor do balde de tarefas.
BucketId String Verdadeiro O ID do depósito de tarefas.
BucketName String Verdadeiro O nome do bloco de tarefas.
BucketType String Verdadeiro O tipo de balde de tarefas.
BucketUrl String Verdadeiro O URL do bloco de tarefas.
Content String Falso O conteúdo do documento.
CreatedAt Datetime Verdadeiro A data e a hora em que o documento foi criado.
CreatorAvatarUrl String Falso URL do avatar do criador.
CreatorFullsizeAvatarUrl String Falso URL do avatar em tamanho real do criador.
CreatorId String Falso O ID do criador do documento.
CreatorName String Falso O nome do criador do documento.
LastUpdaterId String Falso O ID da pessoa que atualizou o documento pela última vez.
LastUpdaterName String Falso O nome da pessoa que atualizou o documento pela última vez.
Private Boolean Falso Se esta tarefa é privada.
SubscribersId String Falso A ID do assinante do documento.
SubscribersName String Falso O nome do assinante do documento.
Title String Falso O título do documento.
Trashed Boolean Falso Valor booleano para tarefas excluídas.
UpdatedAt Datetime Verdadeiro A data e a hora em que o documento foi atualizado pela última vez.
URL String Verdadeiro A URL do documento.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
ProjectId String O ID do projeto associado ao documento.
Pessoas

Recupere e exclua pessoas no Basecamp.

Informações Específicas da Tabela

Selecione

Recupere todas as pessoas da organização, especifique um ID para obter mais informações ou veja quem foi excluído (é necessário acesso de administrador). ID e Trashed são as colunas suportadas pelo Basecamp como critérios de pesquisa.

SELECT * FROM People WHERE Id = '123456789'

SELECT * FROM People WHERE Trashed = true

Inserir

Novas Pessoas podem ser convidadas diretamente para Projetos através da tabela Acessos.

Atualizar

A atualização não é uma operação com suporte para a tabela Pessoas.

Excluir

Especifique o ID da pessoa para excluir o registro da organização.

DELETE FROM People WHERE ID = '123456789'
Colunas
Nome Tipo Somente leitura Referências Descrição
Id [KEY] String Verdadeiro O identificador exclusivo da pessoa.
AccountOwner Boolean Verdadeiro Valor booleano para mostrar se a pessoa atual é o proprietário da conta.
Admin Boolean Verdadeiro Valor booleano para mostrar se a pessoa atual é administrador ou não.
AssignedTodosCount Integer Verdadeiro Número de tarefas atribuídas.
AssignedTodosUpdatedAt Datetime Verdadeiro A data e a hora em que o registro foi atualizado.
AssignedTodosUrl String Verdadeiro A URL da tarefa atribuída.
AppUrl String Verdadeiro O URL do aplicativo.
AvatarUrl String Verdadeiro A URL do avatar da pessoa.
CalendarEventsTodayCount Integer Verdadeiro Número de eventos para hoje.
CanCreateProjects Boolean Verdadeiro Se a pessoa pode criar projetos ou não.
CreatedAt Datetime Verdadeiro A data e a hora em que o registro foi criado.
EmailAddress String Verdadeiro O endereço e-mail da pessoa.
EventsAppUrl String Verdadeiro O URL do aplicativo de eventos.
EventsCount Integer Verdadeiro Número de eventos.
EventsUpdatedAt Datetime Verdadeiro A data e a hora em que o evento foi atualizado.
EventsUrl String Verdadeiro A URL da tarefa atribuída.
FullsizeAvatarUrl String Verdadeiro O URL do avatar em tamanho real da pessoa.
HasBasecampSiblings Boolean Falso Valor booleano para irmãos Basecamp.
IdentityId String Verdadeiro O ID de identidade da pessoa.
Name String Verdadeiro O nome da pessoa.
OutstandingTodosCount Integer Verdadeiro Número de tarefas pendentes.
Trashed Boolean Falso Valor booleano para pessoas excluídas.
UpdatedAt Datetime Verdadeiro A data e a hora em que o registro foi atualizado pela última vez.
Url String Verdadeiro A URL da pessoa.
Projetos

Recupere, crie, atualize e exclua projetos no Basecamp.

Informações Específicas da Tabela

Selecione

Você pode recuperar todos os projetos ativos da organização, filtrar registros por rascunhos e projetos arquivados ou simplesmente definir uma ID de projeto para obter mais informações. Rascunhos, Arquivados e ID são as colunas suportadas como critérios de pesquisa pelo Basecamp.

SELECT * FROM Projects WHERE Drafts = True
SELECT * FROM Projects WHERE Advanced = True
SELECT * FROM Projects WHERE ID = '11111111'

Inserir

Especifique as propriedades Nome e Descrição no mínimo para criar um novo Projeto.

INSERT INTO Projects (Name, Description) VALUES ('Test Proj', 'This is a new test project.')

Atualizar e Excluir

Basta definir o ID do projeto para atualizar ou excluir um projeto ao qual você tem acesso.

UPDATE Projects SET Name = 'Updated Proj', Description = 'This is an updated test project.' WHERE Id = '11111111'

DELETE FROM Projects WHERE ID = '11111111'
Colunas
Nome Tipo Somente leitura Referências Descrição
Id [KEY] String Verdadeiro O identificador exclusivo do projeto.
AccessesAppUrl String Verdadeiro O URL do aplicativo de acesso.
AccessesCount Integer Verdadeiro Os acessos contam.
AccessesUpdatedAt Datetime Verdadeiro Momento em que os acessos foram atualizados.
AccessesUrl String Verdadeiro A URL de acesso.
AppUrl String Verdadeiro O URL do aplicativo.
Archived Boolean Falso Quando o usuário arquiva um projeto, esse valor será definido como verdadeiro.
AttachmentsAppUrl String Verdadeiro O URL do aplicativo de anexos.
AttachmentsCount Integer Verdadeiro Os anexos contam.
AttachmentsUpdatedAt Datetime Verdadeiro Hora em que os anexos foram atualizados.
AttachmentsUrl String Verdadeiro A URL dos anexos.
CalendarEventsAppUrl String Verdadeiro O URL do aplicativo de eventos de calendário.
CalendarEventsCount Integer Verdadeiro Os eventos do calendário contam.
CalendarEventsUpdatedAt Datetime Verdadeiro Hora em que os eventos do calendário foram atualizados.
CalendarEventsUrl String Verdadeiro O URL dos eventos do calendário.
Color String Verdadeiro Cor.
CreatedAt Datetime Verdadeiro O tempo de criação do projeto.
CreatorAvatarUrl String Falso URL do avatar do criador.
CreatorFullsizeAvatarUrl String Falso URL do avatar em tamanho real do criador.
CreatorId String Falso O ID do criador.
CreatorName String Falso O nome do criador.
Description String Falso A descrição do projeto.
DocumentsAppUrl String Verdadeiro A URL do aplicativo de documentos.
DocumentsCount Integer Verdadeiro Os documentos contam.
DocumentsUpdatedAt Datetime Verdadeiro Momento em que os documentos foram atualizados.
DocumentsUrl String Verdadeiro A URL dos documentos.
Drafts Boolean Falso Valor booleano para um projeto de rascunho.
ForwardsAppUrl String Verdadeiro O URL do aplicativo de encaminhamento.
ForwardsCount Integer Verdadeiro Os atacantes contam.
ForwardsUpdatedAt Datetime Verdadeiro Hora em que os encaminhamentos foram atualizados.
ForwardsUrl String Verdadeiro O URL de encaminhamento.
IsClientProject Boolean Falso Se o projeto está relacionado a clientes ou não.
LastEventAt Datetime Falso Hora em que o projeto foi modificado pela última vez.
Name String Falso O nome do projeto.
Starred Boolean Falso Valor booleano para um projeto com estrela.
Template Boolean Falso Valor booleano para um projeto modelo.
TodolistsAppUrl String Verdadeiro O URL do aplicativo listas de tarefas.
TodolistsCompletedCount Integer Verdadeiro As listas de tarefas concluídas contam.
TodolistsRemainingCount Integer Verdadeiro As listas de tarefas restantes contam.
TodolistsUpdatedAt Datetime Verdadeiro Horário em que as listas de tarefas foram atualizadas.
TodolistsUrl String Verdadeiro O URL das listas de tarefas.
TopicsAppUrl String Verdadeiro O URL do aplicativo de tópicos.
TopicsCount Integer Verdadeiro Os tópicos contam.
TopicsUpdatedAt Datetime Verdadeiro Momento em que os tópicos foram atualizados.
TopicsUrl String Verdadeiro A URL dos tópicos.
Trashed Boolean Falso Valor booleano para um projeto descartado.
UpdatedAt Datetime Verdadeiro Hora em que o projeto foi atualizado.
URL String Verdadeiro A URL do projeto.

Visualizações

As exibições são compostas por colunas e pseudocolunas. As exibições são semelhantes às tabelas na forma como os dados são representados; no entanto, as exibições não oferecem suporte a atualizações. Entidades que são representadas como exibições são normalmente entidades somente leitura. Frequentemente, um procedimento armazenado* está disponível para atualizar os dados se tal funcionalidade for aplicável à fonte de dados.

As consultas podem ser executadas em uma exibição como se fosse uma tabela normal, e os dados retornados são semelhantes nesse aspecto. Para saber mais sobre tabelas e procedimentos armazenados, navegue até as entradas correspondentes neste documento de ajuda.

Conector Jitterbit para Visualizações Basecamp
Nome Descrição
Attachments Recupere anexos no Basecamp.
Comments Recupere, crie, atualize e exclua calendários no Basecamp.
Events Recuperar eventos de atividade no Basecamp.
Forwards Recupere Forwards no Basecamp.
ToDoLists Recupere ToDoLists no Basecamp.
ToDos Recupere ToDos no Basecamp.
Topics Recuperar Tópicos no Basecamp.
Anexos

Recupere Anexos no Basecamp.

Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID do anexo.
Key String A chave do anexo.
Name String O nome do anexo.
ByteSize Int O tamanho do anexo em bytes.
CreatedAt Datetime A data em que o anexo foi criado.
UpdatedAt Datetime A data em que o anexo foi atualizado pela última vez.
Url String A URL do anexo.
AppUrl String O AppUrl do anexo.
ThumbnailUrl String O URL da miniatura do anexo.
Private Boolean Indica se o anexo é privado.
Trashed Boolean Indica se o anexo é descartado.
Tags String As tags do anexo.
CreatorId String A ID do criador do anexo.
CreatorName String O nome do criador do anexo.
CreatorAvatarUrl String desc=
CreatorFullsizeAvatarUrl String desc=
AttachableId String O ID do anexável.
AttachableType String O tipo do anexável.
AttachableUrl String O URL do anexável.
AttachableAppUrl String O AppUrl do anexável.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
ProjectId String
Comentários

Recupere, crie, atualize e exclua calendários no Basecamp.

Informações Específicas da Tabela

Selecione

Você pode recuperar todos os Comentários ativos na plataforma, e qualquer campo da tabela pode filtrar o resultado.

SELECT * FROM Comments

SELECT * FROM Comments WHERE ProjectId = '1111111' AND ItemType = 'Message'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O identificador exclusivo do comentário.
ProjectId [KEY] String O identificador exclusivo do projeto no qual o comentário está contido.
ItemId String O identificador exclusivo do tópico que contém o comentário.
ItemType String Tipo do objeto que contém o comentário. Os valores válidos são: Message, Document, Forward, CalendarEvent, Upload, Todolist, Todo.
AttachmentsAggregate String Os anexos relacionados ao comentário.
Content String O conteúdo do comentário.
Private Boolean Privacidade do comentário
Trashed Boolean Se o comentário foi descartado ou não.
CreatedAt Datetime A data e a hora em que o documento foi criado.
CreatorAvatarUrl String URL do avatar do criador.
CreatorFullsizeAvatarUrl String URL do avatar em tamanho real do criador.
CreatorId String A ID do criador do comentário.
CreatorName String O nome do criador do comentário.
UpdatedAt Datetime A data e a hora em que o comentário foi atualizado pela última vez.
Eventos

Recuperar eventos de atividade no Basecamp.

Informações Específicas da Tabela

Selecione

Você pode recuperar todos os eventos de atividade ou filtrar dados pela data de criação. As colunas e operadores suportados pelo Basecamp como critérios de pesquisa são mostrados abaixo.

Coluna Operadores
ProjectId =
PersonId =
CreatedAt >, >=

Por exemplo, a consultar a seguir recupera a atividade que ocorre após a data especificada para a pessoa especificada:

SELECT * FROM Events WHERE CreatedAt >= '2016-01-01' AND PersonId = '1111111'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O identificador exclusivo do evento.
Action String A descrição da ação para o evento.
BucketAppUrl String O URL do aplicativo de eventos de calendário.
BucketColor String A cor do evento do balde.
BucketId String O ID do evento do bucket.
BucketName String O nome do evento do bucket.
BucketType String O tipo de evento de balde.
BucketUrl String O URL do evento do bucket.
CreatedAt Datetime A data e a hora em que o evento foi criado.
CreatorAvatarUrl String URL do avatar do criador.
CreatorFullsizeAvatarUrl String URL do avatar em tamanho real do criador.
CreatorId String O ID do criador do evento.
CreatorName String O nome do criador do evento.
EventableAppUrl String URL do aplicativo programável.
EventableId String Id programável.
EventableType String Tipo evitável.
EventableUrl String URL programável.
Excerpt String O tipo de trecho para este evento.
HtmlUrl String O URL HTML do evento.
Private Boolean Se o evento é privado.
RawExcerpt String O tipo de trecho bruto para este evento.
Summary String O resumo do evento.
Target String O projeto-alvo deste evento.
UpdatedAt Datetime A data e a hora em que o evento foi atualizado pela última vez.
URL String A URL do evento.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
ProjectId String
PersonId String
Encaminha

Recupere Forwards no Basecamp.

Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID do encaminhamento.
Subject String O assunto da frente.
From String
CreatedAt Datetime A data em que o encaminhamento foi criado.
UpdatedAt Datetime A data em que o encaminhamento foi atualizado pela última vez.
Url String A URL do encaminhamento.
AppUrl String O AppUrl do encaminhamento.
Private Boolean Indica se o encaminhamento é privado.
Trashed Boolean Indica se o encaminhamento foi descartado.
BucketId String O ID do depósito do encaminhamento.
BucketName String O nome do bucket do encaminhamento.
BucketType String O tipo de balde do encaminhamento.
BucketUrl String O URL do balde do encaminhamento.
BucketAppUrl String O URL do aplicativo de bucket do encaminhamento.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
ProjectId String
ToDoLists

Recupere ToDoLists no Basecamp.

Informações Específicas da Tabela

Selecione

As seguintes colunas são suportadas pelo Basecamp como critérios de pesquisa:

  • ProjectId
  • Eu ia
  • PersonId
  • Concluído
  • Destruído
  • Criado em

CreatedAt pode ser usado com '>' ou operadores '>='.

A consultar a seguir recupera apenas ToDoLists concluídos pertencentes a um determinado projeto desde uma determinada data.

SELECT * FROM ToDoLists WHERE ProjectId = '11111111' AND Completed = True AND CreatedAt > '2016-01-01'M

A consultar a seguir recupera um único ToDoList de um determinado projeto.

SELECT * FROM ToDoLists WHERE ProjectId = '11111111' AND ID = '123456789'

A consultar a seguir recupera ToDoLists atribuídos a uma determinada pessoa.

SELECT * FROM ToDoLists WHERE PersonId = '11111111'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O identificador exclusivo do tópico.
AppUrl String O URL do aplicativo.
AssignedTodos String Tarefas atribuídas.
BucketAppUrl String O URL do aplicativo do intervalo de tópicos.
BucketColor String A cor do balde de tarefas.
BucketId String O ID do depósito de tarefas.
BucketName String O nome do bloco de tarefas.
BucketType String O tipo de balde de tarefas.
BucketUrl String O URL do bloco de tarefas.
Completed Boolean Se a lista de tarefas está concluída.
CompletedCount Integer Número de tarefas concluídas.
CreatedAt Datetime A data e a hora em que o registro foi criado.
CreatorAvatarUrl String URL do avatar do criador.
CreatorFullsizeAvatarUrl String URL do avatar em tamanho real do criador.
CreatorId String O ID do criador.
CreatorName String O nome do criador.
Description String A descrição da lista de tarefas.
Name String O nome da lista de tarefas.
Position Integer Número da posição da lista de tarefas atual.
Private Boolean Se a lista de tarefas é privada.
RemainingCount Integer Número de tarefas inacabadas.
SubscribersId String O ID do assinante.
SubscribersName String O nome do assinante.
ToDos String Lista de tarefas.
Trashed Boolean Valor booleano para listas de tarefas excluídas.
UpdatedAt Datetime A data e a hora em que o registro foi atualizado pela última vez.
URL String A URL da lista de tarefas.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
ProjectId String
PersonId String
Tarefas

Recupere ToDos no Basecamp.

Informações Específicas da Tabela

Selecione

A seguir estão as colunas suportadas como critérios de pesquisa pelo Basecamp:

  • ProjectId
  • ToDoListId
  • Eu ia
  • Concluído
  • Restante
  • Destruído
  • DueAt
  • Devido a

DueAt e DueOn podem ser usados com '>' ou operadores'>='.

A consultar a seguir recupera apenas ToDos concluídos pertencentes a um determinado projeto.

SELECT * FROM ToDos WHERE ProjectId = '11111111' AND Completed = True

A consultar a seguir filtra os ToDos que vencem desde uma determinada data.

SELECT * FROM ToDos WHERE ProjectId = '11111111' AND DueAt > '2016-01-01'

A consultar a seguir lista os ToDos restantes que pertencem a uma lista ToDo.

SELECT * FROM ToDos WHERE ProjectId = '11111111' AND ToDoListId = '123456789' AND Remaining = true
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O identificador exclusivo do tópico.
AppUrl String O URL do aplicativo.
AssigneeId String Id da pessoa a quem foi atribuído.
AssigneeName String Nome da pessoa designada.
AssigneeType String Tipo de cessionário.
CommentsCount Integer Número de comentários sobre esta tarefa.
Completed Boolean Se a tarefa foi concluída.
Content String Descrição da tarefa.
CreatedAt Datetime A data e a hora em que o registro foi criado.
CreatorAvatarUrl String URL do avatar do criador.
CreatorFullsizeAvatarUrl String URL do avatar em tamanho real do criador.
CreatorId String O ID do criador.
CreatorName String O nome do criador.
DueAt Datetime A data e a hora em que a tarefa está definida para o vencimento.
DueOn Datetime A data e a hora em que a tarefa está definida para o vencimento.
Position Integer Número da posição da tarefa atual na lista.
Private Boolean Se esta tarefa é privada.
Remaining Boolean Valor booleano para tarefas restantes.
SubscribersId String O ID do assinante.
SubscribersName String O nome do assinante.
ToDoList String Lista de afazeres.
ToDoListId String O ID da lista de tarefas.
Trashed Boolean Valor booleano para tarefas excluídas.
UpdatedAt Datetime A data e a hora em que o registro foi atualizado pela última vez.
URL String A URL da tarefa.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
ProjectId String
Tópicos

Recuperar Tópicos no Basecamp.

Informações Específicas da Tabela

Selecione

Você pode recuperar todos os tópicos ativos, classificar os tópicos que pertencem a um projeto ou apenas listar os tópicos arquivados (ProjectId e Archived são as únicas colunas suportadas como critérios de pesquisa pelo Basecamp).

SELECT * FROM Topics WHERE ProjectId = '1111111' ORDER BY UpdatedAt ASC

SELECT * FROM Topics WHERE ProjectId = '1111111' AND Archived = True
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O identificador exclusivo do tópico.
Archived Boolean Valor booleano para tópicos arquivados.
Attachments Integer O número de anexos ao tópico.
BucketAppUrl String O URL do aplicativo do intervalo de tópicos.
BucketColor String A cor do tópico do bucket.
BucketId String O ID do tópico do bucket.
BucketName String O nome do tópico do bucket.
BucketType String O tipo de tópico do bucket.
BucketUrl String O URL do tópico do bucket.
CreatedAt Datetime A data e a hora em que o registro foi criado.
Excerpt String O trecho do último comentário sobre o tema.
LastUpdaterId String O ID da pessoa que fez o último comentário.
LastUpdaterName String O nome da pessoa que atualizou o tópico pela última vez.
Private Boolean Se o tópico é privado.
Title String O título do tópico.
TopicableAppUrl String A URL da entidade Basecamp tópica.
TopicableId String O ID da entidade Basecamp tópica.
TopicableType String O tipo da entidade Basecamp tópica.
TopicableUrl String A URL da entidade Basecamp tópica.
Trashed Boolean Valor booleano para tópicos excluídos.
UpdatedAt Datetime A data e a hora em que o registro foi atualizado pela última vez.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
ProjectId String

Procedimentos Armazenados

Procedimentos armazenados* estão disponíveis para complementar os dados disponíveis no Modelo de Dados. Pode ser necessário atualizar os dados disponíveis em uma exibição usando um procedimento armazenado* porque os dados não fornecem atualizações bidirecionais diretas, semelhantes a tabelas. Nessas situações, a recuperação dos dados é feita usando a visualização ou tabela apropriada, enquanto a atualização é feita chamando um procedimento armazenado. Procedimentos armazenados* pega uma lista de parâmetros e retorna um conjunto de dados que contém a coleção de tuplas que constituem a resposta.

Conector Jitterbit para Procedimentos Armazenados Basecamp
Nome Descrição
GetOAuthAccessToken Obtém o token de acesso OAuth do Basecamp.
GetOAuthAuthorizationURL Obtém o URL de autorização do Basecamp. Acesse a URL retornada na saída em um navegador da Web. Isso solicita o token de acesso que pode ser usado como parte da string de conexão para o Basecamp.
PublishProject Publicará (ativará) um projeto criado a partir de um modelo (rascunho do projeto).
RefreshOAuthAccessToken Atualiza o token de acesso OAuth usado para autenticação com vários serviços Basecamp.
StarProject Vai estrelar um projeto especificado.
UnstarProject Desmarcará um projeto especificado.
GetOAuthAccessToken

Obtém o token de acesso OAuth do Basecamp.

Entrada
Nome Tipo Obrigatório Descrição
AuthMode String Verdade WEB ou APLICATIVO. O modo de autenticação Basecamp. O padrão é APP. O valor padrão é APP.
CallbackUrl String Falso A URL para a qual o usuário será redirecionado após autorizar seu aplicativo.
Verifier String Falso O token do verificador retornado pelo Basecamp. Necessário apenas para Web AuthMode.
State String Falso Este campo indica qualquer estado que pode ser útil para sua aplicação após o recebimento da resposta. Seu aplicativo recebe o mesmo valor que enviou, pois esse parâmetro faz uma viagem de ida e volta para o servidor de autorização do Basecamp. Os usos incluem redirecionar o usuário para o recurso correto em seu site, usar nonces e atenuar a falsificação de solicitação entre sites.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
OAuthAccessToken String O token OAuth.
OAuthRefreshToken String O token de atualização OAuth.
ExpiresIn String O tempo de vida restante do token de acesso em segundos.
GetOAuthAuthorizationURL

Obtém o URL de autorização do Basecamp. Acesse a URL retornada na saída em um navegador da Web. Isso solicita o token de acesso que pode ser usado como parte da string de conexão para o Basecamp.

Entrada
Nome Tipo Obrigatório Descrição
CallbackUrl String Falso A URL para a qual o Basecamp retornará depois que o usuário autorizar seu aplicativo.
State String Falso Este campo indica qualquer estado que pode ser útil para sua aplicação após o recebimento da resposta. Seu aplicativo recebe o mesmo valor que enviou, pois esse parâmetro faz uma viagem de ida e volta para o servidor de autorização do Basecamp. Os usos incluem redirecionar o usuário para o recurso correto em seu site, usar nonces e atenuar a falsificação de solicitação entre sites.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
URL String A URL a ser inserida em um navegador da Web para obter o token do verificador e autorizar o provedor de dados.
PublishProject

Publicará (ativará) um projeto criado a partir de um modelo (rascunho do projeto).

Entrada
Nome Tipo Obrigatório Descrição
ProjectId String Verdade ID do projeto.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Result String Resultado da criação do projeto.
RefreshOAuthAccessToken

Atualiza o token de acesso OAuth usado para autenticação com vários serviços Basecamp.

Entrada
Nome Tipo Obrigatório Descrição
OAuthRefreshToken String Verdade O token de atualização retornou com o token de acesso anterior.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
OAuthAccessToken String O token de autenticação retornado do Basecamp. Isso pode ser usado em chamadas subseqüentes para outras operações para este serviço específico.
OAuthRefreshToken String Um token que pode ser usado para obter um novo token de acesso.
ExpiresIn String O tempo de vida restante no token de acesso.
StarProject

Vai estrelar um projeto especificado.

Entrada
Nome Tipo Obrigatório Descrição
ProjectId String Verdade ID do projeto.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Result String Resultado da estrela do projeto.
UnstarProject

Desmarcará um projeto especificado.

Entrada
Nome Tipo Obrigatório Descrição
ProjectId String Verdade ID do projeto.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Result String Resultado unstar do projeto.

Modelo de Dados do Basecamp 3

Esta seção documenta as Tabelas, Visualizações e Procedimentos armazenados disponível para se conectar a contas do Basecamp 3.

Tabelas

O conector modela os dados no Basecamp em uma lista de tabelas que podem ser consultadas usando instruções SQL padrão.

Geralmente, consultar tabelas Basecamp é o mesmo que consultar uma tabela em um banco de dados relacional. Às vezes, há casos especiais, por exemplo, incluir uma determinada coluna na cláusula WHERE pode ser necessário para obter dados para determinadas colunas na tabela. Isso geralmente é necessário para situações em que uma solicitação separada deve ser feita para cada linha para obter determinadas colunas. Esses tipos de situações estão claramente documentados na parte superior da página da tabela vinculada abaixo.

Conector Jitterbit para Tabelas Basecamp
Nome Descrição
CalendarEvents Recupere eventos de calendário no Basecamp 3.
Comments Recupere comentários em uma gravação do Basecamp 3.
Documents Recupere, crie, atualize e exclua documentos no Basecamp 3.
Messages Recupere mensagens no Basecamp 3.
Projects Recupere, crie, atualize e exclua projetos no Basecamp 3.
ToDoLists Recupere ToDoLists no Basecamp 3.
ToDos Recupere ToDos no Basecamp 3.
Vaults Recupere Vaults (pastas) nas pastas do Basecamp 3.
CalendárioEventos

Recupere eventos de calendário no Basecamp 3.

Informações Específicas da Tabela

Você pode consultar os eventos do calendário no projeto especificado.

Selecione

As seguintes colunas são suportadas como critérios de pesquisa pelo Basecamp:

  • ProjectId
  • CalendárioId
  • Status (por padrão, apenas eventos ativos são recuperados)

Se ProjectId não for especificado na consultar, o ProjectId padrão será usado.

SELECT * FROM CalendarEvents WHERE ProjectId = '11111111' AND CalendarId = '22222222' AND Status = 'active'

Você também pode recuperar um único evento de calendário especificando o ID.

SELECT * FROM CalendarEvents WHERE  ProjectId = '11111111' AND ID = '33333333'

Inserir

Você pode inserir um novo evento de calendário fornecendo ProjectId, CalendarId, StartsAt, EndsAt e Summary como parâmetros necessários.

INSERT INTO CalendarEvents (ProjectId, CalendarId, Summary, StartsAt, EndsAt, Description, Notify, ParticipantsIds ) VALUES ( '1111111', '2222222', 'summary test', '2017-11-11 09:00Z', '2017-11-11 11:00Z', 'description', 'false', '3333333, 4444444')

Atualizar

Você também pode alterar o evento do calendário fornecendo o ProjectId e o ID do evento.

UPDATE CalendarEvents SET Summary = 'Updated summary',  StartsAt =  '2017-11-12', EndsAt = '2017-11-12', AllDay = 'true' WHERE ProjectId = '11111111' AND ID = '1234567689'

Excluir

Os eventos do calendário não podem ser excluídos.

Colunas
Nome Tipo Somente leitura Referências Descrição
Id [KEY] Long Verdadeiro O identificador exclusivo do evento da agenda.
ProjectId Long Verdadeiro Projetos.ID O ID do projeto associado ao cronograma.
CalendarId Long Verdadeiro Projetos.CalendarId O ID do calendário ao qual o evento pertence.
Status String Verdadeiro O status do evento de calendário.
Type String Verdadeiro O tipo do registro retornado.
CreatedAt Datetime Verdadeiro A data e a hora em que o evento de calendário foi criado.
UpdatedAt Datetime Verdadeiro A data e a hora em que o evento do calendário foi atualizado pela última vez.
Description String Falso Descrição fornecida para o evento de calendário.
AllDay Boolean Falso Indica que o evento é um evento de dia inteiro.
StartsAt Datetime Falso A data e a hora em que o evento do calendário começa.
EndsAt Datetime Falso A data e a hora em que o evento do calendário termina.
Summary String Falso Resumo fornecido para o evento do calendário.
ParticipantsIds String Falso Uma lista de IDs de participantes separados por vírgulas.
ParticipantsNames String Verdadeiro Uma lista de nomes de participantes separados por vírgulas.
ParentTitle String Verdadeiro Título do pai.
ParentType String Verdadeiro Tipo do pai.
BucketName String Verdadeiro Nome do bucket que o contém.
BucketType String Verdadeiro Tipo do bucket que o contém.
CreatorId Long Verdadeiro Pessoas.ID O ID do criador.
CreatorName String Verdadeiro O nome do criador.
CommentsCount Integer Verdadeiro Número de comentários que o documento possui.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
Notify String Quando definido como verdadeiro, notificará os participantes sobre o evento.
Comentários

Recupere comentários em uma gravação do Basecamp 3.

Informações Específicas da Tabela

Selecione

As colunas em Comentários são filtradas no lado do cliente. Você pode obter todos os comentários de uma gravação especificando o RecordingId ou pode obter um determinado comentário especificando seu Id.

Se ProjectId não for especificado na consultar, o ProjectId padrão será usado.

SELECT * FROM Comments WHERE ProjectId = '11111111' AND RecordingId = '222222222' AND Content = 'Exempli gratia' AND CreatedAt < '2017-04-18T15:53:38.040-06:00'

Você também pode recuperar um único comentário especificando o ID (desde que tenha especificado o ProjectId na conexão)

SELECT * FROM Comments WHERE ID = '1234567'

Inserir

Você pode inserir um novo comentário, fornecendo ProjectId, RecordingId e Content necessários.

INSERT INTO Comments (Content, ProjectId, RecordingId) VALUES ('Very informative document. Thanks!', 114857506, 392946856)

Atualizar

Você pode alterar as colunas que não são somente leitura fornecendo Id, ProjectId e novos valores.

UPDATE Comments SET Content='I like this better now' WHERE ProjectId='18061798' AND Id='1308746423'

Excluir

Os comentários não podem ser excluídos (sem suporte da API).

Colunas
Nome Tipo Somente leitura Referências Descrição
Id [KEY] String Verdadeiro O ID do comentário.
Content String Falso O conteúdo do comentário.
Title String Verdadeiro O título do comentário.
Status String Verdadeiro O status do comentário.
CreatedAt Datetime Verdadeiro A hora em que o comentário foi criado.
UpdatedAt Datetime Verdadeiro A hora em que o comentário foi atualizado pela última vez.
InheritsStatus Boolean Verdadeiro Se este comentário herda seu status ou não.
URL String Verdadeiro A URL do comentário.
VisibleToClients Boolean Verdadeiro Se este comentário é visível para os clientes ou não.
ProjectId Long Falso Projetos.ID O ID do projeto do qual este comentário é filho. Um projeto contém gravações.
ProjectName String Verdadeiro O nome do projeto do qual este comentário é filho.
RecordingId Long Falso Gravações.ID O ID da gravação em que o comentário está escrito. Uma gravação pode ser um comentário, documento, mensagem, pergunta:resposta, agendamento:entrada, todo, todolist ou upload.
CommenterId String Verdadeiro O ID do comentarista.
CommenterName String Verdadeiro O nome do comentarista.
CommenterIsAdmin Boolean Verdadeiro Se o comentarista é um administrador ou não.
CommenterIsOwner Boolean Verdadeiro Se o comentarista é o proprietário da gravação ou não.
CommenterTitle String Verdadeiro O título do comentarista.
CommenterEmail String Verdadeiro O endereço e-mail do comentarista.
CommenterAvatarURL String Verdadeiro A URL do avatar do comentarista.
CommenterCompanyId String Verdadeiro O ID da empresa do comentarista.
CommenterCompanyName String Verdadeiro O nome da empresa do comentarista.
AppURL String Verdadeiro O URL do aplicativo ao qual este comentário pertence.
BookmarkURL String Verdadeiro A URL do marcador.
CommenterAttachableSGID String Verdadeiro O SGID anexável do comentarista.
Documentos

Recupere, crie, atualize e exclua documentos no Basecamp 3.

Informações Específicas da Tabela

Selecione

Você pode recuperar todos os documentos pertencentes apenas a um determinado Projeto e Vault, ou especificar um Projeto e um determinado Documento ao mesmo tempo (ProjectId, VaultId e ID são as únicas colunas suportadas como critérios de pesquisa pelo Basecamp).

Se ProjectId não for especificado na consultar, o ProjectId padrão será usado.

SELECT * FROM Documents WHERE ProjectId = '11111111' AND VaultId = '222222222'

SELECT * FROM Documents WHERE ProjectId = '11111111' AND ID = '1234567689'

Inserir

Para adicionar um novo documento a um projeto importante, você precisa especificar ProjectId, Vaultid, Title, Content e Status (opcional).

INSERT INTO Documents (ProjectId, Vaultid, Title, Content, Status) VALUES ('11111111', '222222222', 'Memo', 'This is our document content', 'active')

Atualizar

Especifique o ProjectId e o ID do documento para atualizar um documento.

UPDATE Documents SET Title = 'Updated Memo3', Content = 'Updated Content of Memo.' WHERE ProjectId = '11111111' AND ID = '1234567689'

Excluir

DELETE não é compatível com esta tabela.

Colunas
Nome Tipo Somente leitura Referências Descrição
Id [KEY] Long Verdadeiro O identificador exclusivo do documento.
ProjectId Long Verdadeiro Projetos.ID O ID do projeto associado ao documento.
VaultId Long Verdadeiro Cofres.ID A ID do cofre associada ao documento.
Status String Falso O status do cofre.
Title String Falso O título do documento.
Content String Falso O conteúdo do Documento
Type String Verdadeiro O tipo do registro retornado.
CreatedAt Datetime Verdadeiro A data e a hora em que o documento foi criado.
UpdatedAt Datetime Verdadeiro A data e a hora em que o documento foi atualizado pela última vez.
ParentTitle String Verdadeiro Título do pai.
ParentType String Verdadeiro Tipo do pai.
BucketName String Verdadeiro Nome do bucket que o contém.
BucketType String Verdadeiro Tipo do bucket que o contém.
CreatorId Long Verdadeiro Pessoas.ID O ID do criador.
CreatorName String Verdadeiro O nome do criador.
CommentsCount Integer Verdadeiro Número de comentários que o documento possui.
Mensagens

Recupere mensagens no Basecamp 3.

Informações Específicas da Tabela

Você pode consultar as mensagens postadas no quadro de mensagens do projeto especificado.

Selecione

As colunas suportadas como critérios de pesquisa pelo Basecamp são ProjectId, MessageBoardId.

Se ProjectId não for especificado na consultar, o ProjectId padrão será usado.

SELECT * FROM Messages WHERE ProjectId = '11111111' AND MessageBoardId = '22222222'

Você também pode recuperar uma única mensagem especificando o ID.

SELECT * FROM Messages WHERE  ProjectId = '11111111' AND ID = '33333333'

Inserir

Você pode inserir uma nova mensagem, fornecendo o ProjectId, MessageBoardId e Subject necessários, além dos parâmetros relacionados à mensagem.

INSERT INTO Messages (ProjectId, MessageBoardId, Content, Subject, Status ) VALUES ('1111111', '2222222', 'Content test', 'Subject test',  'active')

Atualizar

Você também pode atualizar as mensagens fornecendo o ProjectId e o ID da mensagem.

UPDATE Messages SET subject = 'Updated subject', content = 'Updated content'  WHERE ProjectId = '11111111' AND ID = '1234567689'

Excluir

As mensagens não podem ser excluídas.

Colunas
Nome Tipo Somente leitura Referências Descrição
Id [KEY] Long Verdadeiro O identificador exclusivo da mensagem.
ProjectId Long Verdadeiro Projetos.ID O ID do projeto associado ao cronograma.
MessageBoardId Long Verdadeiro Projetos.MessageBoardId O ID do quadro de mensagens ao qual a mensagem pertence.
Status String Falso O status da mensagem
Type String Verdadeiro O tipo do registro retornado.
CreatedAt Datetime Verdadeiro A data e a hora em que a mensagem foi criada.
UpdatedAt Datetime Verdadeiro A data e a hora em que a mensagem foi atualizada pela última vez.
Content String Falso Conteúdo fornecido para a mensagem
Subject String Falso Assunto da mensagem
ParentTitle String Verdadeiro Título do pai.
ParentType String Verdadeiro Tipo do pai.
BucketName String Verdadeiro Nome do bucket que o contém.
BucketType String Verdadeiro Tipo do bucket que o contém.
CreatorId Long Verdadeiro Pessoas.ID O ID do criador.
CreatorName String Verdadeiro O nome do criador.
CategoryId Long Falso O ID da categoria.
CategoryName String Verdadeiro O nome da categoria.
CommentsCount Integer Verdadeiro Número de comentários que o documento possui.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
IncludeReplies Boolean Defina como true para recuperar respostas para cada mensagem.
Projetos

Recupere, crie, atualize e exclua projetos no Basecamp 3.

Informações Específicas da Tabela

Selecione

Você pode recuperar todos os projetos ativos da organização ou definir um ID de projeto para recuperar um único projeto. ID é a única coluna suportada como critério de pesquisa pelo Basecamp.

SELECT * FROM Projects
SELECT * FROM Projects WHERE ID = '11111111'

Inserir

Especifique pelo menos as propriedades Nome e, opcionalmente, Descrição para criar um novo Projeto.

INSERT INTO Projects (Name, Description) VALUES ('Test Proj', 'This is a new test project.')

Atualizar e Excluir

Defina o ID do projeto para atualizar ou excluir um projeto ao qual você tem acesso.

UPDATE Projects SET Name = 'Updated Project', Description = 'This is an updated test project.' WHERE Id = '11111111'

DELETE FROM Projects WHERE ID = '11111111'
Colunas
Nome Tipo Somente leitura Referências Descrição
Id [KEY] Long Verdadeiro O identificador exclusivo do projeto.
Status String Verdadeiro O estado do projeto.
Purpose String Verdadeiro O objetivo do projeto.
CreatedAt Datetime Verdadeiro O tempo de criação do projeto.
UpdatedAt Datetime Verdadeiro Hora em que o projeto foi atualizado.
Description String Falso A descrição do projeto.
Name String Falso O nome do projeto.
Bookmarked Boolean Falso Valor booleano para um projeto marcado.
CalendarId Long Verdadeiro Id do calendário do projeto.
ChatId Long Verdadeiro Id do chat do projeto.
ToDoSetId Long Verdadeiro ID do ToDo Set do projeto.
MessageBoardId Long Verdadeiro Id do quadro de mensagens do projeto.
QuestionnaireId Long Verdadeiro Id do Questionário do projeto.
VaultId Long Verdadeiro Id do Vault do projeto.
InboxId Long Verdadeiro Id da caixa de entrada do projeto.
ToDoLists

Recupere ToDoLists no Basecamp 3.

Informações Específicas da Tabela

Selecione

As seguintes colunas são suportadas pelo Basecamp como critérios de pesquisa:

  • ProjectId
  • ToDoSetId e Status
  • ProjectId e ID

ToDoSetId pode ser recuperado na tabela Projetos.

A consultar a seguir recupera apenas listas de tarefas concluídas pertencentes a um determinado projeto e um determinado status. Se ProjectId não for especificado na consultar, o ProjectId padrão será usado.

SELECT * FROM ToDoLists WHERE ProjectId = '11111111' AND ToDoSetId = '2222222' AND Status = 'active'

A consultar a seguir recupera um único ToDoList de um determinado projeto.

SELECT * FROM ToDoLists WHERE ProjectId = '11111111' AND ID = '123456789'

Inserir

Especifique o Nome, ProjectId, Descrição (opcional) e o ToDoSetId para inserir uma lista de tarefas pendentes.

INSERT INTO ToDoLists (Name, Description, ProjectId, ToDoSetId ) VALUES ('Name', 'desc', '11111111', '2222222')

Atualizar

O Basecamp permite alterar o nome e a descrição da lista de tarefas, desde que o ProjectId e o ID da lista de tarefas sejam incluídos na consultar:

UPDATE ToDoLists Set Name = 'Updated Name', Description = 'Updated desc' Where ProjectId = '11111111' AND ID = '1234567689'

Excluir

As listas de tarefas não podem ser excluídas.

Colunas
Nome Tipo Somente leitura Referências Descrição
Id [KEY] Long Verdadeiro O identificador exclusivo do tópico.
ProjectId Long Verdadeiro Projetos.ID O ID do projeto associado à lista de tarefas.
ToDoSetId Long Verdadeiro Projetos.ToDoSetId A ID do To Do Set à qual a lista de tarefas pertence.
Status String Verdadeiro O status de tarefa pendente.
Type String Verdadeiro O tipo de registro.
Name String Falso O nome da tarefa.
Completed Boolean Verdadeiro O estado de afazeres.
CompletedRatio String Verdadeiro O estado de tarefas em proporção.
Description String Falso A descrição da lista de tarefas.
CreatedAt Datetime Verdadeiro A data e a hora em que o evento foi criado.
UpdatedAt Datetime Verdadeiro A data e a hora em que o registro foi atualizado pela última vez.
BucketName String Verdadeiro O nome do intervalo da lista de tarefas.
BucketType String Verdadeiro O tipo de bucket da lista de tarefas.
ParentTitle String Verdadeiro Título do pai.
ParentType String Verdadeiro Tipo do pai.
CreatorId Long Verdadeiro Pessoas.ID ID do criador do evento.
CreatorAttachableSgid String Verdadeiro SGID anexável do criador do evento.
CreatorName String Verdadeiro Nome do criador do evento.
CreatorEmailAddress String Verdadeiro Endereço E-mail do criador do evento.
CreatorTitle String Verdadeiro Título do criador do evento.
CreatorBio String Verdadeiro Biografia do criador do evento.
CreatorCreatedAt Datetime Verdadeiro Data e hora de criação do criador do evento.
CreatorUpdatedAt Datetime Verdadeiro Data e hora de atualização do criador do evento.
CreatorAdmin Boolean Verdadeiro Indicação booleana se o criador do evento é um administrador.
CreatorOwner Boolean Verdadeiro Indicação booleana se o criador do evento é um proprietário.
CreatorTimeZone String Verdadeiro Fuso horário do criador do evento.
CreatorCompanyId Long Verdadeiro ID da empresa do criador do evento.
CreatorCompanyName String Verdadeiro Nome da empresa do criador do evento.
CommentsCount Integer Verdadeiro Número de comentários que o documento possui.
Tarefas

Recupere ToDos no Basecamp 3.

Informações Específicas da Tabela

Selecione

As seguintes colunas são suportadas como critérios de pesquisa pelo Basecamp:

  • ProjectId
  • ToDoListId
  • Eu ia
  • Concluído
  • Status

Por padrão, apenas as tarefas ativas serão recuperadas.

Se ProjectId não for especificado na consultar, o ProjectId padrão será usado.

SELECT * FROM ToDos WHERE  ProjectId = '11111111' AND ToDoListId = '222222222' AND Status = 'active' AND Completed = True

Você também pode recuperar uma única tarefa especificando o Id.

SELECT * FROM ToDos WHERE  ProjectId = '11111111' AND ID = '33333333'

Inserir

Você pode inserir uma nova tarefa fornecendo o ProjectId, ToDoListId e Content necessários, além dos parâmetros relacionados à tarefa.

INSERT INTO ToDos (Content, Description, DueOn, StartsOn, AssigneeIds, ProjectId, ToDoListId ) VALUES ('What to do','description','2017-11-11', '2017-11-12', '333333333','1111111111', '22222222')

Atualizar

Você pode alterar as colunas que não são somente leitura fornecendo ProjectId, ID de tarefa e novos valores.

UPDATE ToDos Set Content = 'Updated content' Where ProjectId = '11111111' AND ID = '1234567689'

Você pode alterar o estado Concluído da tarefa fornecendo o ProjectId e a ID da tarefa. A coluna Completed só pode ser atualizada de forma autônoma e outras colunas não podem ser atualizadas na mesma consultar.

UPDATE ToDos Set Completed = True Where ProjectId = '11111111' AND ID = '1234567689'

Excluir

As tarefas não podem ser excluídas.

Colunas
Nome Tipo Somente leitura Referências Descrição
Id [KEY] Long Verdadeiro O identificador exclusivo do todo.
ProjectId Long Verdadeiro Projetos.ID O ID do projeto associado à lista de tarefas.
ToDoListId Long Verdadeiro ToDoLists.ID O ID da lista de tarefas à qual a tarefa pertence.
Status String Verdadeiro O estado a tarefa.
CreatedAt Datetime Verdadeiro A data e a hora em que o evento foi criado.
UpdatedAt Datetime Verdadeiro A data e a hora em que o registro foi atualizado pela última vez.
StartsOn Date Falso A data e a hora em que o todo deve começar.
DueOn Date Falso A data e a hora em que a tarefa é devida.
CommentsCount Integer Verdadeiro Número de comentários que o documento possui.
Description String Falso A descrição da lista de tarefas.
Content String Falso O que fazer.
AssigneesIds String Falso Lista de IDs de usuários atribuídos.
Completed Boolean Falso O estado de afazeres.
CompletedAt Datetime Verdadeiro A data e a hora em que a tarefa foi concluída.
CompletionCreatorId String Verdadeiro A ID do usuário que concluiu a tarefa.
CompletionCreatorName String Verdadeiro O nome do usuário que concluiu a tarefa.
BucketName String Verdadeiro O nome do intervalo da lista de tarefas.
BucketType String Verdadeiro O tipo de bucket da lista de tarefas.
ParentTitle String Verdadeiro Título do pai.
ParentType String Verdadeiro Tipo do pai.
CreatorId Long Verdadeiro Pessoas.ID ID do criador do evento.
CreatorAttachableSgid String Verdadeiro SGID anexável do criador do evento.
CreatorName String Verdadeiro Nome do criador do evento.
CreatorEmailAddress String Verdadeiro Endereço E-mail do criador do evento.
CreatorTitle String Verdadeiro Título do criador do evento.
CreatorBio String Verdadeiro Biografia do criador do evento.
CreatorCreatedAt Datetime Verdadeiro Data e hora de criação do criador do evento.
CreatorUpdatedAt Datetime Verdadeiro Data e hora de atualização do criador do evento.
CreatorAdmin Boolean Verdadeiro Indicação booleana se o criador do evento é um administrador.
CreatorOwner Boolean Verdadeiro Indicação booleana se o criador do evento é um proprietário.
CreatorTimeZone String Verdadeiro Fuso horário do criador do evento.
CreatorCompanyId String Verdadeiro ID da empresa do criador do evento.
CreatorCompanyName String Verdadeiro Nome da empresa do criador do evento.
Cofres

Recupere Vaults (pastas) nas pastas do Basecamp 3.

Informações Específicas da Tabela

Todos os projetos têm um Vault principal (pasta). Vaults adicionais podem ser aninhados no Vault principal ou em qualquer Vault filho.

Selecione

As colunas suportadas como critérios de pesquisa pelo Basecamp são ProjectId, VaultId e Id. Se ProjectId não for especificado na consultar, o ProjectId padrão será usado.

SELECT * FROM Vaults WHERE  ProjectId = '11111111' AND VaultId = '222222222'

Você também pode recuperar uma única tarefa especificando o ID.

SELECT * FROM Vaults WHERE  ProjectId = '11111111' ID = '333333333'

Inserir

Você pode inserir um novo Vault fornecendo ProjectId, VaultId e Title, que são parâmetros obrigatórios.

INSERT INTO Vaults (Title, ProjectId, Vaultid) VALUES ('InsertedVault', '11111111', '222222222')

Atualizar

Você pode atualizar o título do Vault fornecendo ProjectId, VaultId e o novo título.

UPDATE Vaults SET Title = 'Updated title' WHERE ProjectId = '11111111' AND ID = '333333333'

Excluir

Os cofres não podem ser excluídos.

Colunas
Nome Tipo Somente leitura Referências Descrição
Id [KEY] Long Verdadeiro O identificador exclusivo do tópico.
ProjectId Long Verdadeiro Projetos.ID O ID do projeto associado ao cofre.
Status String Verdadeiro O status do cofre.
Title String Falso O título do registro retornado.
Type String Verdadeiro O tipo do registro retornado.
CreatedAt Datetime Verdadeiro A data e a hora em que o registro foi criado.
UpdatedAt Datetime Verdadeiro A data e a hora em que o registro foi atualizado pela última vez.
ParentId Long Verdadeiro Id do pai.
ParentTitle String Verdadeiro Título do pai.
ParentType String Verdadeiro Tipo do pai.
BucketId Long Verdadeiro ID do bucket que o contém.
BucketName String Verdadeiro Nome do bucket que o contém.
BucketType String Verdadeiro Tipo do bucket que o contém.
CreatorId Long Verdadeiro Pessoas.ID O ID do criador.
CreatorName String Verdadeiro O nome do criador.
DocumentsCount Integer Verdadeiro Número de documentos que o cofre contém.
UploadsCount Integer Verdadeiro Número de uploads que o cofre contém.
VaultsCount Integer Verdadeiro Número de cofres que o cofre contém.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
VaultId Long O ID do Vault ao qual o registro pertence.

Visualizações

As exibições são compostas por colunas e pseudocolunas. As exibições são semelhantes às tabelas na forma como os dados são representados; no entanto, as exibições não oferecem suporte a atualizações. Entidades que são representadas como exibições são normalmente entidades somente leitura. Frequentemente, um procedimento armazenado* está disponível para atualizar os dados se tal funcionalidade for aplicável à fonte de dados.

As consultas podem ser executadas em uma exibição como se fosse uma tabela normal, e os dados retornados são semelhantes nesse aspecto. Para saber mais sobre tabelas e procedimentos armazenados, navegue até as entradas correspondentes neste documento de ajuda.

Conector Jitterbit para Visualizações Basecamp
Nome Descrição
Assignments Recupere atribuições no Basecamp 3.
Calendars Recupere calendários no Basecamp 3.
Events Recupere eventos de atividade no Basecamp 3.
People Recupere pessoas no Basecamp 3.
Recordings Recupere as gravações nas pastas do Basecamp 3.
Uploads Recupere uploads no Basecamp 3.
Atribuições

Recupere atribuições no Basecamp 3.

Colunas
Nome Tipo Referências Descrição
Id [KEY] Long O identificador exclusivo da pessoa.
TodoListId Long ToDoLists.ID O identificador exclusivo da lista de tarefas.
ProjectId Long Projetos.ID Use o filtro para recuperar pessoas ativas no projeto com o ID fornecido.
Name String O nome da pessoa.
Owner Boolean Valor booleano para mostrar se a pessoa atual é o proprietário da conta.
Admin Boolean Valor booleano para mostrar se a pessoa atual é administrador ou não.
Title String O título da pessoa.
Bio String Descrição bio da pessoa.
CreatedAt Datetime A data e a hora em que o registro foi criado.
UpdatedAt Datetime A data e a hora em que o registro foi atualizado pela última vez.
EmailAddress String O endereço e-mail da pessoa.
AttachableSgid String O ID do Grupo de Conjunto anexável.
PersonableType String Tipo da pessoa.
TimeZone String Fuso horário legível por humanos para o usuário.
CompanyId Long ID da empresa dos usuários.
CompanyName String Nome da empresa dos usuários.
Calendários

Recupere calendários no Basecamp 3.

Informações Específicas da Tabela

Existe apenas um Calendário (Agenda) em cada projeto Basecamp.

Selecione

Recupere mais detalhes em um calendário específico (ProjectId e ID são as únicas colunas suportadas como critérios de pesquisa pelo Basecamp). Se ProjectId não for especificado na consultar, o ProjectId padrão será usado.

SELECT * FROM Calendars WHERE ProjectId = '111111111' AND ID = '123456789'
Colunas
Nome Tipo Referências Descrição
Id [KEY] Long Projetos.CalendarId O identificador exclusivo do calendário.
ProjectId Long Projetos.ID O ID do projeto associado ao calendário.
Status String O status do calendário.
Type String O tipo do registro retornado.
CreatedAt Datetime A data e a hora em que o calendário foi criado.
UpdatedAt Datetime A data e a hora em que o calendário foi atualizado pela última vez.
Title String Título do calendário.
EntriesCount Integer Número de eventos do calendário.
BucketId Long ID do bucket que o contém.
BucketName String Nome do bucket que o contém.
BucketType String Tipo do bucket que o contém.
CreatorId Long Pessoas.ID O ID do criador.
CreatorName String O nome do criador.
Eventos

Recuperar eventos de atividade no Basecamp 3.

Ver Informações Específicas

Um evento é criado sempre que uma gravação é alterada.

Selecione

Você pode recuperar todos os eventos de atividade no projeto e gravação especificados. As colunas suportadas como critérios de pesquisa pelo Basecamp são ProjectId e RecordingId.

Se ProjectId não for especificado na consultar, o ProjectId padrão será usado.

SELECT * FROM Events WHERE ProjectId = '1111111' AND RecordingId = '22222222'
Colunas
Nome Tipo Referências Descrição
Id [KEY] Long O identificador exclusivo do evento.
ProjectId Long Projetos.ID O ID do projeto associado ao documento.
RecordingId Long Gravações.ID A ID da gravação associada a este evento.
Action String A descrição da ação para o evento.
Details String Detalhes sobre o evento.
CreatedAt Datetime A data e a hora em que o evento foi criado.
CreatorId Long Pessoas.ID ID do criador do evento.
CreatorAttachableSgid String SGID anexável do criador do evento.
CreatorName String Nome do criador do evento.
CreatorEmailAddress String Endereço E-mail do criador do evento.
CreatorTitle String Título do criador do evento.
CreatorBio String Biografia do criador do evento.
CreatorCreatedAt Datetime Data e hora de criação do criador do evento.
CreatorUpdatedAt Datetime Data e hora de atualização do criador do evento.
CreatorAdmin Boolean Indicação booleana se o criador do evento é um administrador.
CreatorOwner Boolean Indicação booleana se o criador do evento é um proprietário.
CreatorTimeZone String Fuso horário do criador do evento.
CreatorCompanyId Long ID da empresa do criador do evento.
CreatorCompanyName String Nome da empresa do criador do evento.
Pessoas

Recupere pessoas no Basecamp 3.

Ver Informações Específicas

Selecione

Recupere todas as pessoas visíveis para o usuário atual, liste as pessoas por projeto ou especifique uma ID para obter mais informações. ID e ProjectId são as colunas suportadas pelo Basecamp como critérios de pesquisa.

SELECT * FROM People

SELECT * FROM People WHERE Id = '123456789'

SELECT * FROM People WHERE ProjectId = '5168618'
Colunas
Nome Tipo Referências Descrição
Id [KEY] Long O identificador exclusivo da pessoa.
Name String O nome da pessoa.
Owner Boolean Valor booleano para mostrar se a pessoa atual é o proprietário da conta.
Admin Boolean Valor booleano para mostrar se a pessoa atual é administrador ou não.
Title String O título da pessoa.
Bio String Descrição bio da pessoa.
CreatedAt Datetime A data e a hora em que o registro foi criado.
UpdatedAt Datetime A data e a hora em que o registro foi atualizado pela última vez.
EmailAddress String O endereço e-mail da pessoa.
AttachableSgid String O ID do Grupo de Conjunto anexável.
PersonableType String Tipo da pessoa.
TimeZone String Fuso horário legível por humanos para o usuário.
CompanyId Long ID da empresa dos usuários.
CompanyName String Nome da empresa dos usuários.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
ProjectId Long
Gravações

Recupere as gravações nas pastas do Basecamp 3.

Ver Informações Específicas

Recupere a maioria das estruturas de dados no Basecamp 3, que são representadas como "Gravações".

Selecione

As colunas suportadas como critérios de pesquisa pelo Basecamp são Type (parâmetro obrigatório), Bucket e Status.

SELECT * FROM Recordings WHERE type = 'Upload' AND Bucket = '1111111, 22222222' AND Status = 'active'
Colunas
Nome Tipo Referências Descrição
Id [KEY] Long O identificador exclusivo do tópico.
Status String O status do cofre. Os valores permitidos são ativo, arquivado, descartado.
Type String O tipo do cofre. Os valores permitidos são Comentário, Documento, Mensagem, Pergunta:Resposta, Agenda:Entrada, Todo, Todolist, Upload.
CreatedAt Datetime A data e a hora em que o evento foi criado.
UpdatedAt Datetime A data e a hora em que o evento foi modificado pela última vez.
CreatorId Long Pessoas.ID Criador de eventos.
CreatorName String Criador de eventos.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
Bucket String
Uploads

Recuperar uploads no Basecamp 3.

Colunas
Nome Tipo Referências Descrição
Id [KEY] Long O identificador exclusivo do arquivo carregado.
ProjectId Long Projetos.ID O ID do projeto associado ao arquivo carregado.
VaultId Long Cofres.ID O ID do Vault associado ao arquivo carregado.
Status String O status do cofre.
Title String O título do arquivo carregado.
ContentType String O tipo de conteúdo do arquivo carregado
Type String O tipo do registro retornado.
CreatedAt Datetime A data e a hora em que o arquivo carregado foi criado.
UpdatedAt Datetime A data e a hora em que o arquivo carregado foi atualizado pela última vez.
ParentTitle String Título do pai.
ParentType String Tipo do pai.
BucketName String Nome do bucket que o contém.
BucketType String Tipo do bucket que o contém.
CreatorId Long Pessoas.ID O ID do criador.
CreatorName String O nome do criador.
CommentsCount Integer Número de comentários que o arquivo carregado possui.
DownloadURL String Número de comentários que o arquivo carregado possui.
ByteSize Integer Número de comentários que o arquivo carregado possui.

Procedimentos Armazenados

Procedimentos armazenados* estão disponíveis para complementar os dados disponíveis no Modelo de Dados. Pode ser necessário atualizar os dados disponíveis em uma exibição usando um procedimento armazenado* porque os dados não fornecem atualizações bidirecionais diretas, semelhantes a tabelas. Nessas situações, a recuperação dos dados é feita usando a visualização ou tabela apropriada, enquanto a atualização é feita chamando um procedimento armazenado. Procedimentos armazenados* pega uma lista de parâmetros e retorna um conjunto de dados que contém a coleção de tuplas que constituem a resposta.

Conector Jitterbit para Procedimentos Armazenados Basecamp
Nome Descrição
GetOAuthAccessToken Obtém o token de acesso OAuth do Basecamp.
GetOAuthAuthorizationURL Obtém o URL de autorização do Basecamp. Acesse a URL retornada na saída em um navegador da Web. Isso solicita o token de acesso que pode ser usado como parte da string de conexão para o Basecamp.
RefreshOAuthAccessToken Atualiza o token de acesso OAuth usado para autenticação com vários serviços Basecamp.
GetOAuthAccessToken

Obtém o token de acesso OAuth do Basecamp.

Entrada
Nome Tipo Obrigatório Descrição
AuthMode String Verdade WEB ou APLICATIVO. O modo de autenticação Basecamp. O padrão é APP. O valor padrão é APP.
CallbackUrl String Falso A URL para a qual o usuário será redirecionado após autorizar seu aplicativo.
Verifier String Falso O token do verificador retornado pelo Basecamp. Necessário apenas para Web AuthMode.
State String Falso Este campo indica qualquer estado que pode ser útil para sua aplicação após o recebimento da resposta. Seu aplicativo recebe o mesmo valor que enviou, pois esse parâmetro faz uma viagem de ida e volta para o servidor de autorização do Basecamp. Os usos incluem redirecionar o usuário para o recurso correto em seu site, usar nonces e atenuar a falsificação de solicitação entre sites.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
OAuthAccessToken String O token OAuth.
OAuthRefreshToken String O token de atualização OAuth.
ExpiresIn String O tempo de vida restante do token de acesso em segundos.
GetOAuthAuthorizationURL

Obtém o URL de autorização do Basecamp. Acesse a URL retornada na saída em um navegador da Web. Isso solicita o token de acesso que pode ser usado como parte da string de conexão para o Basecamp.

Entrada
Nome Tipo Obrigatório Descrição
CallbackUrl String Falso A URL para a qual o Basecamp retornará depois que o usuário autorizar seu aplicativo.
State String Falso Este campo indica qualquer estado que pode ser útil para sua aplicação após o recebimento da resposta. Seu aplicativo recebe o mesmo valor que enviou, pois esse parâmetro faz uma viagem de ida e volta para o servidor de autorização do Basecamp. Os usos incluem redirecionar o usuário para o recurso correto em seu site, usar nonces e atenuar a falsificação de solicitação entre sites.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
URL String A URL a ser inserida em um navegador da Web para obter o token do verificador e autorizar o provedor de dados.
RefreshOAuthAccessToken

Atualiza o token de acesso OAuth usado para autenticação com vários serviços Basecamp.

Entrada
Nome Tipo Obrigatório Descrição
OAuthRefreshToken String Verdade O token de atualização retornou com o token de acesso anterior.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
OAuthAccessToken String O token de autenticação retornado do Basecamp. Isso pode ser usado em chamadas subseqüentes para outras operações para este serviço específico.
OAuthRefreshToken String Um token que pode ser usado para obter um novo token de acesso.
ExpiresIn String O tempo de vida restante no token de acesso.

Tabelas do Sistema

Você pode consultar as tabelas do sistema descritas nesta seção para acessar informações de esquema, informações sobre a funcionalidade da fonte de dados e estatísticas de operação em lote.

Tabelas de Esquema

As tabelas a seguir retornam os metadados do banco de dados para o Basecamp:

Tabelas de Fonte de Dados

As tabelas a seguir retornam informações sobre como se conectar e consultar a fonte de dados:

  • sys_connection_props: Retorna informações sobre as propriedades de conexão disponíveis.
  • sys_sqlinfo: Descreve as consultas SELECT que o conector pode descarregar para a fonte de dados.

Consultar Tabelas de Informações

A tabela a seguir retorna estatísticas de consultar para consultas de modificação de dados:

  • sys_identity: Retorna informações sobre operações em lote ou atualizações únicas.

Sys_catalogs

Lista os bancos de dados disponíveis.

A consultar a seguir recupera todos os bancos de dados determinados pela string de conexão:

SELECT * FROM sys_catalogs
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados.

Sys_schemas

Lista os esquemas disponíveis.

A consultar a seguir recupera todos os esquemas disponíveis:

SELECT * FROM sys_schemas
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados.
SchemaName String O nome do esquema.

Sys_tables

Lista as tabelas disponíveis.

A consultar a seguir recupera as tabelas e exibições disponíveis:

SELECT * FROM sys_tables
Colunas
Nome Tipo Descrição
CatalogName String O banco de dados que contém a tabela ou exibição.
SchemaName String O esquema que contém a tabela ou exibição.
TableName String O nome da tabela ou exibição.
TableType String O tipo de tabela (tabela ou exibição).
Description String Uma descrição da tabela ou exibição.
IsUpdateable Boolean Se a tabela pode ser atualizada.

Sys_tablecolumns

Descreve as colunas das tabelas e exibições disponíveis.

A consultar a seguir retorna as colunas e os tipos de dados da tabela Projetos:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Projects' 
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém a tabela ou exibição.
SchemaName String O esquema que contém a tabela ou exibição.
TableName String O nome da tabela ou exibição que contém a coluna.
ColumnName String O nome da coluna.
DataTypeName String O nome do tipo de dados.
DataType Int32 Um número inteiro indicando o tipo de dados. Esse valor é determinado no tempo de execução com base no ambiente.
Length Int32 O tamanho de armazenamento da coluna.
DisplaySize Int32 A largura máxima normal da coluna designada em caracteres.
NumericPrecision Int32 O número máximo de dígitos em dados numéricos. O comprimento da coluna em caracteres para caracteres e dados de data e hora.
NumericScale Int32 A escala da coluna ou o número de dígitos à direita do ponto decimal.
IsNullable Boolean Se a coluna pode conter null.
Description String Uma breve descrição da coluna.
Ordinal Int32 O número de sequência da coluna.
IsAutoIncrement String Se o valor da coluna é atribuído em incrementos fixos.
IsGeneratedColumn String Se a coluna é gerada.
IsHidden Boolean Se a coluna está oculta.
IsArray Boolean Se a coluna é uma matriz.

Sys_procedures

Lista os procedimentos armazenados disponíveis.

A consultar a seguir recupera os procedimentos armazenados disponíveis:

SELECT * FROM sys_procedures
Colunas
Nome Tipo Descrição
CatalogName String O banco de dados que contém o procedimento armazenado.
SchemaName String O esquema que contém o procedimento armazenado.
ProcedureName String O nome do procedimento armazenado.
Description String Uma descrição do procedimento armazenado.
ProcedureType String O tipo do procedimento, como PROCEDURE ou FUNCTION.

Sys_procedureparameters

Descreve procedimento armazenado* parâmetros.

A consultar a seguir retorna informações sobre todos os parâmetros de entrada para o procedimento armazenado RefreshOAuthAccessToken:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='RefreshOAuthAccessToken' AND Direction=1 OR Direction=2
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém o procedimento armazenado.
SchemaName String O nome do esquema que contém o procedimento armazenado.
ProcedureName String O nome do procedimento armazenado* contendo o parâmetro.
ColumnName String O nome do procedimento armazenado* parâmetro.
Direction Int32 Um número inteiro correspondente ao tipo do parâmetro: entrada (1), entrada/saída (2) ou saída (4). parâmetros de tipo de entrada/saída podem ser parâmetros de entrada e saída.
DataTypeName String O nome do tipo de dados.
DataType Int32 Um número inteiro indicando o tipo de dados. Esse valor é determinado no tempo de execução com base no ambiente.
Length Int32 O número de caracteres permitido para dados de caractere. O número de dígitos permitidos para dados numéricos.
NumericPrecision Int32 A precisão máxima para dados numéricos. O comprimento da coluna em caracteres para caracteres e dados de data e hora.
NumericScale Int32 O número de dígitos à direita do ponto decimal em dados numéricos.
IsNullable Boolean Se o parâmetro pode conter null.
IsRequired Boolean Se o parâmetro é necessário para a execução do procedimento.
IsArray Boolean Se o parâmetro é uma matriz.
Description String A descrição do parâmetro.
Ordinal Int32 O índice do parâmetro.

Sys_keycolumns

Descreve as chaves primárias e estrangeiras. A consultar a seguir recupera a chave primária da tabela Projetos:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Projects'
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém a chave.
SchemaName String O nome do esquema que contém a chave.
TableName String O nome da tabela que contém a chave.
ColumnName String O nome da coluna chave.
IsKey Boolean Se a coluna é uma chave primária na tabela referenciada no campo TableName.
IsForeignKey Boolean Se a coluna é uma chave estrangeira referenciada no campo TableName.
PrimaryKeyName String O nome da chave primária.
ForeignKeyName String O nome da chave estrangeira.
ReferencedCatalogName String O banco de dados que contém a chave primária.
ReferencedSchemaName String O esquema que contém a chave primária.
ReferencedTableName String A tabela que contém a chave primária.
ReferencedColumnName String O nome da coluna da chave primária.

Sys_foreignkeys

Descreve as chaves estrangeiras. A consultar a seguir recupera todas as chaves estrangeiras que se referem a outras tabelas:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém a chave.
SchemaName String O nome do esquema que contém a chave.
TableName String O nome da tabela que contém a chave.
ColumnName String O nome da coluna chave.
PrimaryKeyName String O nome da chave primária.
ForeignKeyName String O nome da chave estrangeira.
ReferencedCatalogName String O banco de dados que contém a chave primária.
ReferencedSchemaName String O esquema que contém a chave primária.
ReferencedTableName String A tabela que contém a chave primária.
ReferencedColumnName String O nome da coluna da chave primária.
ForeignKeyType String Designa se a chave estrangeira é uma chave de importação (aponta para outras tabelas) ou de exportação (referenciada de outras tabelas).

Sys_indexes

Descreve os índices disponíveis. Ao filtrar por índices, você pode escrever consultas mais seletivas com tempos de resposta de consultar mais rápidos.

A consultar a seguir recupera todos os índices que não são chaves primárias:

SELECT * FROM sys_indexes WHERE IsPrimary='false'
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém o índice.
SchemaName String O nome do esquema que contém o índice.
TableName String O nome da tabela que contém o índice.
IndexName String O nome do índice.
ColumnName String O nome da coluna associada ao índice.
IsUnique Boolean True se o índice for exclusivo. Falso caso contrário.
IsPrimary Boolean Verdadeiro se o índice for uma chave primária. Falso caso contrário.
Type Int16 Um valor inteiro correspondente ao tipo de índice: estatística (0), agrupado (1), hash (2) ou outro (3).
SortOrder String A ordem de classificação: A para crescente ou D para decrescente.
OrdinalPosition Int16 O número de sequência da coluna no índice.

Sys_connection_props

Retorna informações sobre as propriedades de conexão disponíveis e as definidas na string de conexão.

Ao consultar esta tabela, a string de conexão de configuração deve ser usada:

jdbc:cdata:basecamp:config:

Esta string de conexão permite que você consultar esta tabela sem uma conexão válida.

A consultar a seguir recupera todas as propriedades de conexão que foram definidas na string de conexão ou definidas por meio de um valor padrão:

SELECT * FROM sys_connection_props WHERE Value <> ''
Colunas
Nome Tipo Descrição
Name String O nome da propriedade de conexão.
ShortDescription String Uma breve descrição.
Type String O tipo de dados da propriedade de conexão.
Default String O valor padrão, se não houver um definido explicitamente.
Values String Uma lista separada por vírgulas de valores possíveis. Um erro de validação é lançado se outro valor for especificado.
Value String O valor que você definiu ou um padrão pré-configurado.
Required Boolean Se a propriedade é necessária para se conectar.
Category String A categoria da propriedade de conexão.
IsSessionProperty String Se a propriedade é uma propriedade de sessão, usada para salvar informações sobre a conexão atual.
Sensitivity String O nível de sensibilidade da propriedade. Isso informa se a propriedade é ofuscada nos formulários de registro e autenticação.
PropertyName String Uma forma truncada em camel case do nome da propriedade de conexão.
Ordinal Int32 O índice do parâmetro.
CatOrdinal Int32 O índice da categoria do parâmetro.
Hierarchy String Mostra as propriedades dependentes associadas que precisam ser definidas juntamente com esta.
Visible Boolean Informa se a propriedade está visível na UI da conexão.
ETC String Diversas informações diversas sobre o imóvel.

Sys_sqlinfo

Descreve o processamento da consultar SELECT que o conector pode transferir para a fonte de dados.

Processamento de Consultas Colaborativas

Ao trabalhar com fontes de dados que não suportam SQL-92, você pode consultar a exibição sys_sqlinfo para determinar os recursos de consultar das APIs subjacentes, expressas na sintaxe SQL. O conector transfere o máximo possível do processamento da instrução SELECT para o servidor e, em seguida, processa o restante da consultar na memória.

Descobrindo os Recursos SELECT da Fonte de Dados

Abaixo está um exemplo de conjunto de dados de recursos SQL. O conjunto de resultados a seguir indica a funcionalidade SELECT que o conector pode descarregar para a fonte de dados ou processar o lado do cliente. Sua fonte de dados pode suportar sintaxe SQL adicional. Alguns aspectos da funcionalidade SELECT são retornados em uma lista separada por vírgulas, se suportados; caso contrário, a coluna contém NO.

Nome Descrição Valores Possíveis
AGGREGATE_FUNCTIONS Funções de agregação suportadas. AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT Se a função COUNT é suportada. YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR O caractere de abertura usado para escapar de um identificador. [
IDENTIFIER_QUOTE_CLOSE_CHAR O caractere de fechamento usado para escapar de um identificador. ]
SUPPORTED_OPERATORS Uma lista de operadores SQL com suporte. =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY Se GROUP BY é compatível e, em caso afirmativo, o grau de suporte. NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
STRING_FUNCTIONS Funções de string suportadas. LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS Funções numéricas suportadas. ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS Funções de data/hora suportadas. NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES Indica tabelas ignoradas durante a replicação.
REPLICATION_TIMECHECK_COLUMNS Uma matriz de string contendo uma lista de colunas que serão usadas para verificar (na ordem especificada) para usar como uma coluna modificada durante a replicação.
IDENTIFIER_PATTERN Valor de string que indica qual string é válida para um identificador.
SUPPORT_TRANSACTION Indica se o provedor oferece suporte a transações como confirmação e reversão. YES, NO
DIALECT Indica o dialeto SQL a ser usado.
KEY_PROPERTIES Indica as propriedades que identificam o banco de dados uniforme.
SUPPORTS_MULTIPLE_SCHEMAS Indica se vários esquemas podem existir para o provedor. YES, NO
SUPPORTS_MULTIPLE_CATALOGS Indica se vários catálogos podem existir para o provedor. YES, NO
DATASYNCVERSION A versão do Data Sync necessária para acessar este driver. Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY A categoria Data Sync deste driver. Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL Se a funcionalidade SQL aprimorada além do que é oferecido pela API é suportada. TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS Se as operações em lote são suportadas. YES, NO
SQL_CAP Todos os recursos SQL suportados para este driver. SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS Um valor de string especifica o cacheOptions preferencial.
ENABLE_EF_ADVANCED_QUERY Indica se o driver oferece suporte direto a consultas avançadas provenientes do Entity Framework. Caso contrário, as consultas serão tratadas no lado do cliente. YES, NO
PSEUDO_COLUMNS Uma matriz de cadeia de caracteres que indica as pseudocolunas disponíveis.
MERGE_ALWAYS Se o valor for verdadeiro, o modo de mesclagem será executado à força no Data Sync. TRUE, FALSE
REPLICATION_MIN_DATE_QUERY Uma consultar de seleção para retornar a data e hora de início da replicação.
REPLICATION_MIN_FUNCTION Permite que um provedor especifique o nome da fórmula a ser usado para executar um min do lado do servidor.
REPLICATION_START_DATE Permite que um provedor especifique uma data de início de replicação.
REPLICATION_MAX_DATE_QUERY Uma consultar de seleção para retornar a data e hora de término da replicação.
REPLICATION_MAX_FUNCTION Permite que um provedor especifique o nome da fórmula a ser usado para executar um máximo do lado do servidor.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE Uma lista de tabelas que ignorará a divisão da replicação em blocos na replicação inicial.
CHECKCACHE_USE_PARENTID Indica se a instrução CheckCache deve ser executada na coluna de chave pai. TRUE, FALSE
CREATE_SCHEMA_PROCEDURES Indica procedimentos armazenados* que pode ser usado para gerar arquivos de esquema.

A consultar a seguir recupera os operadores que podem ser usados na cláusula WHERE:

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

Observe que tabelas individuais podem ter diferentes limitações ou requisitos na cláusula WHERE; consulte o Modelo de Dados para obter mais informações.

Colunas
Nome Tipo Descrição
NAME String Um componente da sintaxe SQL ou um recurso que pode ser processado no servidor.
VALUE String Detalhes sobre a sintaxe SQL ou SQL suportada.

Sys_identity

Retorna informações sobre tentativas de modificação.

A consultar a seguir recupera os IDs das linhas modificadas em uma operação em lote:

SELECT * FROM sys_identity
Colunas
Nome Tipo Descrição
Id String O ID gerado pelo banco de dados retornado de uma operação de modificação de dados.
Batch String Um identificador para o lote. 1 para uma única operação.
Operation String O resultado da operação no lote: INSERTED, UPDATED ou DELETED.
Message String SUCCESS ou uma mensagem de erro se a atualização no lote falhou.

Propriedades de Configurações Avançadas

As propriedades de configurações avançadas são as várias opções que podem ser usadas para estabelecer uma conexão. Esta seção fornece uma lista completa das opções que você pode configurar. Clique nos links para mais detalhes.

Autenticação

Propriedade Descrição
AuthScheme O tipo de autenticação a ser usado ao se conectar ao Basecamp.
Schema Especifique a versão do Basecamp com a qual se conectar.
User Nome de usuário do usuário atualmente autenticado.
Password Senha do usuário atualmente autenticado.
AccountId ID da conta do usuário autenticado no momento.
ProjectId A ID do projeto do usuário autenticado no momento.

OAuth

Propriedade Descrição
InitiateOAuth Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar.
OAuthClientId O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthClientSecret O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthAccessToken O token de acesso para conexão usando OAuth.
CallbackURL O URL de retorno de chamada OAuth ao qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo.
OAuthAuthorizationURL A URL de autorização para o serviço OAuth.
OAuthAccessTokenURL A URL da qual recuperar o token de acesso OAuth.
OAuthVerifier O código do verificador retornado da URL de autorização OAuth.
OAuthRefreshToken O token de atualização OAuth para o token de acesso OAuth correspondente.
OAuthExpiresIn O tempo de vida em segundos do OAuth AccessToken.
OAuthTokenTimestamp O registro de data e hora da época do Unix em milissegundos quando o token de acesso atual foi criado.

SSL

Propriedade Descrição
SSLServerCert O certificado a ser aceito do servidor ao conectar usando TLS/SSL.

Esquema

Propriedade Descrição
Location Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados.
BrowsableSchemas Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tables=TableA, TableB, TableC.
Views Restringe as visualizações relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA, ViewB, ViewC.

Diversos

Propriedade Descrição
MaxRows Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.
Other Essas propriedades ocultas são usadas apenas em casos de uso específicos.
PseudoColumns Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela.
Timeout O valor em segundos até que o erro de timeout seja lançado, cancelando a operação.

Autenticação

Esta seção fornece uma lista completa de propriedades de autenticação que você pode configurar.

Propriedade Descrição
AuthScheme O tipo de autenticação a ser usado ao se conectar ao Basecamp.
Schema Especifique a versão do Basecamp com a qual se conectar.
User Nome de usuário do usuário atualmente autenticado.
Password Senha do usuário atualmente autenticado.
AccountId ID da conta do usuário autenticado no momento.
ProjectId A ID do projeto do usuário autenticado no momento.

AuthScheme

O tipo de autenticação a ser usado ao se conectar ao Basecamp.

Valores Possíveis

Auto, Basic, OAuth

Tipo de Dados

string

Valor Padrão

"Auto"

Observações
  • Auto: permite que o driver decida automaticamente com base nas outras propriedades de conexão que você definiu.
  • Básico: Defina para usar autenticação de usuário/senha BÁSICA.
  • OAuth: Defina para executar a autenticação OAuth.

Esquema

Especifique a versão do Basecamp com a qual se conectar.

Valores Possíveis

V2, V3

Tipo de Dados

string

Valor Padrão

"V2"

Observações

Os esquemas disponíveis são V2 (para usar a API do Basecamp 2) e V3 (para usar a API do Basecamp 3).

Do Utilizador

Nome de usuário do usuário atualmente autenticado.

Tipo de Dados

string

Valor Padrão

""

Observações

Nome de usuário do usuário atualmente autenticado. Esta propriedade é necessária para executar comandos.

Senha

Senha do usuário atualmente autenticado.

Tipo de Dados

string

Valor Padrão

""

Observações

Senha do usuário atualmente autenticado. Esta propriedade é necessária para executar comandos.

Id da Conta

ID da conta do usuário autenticado no momento.

Tipo de Dados

string

Valor Padrão

""

Observações

ID da conta do usuário autenticado no momento. Esta propriedade é necessária para executar comandos.

ProjectId

A ID do projeto do usuário autenticado no momento.

Tipo de Dados

string

Valor Padrão

""

Observações

A ID do projeto do usuário autenticado no momento. Por padrão, ele será definido como o primeiro ID do projeto da sua lista de projetos.

OAuth

Esta seção fornece uma lista completa de propriedades OAuth que você pode configurar.

Propriedade Descrição
InitiateOAuth Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar.
OAuthClientId O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthClientSecret O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthAccessToken O token de acesso para conexão usando OAuth.
CallbackURL O URL de retorno de chamada OAuth ao qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo.
OAuthAuthorizationURL A URL de autorização para o serviço OAuth.
OAuthAccessTokenURL A URL da qual recuperar o token de acesso OAuth.
OAuthVerifier O código do verificador retornado da URL de autorização OAuth.
OAuthRefreshToken O token de atualização OAuth para o token de acesso OAuth correspondente.
OAuthExpiresIn O tempo de vida em segundos do OAuth AccessToken.
OAuthTokenTimestamp O registro de data e hora da época do Unix em milissegundos quando o token de acesso atual foi criado.

InitiateOAuth

Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar.

Valores Possíveis

OFF, GETANDREFRESH, REFRESH

Tipo de Dados

string

Valor Padrão

"OFF"

Observações

As seguintes opções estão disponíveis:

  1. OFF: Indica que o fluxo OAuth será tratado inteiramente pelo usuário. Um OAuthAccessToken será necessário para autenticação.
  2. GETANDREFRESH: Indica que todo o fluxo OAuth será tratado pelo conector. Se nenhum token existir atualmente, ele será obtido solicitando ao usuário por meio do navegador. Se existir um token, ele será atualizado quando aplicável.
  3. REFRESH: Indica que o conector tratará apenas da atualização do OAuthAccessToken. O usuário nunca será solicitado pelo conector a autenticar por meio do navegador. O usuário deve manipular a obtenção do OAuthAccessToken e OAuthRefreshToken inicialmente.

OAuthClientId

O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

Como parte do registro de um aplicativo OAuth, você receberá o OAuthClientId valor, às vezes também chamado de chave do consumidor e segredo do cliente, o OAuthClientSecret.

OAuthClientSecret

O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

Como parte do registro de um aplicativo OAuth, você receberá o OAuthClientId, também chamada de chave do consumidor. Você também receberá um segredo do cliente, também chamado de segredo do consumidor. Defina o segredo do cliente no OAuthClientSecret propriedade.

OAuthAccessToken

O token de acesso para conexão usando OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

O OAuthAccessToken propriedade é usada para conectar usando OAuth. O OAuthAccessToken é recuperado do servidor OAuth como parte do processo de autenticação. Ele tem um tempo limite dependente do servidor e pode ser reutilizado entre as solicitações.

O token de acesso é usado no lugar do seu nome de usuário e senha. O token de acesso protege suas credenciais, mantendo-as no servidor.

URL de Retorno

O URL de retorno de chamada OAuth ao qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo.

Tipo de Dados

string

Valor Padrão

""

Observações

Durante o processo de autenticação, o servidor de autorização OAuth redireciona o usuário para esta URL. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo.

OAuthAuthorizationURL

A URL de autorização para o serviço OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

A URL de autorização para o serviço OAuth. Nessa URL, o usuário efetua login no servidor e concede permissões ao aplicativo. No OAuth 1.0, se as permissões forem concedidas, o token de solicitação será autorizado.

OAuthAccessTokenURL

A URL da qual recuperar o token de acesso OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

A URL da qual recuperar o token de acesso OAuth. No OAuth 1.0, o token de solicitação autorizado é trocado pelo token de acesso nessa URL.

OAuthVerifier

O código do verificador retornado da URL de autorização OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

O código do verificador retornado da URL de autorização OAuth. Isso pode ser usado em sistemas em que um navegador não pode ser iniciado, como sistemas headless.

Autenticação em Máquinas Sem Cabeça

Consulte para obter o OAuthVerifier valor.

Defina OAuthSettingsLocation juntamente com OAuthVerifier. Quando você conecta, o conector troca o OAuthVerifier para os tokens de autenticação OAuth e os salva, criptografados, no arquivo especificado. Definir InitiateOAuth para GETANDREFRESH automatizar a troca.

Depois que o arquivo de configurações OAuth for gerado, você poderá remover OAuthVerifier nas propriedades de conexão e conecte-se com OAuthSettingsLocation definir.

Para atualizar automaticamente os valores do token OAuth, defina OAuthSettingsLocation e adicionalmente defina InitiateOAuth para ATUALIZAR.

OAuthRefreshToken

O token de atualização OAuth para o token de acesso OAuth correspondente.

Tipo de Dados

string

Valor Padrão

""

Observações

O OAuthRefreshToken a propriedade é usada para atualizar o OAuthAccessToken ao usar a autenticação OAuth.

OAuthExpiresIn

O tempo de vida em segundos do OAuth AccessToken.

Tipo de Dados

string

Valor Padrão

""

Observações

Emparelhe com OAuthTokenTimestamp para determinar quando o AccessToken expirará.

OAuthTokenTimestamp

O registro de data e hora da época do Unix em milissegundos quando o token de acesso atual foi criado.

Tipo de Dados

string

Valor Padrão

""

Observações

Emparelhe com OAuthExpiresIn para determinar quando o AccessToken expirará.

SSL

Esta seção fornece uma lista completa de propriedades SSL que você pode configurar.

Propriedade Descrição
SSLServerCert O certificado a ser aceito do servidor ao conectar usando TLS/SSL.

SSLServerCert

O certificado a ser aceito do servidor ao conectar usando TLS/SSL.

Tipo de Dados

string

Valor Padrão

""

Observações

Se estiver usando uma conexão TLS/SSL, esta propriedade pode ser usada para especificar o certificado TLS/SSL a ser aceito do servidor. Qualquer outro certificado que não seja confiável para a máquina é rejeitado.

Esta propriedade pode assumir as seguintes formas:

Descrição Exemplo
Um certificado PEM completo (exemplo abreviado para concisão) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
Um caminho para um arquivo local contendo o certificado C:\cert.cer
A chave pública (exemplo abreviado para concisão) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
O Thumbprint MD5 (os valores hexadecimais também podem ser separados por espaço ou dois-pontos) ecadbdda5a1529c58a1e9e09828d70e4
A impressão digital SHA1 (os valores hexadecimais também podem ser separados por espaço ou dois-pontos) 34a929226ae0819f2ec14b4a3d904f801cbb150d

Se não for especificado, qualquer certificado confiável pela máquina será aceito.

Os certificados são validados como confiáveis pela máquina com base no armazenamento confiável do sistema. O armazenamento confiável usado é o valor 'javax.net.ssl.trustStore' especificado para o sistema. Se nenhum valor for especificado para esta propriedade, o armazenamento confiável padrão do Java será usado (por exemplo, JAVA_HOME\lib\security\cacerts).

Use '*' para indicar a aceitação de todos os certificados. Observe que isso não é recomendado devido a questões de segurança.

Esquema

Esta seção fornece uma lista completa de propriedades de esquema que você pode configurar.

Propriedade Descrição
Location Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados.
BrowsableSchemas Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tables=TableA, TableB, TableC.
Views Restringe as visualizações relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA, ViewB, ViewC.

Localização

Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados.

Tipo de Dados

string

Valor Padrão

"%APPDATA%\\\Basecamp Data Provider\\Schema"

Observações

O caminho para um diretório que contém os arquivos de esquema para o conector (arquivos .rsd para tabelas e exibições, arquivos .rsb para procedimentos armazenados). A localização da pasta pode ser um caminho relativo a partir da localização do executável. O Location a propriedade só é necessária se você quiser personalizar definições (por exemplo, alterar um nome de coluna, ignorar uma coluna e assim por diante) ou estender o modelo de dados com novas tabelas, exibições ou procedimentos armazenados.

Observação: Como esse conector oferece suporte a vários esquemas, a estrutura dos arquivos de esquema personalizados do Basecamp é a seguinte:

  • Cada esquema recebe uma pasta correspondente a esse nome de esquema.
  • Essas pastas de esquema estão contidas em uma pasta pai.
  • O parent folder deve ser definido como Location, não a pasta de um esquema individual.

Se não for especificado, o local padrão é "%APPDATA%\\ Basecamp Data Provider\Schema" com %APPDATA% sendo definido para o diretório de configuração do usuário:

Plataforma %APPDATA%
Windows O valor da variável de ambiente APPDATA
Mac ~/Biblioteca/Suporte de aplicativos
Linux ~/.config

Esquemas Navegáveis

Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Tipo de Dados

string

Valor Padrão

""

Observações

Listar os esquemas de bancos de dados pode ser caro. Fornecer uma lista de esquemas na string de conexão melhora o desempenho.

Tabelas

Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tabelas=TabelaA,TabelaB,TabelaC.

Tipo de Dados

string

Valor Padrão

""

Observações

Listar as tabelas de alguns bancos de dados pode ser caro. Fornecer uma lista de tabelas na string de conexão melhora o desempenho do conector.

Essa propriedade também pode ser usada como uma alternativa para listar automaticamente as exibições se você já souber com quais deseja trabalhar e, caso contrário, haveria muitas para trabalhar.

Especifique as tabelas que deseja em uma lista separada por vírgulas. Cada tabela deve ser um identificador SQL válido com quaisquer caracteres especiais escapados usando colchetes, aspas duplas ou acentos graves. Por exemplo, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Observe que, ao conectar-se a uma fonte de dados com vários esquemas ou catálogos, você precisará fornecer o nome totalmente qualificado da tabela nesta propriedade, como no último exemplo aqui, para evitar ambigüidade entre tabelas que existem em vários catálogos ou esquemas.

Visualizações

Restringe as exibições relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA,ViewB,ViewC.

Tipo de Dados

string

Valor Padrão

""

Observações

Listar as exibições de alguns bancos de dados pode ser caro. Fornecer uma lista de exibições na string de conexão melhora o desempenho do conector.

Essa propriedade também pode ser usada como uma alternativa para listar automaticamente as exibições se você já souber com quais deseja trabalhar e, caso contrário, haveria muitos para trabalhar.

Especifique as exibições desejadas em uma lista separada por vírgulas. Cada exibição deve ser um identificador SQL válido com quaisquer caracteres especiais escapados usando colchetes, aspas duplas ou acentos graves. Por exemplo, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Observe que, ao conectar-se a uma fonte de dados com vários esquemas ou catálogos, você precisará fornecer o nome totalmente qualificado da tabela nesta propriedade, como no último exemplo aqui, para evitar ambigüidade entre tabelas que existem em vários catálogos ou esquemas.

Diversos

Esta seção fornece uma lista completa de diversas propriedades que você pode configurar.

Propriedade Descrição
MaxRows Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.
Other Essas propriedades ocultas são usadas apenas em casos de uso específicos.
PseudoColumns Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela.
Timeout O valor em segundos até que o erro de timeout seja lançado, cancelando a operação.

MaxRows

Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.

Tipo de Dados

int

Valor Padrão

-1

Observações

Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.

Outro

Essas propriedades ocultas são usadas apenas em casos de uso específicos.

Tipo de Dados

string

Valor Padrão

""

Observações

As propriedades listadas abaixo estão disponíveis para casos de uso específicos. Os casos de uso e a funcionalidade normais do driver não devem exigir essas propriedades.

Especifique várias propriedades em uma lista separada por ponto e vírgula.

Integração e Formatação
Propriedade Descrição
DefaultColumnSize Define o comprimento padrão dos campos de string quando a fonte de dados não fornece o comprimento da coluna nos metadados. O valor padrão é 2000. Voltar para o início
ConvertDateTimeToGMT Determina se os valores de data e hora devem ser convertidos em GMT, em vez da hora local da máquina.
RecordToFile=filename Registra a transferência de dados do soquete subjacente para o arquivo especificado.

Pseudocolunas

Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela.

Tipo de Dados

string

Valor Padrão

""

Observações

Essa configuração é particularmente útil no Entity Framework, que não permite definir um valor para uma pseudocoluna, a menos que seja uma coluna de tabela. O valor dessa configuração de conexão está no formato "Table1=Column1, Table1=Column2, Table2=Column3". Você pode usar o caractere "*" para incluir todas as tabelas e todas as colunas; por exemplo, "*=*".

Tempo Esgotado

O valor em segundos até que o erro de timeout seja lançado, cancelando a operação.

Tipo de Dados

int

Valor Padrão

60

Observações

Se Timeout = 0, as operações não expiram. As operações são executadas até serem concluídas com êxito ou até encontrarem uma condição de erro.

Se Timeout expira e a operação ainda não está concluída, o conector lança uma exceção.