Detalhes da Conexão do Zoho Projects¶

Introdução¶

Versão do conector

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

Começando¶

Suporte à versão do Zoho Projects

O conector utiliza a API do Zoho Projects (são usados tanto o restapi quanto a API v3) para permitir o acesso bidirecional aos dados de gerenciamento de projetos do Zoho Projects.

Estabelecendo uma Conexão¶

Autenticação para Zoho Projects¶

O conector já está registrado no Zoho Projects como um aplicativo OAuth. Como tal, por padrão, usará automaticamente suas Credenciais incorporadas conectar.

Se você usar as credenciais incorporadas, nenhuma outra ação será necessária para estabelecer uma conexão.

Se preferir usar seu próprio aplicativo OAuth personalizado, consulte Credenciais personalizadas.

Usando Autenticação OAuth¶

OAuth requer que o usuário autenticado interaja com o Zoho Projects 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 Zoho Projects e você pode se conectar com suas credenciais incorporadas. Você pode querer criar um aplicativo OAuth personalizado para alterar as informações exibidas quando os usuários fazem login no endpoint OAuth do Zoho Projects para conceder permissões ao conector.

Criando um Aplicativo OAuth Personalizado¶

Consulte Criando um aplicativo OAuth personalizado para um procedimento.

Credenciais Incorporadas¶

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 conectar: InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente o OAuthAccessToken. 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¶

Autenticação de Área de Trabalho com Seu Aplicativo OAuth¶

Siga as etapas abaixo para autenticar com as credenciais de um aplicativo OAuth personalizado. Consulte Criando um aplicativo OAuth personalizado.

Obtenha um Token de Acesso OAuth¶

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

• 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.
• CallbackURL: Defina isso para o URL de redirecionamento nas configurações do aplicativo.
• InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente o OAuthAccessToken.

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.

Máquinas Sem Cabeça¶

Usando OAuth em uma Máquina Sem Periféricos¶

Para criar fontes de dados do Zoho Projects 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 para um Aplicativo OAuth Personalizado¶

Crie um aplicativo OAuth personalizado

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 aplicativo nas configurações do aplicativo.
• OAuthClientSecret: Defina isso como o Segredo do aplicativo nas configurações do aplicativo.

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.
4. Salve o valor do servidor de contas. Você definirá isso no AccountsServer 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.
• AccountsServer: Defina isso para o servidor de contas que você obteve no redirecionamento.
• 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.

Conecte-se aos dados

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 provedor para ativar a atualização automática do token de acesso.
• InitiateOAuth: Configure para ATUALIZAR.

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 como o ID do cliente nas configurações do aplicativo.
• OAuthClientSecret: Defina isso como o segredo do cliente nas configurações do aplicativo.
• CallbackURL: Defina isso para o URL de retorno de chamada nas configurações do aplicativo.

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.
• 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.

Criando um Aplicativo OAuth Personalizado¶

O Zoho Projects usa o padrão de autenticação OAuth, que exige que o usuário autenticado interaja com o Zoho Projects por meio do navegador. O conector facilita a troca OAuth de várias maneiras, conforme descrito abaixo.

Registrando um Aplicativo OAuth¶

Antes de começar com a autorização e fazer qualquer chamada para a API do Zoho CRM, você precisa registrar seu aplicativo com o Zoho CRM. Você pode seguir o procedimento abaixo para obter o OAuthClientId, OAuthClientSecret, e CallbackURL propriedades de conexão.

1. Navegue até o Zoho Developer Console.

2. Clique em Adicionar cliente e em Aplicativo baseado em servidor.

3. Insira o nome do cliente, o URL da página inicial e o URL de redirecionamento.

4. Se você estiver se conectando a partir de um aplicativo de desktop, defina o URL de retorno para http://localhost:33333, ou outro número de porta de sua escolha.

   Se você estiver se conectando a partir de um aplicativo da Web, defina a URL de retorno de chamada que deseja usar como uma URL de redirecionamento confiável, onde o usuário retornará com o token que verifica se ele concedeu acesso ao seu aplicativo.

5. Clique em Create.

Autenticar para Zoho Projects a Partir de um Aplicativo de Desktop¶

Depois de definir as seguintes propriedades de conexão, 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 propriedade de conexão.
• OAuthClientId: Defina isso para o ID do cliente que você definiu para seu aplicativo OAuth.
• OAuthClientSecret: Defina isso como o segredo do cliente que você definiu para seu aplicativo OAuth.
• CallbackURL: Defina isso para o URL de retorno de chamada que você definiu para seu aplicativo OAuth.

Quando você se 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.

Autenticar para Zoho Projects a Partir de um Aplicativo da Web¶

Siga as etapas abaixo para obter e gerenciar os valores de token OAuth no fluxo da Web.

Obtenha um Token de Acesso¶

Defina as seguintes propriedades de conexão para obter o OAuthAccessToken:

• 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.

Você pode então chamar procedimentos armazenados* para concluir a troca OAuth:

1. Chame o GetOAuthAuthorizationURL procedimento armazenado. Defina a entrada AuthMode como WEB e defina a entrada CallbackURL como o URI de redirecionamento especificado nas configurações do aplicativo. O procedimento armazenado* retorna a URL para o endpoint OAuth.
2. Faça login e autorize o aplicativo. Você é redirecionado de volta para o URL de retorno de chamada.
3. Chame o GetOAuthAccessToken procedimento armazenado. Configure a entrada AuthMode para WEB. Defina a entrada do Verifier para o parâmetro "code" na string de consultar do URL de retorno de chamada.

Conecte-se aos Dados e Atualize o Token¶

O OAuthAccessToken retornado por GetOAuthAccessToken tem um tempo de vida limitado. Para atualizar automaticamente o token, defina o seguinte na primeira conexão de dados. Como alternativa, use o RefreshOAuthAccessToken procedimento armazenado* para atualizar manualmente o token.

• InitiateOAuth: Configure para ATUALIZAR. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente o OAuthAccessToken.
• OAuthSettingsLocation: Defina como o caminho em que o conector salvará os valores OAuth, para serem mantidos nas conexões.
• 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.
• OAuthRefreshToken: Defina isso para o token de atualização retornado por GetOAuthAccessToken.
• OAuthAccessToken: Defina isso para o token de acesso retornado por GetOAuthAccessToken.

Nas conexões de dados subsequentes, defina o seguinte:

• InitiateOAuth
• OAuthSettingsLocation

Modelo de Dados¶

Visão geral

Esta seção mostra os objetos de API disponíveis e fornece mais informações sobre a execução do SQL para a API do Zoho Projects.

Características principais

• O conector modela entidades do Zoho Projects como projetos, eventos e usuários como exibições relacionais, permitindo que você escreva SQL para consultar dados do Zoho Projects.
• Procedimentos armazenados* permitem que você execute operações no Zoho Projects.
• A conectividade ao vivo com esses objetos significa que quaisquer alterações em sua conta do Zoho Projects são refletidas imediatamente ao usar o conector.

Mesas

Tabelas descreve as tabelas disponíveis. As tabelas são definidas estaticamente para modelar projetos, eventos, usuários, etc.

Visualizações

Visualizações descreve as exibições disponíveis. As visões são definidas estaticamente para modelar clientes, documentos, atividades, etc.

Procedimentos armazenados

NOTE: Procedimentos armazenados não são suportados atualmente. Veja a nota para detalhes.

Procedimentos armazenados são interfaces semelhantes a funções para Zoho Projects. Procedimentos armazenados* permitem que você execute operações no Zoho Projects, incluindo a aprovação de registros de tempo e reordenação de tarefas.

Tabelas¶

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

Geralmente, consultar tabelas do Zoho Projects é 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 do Zoho Projects¶

Tarefas Associadas a Bugs¶

Busca os detalhes da tarefa associada a um bug.

Informações Específicas da Tabela¶

Esta tabela mostra associações entre Bugs e Tarefas.

Selecione¶

• BugId suporta o seguinte operador: =.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM BugAssociatedTasks WHERE BugId = '123439000000045005'

Inserir¶

Para adicionar uma nova associação bug-tarefa, especifique os campos BugId e TaskId.

INSERT INTO BugAssociatedTasks (BugId, TaskId) VALUES ('123418000000045005', '["123418000000044005"]') 

Excluir¶

Para excluir uma associação bug-tarefa existente, especifique os campos BugId e TaskId.

DELETE FROM BugAssociatedTasks WHERE BugId = '123418000000045005' AND TaskId = '123418000000044005'

Colunas¶

BugComentários¶

Buscar comentários para o bug.

Selecione¶

• BugId é necessário para recuperar comentários de bug.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM BugComments WHERE BugId = '123456000000045005'

Inserir¶

Para adicionar um comentário de bug, especifique os campos BugId e Comment.

INSERT INTO BugComments (BugId, Comment) VALUES ('123456000000045005', 'Test Comment #1')

Excluir¶

Os comentários de bug podem ser excluídos fornecendo o ID e emitindo uma instrução DELETE.

DELETE FROM BugComments WHERE BugId = '123456000000045005' AND ID = '123456000000045042'

Colunas¶

BugEntityProperties¶

Recupera os dados armazenados em uma entidade. O argumento deste método deve ser a chave que foi utilizada quando os mesmos dados foram armazenados.

Informações Específicas da Tabela¶

As propriedades de entidade são pares de valor-chave armazenados nas entidades de bug. Eles podem ser usados para armazenar detalhes necessários para integrações de API, mas não precisam estar visíveis na interface do usuário. A chave deve ser uma String e o Value pode ser uma string simples ou um objeto json. Você pode armazenar vários par chave-valor para uma única entidade. Essas propriedades de entidade podem ser armazenadas/recuperadas/atualizadas/excluídas usando as seguintes consultas.

Selecione¶

• BugId e PropertyKey são necessários para recuperar as Propriedades da Entidade de Bug.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM BugEntityProperties WHERE BugId = '123456000000034087' AND PropertyKey = 'key1' 

Inserir¶

Para adicionar uma nova propriedade de entidade de bug, especifique os campos BugId, PropertyKey e PropertyValue.

INSERT INTO BugEntityProperties (BugId, PropertyKey, PropertyValue) VALUES ('123456000000034087', 'key1', 'This is a test value')

Atualizar¶

ZohoProjects permite atualizações para a coluna PropertyValue.

UPDATE BugEntityProperties SET PropertyValue = 'This is an updated property value' WHERE BugId = '123456000000034087' AND PropertyKey = 'key1'

Excluir¶

As propriedades da entidade de bug podem ser excluídas fornecendo Id, BugId, PropertyKey e emitindo uma instrução DELETE.

DELETE FROM BugEntityProperties WHERE BugId = '166135000000034087' AND PropertyKey = 'key1' AND ID = '166135000000035001'

Colunas¶

BugFollowers¶

Obter lista de seguidores para o bug.

Selecione¶

• BugId é necessário para recuperar Bug Followers.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM BugFollowers WHERE BugId = '123456000000042110'

Inserir¶

Para adicionar um Bug Follower, especifique os campos BugId e Follower.

INSERT INTO BugFollowers (BugId, BugFollowers) VALUES ('123456000000042110', '12345649448')

Excluir¶

Seguidores de bugs podem ser excluídos fornecendo o ID e emitindo uma instrução DELETE.

DELETE FROM BugFollowers WHERE BugId = '123456000000042110'  AND  FollowerId = '12345649448'

Colunas¶

Insetos¶

Obtém todas as tarefas no projeto fornecido. Ele busca apenas as tarefas principais e não as subtarefas.

Selecione¶

Colunas que suportam o operador =:

• Eu ia
• Hora de criação
• Bandeira
• Tipo de estado
• CustomViewId

Colunas que suportam os operadores = e IN:

• AssigneeId
• ClassificationId
• Escalation Level
• ModuleId
• ID da gravidade
• StatusId
• ReporterId
• MilestoneId
• AffectedMilestoneId

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM Bugs
    WHERE ReporterId IN ('12341021738')
    AND AssigneeId IN ('12341021738')
    AND ClassificationId IN ('123456000000030015')
    AND EscalationLevel IN ('0')
    AND Flag = 'Internal'
    AND ModuleId IN ('123456000000030145')
    AND SeverityId IN ('123456000000030151')
AND StatusId IN ('123456000000030083')

Inserir¶

Para criar um novo Bug, você pode especificar os seguintes campos:

• Título
• AssigneeId
• ClassificationId
• Descrição
• Data de vencimento
• Bandeira
• ModuleId
• ID reproduzível
• ID da gravidade
• Taxa Horária
• BugFollowers
• MilestoneId

Para criar um novo Bug, especifique os seguintes campos:

INSERT INTO Bugs (Title, Description, AssigneeId, flag, ClassificationId, DueDate, ModuleId, SeverityId, ReproducibleId, HourlyRate, CustomField1)
VALUES ('SQL Inserted Bug #5', 'Test Description', '12341249448', 'Internal', '123456000000031015', '2022-03-20', '123456000000031145', '123456000000031149', '123456000000031053', '2', 'TestCustomField')

Atualizar¶

Você pode usar a consultar abaixo para atualizar um bug:

UPDATE Bugs
SET Title = 'SQL Inserted Bug #5',
    Description = 'Another Test Description',
    AssigneeId = '20081249448',
    ClassificationId = '165818000000031015',
    DueDate = '2022-03-20',
    ModuleId = '165818000000031145',
    SeverityId = '165818000000031149',
    ReproducibleId = '165818000000031053',
    HourlyRate = '2',
    cf1 = 'Custom Field Edited #1'
WHERE ID = '165818000000042126'

Excluir¶

Os bugs podem ser excluídos fornecendo o ID e emitindo uma instrução DELETE.

DELETE FROM Bugs WHERE ID = '123456000000042126' 

Colunas¶

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.

BugTimelogs¶

Obtém os logs de tempo em um bug específico.

Selecione¶

• BugId é necessário para recuperar registros de tempo de bug.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM BugTimelogs WHERE BugId = '123456000000045005'

Inserir¶

Para adicionar um Bug TimeLog, especifique os campos BugId e Follower.

INSERT INTO BugTimelogs (BugId, LogDate, BillStatus, HoursDisplay, Notes)
VALUES ('123456000000045005', '2022-03-03', 'Non Billable', '01:20', 'This is a test timelog')

Atualizar¶

Para atualizar um Bug TimeLog, especifique os campos BugId e ID.

UPDATE BugTimelogs
    SET Notes = 'This is an updated SQL Note'
WHERE BugId = '165818000000045005' AND ID = '123456000000044025'

Excluir¶

Bug TimeLogs pode ser excluído fornecendo o BugId e ID e emitindo uma instrução DELETE.

DELETE FROM BugTimelogs WHERE BugId = '123456000000045005' AND ID = '123456000000044025'

Colunas¶

Contatos¶

Busca todos os contatos do cliente de um portal.

Selecione¶

• ClientId é necessário para recuperar contatos.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM Contacts WHERE ClientId = '123456000000045005'

Inserir¶

Para criar um novo contato, você pode especificar os seguintes campos:

• ID do Cliente
• Primeiro nome
• Sobrenome
• E-mail
• Taxa de Fatura
• Projetos de trabalho

INSERT INTO Contacts(WorkProjects, ClientId, FirstName, LastName, Email, Invoicerate)
VALUES ('123456000000031899', '123456000000039025', 'TestFirstname222', 'TestLastname222', 'testemail@example.com', '15')

Atualizar¶

Para atualizar um contato, especifique o campo ID.

UPDATE Contacts
    SET FirstName = 'updatedname', LastName = 'updatedlastname', email = 'updatedemail@example.com'
WHERE ID = '166135000000038075'

Excluir¶

Os contatos podem ser excluídos fornecendo o ID e emitindo uma instrução DELETE.

DELETE FROM Contacts WHERE ID = '123456000000040053' 

Colunas¶

Eventos¶

Busca todas as tags presentes em um portal específico.

Selecione¶

• Status suporta o seguinte operador =.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM Events WHERE Status = 'open'

Inserir¶

Para criar um novo evento, você pode especificar os seguintes campos:

• Título
• DuraçãoHora
• DuraçãoMinutos
• Localização
• Participantes
• Lembrete
• Repita
• Agendado Em
• tempos de repetição

INSERT INTO Events (Title, ScheduledOn, DurationHour, DurationMinutes, Participants, Reminder, Repeat, Location)
VALUES ('SQL Event #2', '2022-03-20T18:00:00', '2', '30', '20081249448', '15 mins', 'only once', 'Test Location 2')

Atualizar¶

Para atualizar um evento, especifique o campo ID.

UPDATE Events
    SET title = 'Updated Title #1', DurationHour = '4', DurationMinutes = '10', ScheduledOn = '2022-05-01T23:12:00', Participants = '20081249448'
WHERE ID = '123456000000045018'

Excluir¶

Os eventos podem ser excluídos fornecendo o ID e emitindo uma instrução DELETE.

DELETE FROM Events WHERE ID = '123456000000045018'  

Colunas¶

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.

FórumCategorias¶

Obtém todas as categorias do fórum.

Selecione¶

Você pode usar a consultar abaixo para obter todas as categorias do fórum:

SELECT * FROM ForumCategories

Inserir¶

Para criar uma nova categoria de fórum, você pode usar a consultar abaixo:

INSERT INTO ForumCategories (name) VALUES ('New Forum Category')

Excluir¶

ForumCategories podem ser excluídas fornecendo o ID e emitindo uma instrução DELETE.

DELETE FROM ForumCategories WHERE ID = '123456000000045018'

Colunas¶

Fórum Comentários¶

Obtém todos os comentários do fórum.

Selecione¶

• ForumId é necessário para recuperar comentários do fórum.

Você pode usar a consultar abaixo para obter todos os comentários do fórum:

SELECT * FROM ForumComments WHERE ForumId = '123456000000045018'

Inserir¶

Para criar um novo comentário no fórum, você pode usar a consultar abaixo:

INSERT INTO ForumComments (ForumId, Content, ParentId)
VALUES ('123456000000045028', 'Forum Comment Reply', '123456000000043083')

Excluir¶

Os comentários do fórum podem ser excluídos fornecendo o Id, ForumId e emitindo uma instrução DELETE.

DELETE FROM ForumComments WHERE ID = '123456000000043083' AND ForumId = '123456000000045028'

Colunas¶

Fóruns¶

Obtém todos os fóruns no projeto fornecido.

Selecione¶

• Id e CategoryId suporta o seguinte operador: =.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM Forums WHERE ID = '123456000000043771' 

Inserir¶

Para criar um novo Fórum, você pode especificar os seguintes campos:

• Nome
• Tipo
• Categoria ID
• Contente
• Bandeira
• IsAnnouncementPost
• IsStickyPost
• Notificar

Para criar um novo Fórum, você pode usar a consultar abaixo:

INSERT INTO Forums (Name, Type, CategoryId, Content, Flag, IsAnnouncementPost, IsStickyPost)
VALUES ('Forum Post', 'normal', '123456000000039039', 'Content for Forum Post', 'internal', false, false)

Atualizar¶

Para atualizar um Fórum, especifique o campo ID.

UPDATE Forums
    SET Name = 'Updated Post Name', CategoryId = '123456000000093039', Content = 'Updated forum post content' 
WHERE ID = '123456000000043771' 

Excluir¶

Os fóruns podem ser excluídos fornecendo o ID e emitindo uma instrução DELETE.

DELETE FROM Forums WHERE ID = '123456000000043771' 

Colunas¶

Conquistas¶

Obtém a lista de layouts de projeto.

Selecione¶

Colunas que suportam o operador =:

• Eu ia
• Bandeira
• OwnerId
• Status
• Tipo de exibição
• LastModifiedTime

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM Milestones WHERE ID = '123456000000043771' WHERE flag = 'internal' 

Inserir¶

Para criar um novo Marco, você pode especificar os seguintes campos:

• Nome
• Bandeira
• Data de início
• Data final
• OwnerId

Para criar um novo Milestone, você pode usar a consultar abaixo:

INSERT INTO Milestones (name, StartDate, EndDate, OwnerId, flag)
VALUES ('New Milestone name', '2022-03-01', '2022-03-10', '1234567890', 'internal')

Atualizar¶

Para atualizar um marco, especifique o campo ID.

UPDATE Milestones
    SET Name = 'Updated Name',
        Flag = 'external',
        StartDate = '2022-02-01',
        EndDate = '2022-03-01',
        OwnerId = '1234567890' " +
WHERE ID = '123456000000043021'

Excluir¶

Os marcos podem ser excluídos fornecendo o ID e emitindo uma instrução DELETE.

DELETE FROM Milestones WHERE ID = '123456000000043021' 

Colunas¶

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.

PortalClientes¶

Retorna a lista de empresas clientes do portal.

Selecione¶

Você pode usar a consultar abaixo para obter todos os clientes do portal:

SELECT * FROM PortalClients

Inserir¶

Para criar um novo PortalClient você pode especificar os seguintes campos:

• Nome
• Cidade
• País
• Estado
• Primeiro Endereço
• Segundo Endereço
• WebAddress
• CEP
• E-mail do usuário
• Projetos de trabalho
• Cliente Primário

INSERT INTO PortalClients (Name, UserEmail, WebAddress, FirstAddress, SecondAddress, City, State, Country, PrimaryClient, ZipCode)
VALUES ('Company12', 'email1@example.com', 'www.example.com', 'Address line 1', 'Address line 2', 'Budapest', 'Hungary', 'Hungary', 'Yes', '1025')

Colunas¶

Portais¶

Obtém todos os portais para o usuário logado.

Selecione¶

O conector usará a API do Zoho Projects para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

• Id e ViewId suporta o seguinte operador: =.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM Portals WHERE ID = '20081021809'

Colunas¶

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.

ProjectEntityProperties¶

Recupera os dados armazenados em uma entidade. O argumento deste método deve ser a chave que foi utilizada quando os mesmos dados foram armazenados.

Informações Específicas da Tabela¶

As propriedades da entidade são pares chave-valor armazenados nas entidades do projeto. Eles podem ser usados para armazenar detalhes necessários para integrações de API, mas não precisam estar visíveis na interface do usuário. A chave deve ser uma string e o valor pode ser uma string simples ou um objeto json. Você pode armazenar vários par chave-valor para uma única entidade. Essas propriedades de entidade podem ser armazenadas/recuperadas/atualizadas/excluídas usando as consultas abaixo.

Selecione¶

• PropertyKey é necessário para recuperar ProjectEntityProperties.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM ProjectEntityProperties WHERE PropertyKey = 'key1' 

Inserir¶

Para adicionar uma nova propriedade de entidade de projeto, especifique os campos PropertyKey e PropertyValue.

INSERT INTO ProjectEntityProperties (PropertyKey, PropertyValue) VALUES ('key1', 'This is a test value')

Atualizar¶

ZohoProjects permite atualizações para a coluna PropertyValue.

UPDATE ProjectEntityProperties SET PropertyValue = 'This is an updated property value' WHERE PropertyKey = 'key1'

Excluir¶

As propriedades da entidade do projeto podem ser excluídas fornecendo Id, PropertyKey e emitindo uma instrução DELETE.

DELETE FROM ProjectEntityProperties WHERE PropertyKey = 'key1' AND ID = '166135000000035001'

Colunas¶

Grupos de Projetos¶

Obtém todos os grupos para o projeto especificado.

Selecione¶

Você pode usar a consultar abaixo para obter todos os ProjectGroups:

SELECT * FROM ProjectGroups

Inserir¶

Para criar um novo ProjectGroup, você pode usar a consultar abaixo:

INSERT INTO ProjectGroups(name) VALUES ('New Project Group')

Excluir¶

ProjectGroups podem ser excluídos fornecendo o ID e emitindo uma instrução DELETE.

DELETE FROM ProjectGroups WHERE ID = '123456000000045018'  

Colunas¶

Projetos¶

Obtém todos os projetos para o usuário logado.

Selecione¶

Colunas que suportam o operador =:

• Eu ia
• Data de criação
• Status
• LastModifiedTime

Colunas que suportam os operadores = e IN:

• GroupId
• Cessionário

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM Projects WHERE ID = '123456000000039053' 

Inserir¶

Para criar um novo Projeto, você pode especificar os seguintes campos:

• Nome
• Status de Faturamento
• Tipo de Faturamento
• Moeda
• Descrição
• Público
• OwnerId
• Tipo de Orçamento
• Valor Orçamentário
• Avaliar
• Método de Rastreamento de Orçamento
• Custo fixo
• ID do modelo
• Limite
• Data de início
• Data final
• EnableRollup

Para criar um novo Projeto especifique os seguintes campos:

INSERT INTO Projects (Name, BudgetType, BudgetValue, BillingStatus, BillingType, Currency, Description, Public, BudgetType, BudgetTrackingMethod)
VALUES ('New Project', '2', '2.5', 'Billable', '2', 'EUR', 'TestDescription 123', 'no', '2', '4')

Atualizar¶

Você pode usar a consultar abaixo para atualizar um projeto:

UPDATE Projects
    SET Currency = 'USD', SingleLinCustomField = 'New Custom Field Value' 
WHERE ID = '123456000000039053'

Excluir¶

Os projetos podem ser excluídos fornecendo o ID e emitindo uma instrução DELETE.

DELETE FROM Projects WHERE ID = '123456000000039053' 

Colunas¶

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.

Usuários do Projeto¶

Obtém os detalhes de todos os usuários em um projeto específico.

Colunas¶

Status¶

Obtém os status do projeto fornecido.

Selecione¶

Você pode usar a consultar abaixo para obter todos os status:

SELECT * FROM Statuses

Inserir¶

Para criar um novo Status, você pode especificar os seguintes campos:

INSERT INTO Statuses (Content) VALUES ('My Custom Status')

Colunas¶

Tag¶

Busca todas as tags presentes em um portal específico.

Selecione¶

Você pode usar a consultar abaixo para obter todas as tags:

SELECT * FROM Tags

Inserir¶

Para criar uma nova Tag você pode especificar os seguintes campos:

INSERT INTO Tags (Name, ColorClass) VALUES ('New Tag', 'bg-tag16') 

Atualizar¶

Para atualizar um Tag especifique o campo ID.

UPDATE Tags SET Name = 'Updated Name', ColorClass = 'bg-tag99' WHERE ID = '123456000000043057'

Excluir¶

As tags podem ser excluídas fornecendo o ID e emitindo uma instrução DELETE.

DELETE FROM Tags WHERE ID = '123456000000043057' 

Colunas¶

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.

TarefaAtividades¶

Recupere detalhes de quem modificou uma tarefa específica e quando.

Selecione¶

• TaskId é necessário para recuperar comentários do fórum.

Você pode usar a consultar abaixo para obter todas as atividades para uma determinada tarefa:

SELECT * FROM TaskActivities WHERE TaskId = '123456789' 

Colunas¶

TarefaComentários¶

Obtenha todos os comentários da tarefa.

Selecione¶

• TaskId é necessário para recuperar os comentários da tarefa.
• LastModifiedTime suporta o seguinte operador: =.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM TaskComments WHERE TaskId = '123456000000040013'

Inserir¶

Para adicionar um Comentário de Tarefa, especifique os campos TaskId e Comentário.

INSERT INTO TaskComments (TaskId, content) VALUES ('123456000000040013', 'SQL Comment #6')

Atualizar¶

Para atualizar os comentários de uma tarefa, especifique o campo ID.

UPDATE TaskComments
    SET Content = 'Updated forum post content' 
WHERE ID = '123456000000043771' AND TaskId = '123456000000040013'

Excluir¶

Os comentários da tarefa podem ser excluídos fornecendo o ID e emitindo uma instrução DELETE.

DELETE FROM TaskComments WHERE TaskId = '123456000000045005' AND ID = '123456000000045042' 

Colunas¶

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.

TarefaCampos Personalizados¶

Informações de uso para a operação TaskCustomfields.rsd.

Colunas¶

TaskEntityProperties¶

Recupera os dados armazenados em uma entidade. O argumento deste método deve ser a chave que foi utilizada quando os mesmos dados foram armazenados.

Informações Específicas da Tabela¶

As propriedades de entidade são pares de valor-chave armazenados nas entidades de tarefa. Eles podem ser usados para armazenar detalhes necessários para integrações de API, mas não precisam estar visíveis na interface do usuário. A chave deve ser uma string e o valor pode ser uma string simples ou um objeto json. Você pode armazenar vários par chave-valor para uma única entidade. Essas propriedades de entidade podem ser armazenadas/recuperadas/atualizadas/excluídas usando as consultas abaixo.

Selecione¶

• TaskId e PropertyKey são necessários para recuperar as Propriedades da Entidade de Tarefa.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM TaskEntityProperties WHERE TaskId = '123456000000034087' AND PropertyKey = 'key1' 

Inserir¶

Para adicionar uma nova propriedade de entidade de tarefa, especifique os campos TaskId, PropertyKey e PropertyValue.

INSERT INTO TaskEntityProperties (TaskId, PropertyKey, PropertyValue) VALUES ('123456000000034087', 'key1', 'This is a test value')

Atualizar¶

ZohoProjects permite atualizações para a coluna PropertyValue.

UPDATE TaskEntityProperties SET PropertyValue = 'This is an updated property value' WHERE TaskId = '123456000000034087' AND PropertyKey = 'key1'

Excluir¶

As propriedades da entidade de tarefa podem ser excluídas fornecendo Id, TaskId, PropertyKey e emitindo uma instrução DELETE.

DELETE FROM TaskEntityProperties WHERE TaskId = '166135000000034087' AND PropertyKey = 'key1' AND ID = '166135000000035001'

Colunas¶

Listas de Tarefas¶

Obtenha todas as listas de tarefas no projeto fornecido.

Selecione¶

• MilestoneId e Flag suporta o seguinte operador: =.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM Tasklists WHERE MilestoneId = '12345600000123' AND Flag = 'internal' 

Inserir¶

Para criar uma nova lista de tarefas, você pode especificar os seguintes campos:

• Nome
• MilestoneId
• TaskTemplateId
• Dias de Turno
• Bandeira

INSERT INTO Tasklists (name, flag, ShiftDays)
VALUES ('New Tasklist #2', 'internal', '2022-03-10T01:00:00Z')

Atualizar¶

Para atualizar uma lista de tarefas, especifique o campo ID.

UPDATE Tasklists SET Name = 'SQL Updated tasklist #7' WHERE ID = '123456000000041033'

Excluir¶

As listas de tarefas podem ser excluídas fornecendo o ID e emitindo uma instrução DELETE.

DELETE FROM Tasklists WHERE ID = '123456000000041033'

Colunas¶

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.

Tarefas¶

Obtém todas as tarefas no projeto fornecido. Ele busca apenas as tarefas principais e não as subtarefas.

Selecione¶

Colunas que suportam o operador =:

• Eu ia
• Criado por
• MilestoneId
• Prioridade
• TasklistId
• Proprietário
• Status
• Tempo
• LastModifiedTime
• ViewId

• CreatedDate e LastModifiedTime suporte: ORDEM

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM Tasks WHERE MilestoneId = '12345600000123' AND Priority = 'High' ORDER BY CreatedDate

Inserir¶

Para criar uma nova tarefa, você pode especificar os seguintes campos:

• Nome
• Descrição
• Os Proprietários
• Duração
• Tipo de Duração
• Data final
• Prioridade
• Data de início
• TasklistId
• Trabalhar
• GroupNameAssociatedTeamsQualquer equipe
• Taxa Por Hora
• Cadeia de lembretes
• Recorrência
• Valor Orçamentário
• Limiar Orçamentário

INSERT INTO Tasks (Name, Description, Duration, DurationType, Priority,  BudgetValue)
VALUES ('New Task #2', 'This is a test description', '5', 'hrs', 'High', '1000')

Atualizar¶

Para atualizar uma Tarefa, especifique o campo ID.

UPDATE Tasks SET Priority = 'Low' WHERE ID = '123456000000034003'

Excluir¶

As tarefas podem ser excluídas fornecendo o ID e emitindo uma instrução DELETE.

DELETE FROM Tasks WHERE ID = '123456000000034003'

Colunas¶

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.

TarefaSubtarefas¶

Visualize todas as subtarefas da tarefa especificada.

Selecione¶

• TaskId é necessário para recuperar subtarefas de tarefas.

Você pode usar a consultar abaixo para obter todas as subtarefas de tarefas:

SELECT * FROM TaskSubtasks WHERE TaskId = '12345600000123' 

Inserir¶

Para criar uma nova tarefa, você pode especificar os seguintes campos:

• TaskId
• Nome
• Descrição
• Duração
• Tipo de Duração
• Prioridade
• Data de início
• Data final
• Pessoa responsável

INSERT INTO TaskSubtasks (TaskId, Name, StartDate, EndDate, Duration, DurationType, Priority, Description)
VALUES ('165818000000040013', 'Sql Subtask #4', '2022-03-01', '2022-03-10', '2', 'hrs', 'High', 'Test description of the subtask')

Colunas¶

TaskTimelogs¶

Obtém os registros de tempo em uma tarefa específica.

Selecione¶

• TaskId é necessário para recuperar logs de tempo de tarefa.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM TaskTimelogs WHERE TaskId = '123456000000045005'

Inserir¶

Para criar um novo Timelog de Tarefa, você pode especificar os seguintes campos:

• TaskId
• Estado da Fatura
• Notas
• Mostrador de Horas
• LogData
• OwnerId

INSERT INTO TaskTimelogs (TaskId, LogDate, BillStatus, HoursDisplay, Notes) " +
VALUES ('123456000000040013', '2022-03-03', 'Non Billable', '01:20', 'This is a test timelog')

Atualizar¶

Para atualizar um Task TimeLog, especifique os campos TaskId e ID.

UPDATE TaskTimelogs
    SET Notes = 'This is an updated SQL Note'
WHERE TaskId = '165818000000040013' AND ID = '165818000000045001'

Excluir¶

Os TimeLogs da tarefa podem ser excluídos fornecendo TaskId e ID e emitindo uma instrução DELETE.

DELETE FROM TaskTimelogs WHERE TaskId = '123456000000045005' AND ID = '123456000000044025'

Colunas¶

Equipes¶

Busque os detalhes da equipe no portal.

Selecione¶

Você pode usar a consultar abaixo para obter todas as equipes:

SELECT * FROM Teams

Inserir¶

Para criar uma nova equipe, você pode especificar os seguintes campos:

• Nome do grupo
• E-mailAlias
• UserIdArr
• ProjIds
• Liderança da equipe

INSERT INTO Teams (GroupName, UserIdArr, TeamLead, ProjIds)" +
VALUES ('TestTeam5', '["123456000000031003", "123456000000032055"]', '123456000000032055', '["123456000000031899"]

Atualizar¶

Para atualizar uma equipe, especifique o campo GroupId.

UPDATE Teams
SET TeamLead = '123456000000031003', 
    UserIdArr = '["123456000000031003", "123456000000032055"]',
    ProjIds = '["123456000000031899"]', 
    GroupName = 'TestTeam5' 
WHERE GroupId = '123456000000036001'

Excluir¶

As equipes podem ser excluídas fornecendo o GroupId e emitindo uma instrução DELETE.

DELETE FROM Teams WHERE GroupId = '123456000000044025' 

Colunas¶

TeamUsers¶

Buscar detalhes de uma equipe em particular.

Selecione¶

• GroupId é necessário para recuperar os usuários da equipe.

Você pode usar a consultar abaixo para obter todos os usuários da equipe:

SELECT * FROM TeamUsers WHERE GroupId = '123456000000033021'

Inserir¶

Para criar uma nova Equipe você deve especificar os seguintes campos:

• GroupId
• Zpuid

INSERT INTO TeamUsers (GroupId, ZPUID)
VALUES ('123456000000034163', '123456000000031003')

Excluir¶

TeamUsers podem ser excluídos fornecendo GroupId e ID e emitindo uma instrução DELETE.

DELETE FROM TeamUsers WHERE GroupId = '123456000000034163' AND ID = '123456000000031003'

Colunas¶

Usuários¶

Obtém os detalhes de todos os usuários em um projeto específico.

Colunas¶

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.

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.

Visualizações dinâmicas, como consultas expostas como visualizações e visualizações para procurar combinações específicas de itens de trabalho project_team são suportadas.

Conector Jitterbit para Exibições do Zoho Projects¶

Atividades¶

Liste todas as atividades recentes do projeto.

Selecione¶

Esta é uma visualização em nível de projeto. Você pode usar a consultar abaixo para obter todas as atividades:

SELECT * FROM Activities

Colunas¶

BugActivities¶

Obtém todas as atividades para o bug fornecido.

Selecione¶

Esta é uma visão de nível de bug.

• BugId é necessário para recuperar BugActivities.

Você pode usar a consultar abaixo para obter todas as BugActivities:

SELECT * FROM BugActivities WHERE BugId = '12345600001'

Colunas¶

BugAnexos¶

Obtenha detalhes de anexos para um bug.

Colunas¶

BugCustomFields¶

Obtém todos os campos personalizados no projeto fornecido.

Selecione¶

Esta é uma visualização em nível de projeto. Você pode usar a consultar abaixo para obter todos os BugCustomFields:

SELECT * FROM BugCustomFields WHERE BugId = '12345600001'

Colunas¶

Resolução de Bug¶

Obtenha a resolução do bug.

Colunas¶

Clientes¶

Retorna a lista de empresas clientes associadas a um ID de projeto específico.

Selecione¶

Esta é uma visualização em nível de projeto.

• Id suporta o seguinte operador: =.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM Clients WHERE ID = '12345600001'

Colunas¶

Documentos¶

Liste todas as atividades recentes do projeto.

Colunas¶

MyBugs¶

Lista todos os bugs criados por você ou atribuídos a você.

Selecione¶

Esta é uma exibição em nível de portal.

• StatusType, Owner, ViewType e ViewType suporta o seguinte operador: =.
• CreatedDate e LastModifiedTime suporte: ORDEM

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM MyBugs WHERE Owner = '12345021738' AND ViewType = 'owned' AND StatusType = 'open' ORDER BY CreatedDate

Colunas¶