Ir para o conteúdo

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

Nome Descrição
BugAssociatedTasks Busca os detalhes da tarefa associada a um bug.
BugComments Buscar comentários para o bug.
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.
BugFollowers Obter lista de seguidores para o bug.
Bugs Obtém todas as tarefas no projeto fornecido. Ele busca apenas as tarefas principais e não as subtarefas.
BugTimelogs Obtém os logs de tempo em um bug específico.
Contacts Busca todos os contatos do cliente de um portal.
Events Busca todas as tags presentes em um portal específico.
ForumCategories Obtém todas as categorias do fórum.
ForumComments Obtém todos os comentários do fórum.
Forums Obtém todos os fóruns no projeto fornecido.
Milestones Obtém a lista de layouts de projeto.
PortalClients Retorna a lista de empresas clientes do portal.
Portals Obtém todos os portais para o usuário logado.
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.
ProjectGroups Obtém todos os grupos para o projeto especificado.
Projects Obtém todos os projetos para o usuário logado.
ProjectUsers Obtém os detalhes de todos os usuários em um projeto específico.
Statuses Obtém os status do projeto fornecido.
Tags Busca todas as tags presentes em um portal específico.
TaskActivities Recupere detalhes de quem modificou uma tarefa específica e quando.
TaskComments Obtenha todos os comentários da tarefa.
TaskCustomfields Informações de uso para a operação TaskCustomfields.rsd.
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.
Tasklists Obtenha todas as listas de tarefas no projeto fornecido.
Tasks Obtém todas as tarefas no projeto fornecido. Ele busca apenas as tarefas principais e não as subtarefas.
TaskSubtasks Visualize todas as subtarefas da tarefa especificada.
TaskTimelogs Obtém os registros de tempo em uma tarefa específica.
Teams Busque os detalhes da equipe no portal.
TeamUsers Buscar detalhes de uma equipe em particular.
Users Obtém os detalhes de todos os usuários em um projeto específico.

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
Nome Tipo Somente leitura Descrição
BugId String Falso Identificação do bug.
TaskId String Falso ID de tarefa associada.
TaskName String Falso Nome da tarefa associada.
Prefix String Falso Prefixo de Tarefa Associado.
ProjectId String Falso ID do projeto de tarefa associada.
TaskOwners String Falso Proprietários de Tarefas Associadas.
TaskPercentageCompleted String Falso Porcentagem de Tarefa Associada Concluída.
TaskPriority String Falso Prioridade de Tarefa Associada.
TaskListId String Falso Identificação da lista de tarefas associada.

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
Nome Tipo Somente leitura Descrição
BugId [KEY] String Falso Identificação do bug.
Id [KEY] String Falso ID do comentário do bug.
Comment String Falso Conteúdo do comentário do bug.
AddedBy String Falso Comentário de bug adicionado por.
AddedPersonName String Falso Comentário de bug adicionado nome da pessoa.
CreatedDate Date Falso Data de criação do comentário do bug.
CreatedDateTime Datetime Falso Data e hora de criação do comentário do bug.
UpdatedBy String Falso Comentário de bug atualizado por.
UpdatedPerson String Falso Pessoa atualizada do comentário do bug.
UpdatedDate Date Falso Data de atualização do comentário do bug.
UpdatedDateTime Datetime Falso Comentário do Bug Atualizado Data Hora.

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
Nome Tipo Somente leitura Descrição
Id [KEY] String Falso Identificação da propriedade da entidade do bug.
BugId [KEY] String Falso Identificação do bug.
PropertyKey [KEY] String Falso Chave de propriedade de entidade de bug.
PropertyValue String Falso Valor da propriedade da entidade do bug.

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
Nome Tipo Somente leitura Descrição
BugId [KEY] String Falso Identificação do bug.
FollowerId String Falso Identificação do seguidor do bug.
FollowerName String Falso Nome do seguidor do bug.
BugFollowers String Falso Seguidores de Bug.

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
Nome Tipo Somente leitura Descrição
Id [KEY] String Falso Identificação do bug.
Key String Falso Chave de Bug.
Title String Falso Título do Bug.
AssigneeId String Falso Identificação do responsável pelo bug.
AssigneeName String Falso Nome do responsável pelo bug.
AssigneeZpuid String Falso Bug responsável ZPUID.
AttachmentCount String Falso Contagem de anexos de bug.
BugNumber String Falso Número do Bug.
BugPrefix String Falso Prefixo de bug.
ClassificationId Long Falso Identificação da classificação do bug.
ClassificationType String Falso Tipo de classificação de bug.
Closed Boolean Falso Bug Fechado.
CommentCount String Falso Contagem de comentários de bug.
CreatedTime Date Falso Hora de Criação do Bug.
CreatedDateTime Datetime Falso Data e hora de criação do bug.
Description String Falso Descrição do Bug.
DueDate Date Falso Data de Vencimento do Bug.
DueDateTime Datetime Falso Hora da data de vencimento do bug.
EscalationLevel String Falso Nível de escalonamento de bug.
Flag String Falso Bandeira de Bug. Os valores permitidos são internos, externos.
LinkSelfUrl String Falso Url de link de bug.
LinkTimesheetUrl String Falso Url do Quadro de Horários do Link do Bug.
LinkWebUrl String Falso Url da Web do link do bug.
ModuleId Long Falso Identificação do módulo de bug.
ModuleName String Falso Nome do módulo de bug.
ReportedPerson String Falso Pessoa relatada por bug.
ReporterEmail String Falso E-mail do relator de bugs.
ReporterId String Falso Identificação do relator de erros.
ReporterNonZuser String Falso Bug Reporter Não usuário.
ReproducibleId Long Falso ID reproduzível do bug.
ReproducibleType String Falso Tipo reproduzível de bug.
SeverityId Long Falso Identificação da gravidade do bug.
SeverityType String Falso Tipo de gravidade do bug.
StatusColorcode String Falso Código de cores de status de bug.
StatusId String Falso Identificação do status do bug.
StatusType String Falso Tipo de status de bug. Os valores permitidos são aberto, fechado.
UpdatedDate Date Falso Data de atualização do bug.
UpdatedDateTime Datetime Falso Data e hora da atualização do bug.
GroupNameAssociatedTeamsAnyTeam String Falso Bug Group Name Associated Teams by Any Team.
GroupNameAssociatedTeamsCount Integer Falso Contagem de equipes associadas ao nome do grupo de bugs.
GroupNameIsTeamUnassigned Boolean Falso O nome do grupo de bugs é equipe não atribuída.
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
HourlyRate String Taxa horária de bug.
BugFollowers String Seguidores de Bugs.
CustomViewId String ID de visualização personalizada do bug.
MilestoneId String Identificação do marco do bug.
AffectedMilestoneId String ID de marco afetado por bug.

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
Nome Tipo Somente leitura Descrição
BugId [KEY] String Falso Identificação do bug.
Id [KEY] String Falso Identificação do log de tempo do bug.
AddedByName String Falso Log de tempo de bug adicionado por nome.
AddedByZpuid String Falso Log de tempo de bug adicionado por ZPUID.
AddedByZuid Long Falso Log de tempo de bug adicionado por ZUID.
ApprovalStatus String Falso Status de aprovação do log de tempo de bug.
ApproverName String Falso Nome do aprovador de log de tempo de bug.
BillStatus String Falso Status de fatura de registro de tempo de bug. Os valores permitidos são Facturáveis, Não Faturáveis.
BugTitle String Falso Título do bug do log de tempo do bug.
CreatedDate Date Falso Data de criação do log de tempo do bug.
CreatedDateTime Datetime Falso Bug Time Log criado data e hora.
Hours Integer Falso Bug Time Log Hours.
Minutes Integer Falso Bug Time Log Minutos.
HoursDisplay String Falso Exibição de horas de log de tempo de bug.
LastModifiedDate Date Falso Data da última modificação do registro de tempo do bug.
LastModifiedDateTime Datetime Falso Data e hora da última modificação do log de tempo do bug.
LinkSelfUrl String Falso Url de auto-link de log de tempo de bug.
LogDate Date Falso Data do registro do tempo do bug.
LogDateTime Datetime Falso Hora do bug Data e hora do log.
Notes Unknown Falso Notas de registro de tempo de bug.
OwnerId String Falso Identificação do proprietário do log de tempo do bug.
OwnerName String Falso Nome do proprietário do log de tempo do bug.
TotalMinutes Integer Falso Total de minutos do log de tempo do bug.

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
Nome Tipo Somente leitura Descrição
ClientId String Falso Identificação do cliente de contato.
Id [KEY] String Falso Identificação do contato.
CrmContactId String Falso ID de contato do CRM de contato.
DisplayName String Falso Nome de exibição do contato.
FirstName String Falso Nome do contato.
LastName String Falso Sobrenome do contato.
Email String Falso E-mail de contato.
InvoiceRate String Falso Taxa de fatura de contato.
WorkProjects String Falso Matriz de IDs de projeto. Vários IDs podem ser separados por vírgula.

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
Nome Tipo Somente leitura Descrição
Id [KEY] String Falso Identificação do evento.
Title String Falso Título do evento.
CreatedBy String Falso Evento criado por.
CreatedByZpuid String Falso Evento Criado por ZPUID.
CreatedOn Long Falso Evento criado em.
DurationHour String Falso Hora de duração do evento.
DurationMinutes String Falso Minutos de duração do evento.
Location String Falso Local do evento.
Occurred Integer Falso Evento ocorrido.
Occurrences Integer Falso Ocorrências de Eventos.
Participants String Falso Participantes do evento.
ProjectName String Falso Nome do projeto do evento.
Reminder String Falso Lembrete de evento. Os valores permitidos são no horário, 15 minutos, 30 minutos, 1 hora, 2 horas, 6 horas, 12 horas, 1 dia.
Repeat String Falso Repetição do evento. Os valores permitidos são apenas uma vez, todos os dias, todas as semanas, todos os meses, todos os anos.
ScheduledOn String Falso Evento agendado.
ScheduledOnLong String Falso Evento agendado em longo prazo.
ScheduledOnTo String Falso Evento agendado para.
ScheduledOnToLong String Falso Evento agendado para muito tempo.
RepeatTimes String Falso Tempos de Repetição do Evento. Os valores permitidos são 2, 3, 4, 5, 6, 7, 8, 9, 10.
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
Status String Estado do evento. Os valores permitidos são aberto, fechado.

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
Nome Tipo Somente leitura Descrição
Id [KEY] String Falso ID da categoria do fórum.
Name String Falso Nome da categoria do fórum.

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
Nome Tipo Somente leitura Descrição
ForumId [KEY] Long Falso Fórum ID.
Id [KEY] String Falso ID do comentário do fórum.
Content String Falso Conteúdo do comentário do fórum.
Type String Falso Tipo de comentário do fórum.
Attachments String Falso Anexos de comentários do fórum.
IsBestAnswer Boolean Falso O comentário do fórum é a melhor resposta.
Level String Falso Nível de comentário do fórum.
ParentId String Falso ID pai do comentário do fórum.
ParentPostedBy String Falso Comentário do fórum Pai Postado por.
ParentPostedByZpuid String Falso Comentário do fórum Pai Postado por ZPUID.
PostDate Date Falso Data de postagem do comentário no fórum.
PostDateTime Datetime Falso Comentário do Fórum Postar Data Hora.
PostedBy String Falso Comentário do fórum postado por.
PostedByZpuid String Falso Comentário do fórum postado por Zpuid.
PostedPerson String Falso Comentário do Fórum Postado Pessoa.
RootId String Falso ID da raiz do comentário do fórum.
ThirdPartyAttachments String Falso Comentários do fórum Anexos de terceiros.

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
Nome Tipo Somente leitura Descrição
Id [KEY] String Falso Fórum ID.
Name String Falso Nome do Fórum.
Type String Falso Tipo de Fórum. Os valores permitidos são normal, pergunta.
Attachments String Falso Anexos do Fórum.
CategoryId String Falso ID da categoria do fórum.
CategoryName String Falso Nome da categoria do fórum.
CommentCount Integer Falso Contagem de comentários do fórum.
Content String Falso Conteúdo do Fórum.
Flag String Falso Bandeira do Fórum.
IsAnnouncementPost Boolean Falso Fórum é postagem de anúncio.
IsStickyPost Boolean Falso Fórum é post pegajoso.
LastActivityDate Date Falso Data da última atividade do fórum.
LastActivityDateTime Datetime Falso Hora da última atividade do fórum.
LastModifiedDate Date Falso Data da última modificação do fórum.
LastModifiedDateTime Datetime Falso Data e Hora da Última Modificação do Fórum.
LinkSelfUrl String Falso Url do link do fórum.
PostDate Date Falso Data de postagem do fórum.
PostDateTime Datetime Falso Data da postagem do fórum.
PostedBy String Falso Fórum Postado por.
PostedByZpuid String Falso Fórum Postado por ZPUID.
PostedPerson String Falso Pessoa postada no fórum.
ThirdPartyAttachments String Falso Anexos de terceiros do fórum.
Notify String Falso Digite os IDs de e-mail do usuário a serem notificados (vários e-mails podem ser separados por vírgula).

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
Nome Tipo Somente leitura Descrição
Id [KEY] String Falso ID do marco do projeto.
Name String Falso Nome do marco do projeto.
Flag String Falso Bandeira de Marco. Os valores permitidos são internos, externos.
Closed Boolean Falso Marco Fechado.
CreatedDate Date Falso Data de Criação do Marco.
CreatedDateTime Datetime Falso Data e hora de criação do marco.
StartDate Date Falso Data de início do marco.
StartDateTime Datetime Falso Data de Início do Marco Hora.
EndDate Date Falso Data de término do marco.
EndDateTime Datetime Falso Data de término do marco.
Actual Integer Falso Marco Real.
ActualCostFormatted String Falso Custo real do marco formatado.
ActualHoursFormatted String Falso Horas reais do marco formatadas.
Balance Integer Falso Balanço de Marco.
BalanceCostFormatted String Falso Custo de saldo de marco formatado.
BcyActual Integer Falso Marco Bcy Real.
BcyActualCost String Falso Custo real do Marco Bcy.
BcyForecasted Integer Falso Marco Bcy previsto.
BcyForecastedCost String Falso Custo Previsto do Marco Bcy.
BcyPlanned Integer Falso Marco Bcy planejado.
BcyPlannedCost String Falso Custo planejado Bcy do marco.
BudgetType Integer Falso Tipo de orçamento de marco.
CurrencyCode String Falso Código da Moeda Milestone.
Difference Integer Falso Diferença de marco.
DifferenceFormatted String Falso Diferença de Marco Formatada.
Forecasted Integer Falso Marco previsto.
ForecastedCostFormatted String Falso Custo previsto de marco formatado.
ForecastedHoursFormatted String Falso Horas previstas de marcos formatadas.
LastCalculatedTime String Falso Hora calculada do último marco.
Planned Integer Falso Marco planejado.
PlannedCostFormatted String Falso Custo planejado do marco formatado.
PlannedHoursFormatted String Falso Horas planejadas de marcos formatadas.
IsWorkfieldRemoved Boolean Falso Marco é campo de trabalho removido.
LastUpdatedDate Date Falso Data da última atualização do marco.
LastUpdatedDateTime Datetime Falso Data e hora da última atualização do marco.
SelfUrl String Falso Auto URL do marco.
StatusUrl String Falso URL de status do marco.
OwnerId String Falso ID do proprietário do marco.
OwnerName String Falso Nome do proprietário do marco.
OwnerZpuid String Falso Proprietário do Marco ZPUID.
ProjectId String Falso ID do projeto.
ProjectName String Falso Nome do Projeto.
Sequence Integer Falso Sequência de marcos.
Status String Falso Status. Os valores permitidos são completed, notcompleted.
StatusColorCode String Falso Código de cores de status.
StatusId String Falso Identificação do estado.
StatusName String Falso Nome do estado.
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
DisplayType String Tipo de exibição de marco. Os valores permitidos são próximos, atrasados.
LastModifiedTime Datetime Hora da última modificação do marco.

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
Nome Tipo Somente leitura Descrição
Id [KEY] String Falso ID do Cliente.
Name String Falso Nome do cliente.
City String Falso Cidade Cliente.
Country String Falso País do cliente.
State String Falso Estado do cliente.
CrmAccountId String Falso ID da conta CRM do cliente.
FirstAddress String Falso Primeiro endereço do cliente.
SecondAddress String Falso Segundo endereço do cliente.
WebAddress String Falso Endereço da Web do cliente.
ZipCode String Falso CEP do cliente.
UserId String Falso ID do usuário do cliente.
UserName String Falso Nome de usuário do cliente.
UserEmail String Falso E-mail do usuário cliente.
UserZpuid String Falso Usuário cliente Zpuid.
WorkProjects String Falso Projetos de trabalho do cliente.
PrimaryClient String Falso Cliente Cliente Primário. Os valores permitidos são Sim, Não.

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
Nome Tipo Somente leitura Descrição
Id [KEY] String Falso Identificação do portal.
Name String Falso Nome do Portal.
CompanyName String Falso Nome da Empresa do Portal.
AvailableClients Integer Falso Clientes Disponíveis no Portal.
AvailableUsers Integer Falso Usuários Disponíveis do Portal.
AvailableProjects Integer Falso Projetos Disponíveis no Portal.
BugPlan String Falso Plano de Bug do Portal.
BugPlural String Falso Plural de Bugs.
BugSingular String Falso Inseto Singular.
CanAddTemplate Boolean Falso Pode adicionar modelo de portal.
CanCreateProject Boolean Falso Pode criar projeto de portal.
Default Boolean Falso Portal Padrão.
ExtensionsAppSettings String Falso Configurações de aplicativos de localizações de extensões de portal.
ExtensionsAttachmentPicker String Falso Seletor de anexos de locais de extensões do portal.
ExtensionsBlueprintDuring String Falso Projeto de localizações de extensões de portal durante.
ExtensionsIssueTab String Falso Guia de problemas de localização das extensões do portal.
ExtensionsIssuedetailsRightpanel String Falso Localizações das Extensões do Portal Detalhes do Problema Painel Direito.
ExtensionsProjectTab String Falso Localizações das Extensões do Portal Guia do Projeto.
ExtensionsTaskTab String Falso Guia de Tarefas Locais das Extensões do Portal.
ExtensionsTaskTransition String Falso Transição de Tarefa de Locais de Extensões de Portal.
ExtensionsTaskdetailsRightpanel String Falso Localizações das extensões do portal Detalhes da tarefa Painel direito.
ExtensionsTopBand String Falso Localização das Extensões do Portal Top Band.
GmtTimeZone String Falso Fuso Horário GMT do Portal.
GmtTimeZoneOffset Integer Falso Deslocamento do Fuso Horário GMT do Portal.
MeetingEnabled Boolean Falso Reunião do portal habilitada.
PeopleEnabled Boolean Falso Pessoas do portal habilitadas.
CrmPartner Boolean Falso Portal CRM Partner.
DisplayProjectPrefix Boolean Falso Prefixo do Projeto de Exibição do Portal.
DisplayTaskPrefix Boolean Falso Prefixo da Tarefa de Exibição do Portal.
NewPlan Boolean Falso Portal Novo Plano.
SprintsIntegrated Boolean Falso Portal Sprints Integrado.
TagsAvailable Boolean Falso Tags do portal disponíveis.
TimeLogRestricted Boolean Falso Registro de tempo do portal restrito.
ProjectsModuleId String Falso ID do Módulo de Projetos do Portal.
TasksModuleId String Falso ID do Módulo de Tarefas do Portal.
ProjectUrl String Falso URL do Projeto Portal.
LocaleCode String Falso Código de localidade do portal.
LocaleCountry String Falso Local do Portal País.
Language String Falso Linguagem do Portal.
LoginZpuid Long Falso Portal de login ZPUID.
MaxClients Integer Falso Clientes do Portal Max.
MaxUsers Integer Falso Usuários Máximos do Portal.
NewUserPlan Boolean Falso Plano de Novo Usuário do Portal.
PercentageCalculation String Falso Cálculo da Porcentagem do Portal.
Plan String Falso Plano Portal.
ProfileId Long Falso ID do perfil do portal.
ProfileName String Falso Nome do Perfil do Portal.
ProfileType Integer Falso Tipo de Perfil do Portal.
ActiveProjects Integer Falso Projetos Ativos do Portal.
ProjectPrefix String Falso Prefixo do projeto do portal.
Role String Falso Função do Portal.
RoleId String Falso ID da Função do Portal.
RoleName String Falso Nome da Função do Portal.
BusinessHoursEnd Integer Falso Fim do Horário de Funcionamento do Portal.
BusinessHoursStart Integer Falso Início do Horário Comercial do Portal.
DateFormat String Falso Formato de Data do Portal.
DefaultCurrency String Falso Moeda Padrão do Portal.
DefaultDependencyType String Falso Tipo de dependência padrão do portal.
BudgetPermission Boolean Falso Permissão de Orçamento do Portal.
Holidays String Falso Feriados do Portal.
BudgetEnabled Boolean Falso Orçamento do portal ativado.
LastSyncTime String Falso Hora da Última Sincronização do Portal.
StartDayOfWeek String Falso Dia de Início da Semana do Portal.
TaskDateFormat String Falso Formato de Data da Tarefa do Portal.
TaskDurationType String Falso Tipo de Duração da Tarefa do Portal.
TimeZone String Falso Fuso Horário do Portal.
EditTimeLogRestricted Boolean Falso Log de tempo de edição do portal restrito.
LogFutureTimeAllowed Boolean Falso Tempo futuro de log do portal permitido.
LogPastTimeAllowed Boolean Falso Tempo de Log do Portal Passado Permitido.
DefaultBillingStatus String Falso Status de cobrança padrão do portal.
TimesheetApprovalEnabled Boolean Falso Aprovação do Quadro de Horários do Portal Habilitada.
WorkingDays String Falso Jornadas de Trabalho do Portal.
SprintsProjectPermission Boolean Falso Permissão do Projeto Portal Sprints.
StorageType String Falso Tipo de armazenamento do portal.
TrialEnabled Boolean Falso Avaliação do portal ativada.
LogHrRestrictedByWorkHr Boolean Falso Portal Log Hr restrito por Work Hr.
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
ViewId String

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
Nome Tipo Somente leitura Descrição
Id [KEY] String Falso ID da propriedade da entidade do projeto.
PropertyKey [KEY] String Falso Chave de propriedade da entidade do projeto.
PropertyValue String Falso Valor da propriedade da entidade do projeto.

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
Nome Tipo Somente leitura Descrição
Id [KEY] String Falso ID do grupo de projeto.
Name String Falso Nome do grupo de projetos.
Default Boolean Falso É Grupo de projeto padrão.

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
Nome Tipo Somente leitura Descrição
Id [KEY] String Falso ID do projeto.
Name String Falso Nome do Projeto.
Key String Falso Chave do Projeto.
BugsEnabled Boolean Falso Bugs de projeto ativados.
BillingStatus String Falso Status de cobrança do projeto. Os valores permitidos são Facturáveis, Não Faturáveis.
BillingType String Falso Mencione o método de cobrança para faturamento. (1 = Com base nas horas do projeto, 2 = Com base nas horas da equipe, 3 = Custo fixo do projeto, 4 = Com base nas horas da tarefa/problema). Os valores permitidos são 1, 2, 3, 4.
BugClientPermission String Falso Permissão do cliente de bug do projeto.
BugsClosed Integer Falso Bugs do projeto encerrados.
BugsOpen Integer Falso Bugs do Projeto Abertos.
BugsDefaultView String Falso Visualização padrão de bugs do projeto.
BugsPrefix String Falso Prefixo de bugs do projeto.
CreatedDate Date Falso Data de Criação do Projeto.
CreatedDateTime Datetime Falso Data e hora de criação do projeto.
CustomStatusColor String Falso Cor de status personalizada do projeto.
CustomStatusId String Falso ID de status personalizado do projeto.
CustomStatusName String Falso Nome do status personalizado do projeto.
Currency String Falso A moeda padrão do seu projeto. Exemplo: USD, INR, etc.
CurrencySymbol String Falso Símbolo de moeda do projeto.
Description String Falso Descrição do Projeto.
EnabledTabs String Falso Guias habilitadas para projeto.
ChatEnabled Boolean Falso Bate-papo do projeto ativado.
ClientAssignBug String Falso Bug de atribuição do cliente do projeto.
Public String Falso Projeto Público. Os valores permitidos são sim, não.
SprintsProject Boolean Falso Projeto Sprints do Projeto.
Strict String Falso Projeto Estrito.
BugLayoutId String Falso ID do layout do bug do projeto.
BugLayoutName String Falso Nome do layout do bug do projeto.
ProjectLayoutId String Falso Projeto ID do layout do projeto.
ProjectLayoutName String Falso Projeto Nome do layout do projeto.
TaskLayoutId String Falso ID do Layout da Tarefa do Projeto.
TaskLayoutName String Falso Nome do Layout da Tarefa do Projeto.
ActivityUrl String Falso URL da atividade do projeto.
BugUrl String Falso URL do bug do projeto.
DocumentUrl String Falso URL do documento do projeto.
EventUrl String Falso URL do evento do projeto.
FolderUrl String Falso URL da pasta do projeto.
ForumUrl String Falso URL do fórum do projeto.
MilestoneUrl String Falso URL do marco do projeto.
SelfUrl String Falso Url do próprio projeto.
StatusUrl String Falso URL de status do projeto.
TaskUrl String Falso URL da tarefa do projeto.
TasklistUrl String Falso URL da lista de tarefas do projeto.
TimesheetUrl String Falso URL do Quadro de Horários do Projeto.
UserUrl String Falso URL do usuário do projeto.
MilestoneClosed Integer Falso Marco do Projeto Fechado.
MilestoneOpen Integer Falso Marco do projeto aberto.
OwnerId String Falso ID do proprietário do projeto.
OwnerName String Falso Nome do proprietário do projeto.
OwnerZpUid String Falso Proprietário do Projeto Zp Uid.
ProfileId Long Falso ID do perfil do projeto.
ProjectPercent String Falso Projeto Porcentagem do Projeto.
Role String Falso Papel do Projeto.
ShowProjectOverview Boolean Falso Projeto Mostrar visão geral do projeto.
Status String Falso Status do projeto. Os valores permitidos são ativo, arquivado, modelo.
SettingsDate Boolean Falso Data de configurações do projeto.
SettingsLogHours Boolean Falso Horas de registro de configurações do projeto.
SettingsPercentage Boolean Falso Porcentagem de configurações do projeto.
SettingsPlan Boolean Falso Plano de configurações do projeto.
SettingsWorkHours Boolean Falso Horas de Trabalho de Configurações do Projeto.
TaskClosed Integer Falso Tarefa do Projeto Fechada.
TaskOpen Integer Falso Tarefa do projeto aberta.
TaskbugPrefix String Falso Prefixo do Taskbug do Projeto.
UpdatedDate Date Falso Data de atualização do projeto.
UpdatedDateTime Datetime Falso Data e hora de atualização do projeto.
WorkspaceId String Falso ID do espaço de trabalho do projeto.
BudgetType String Falso Tipo do seu orçamento. Valores aceitos 0, 1, 2, 3, 4, 5 e 6. (0 = Nenhum, 1 = Com base no valor, 2 = Com base em horas, 3 = Com base no valor do marco, 4 = Com base no marco de horas, 5 = Com base na quantidade de tarefa e 6 = Baseado em horas de tarefa). Os valores permitidos são 1, 2, 3, 4, 5, 6.
BudgetTypeValue String Falso Valor do tipo de orçamento do projeto.
BudgetValue String Falso Valor do orçamento do projeto.
Rate String Falso Taxa do Projeto.
BudgetTrackingMethod String Falso Método para acompanhar o orçamento do seu projeto. Valores aceitos 1, 2 e 4. (1 = Horas de projeto, 2 = Horas de equipe, 4 = Horas de tarefa/emissão).
FixedCost String Falso Custo Fixo do Projeto.
TemplateId String Falso ID do modelo do projeto.
Threshold String Falso Especifique o limite do orçamento (Valor ou horas).
StartDate String Falso Data de início do projeto.
EndDate String Falso Data de término do projeto.
EnableRollup String Falso Rollup de habilitação de projeto. Os valores permitidos são Sim, Não.
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
LastModifiedTime Datetime Hora da última modificação do projeto.
GroupId String ID do grupo de projeto.
Assignee String Cessionário do Projeto.

Usuários do Projeto

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

Colunas
Nome Tipo Somente leitura Descrição
Id [KEY] String Falso ID do usuário.
Name String Falso Nome de usuário.
Active Boolean Falso Usuário Ativo.
ChatAccess Boolean Falso Acesso de bate-papo do usuário.
Email String Falso E-mail do usuário.
PortalProfileName String Falso Nome do perfil do portal do usuário.
PortalRoleId String Falso ID da função do portal do usuário.
PortalRoleName String Falso Nome da Função do Portal do Usuário.
ProfileId String Falso ID do perfil do usuário.
ProfileType String Falso Tipo de perfil de usuário.
ProjectProfileId String Falso ID do perfil do projeto do usuário.
Role String Falso Papel do usuário. Os valores permitidos são gerente, funcionário, contratado.
RoleId String Falso ID da função do usuário.
RoleName String Falso Nome da função do usuário.
Zpuid String Falso ZPUID do usuário.
WorkProjects String Falso Projetos de trabalho do usuário.
UserType String Falso Tipo de usuário do usuário. Os valores permitidos são ativo, inativo.

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
Nome Tipo Somente leitura Descrição
Id [KEY] String Falso Identificação do estado.
Content String Falso Conteúdo do estado.
PostedBy String Falso Estado Postado por.
PostedPerson String Falso Pessoa postada com status.
PostedDate Date Falso Data de postagem do status.
PostedDateTime Datetime Falso Status Postado Data Hora.

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
Nome Tipo Somente leitura Descrição
Id [KEY] String Falso Identificação da etiqueta.
Name String Falso Nome da etiqueta.
ColorClass String Falso Classe de cores de marca.
CreatedBy String Falso Marca criada por.
CreatedByName String Falso Marca criada por nome.
CreatedByEmail String Falso Marca criada por E-mail.
CreatedByFirstName String Falso Marca criada pelo nome.
CreatedByLastName Unknown Falso Marca criada pelo sobrenome.
CreatedByIsClientUser Boolean Falso Marca criada por é usuário do cliente.
CreatedByZpuid String Falso Marca criada por Zpuid.
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
Tags String

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
Nome Tipo Somente leitura Descrição
TaskId String Falso Identificação da tarefa.
Id [KEY] String Falso Identificação da atividade da tarefa.
Name String Falso Nome da atividade da tarefa.
ActivityBy String Falso Atividade da tarefa por.
OldValue Unknown Falso Valor antigo da atividade da tarefa.
NewValue Unknown Falso Tarefa Atividade Novo valor.
State String Falso Estado da atividade da tarefa.
Time Date Falso Tempo de atividade da tarefa.
DateTime Datetime Falso Tarefa Atividade Data Hora.
Zuid String Falso Tarefa Atividade ZUID.

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
Nome Tipo Somente leitura Descrição
TaskId [KEY] String Falso Identificação da tarefa.
Id [KEY] String Falso ID do comentário da tarefa.
Content String Falso Conteúdo do comentário da tarefa.
AddedPersonId String Falso Comentário da tarefa Id da pessoa adicionada.
AddedPersonName String Falso Comentário da tarefa Nome da pessoa adicionada.
AddedVia String Falso Comentário de tarefa adicionado via.
Attachments String Falso Anexos de comentários de tarefas.
CreatedDate Date Falso Data de criação do comentário da tarefa.
CreatedDateTime Datetime Falso Comentário da Tarefa Data e Hora de Criação.
LastModifiedDate Date Falso Data da última modificação do comentário da tarefa.
LastModifiedDateTime Datetime Falso Tarefa Comentário Última modificação Data Hora.
ProjectName String Falso Tarefa Comentário Nome do projeto.
SprintsNotesId Integer Falso Tarefa Comentário Sprints Notas Id.
ThirdPartyAttachments String Falso Tarefa Comentário Anexos de terceiros.
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
LastModifiedTime Datetime Hora da última modificação do comentário da tarefa.

TarefaCampos Personalizados

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

Colunas
Nome Tipo Somente leitura Descrição
ColumnName [KEY] String Falso Nome da coluna do campo personalizado da tarefa.
ColumnType [KEY] String Falso Tipo de coluna de campo personalizado de tarefa.
DisplayName [KEY] String Falso Nome de exibição do campo personalizado da tarefa.
IsDefault [KEY] String Falso O campo personalizado da tarefa é padrão.
IsEncrypted [KEY] String Falso O campo personalizado da tarefa é criptografado.
IsMandatory String Falso O campo personalizado da tarefa é obrigatório.

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
Nome Tipo Somente leitura Descrição
Id [KEY] String Falso Id da propriedade da entidade da tarefa.
TaskId [KEY] String Falso Identificação da tarefa.
PropertyKey [KEY] String Falso Chave de propriedade da entidade de tarefa.
PropertyValue String Falso Valor da propriedade da entidade da tarefa.

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
Nome Tipo Somente leitura Descrição
Id [KEY] String Falso ID da lista de tarefas.
Name String Falso Nome da lista de tarefas.
Completed Boolean Falso Lista de tarefas concluída.
CreatedDate Date Falso Data de Criação da Lista de Tarefas.
CreatedDateTime Datetime Falso Data e Hora de Criação da Lista de Tarefas.
LastUpdatedDate Date Falso Data da última atualização da lista de tarefas.
LastUpdatedDateTime Datetime Falso Data e hora da última atualização da lista de tarefas.
LinkSelfUrl String Falso URL do link da lista de tarefas.
LinkTaskUrl String Falso URL da tarefa do link da lista de tarefas.
MilestoneClosed Boolean Falso Marco da lista de tarefas fechado.
MilestoneCreatedDate Date Falso Data de Criação do Marco da Lista de Tarefas.
MilestoneCreatedDateTime Datetime Falso Data e Hora de Criação do Marco da Lista de Tarefas.
MilestoneEndDate Date Falso Data de término do marco da lista de tarefas.
MilestoneEndDateTime Datetime Falso Data e hora de término do marco da lista de tarefas.
MilestoneFlag String Falso Sinalizador de marco da lista de tarefas.
MilestoneId String Falso ID do marco da lista de tarefas.
MilestoneIsWorkfieldRemoved Boolean Falso O marco da lista de tarefas foi removido do campo de trabalho.
MilestoneLastUpdatedDate Date Falso Data da última atualização do marco da lista de tarefas.
MilestoneLastUpdatedDateTime Datetime Falso Data e hora da última atualização do marco da lista de tarefas.
MilestoneLinkSelfUrl String Falso URL próprio do link do marco da lista de tarefas.
MilestoneLinkStatusUrl String Falso URL de status do link do marco da lista de tarefas.
MilestoneName String Falso Nome do marco da lista de tarefas.
MilestoneOwnerId String Falso ID do proprietário do marco da lista de tarefas.
MilestoneOwnerName String Falso Nome do proprietário do marco da lista de tarefas.
MilestoneOwnerZpuid String Falso Lista de Tarefas Proprietário do Marco Zpuid.
MilestoneProjectId String Falso ID do projeto de marco da lista de tarefas.
MilestoneProjectName String Falso Nome do projeto de marco da lista de tarefas.
MilestoneSequence Integer Falso Sequência de marcos da lista de tarefas.
MilestoneStartDate Date Falso Data de início do marco da lista de tarefas.
MilestoneStartDateTime Datetime Falso Data e hora de início do marco da lista de tarefas.
MilestoneStatus String Falso Status do Marco da Lista de Tarefas.
MilestoneStatusDetColorcode String Falso Tarefas Milestone Status Det Colorcode.
MilestoneStatusDetId String Falso Identificação do status do marco da lista de tarefas
MilestoneStatusDetName String Falso Nome do Det do Status do Marco da Lista de Tarefas.
Rolled Boolean Falso Lista de Tarefas Rolada.
Sequence Integer Falso Sequência da lista de tarefas.
TaskCountOpen Integer Falso Contagem de tarefas da lista de tarefas aberta.
TaskTemplateId String Falso ID do modelo de lista de tarefas.
ShiftDays Datetime Falso A data e hora ISO 8601 a partir da qual a data de início da tarefa é calculada, com base nos dias de turno.
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
Flag String Sinalizador de lista de tarefas. Os valores permitidos são internos, externos.

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
Nome Tipo Somente leitura Descrição
Id [KEY] String Falso Identificação da tarefa.
Name String Falso Nome da tarefa.
Key String Falso Chave de tarefa.
BillingType String Falso Tipo de Faturamento da Tarefa.
Completed Boolean Falso Tarefa completa.
CreatedBy String Falso Tarefa criada por.
CreatedByEmail String Falso Tarefa criada por E-mail.
CreatedByZpuid String Falso Tarefa criada por Zpuid.
CreatedPerson String Falso Pessoa criada pela tarefa.
CreatedDate Date Falso Data de Criação da Tarefa.
CreatedDateTime Datetime Falso Data e hora de criação da tarefa.
Description String Falso Descrição da tarefa.
Owners String Falso Proprietários de Tarefas.
Duration String Falso Duração da Tarefa.
DurationType String Falso Tipo de duração da tarefa. Os valores permitidos são dias, horas.
EndDate Date Falso Data de término da tarefa.
EndDateTime Datetime Falso Data de término da tarefa Hora.
CommentAdded Boolean Falso Comentário de tarefa adicionado.
DocsAssociated Boolean Falso Tarefa Documentos Associados.
ForumAssociated Boolean Falso Tarefa Fórum Associado.
RecurrenceSet Boolean Falso Conjunto de Recorrência de Tarefa.
ReminderSet Boolean Falso Conjunto de lembretes de tarefas.
Parent Boolean Falso Tarefa Pai.
LastUpdatedDate Date Falso Data da última atualização da tarefa.
LastUpdatedDateTime Datetime Falso Data e hora da última atualização da tarefa.
LinkSelfUrl String Falso URL próprio do link de tarefa.
LinkTimesheetUrl String Falso URL do Quadro de Horários do Link da Tarefa.
LinkWebUrl String Falso URL da Web do link da tarefa.
LogHoursBillableHours String Falso Horas de Log de Tarefas Horas Faturáveis.
LogHoursNonBillableHours String Falso Horas de Log de Tarefas Horas Não Faturáveis.
MilestoneId String Falso ID do marco da tarefa.
OrderSequence Integer Falso Sequência de ordem de tarefa.
PercentComplete String Falso Porcentagem concluída da tarefa.
Priority String Falso Prioridade de Tarefa. Os valores permitidos são nenhum, baixo, médio, alto.
StartDate Date Falso Data de início da tarefa.
StartDateTime Datetime Falso Data de Início da Tarefa Hora.
StatusColorCode String Falso Código de cores do status da tarefa.
StatusName String Falso Nome do status da tarefa.
StatusId String Falso Identificação do status da tarefa.
StatusType String Falso Tipo de status da tarefa.
Subtasks Boolean Falso Tarefa Subtarefas.
TaskFollowers String Falso Seguidores de Tarefas.
TaskFollowerSize Integer Falso Tamanho do seguidor da tarefa.
TasklistId String Falso ID da lista de tarefas.
TasklistName String Falso Nome da lista de tarefas.
Work String Falso Tarefa Trabalho.
WorkForm String Falso Formulário de Trabalho de Tarefa.
WorkType String Falso Tipo de trabalho da tarefa. Os valores permitidos são work_hrs_per_day.
GroupNameAssociatedTeamsAnyTeam String Falso Nome do Grupo de Tarefas Equipes Associadas Qualquer Equipe.
GroupNameAssociatedTeamsCount Integer Falso Nome do Grupo de Tarefas Contagem de Equipes Associadas.
GroupNameIsTeamUnassigned Boolean Falso O nome do grupo de tarefas é Equipe não atribuída.
RatePerHour String Falso Taxa de tarefas por hora.
ReminderString String Falso Cadeia de lembrete de tarefa.
Recurrence String Falso Recorrência de tarefas.
BudgetValue String Falso Valor do Orçamento da Tarefa.
BudgetThreshold String Falso Limite de Orçamento de 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
Owner String Proprietário da Tarefa.
Status String Estado da Tarefa. Os valores permitidos são completed, notcompleted.
Time String Hora da Tarefa. Os valores permitidos são vencido, hoje, amanhã.
LastModifiedTime Datetime Hora da Última Modificação da Tarefa.
ViewId String Identificação da visualização da tarefa.

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
Nome Tipo Somente leitura Descrição
TaskId String Falso Identificação da tarefa.
Id [KEY] String Falso ID da subtarefa.
Name String Falso Nome da subtarefa.
Key String Falso Chave de subtarefa.
BillingType String Falso Tipo de cobrança da subtarefa.
Completed Boolean Falso Subtarefa concluída.
CreatedBy String Falso Subtarefa criada por.
CreatedByEmail String Falso Subtarefa criada por E-mail.
CreatedByZpuid String Falso Subtarefa criada por Zpuid.
CreatedPerson String Falso Pessoa criada na subtarefa.
CreatedTime Date Falso Hora de criação da subtarefa.
CreatedDateTime Datetime Falso Data e hora de criação da subtarefa.
Depth Integer Falso Profundidade da subtarefa.
Description String Falso Descrição da subtarefa.
DetailsOwners String Falso Proprietários de detalhes da subtarefa.
Duration String Falso Duração da Subtarefa.
DurationType String Falso Tipo de duração da subtarefa. Os valores permitidos são dias, horas.
IsCommentAdded Boolean Falso A subtarefa é um comentário adicionado.
IsDocsAssociated Boolean Falso A subtarefa está associada a documentos.
IsForumAssociated Boolean Falso A subtarefa está associada ao fórum.
IsRecurrenceSet Boolean Falso A subtarefa é um conjunto de recorrência.
IsReminderSet Boolean Falso A subtarefa é um lembrete definido.
IsParent Boolean Falso A subtarefa é pai.
LastUpdatedTime Date Falso Hora da última atualização da subtarefa.
LastUpdatedDateTime Datetime Falso Data e hora da última atualização da subtarefa.
LinkSelfUrl String Falso URL do link da subtarefa.
LinkTimesheetUrl String Falso URL da planilha de horas do link da subtarefa.
LinkWebUrl String Falso URL da Web do link da subtarefa.
LogBillableHours String Falso Horas faturáveis de registro de subtarefa.
LogNonBillableHours String Falso Horas não faturáveis do registro de subtarefa.
MilestoneId String Falso ID do marco da subtarefa.
OrderSequence Integer Falso Sequência de ordem de subtarefa.
ParentTaskId String Falso ID da tarefa pai da subtarefa.
PercentComplete String Falso Porcentagem concluída da subtarefa.
Priority String Falso Prioridade de subtarefa. Os valores permitidos são nenhum, baixo, médio, alto.
RootTaskId String Falso ID da tarefa raiz da subtarefa.
StatusColorCode String Falso Código de cor do status da subtarefa.
StatusId String Falso ID do status da subtarefa.
StatusName String Falso Nome do status da subtarefa.
StatusType String Falso Tipo de status da subtarefa.
Subtasks Boolean Falso Subtarefas Subtarefas.
TaskFollowers String Falso Seguidores de tarefas de subtarefa.
TaskFollowerSize Integer Falso Tamanho do seguidor da tarefa da subtarefa.
TasklistId String Falso ID da lista de tarefas da subtarefa.
TasklistName String Falso Nome da lista de tarefas da subtarefa.
Work String Falso Trabalho de Subtarefa.
WorkForm String Falso Formulário de Trabalho de Subtarefa.
WorkType String Falso Tipo de trabalho da subtarefa.
GroupNameAssociatedTeamsAnyTeam String Falso Nome do grupo de subtarefas Equipes associadas Qualquer equipe.
GroupNameAssociatedTeamsCount Integer Falso Nome do grupo de subtarefa Contagem de equipes associadas.
GroupNameIsTeamUnassigned Boolean Falso O nome do grupo de subtarefas é Equipe não atribuída.
StartDate Date Falso Data de início da subtarefa.
EndDate Date Falso Data de término da subtarefa.
PersonResponsible String Falso Pessoa responsável pela subtarefa.

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
Nome Tipo Somente leitura Descrição
TaskId [KEY] String Falso Identificação da tarefa.
Id [KEY] String Falso Identificação do registro de tempo da tarefa.
AddedByName String Falso Registro de tempo da tarefa adicionado por nome.
AddedByZpuid String Falso Log de tempo da tarefa adicionado por Zpuid.
AddedByZuid Long Falso Log de tempo da tarefa adicionado por Zuid.
ApprovalStatus String Falso Status de aprovação do registro de tempo da tarefa.
ApproverName String Falso Nome do aprovador do registro de tempo da tarefa.
BillStatus String Falso Status da conta de registro de tempo da tarefa. Os valores permitidos são Facturáveis, Não Faturáveis.
CreatedDate Date Falso Data de criação do registro de tempo da tarefa.
CreatedDateTime Datetime Falso Data e hora de criação do registro de hora da tarefa.
StartTime Datetime Falso Hora de início do registro de hora da tarefa.
EndTime Datetime Falso Hora de término do registro de hora da tarefa.
Notes String Falso Notas de registro de tempo de tarefa.
HoursDisplay String Falso Exibição de horas do registro de tempo da tarefa.
Hours Integer Falso Horas de registro de tempo da tarefa.
Minutes Integer Falso Minutos de registro de tempo da tarefa.
IsParent Boolean Falso O log de tempo da tarefa é pai.
IsSubTask Boolean Falso O registro de tempo da tarefa é uma subtarefa.
LastModifiedDate Date Falso Data da última modificação do registro de tempo da tarefa.
LastModifiedDateTime Datetime Falso Data e hora da última modificação do registro de hora da tarefa.
LinkSelfUrl String Falso Url de auto-link de registro de tempo de tarefa.
LogDate Date Falso Data do registro de horário da tarefa.
LogDateTime Datetime Falso Hora da tarefa Data do registro Hora.
OwnerId String Falso ID do proprietário do registro de tempo da tarefa.
OwnerName String Falso Nome do proprietário do registro de tempo da tarefa.
SubTaskLevel String Falso Nível de subtarefa do registro de tempo da tarefa.
TaskName String Falso Nome da tarefa de registro de tempo da tarefa.
TaskListId Long Falso Identificação da lista de tarefas do log de tempo da tarefa.
TaskListName String Falso Nome da lista de tarefas do log de tempo da tarefa.
TotalMinutes Integer Falso Total de minutos do registro de tempo da tarefa.

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
Nome Tipo Somente leitura Descrição
GroupId [KEY] String Falso ID do grupo da equipe.
GroupName String Falso Grupo Nome da equipe.
CreatedBy String Falso Equipe criada por.
CreatedTime String Falso Tempo criado da equipe.
Description String Falso Descrição da equipe.
EmailAlias String Falso ID E-mail da equipe.
EmailVerified Boolean Falso E-mail verificado da equipe.
OrgId String Falso ID da organização da equipe.
OwnerEmail String Falso E-mail do proprietário da equipe.
OwnerName String Falso Proprietário Nome da equipe.
OwnerZpuid String Falso Proprietário Zpuid da equipe.
OwnerZuid String Falso Proprietário Zuid da equipe.
Prefix String Falso Prefixo da equipe.
UpdatedBy String Falso Atualizado por da equipe.
UpdatedTime String Falso Tempo atualizado da equipe.
HasGroupEdit Boolean Falso Tem Group Edit da equipe.
ProjectCount Integer Falso Projeto Contagem da equipe.
UserCount Integer Falso Contagem de usuários da equipe.
UserIdArr String Falso Matriz de múltiplos Zpuid.
UserObj String Falso Objeto do usuário da equipe.
ProjIds String Falso Matriz de vários IDs de projeto.
TeamLead String Falso ZPuid do líder da equipe.

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
Nome Tipo Somente leitura Descrição
ProjectId String Falso ID do projeto.
GroupId String Falso Identificação da equipe.
Id [KEY] String Falso ID do usuário.
Name String Falso Nome de usuário.
AddedBy String Falso Usuário adicionado por.
AddedTime String Falso Tempo adicionado pelo usuário.
Confirmed String Falso Usuário confirmado.
CreatedBy String Falso Usuário criado por.
CreatedTime String Falso Tempo criado pelo usuário.
CreatedUser String Falso Usuário criado pelo usuário.
Description String Falso Descrição do usuário.
DisplayName String Falso Nome de exibição do usuário.
Email String Falso E-mail do usuário.
EntityType String Falso Tipo de entidade do usuário.
FirstName String Falso Nome do usuário.
IsClient Boolean Falso O usuário é cliente.
IsDefault Boolean Falso O usuário é padrão.
LastAccessedTime String Falso Hora do último acesso do usuário.
LastName String Falso Sobrenome do usuário.
LastUpdatedTime String Falso Hora da última atualização do usuário.
RoleId String Falso ID da função do usuário.
RoleName String Falso Nome da função do usuário.
Type String Falso Tipo de usuário.
UpdatedBy String Falso Usuário atualizado por.
UpdatedDate String Falso Data de atualização do usuário.
UpdatedDateTime String Falso Data e hora atualizadas pelo usuário.
UserStatus String Falso Usuário Status do usuário.
Zpuid String Falso Usuário Zpuid.
Zuid String Falso Usuário Zuid.

Usuários

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

Colunas
Nome Tipo Somente leitura Descrição
Id [KEY] String Falso ID do usuário.
Name String Falso Nome de usuário.
Active Boolean Falso Usuário Ativo.
ChatAccess Boolean Falso Acesso de bate-papo do usuário.
Email String Falso E-mail do usuário.
PortalProfileName String Falso Nome do perfil do portal do usuário.
PortalRoleId String Falso ID da função do portal do usuário.
PortalRoleName String Falso Nome da Função do Portal do Usuário.
ProfileId String Falso ID do perfil do usuário.
ProfileType String Falso Tipo de perfil de usuário.
ProjectProfileId String Falso ID do perfil do projeto do usuário.
Role String Falso Papel do usuário. Os valores permitidos são gerente, funcionário, contratado.
RoleId String Falso ID da função do usuário.
RoleName String Falso Nome da função do usuário.
Zpuid String Falso Usuário Zpuid.
WorkProjects String Falso Projetos de trabalho do usuá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
UserType String Tipo de usuário. Os valores permitidos são ativo, inativo.

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

Nome Descrição
Activities Liste todas as atividades recentes do projeto.
BugActivities Obtém todas as atividades para o bug fornecido.
BugAttachments Obtenha detalhes de anexos para um bug.
BugCustomFields Obtém todos os campos personalizados no projeto fornecido.
BugResolution Obtenha a resolução do bug.
Clients Retorna a lista de empresas clientes associadas a um ID de projeto específico.
Documents Liste todas as atividades recentes do projeto.
MyBugs Lista todos os bugs criados por você ou atribuídos a você.
MyMilestones Obtenha todos os marcos atribuídos a um determinado usuário em determinado projeto.
MyTasks Obtém todas as suas tarefas no portal.
MyTimelogs Obtém os logs de tempo em um bug específico.
ProjectCustomFields Obtém todos os campos personalizados do projeto.
ProjectCustomStatus Obtém a lista de todos os status personalizados do projeto.
ProjectLayouts Obtém a lista de layouts de projeto.
Timelogs Obtém os logs de tempo em um bug específico.
TaskAttachments Recupere detalhes de anexos associados à tarefa.
TaskLayouts Visualize a lista de todos os layouts de tarefas disponíveis em seu portal.
TaskStatusHistory Busca o histórico de status das tarefas do Portal.
Timelogs Obtém os logs de tempo em um bug específico.
TimesheetCustomFields Busque todos os campos personalizados do quadro de horários em todo o projeto.
PortalUsersRemaining Obtém os detalhes de todos os usuários em um portal específico.

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
Nome Tipo Descrição
Id [KEY] String ID da atividade do projeto.
Name String Nome da atividade do projeto.
Activity By String Autor da atividade do projeto.
Activity For String Atividade de Projeto para Entidade.
Display Time String Tempo de Exibição da Atividade do Projeto.
State String Estado da atividade do projeto.
Time String Tempo de atividade do projeto.

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
Nome Tipo Descrição
BugId String Identificação do bug.
Action String Ação de atividade de bug.
Type String Tipo de atividade de bug.
PreviousValue String Valor anterior da atividade de bug.
CurrentValue String Valor atual da atividade do bug.
ActionBy String Ação de atividade de bug por.
ActionField String Campo de ação de atividade de bug.
ActionDate Date Data de ação da atividade do bug.
ActionDateTime Datetime Data e hora da ação da atividade do bug.
Zuid [KEY] String Atividade de Bug ZUID.

BugAnexos

Obtenha detalhes de anexos para um bug.

Colunas
Nome Tipo Descrição
BugId String Identificação do bug.
AttachmentId Long Identificação do anexo.
FileName String Nome do arquivo anexado.
FileType String Tipo de arquivo anexado.
FileSize Integer Tamanho do arquivo anexado.
FileEncAttachParam String Arquivo Anexado Enc Anexar Param.
FileUri String Arquivo anexado Uri.
AttachedDate Date Data em anexo.
AttachedDateTime Datetime Data e hora em anexo.
AuthorId String ID do autor do anexo.
AuthorName String Nome do autor do anexo.
IsDocsAttachment Boolean É anexo de documentos.

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
Nome Tipo Descrição
LabelName String Nome do rótulo do campo personalizado do bug.
ColumnName String Nome da coluna do campo personalizado do bug.
DefaultValue String Valor padrão do campo personalizado de bug.
FieldType String Tipo de campo de campo personalizado de bug.
IsEnc Boolean O campo personalizado de bug é enc.
IsMandatory Boolean O campo personalizado do bug é obrigatório.
IsPi Boolean O campo personalizado do bug é Pi.
IsVisible Boolean O campo personalizado do bug está visível.
NewColumnName String Nome da nova coluna do campo personalizado do bug.
PicklistValues String Valores de lista de opções de campo personalizado de bug.

Resolução de Bug

Obtenha a resolução do bug.

Colunas
Nome Tipo Descrição
BugId String Identificação do bug.
Resolver String Resolvedor de Bugs.
ResolverId String ID do solucionador de bugs.
Resolution String Resolução de Bugs.
ResolutionThirdPartyAttachments String Resolução de Bug Anexos de Terceiros.
ResolvedDate Date Data de resolução do bug.
ResolvedDateTime Datetime Bug resolvido Data Hora.
ResolverZpuid String Resolução de bugs ZPUID.

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
Nome Tipo Descrição
Id [KEY] String ID do Cliente.
Name String Nome do cliente.
City String Cidade Cliente.
Country String País do cliente.
CrmAccountId String ID da conta CRM do cliente.
FirstAddress String Primeiro endereço do cliente.
SecondAddress String Segundo endereço do cliente.
State String Estado do cliente.
WebAddress String Endereço da Web do cliente.
ZipCode String CEP do cliente.
UserId String ID do usuário do cliente.
UserName String Nome de usuário do cliente.
UserEmail String E-mail do usuário cliente.
UserZpuid String ZPUID do usuário cliente.

Documentos

Liste todas as atividades recentes do projeto.

Colunas
Nome Tipo Descrição
Id [KEY] String ID da atividade do projeto.
Name String Nome da atividade do projeto.
Activity By String Autor da atividade do projeto.
Activity For String Atividade de Projeto Para.
Display Time String Tempo de Exibição da Atividade do Projeto.
State String Estado da atividade do projeto.
Time String Tempo de atividade do projeto.

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
Nome Tipo Descrição
Id [KEY] String Identificação do bug.
Key String Chave de Bug.
Title String Título do Bug.
AssigneeId String Identificação do responsável pelo bug.
AssigneeName String Nome do responsável pelo bug.
AssigneeZpuid String Bug responsável ZPUID.
AttachmentCount String Contagem de anexos de bug.
BugPrefix String Prefixo de bug.
ClassificationId Long Identificação da classificação do bug.
ClassificationType String Tipo de classificação de bug.
Closed Boolean Bug Fechado.
CommentCount String Contagem de comentários de bug.
CreatedDate Date Data de Criação do Bug.
CreatedDateTime Datetime Data e hora de criação do bug.
Description String Descrição do Bug.
DueDate Date Data de Vencimento do Bug.
DueDateTime Date Hora da data de vencimento do bug.
Flag String Bandeira de Bug.
LinkSelfUrl String Url de link de bug.
LinkTimesheetUrl String Url do Quadro de Horários do Link do Bug.
ModuleId Long Identificação do módulo de bug.
ModuleName String Nome do módulo de bug.
ProjectId Long ID do projeto de bug.
ProjectIdString String Cadeia de ID do projeto de bug.
ProjectName String Nome do projeto do bug.
ReportedPerson String Pessoa relatada por bug.
ReporterId String Identificação do relator de erros.
ReproducibleId Long ID reproduzível do bug.
ReproducibleType String Tipo reproduzível de bug.
SeverityId Long Identificação da gravidade do bug.
SeverityType String Tipo de gravidade do bug.
StatusId Long Identificação do status do bug.
StatusType String Tipo de status de bug. Os valores permitidos são aberto, fechado.
UpdatedDate Date Data de atualização do bug.
UpdatedDateTime Datetime Data e hora da atualização do bug.
UpdatedTimeLong Long Bug atualizado por muito tempo.
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
Owner String Proprietário do Bug.
ViewType String Tipo de exibição de bug. Os valores permitidos são reportados, próprios.
LastModifiedTime Datetime Hora da última modificação do bug.

Meus Marcos

Obtenha todos os marcos atribuídos a um determinado usuário em determinado projeto.

Selecione

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

  • ProjectId e Flag suporta o seguinte operador: =.
  • ProjectId suporta o operador: IN
  • CreatedDate e LastModifiedTime suporte: ORDEM

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

SELECT * FROM MyMilestones WHERE ProjectId IN ('12345000000030899', '12345000000033005') AND Flag = 'internal' ORDER BY CreatedDate
Colunas
Nome Tipo Descrição
ProjectId String ID do projeto.
Id [KEY] String Identificação do marco.
Name String Nome do marco.
Closed Boolean Marco Fechado.
CreatedDate Date Data de Criação do Marco.
CreatedDateTime Datetime Data e hora de criação do marco.
EndDate Date Data de término do marco.
EndDateTime Datetime Data de término do marco.
Flag String Bandeira de Marco. Os valores permitidos são internos, externos.
IsWorkfieldRemoved Boolean Marco é campo de trabalho removido.
LastUpdatedDate Date Data da última atualização do marco.
LastUpdatedDateTime Datetime Data e hora da última atualização do marco.
SelfUrl String Auto URL do marco.
StatusUrl String URL de status do marco.
OwnerId String ID do proprietário do marco.
OwnerName String Nome do proprietário do marco.
OwnerZpuid String Proprietário do Marco ZPUID.
ProjectName String Nome do projeto de marco.
Sequence Integer Sequência de marcos.
StartDate Date Data de início do marco.
StartDateTime Datetime Data de Início do Marco Hora.
Status String Status do marco.
StatusColorCode String Código de cores do status do marco.
StatusId String Identificação do status do marco.
StatusName String Nome do status do marco.
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
LastModifiedTime Datetime Hora da última modificação do marco.

Minhas Tarefas

Obtém todas as suas tarefas no portal.

Selecione

Esta é uma exibição em nível de portal. Colunas que suportam o operador =:

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


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

SELECT * FROM MyTasks WHERE MilestoneId = '12345600000123' AND Priority = 'High' 
Colunas
Nome Tipo Descrição
ProjectId String ID do projeto.
Id [KEY] String Identificação da tarefa.
Name String Nome da tarefa.
Key String Chave de tarefa.
BillingType String Tipo de Faturamento da Tarefa.
Completed Boolean Tarefa completa.
CreatedBy String Tarefa criada por.
CreatedByEmail String Tarefa criada por E-mail.
CreatedByZpuid String Tarefa criada por Zpuid.
CreatedPerson String Pessoa criada pela tarefa.
CreatedDate Date Data de Criação da Tarefa.
CreatedDateTime Datetime Data e hora de criação da tarefa.
Description String Descrição da tarefa.
Owners String Proprietários de Tarefas.
Duration String Duração da Tarefa.
DurationType String Tipo de duração da tarefa.
EndDate Date Data de término da tarefa.
EndDateTime Datetime Data de término da tarefa Hora.
CommentAdded Boolean Comentário de tarefa adicionado.
DocsAssociated Boolean Tarefa Documentos Associados.
ForumAssociated Boolean Tarefa Fórum Associado.
RecurrenceSet Boolean Conjunto de Recorrência de Tarefa.
ReminderSet Boolean Conjunto de lembretes de tarefas.
Parent Boolean Tarefa Pai.
LastUpdatedDate Date Data da última atualização da tarefa.
LastUpdatedDateTime Datetime Data e hora da última atualização da tarefa.
LinkSelfUrl String URL próprio do link de tarefa.
LinkTimesheetUrl String URL do Quadro de Horários do Link da Tarefa.
LinkWebUrl String URL da Web do link da tarefa.
LogHoursBillableHours String Horas de Log de Tarefas Horas Faturáveis.
LogHoursNonBillableHours String Horas de Log de Tarefas Horas Não Faturáveis.
MilestoneId String ID do marco da tarefa.
OrderSequence Integer Sequência de ordem de tarefa.
PercentComplete String Porcentagem concluída da tarefa.
Priority String Prioridade de Tarefa. Os valores permitidos são nenhum, baixo, médio, alto.
StartDate Date Data de início da tarefa.
StartDateTime Datetime Data de Início da Tarefa Hora.
StatusColorCode String Código de cores do status da tarefa.
StatusId String Identificação do status da tarefa.
StatusName String Nome do status da tarefa.
StatusType String Tipo de status da tarefa.
Subtasks Boolean Tarefa Subtarefas.
TaskFollowers String Seguidores de Tarefas.
TaskFollowerSize Integer Tamanho do seguidor da tarefa.
TasklistId String Identificação da lista de tarefas da tarefa.
TasklistIdString String Cadeia de ID da Lista de Tarefas da Tarefa.
TasklistName String Tarefa Nome da lista de tarefas.
Work String Tarefa Trabalho.
WorkForm String Formulário de Trabalho de Tarefa.
WorkType String Tipo de trabalho da tarefa.
GroupNameAssociatedTeamsAnyTeam String Nome do Grupo de Tarefas Equipes Associadas Qualquer Equipe.
GroupNameAssociatedTeamsCount Integer Nome do Grupo de Tarefas Contagem de Equipes Associadas.
GroupNameIsTeamUnassigned Boolean O nome do grupo de tarefas é Equipe não atribuída.
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
Owner String Proprietário da Tarefa.
Status String Estado da Tarefa. Os valores permitidos são completed, notcompleted.
Time String Hora da Tarefa. Os valores permitidos são vencido, hoje, amanhã.
LastModifiedTime Datetime Hora da Última Modificação da Tarefa.
CustomViewId String ID de visualização personalizada da tarefa.

MyTimelogs

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

Selecione

Esta é uma exibição em nível de portal. Colunas que suportam o operador =:

  • Estado da Fatura
  • Data
  • Do utilizador
  • ViewType
  • Tipo de Componente


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

SELECT * FROM MyTimelogs WHERE User = '123450000123'
Colunas
Nome Tipo Descrição
Id [KEY] String Identificação do registro de tempo.
AddedByName String Registro de tempo adicionado por nome.
AddedByZpuid String Registro de tempo adicionado por Zpuid.
AddedByZuid Long Registro de tempo adicionado por Zuid.
ApprovalStatus String Status de aprovação do registro de horas.
ApproverName String Nome do aprovador de registro de tempo.
BillStatus String Status da conta de registro de tempo. Os valores permitidos são todos, faturáveis, não faturáveis.
CreatedDate Date Data de criação do registro de horas.
CreatedDateTime Datetime Data de Criação do Registro de Hora Hora.
StartTime Datetime Hora de início do registro de horas.
EndTime Datetime Hora de término do registro de horas.
Notes String Notas de registro de tempo.
HoursDisplay String Exibição de horas de registro de tempo.
Hours Integer Horas de registro de tempo.
Minutes Integer Minutos de registro de tempo.
IsParent Boolean O registro de horas é pai.
IsSubTask Boolean Log de tempo é subtarefa.
LastModifiedDate Date Data da última modificação do registro de horas.
LastModifiedDateTime Datetime Data da última modificação do registro de hora Hora.
LinkSelfUrl String Auto URL do link de registro de tempo.
LogDate Date Data do Registro de Hora.
LogDateTime Datetime Hora Log Data Hora.
OwnerId String ID do proprietário do registro de tempo.
OwnerName String Nome do proprietário do registro de tempo.
SubTaskLevel String Nível de subtarefa de registro de tempo.
TaskName String Nome da tarefa de registro de tempo.
TaskListId Long Identificação da lista de tarefas do registro de horas.
TaskListName String Nome da lista de tarefas do registro de horas.
TotalMinutes Integer Total de minutos do registro de tempo.
ProjectId String ID do projeto de registro de tempo.
ProjectName String Nome do projeto de registro de tempo.
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
Date Date Data do Registro de Hora.
User String Usuário de registro de tempo.
ViewType String Tipo de exibição de registro de tempo. Os valores permitidos são dia, semana, mês.
ComponentType String Tipo de componente de registro de tempo. Os valores permitidos são bug, task, general.

ProjectCustomFields

Obtém todos os campos personalizados do projeto.

Selecione

Você pode usar a consultar abaixo para obter todos os campos personalizados do projeto:

SELECT * FROM ProjectCustomFields
Colunas
Nome Tipo Descrição
Id [KEY] String ID de campo personalizado.
Name String Nome do campo personalizado.
FieldType String Tipo de campo personalizado.
FieldId String Identificação do campo.
PII Boolean PII de campo personalizado.
Encrypted Boolean Criptografado.
DefaultValue String Valor padrão do campo personalizado.
PickList String Opções de lista de seleção de campo personalizado.

ProjectCustomStatus

Obtém a lista de todos os status personalizados do projeto.

Selecione

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

SELECT * FROM ProjectCustomStatus
Colunas
Nome Tipo Descrição
Id [KEY] String Identificação do portal.
Name String Nome do Portal.
Closed Boolean Portal Fechado.
Default Boolean Padrão do Portal.
HasDefaultValue Boolean Portal tem valor padrão.
Sequence Int Sequência de Portais.
StatusColor String Cor do status do portal.
StatusColorHexcode String Código hexadecimal da cor do status do portal.

ProjectLayouts

Obtém a lista de layouts de projeto.

Selecione

Você pode usar a consultar abaixo para obter todos os layouts de projeto:

SELECT * FROM ProjectLayouts
Colunas
Nome Tipo Descrição
Id [KEY] String ID do layout do projeto.
Name String Nome do layout do projeto.
Default Boolean É o layout de projeto padrão.

Registros de Tempo

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

Selecione

Esta é uma visualização em nível de projeto. Colunas que suportam o operador =:

  • Estado da Fatura
  • Data
  • Do utilizador
  • ViewType
  • Tipo de Componente


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

SELECT * FROM ProjectLayouts
Colunas
Nome Tipo Descrição
Id [KEY] String Identificação do registro de tempo.
AddedByName String Registro de tempo adicionado por nome.
AddedByZpuid String Log de tempo adicionado por ZPUID.
AddedByZuid Long Registro de tempo adicionado por ZUID.
ApprovalStatus String Status de aprovação do registro de horas.
ApproverName String Nome do aprovador de registro de tempo.
BillStatus String Status da conta de registro de tempo. Os valores permitidos são todos, faturáveis, não faturáveis.
CreatedDate Date Data de criação do registro de horas.
CreatedDateTime Datetime Data de Criação do Registro de Hora Hora.
StartTime Datetime Hora de início do registro de horas.
EndTime Datetime Hora de término do registro de horas.
Notes String Notas de registro de tempo.
HoursDisplay String Exibição de horas de registro de tempo.
Hours Integer Horas de registro de tempo.
Minutes Integer Minutos de registro de tempo.
IsParent Boolean O registro de horas é pai.
IsSubTask Boolean Log de tempo é subtarefa.
LastModifiedDate Date Data da última modificação do registro de horas.
LastModifiedDateTime Datetime Data da última modificação do registro de hora Hora.
LinkSelfUrl String Auto URL do link de registro de tempo.
LogDate Date Data do Registro de Hora.
LogDateTime Datetime Hora Log Data Hora.
OwnerId String ID do proprietário do registro de tempo.
OwnerName String Nome do proprietário do registro de tempo.
SubTaskLevel String Nível de subtarefa de registro de tempo.
TaskName String Nome da tarefa de registro de tempo.
TaskListId Long Identificação da lista de tarefas do registro de horas.
TaskListName String Nome da lista de tarefas do registro de horas.
TotalMinutes Integer Total de minutos do registro de tempo.
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
Date Date Data do Registro de Hora.
User String Usuário de registro de tempo.
ViewType String Tipo de exibição de registro de tempo. Os valores permitidos são dia, semana, mês.
ComponentType String Tipo de componente de registro de tempo. Os valores permitidos são bug, task, general.

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

Selecione

Esta é uma visualização em nível de projeto. Colunas que suportam o operador =:

  • Estado da Fatura
  • Data
  • Do utilizador
  • ViewType
  • Tipo de Componente


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

SELECT * FROM ProjectLayouts
Colunas
Nome Tipo Descrição
Id [KEY] String Identificação do registro de tempo.
AddedByName String Registro de tempo adicionado por nome.
AddedByZpuid String Registro de tempo adicionado por Zpuid.
AddedByZuid Long Registro de tempo adicionado por Zuid.
ApprovalStatus String Status de aprovação do registro de horas.
ApproverName String Nome do aprovador de registro de tempo.
BillStatus String Status da conta de registro de tempo. Os valores permitidos são todos, faturáveis, não faturáveis.
CreatedDate Date Data de criação do registro de horas.
CreatedDateTime Datetime Data de Criação do Registro de Hora Hora.
StartTime Datetime Hora de início do registro de horas.
EndTime Datetime Hora de término do registro de horas.
Notes String Notas de registro de tempo.
HoursDisplay String Exibição de horas de registro de tempo.
Hours Integer Horas de registro de tempo.
Minutes Integer Minutos de registro de tempo.
IsParent Boolean O registro de horas é pai.
IsSubTask Boolean Log de tempo é subtarefa.
LastModifiedDate Date Data da última modificação do registro de horas.
LastModifiedDateTime Datetime Data da última modificação do registro de hora Hora.
LinkSelfUrl String Auto URL do link de registro de tempo.
LogDate Date Data do Registro de Hora.
LogDateTime Datetime Hora Log Data Hora.
OwnerId String ID do proprietário do registro de tempo.
OwnerName String Nome do proprietário do registro de tempo.
SubTaskLevel String Nível de subtarefa de registro de tempo.
TaskName String Nome da tarefa de registro de tempo.
TaskListId Long Identificação da lista de tarefas do registro de horas.
TaskListName String Nome da lista de tarefas do registro de horas.
TotalMinutes Integer Total de minutos do registro de tempo.
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
Date Date Data do Registro de Hora.
User String Usuário de registro de tempo.
ViewType String Tipo de exibição de registro de tempo. Os valores permitidos são dia, semana, mês.
ComponentType String Tipo de componente de registro de tempo. Os valores permitidos são bug, task, general.

TarefaAnexos

Recupere detalhes de anexos associados à tarefa.

Selecione

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

  • TaskId é necessário para recuperar TaskAttachments.

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

SELECT * FROM TaskAttachments WHERE TaskId = '123456000000112'
Colunas
Nome Tipo Descrição
TaskId String Identificação da tarefa.
Id [KEY] String ID do anexo da tarefa.
AuthorId String ID do autor do anexo da tarefa.
ContentType String Tipo de conteúdo do anexo de tarefa.
DocsDownloadUrl String Url de download de documentos de anexo de tarefa.
DownloadUrl String Baixar Anexo de Tarefa.
Extension String Extensão de anexo de tarefa.
Filename String Nome do arquivo do anexo da tarefa.
Owner String Proprietário do Anexo de Tarefa.
Size Integer Tamanho do anexo de tarefa em bytes.
TaskId Long Identificação da tarefa do anexo de tarefa.
ThumbnailUrl String URL da miniatura do anexo da tarefa.
UploadedTime Long Tempo de upload do anexo de tarefa.

Layouts de Tarefas

Visualize a lista de todos os layouts de tarefas disponíveis em seu portal.

Selecione

Esta é uma exibição em nível de portal. Você pode usar a consultar abaixo para obter todos os layouts de tarefas:

SELECT * FROM TaskLayouts
Colunas
Nome Tipo Descrição
Id [KEY] String Identificação do Layout da Tarefa.
Name String Nome do Layout da Tarefa.
Default Boolean Padrão de Layout de Tarefa.

TarefaStatusHistórico

Busca o histórico de status das tarefas do Portal.

Selecione

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

  • LastModifiedTime suporta: ORDEM

Você pode usar a consultar abaixo para obter todos os layouts de tarefas:

SELECT * FROM TaskStatusHistory ORDER BY LastModifiedTime
Colunas
Nome Tipo Descrição
Id [KEY] String Identificação do histórico de status da tarefa.
Name String Nome do histórico de status da tarefa.
StatusId String Id do status do histórico de status da tarefa.
StatusName String Nome do status do histórico de status da tarefa.
PreviousStatusId String Id do status anterior do histórico do status da tarefa.
PreviousStatusName String Histórico de status da tarefa Nome do status anterior.
UpdatedStatusId String Id de status atualizado do histórico de status da tarefa.
UpdatedStatusName String Histórico de status da tarefa Nome do status atualizado.
TransitionTimeMillis String Tarefa Status Histórico Tempo de Transição Millis.
TransitionTimeDuration String Duração do tempo de transição do histórico de status da tarefa.
UpdatedBy String Histórico de status da tarefa atualizado por.
UpdatedByName String Histórico de status da tarefa atualizado por nome.
UpdatedByEmail String Histórico de status da tarefa atualizado por E-mail.
UpdatedOn Datetime Histórico de status da tarefa atualizado em.
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
LastModifiedTime Datetime Hora da última modificação do histórico do status da tarefa.

Quadro de HoráriosCampos Personalizados

Busque todos os campos personalizados do quadro de horários em todo o projeto.

Selecione

Esta é uma exibição em nível de portal. Você pode usar a consultar abaixo para obter todos os campos personalizados do quadro de horários:

SELECT * FROM TimesheetCustomFields
Colunas
Nome Tipo Descrição
Id [KEY] String Id do campo personalizado da planilha de horas.
FieldName String Nome do campo personalizado da planilha de horas.
DataType String Tipo de dados do campo personalizado da planilha de horas.
UniqueColumn String Coluna exclusiva do campo personalizado da planilha de horas.

PortalUsuáriosRestantes

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

Selecione

Esta é uma visualização em nível de projeto. Você pode usar a consultar abaixo para obter o número restante de usuários para o seu portal:

SELECT * FROM PortalUsersRemaining
Colunas
Nome Tipo Descrição
AvailableUsersCount String Contagem de usuários disponíveis.

Procedimentos Armazenados

Procedimentos armazenados* são interfaces semelhantes a funções que estendem a funcionalidade do conector além das simples operações SELECT/INSERT/UPDATE/DELETE com o Zoho Projects.

Procedimentos armazenados* aceite uma lista de parâmetros, execute a função pretendida e, em seguida, retorne, se aplicável, quaisquer dados de resposta relevantes do Zoho Projects, junto com uma indicação se o procedimento foi bem-sucedido ou falhou.

Conector Jitterbit para Procedimentos Armazenados do Zoho Projects

Nome Descrição
AddUserToClientCompany Adiciona o usuário a uma empresa cliente existente.
ApproveTimelog Aprovar registro de tempo geral/bug/tarefa.
AssociateBugs Associar bugs relacionados a uma tarefa.
AssociateContacts Associa uma tag a uma entidade específica em um projeto específico.
AssociateTags Associa uma tag a uma entidade específica em um projeto específico.
DissociateBugs Associar bugs relacionados a uma tarefa.
DissociateContacts Dissocie um contato do cliente de um projeto.
DissociateTags Dissocia uma tag com uma entidade específica em um projeto específico.
ForumFollow Siga uma postagem no fórum.
ForumSelectBestAnswer Deixar de seguir uma postagem no fórum.
ForumUnfollow Deixar de seguir uma postagem no fórum.
ForumUnselectBestAnswer Deixar de seguir uma postagem no fórum.
GetOAuthAccessToken Obtém um token de autenticação de ZohoProjects.
GetOAuthAuthorizationURL Obtém a URL de autorização que deve ser aberta separadamente pelo usuário para conceder acesso ao seu aplicativo. Necessário apenas ao desenvolver aplicativos da Web. Você solicitará o OAuthAccessToken deste URL.
RefreshOAuthAccessToken Atualiza o token de acesso OAuth usado para autenticação com ZohoProjects.
SelectTeamLead Atualize o líder da equipe.
TaskFollow Siga uma tarefa no projeto fornecido.
TaskMove Move uma tarefa de uma lista de tarefas para outra lista de tarefas. A lista de tarefas de destino pode ser do mesmo projeto ou de um projeto diferente.
TaskReorder Reordena as tarefas no projeto fornecido. A tarefa será reordenada entre duas tarefas com base nos IDs de tarefa anterior e seguinte.
TaskUnfollow Deixar de seguir uma tarefa no projeto fornecido.

AddUserToClientCompany

Adiciona o usuário a uma empresa cliente existente.

Informações Específicas do Procedimento

Um exemplo de consultar para executar este procedimento armazenado* é mostrado abaixo:

EXEC AddUserToClientCompany PortalId = '12345317133', CompanyId = '123456000000039025', ContactEmail = 'test@example.com'
Entrada
Nome Tipo Obrigatório Descrição
PortalId String Verdade Especifique o ID do portal.
CompanyId String Verdade Especifique o ID da empresa cliente.
ContactEmail String Verdade ID E-mail do usuário cliente.
WorkProjects String Falso Vários IDs de projeto são separados por vírgula.
ProfileId String Falso Especifique o ID do perfil. profile_id é obtido da API Get Portal Users.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Especifica se a execução foi bem-sucedida.

Aprovar Registro de Tempo

Aprovar registro de tempo geral/bug/tarefa.

Informações Específicas do Procedimento

Um exemplo de consultar para executar este procedimento armazenado* é mostrado abaixo:

EXEC ApproveTimelog PortalId = '12345317133', ProjectId = '123456000000031899', LogId = '123456000000031977', Approval = 'approve', Reason = 'Submitted timelog is approved', EntityType = 'general', EntityId = '1234560001'
Entrada
Nome Tipo Obrigatório Descrição
PortalId String Verdade Especifique o ID do portal.
ProjectId String Verdade Especifique o ID do grupo.
LogId String Verdade Especifique o ID do log.
EntityType String Falso Especifique o tipo de entidade para aprovar o horário do log. Os valores permitidos são task, bug, general.
EntityId String Falso ID da entidade especificada pelo parâmetro 'EntityType'
Approval String Verdade O registro de tempo é aprovado se o valor fornecido for aprovado. Os valores permitidos são aprovar, pendente, rejeitar.
Reason String Falso O motivo deve ser mencionado se o registro de tempo for rejeitado. O motivo não deve exceder 250 caracteres.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Especifica se a execução foi bem-sucedida.

AssociateBugs

Associar bugs relacionados a uma tarefa.

Informações Específicas do Procedimento

Um exemplo de consultar para executar este procedimento armazenado* é mostrado abaixo:

EXEC AssociateBugs PortalId = '12345317133', ProjectId = '123456000000031899', TaskId = '123456000000031977', BugId = '123456000000034087'
Entrada
Nome Tipo Obrigatório Descrição
PortalId String Verdade Especifique o ID do portal.
ProjectId String Verdade Especifique o ID do grupo.
TaskId String Verdade Especifique o ID da tarefa.
BugId String Verdade ID para vários bugs devem ser separados por vírgulas.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Especifica se a execução foi bem-sucedida.

AssociadosContatos

Associa uma tag a uma entidade específica em um projeto específico.

Informações Específicas do Procedimento

Um exemplo de consultar para executar este procedimento armazenado* é mostrado abaixo:

EXEC AssociateContacts PortalId = '12345317133', ProjectId = '123456000000031899', ContactId = '1234560000000123456'
Entrada
Nome Tipo Obrigatório Descrição
PortalId String Verdade Especifique o ID do portal.
ProjectId String Verdade Especifique o ID do grupo.
ContactId String Verdade Matriz de IDs de contato do cliente. Vários IDs podem ser separados por vírgula.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Especifica se a execução foi bem-sucedida.

AssociateTags

Associa uma tag a uma entidade específica em um projeto específico.

Informações Específicas do Procedimento

Um exemplo de consultar para executar este procedimento armazenado* é mostrado abaixo:

EXEC AssociateTags PortalId = '12345317133', ProjectId = '123456000000031899', TagId = '123456000000031977', EntityType = 'Task',  EntityId = '123456000000034087'
Entrada
Nome Tipo Obrigatório Descrição
PortalId String Verdade Especifique o ID do portal.
ProjectId String Verdade Especifique o ID do grupo.
TagId String Verdade Especifique o ID da etiqueta.
EntityType String Verdade Especifique o tipo de entidade para aprovar o horário do log. Os valores permitidos são Projeto, Marco, Lista de Tarefas, Tarefa, Bug, Fórum, Status.
EntityId String Verdade ID da entidade especificada pelo parâmetro 'EntityType'
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Especifica se a execução foi bem-sucedida.

DissociateBugs

Associar bugs relacionados a uma tarefa.

Informações Específicas do Procedimento

Um exemplo de consultar para executar este procedimento armazenado* é mostrado abaixo:

EXEC DissociateBugs PortalId = '12345317133', ProjectId = '123456000000031899', TaskId = '123456000000031977', BugId = '123456000000034087'
Entrada
Nome Tipo Obrigatório Descrição
PortalId String Verdade Especifique o ID do portal.
ProjectId String Verdade Especifique o ID do grupo.
TaskId String Verdade Especifique o ID da tarefa.
BugId String Verdade ID para vários bugs devem ser separados por vírgulas.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Especifica se a execução foi bem-sucedida.

DissociarContatos

Dissocie um contato do cliente de um projeto.

Informações Específicas do Procedimento

Um exemplo de consultar para executar este procedimento armazenado* é mostrado abaixo:

EXEC DissociateContacts PortalId = '12345317133', ProjectId = '123456000000031899', ContactId = '1234560000000123456'
Entrada
Nome Tipo Obrigatório Descrição
PortalId String Verdade Especifique o ID do portal.
ProjectId String Verdade Especifique o ID do grupo.
ContactId String Verdade Matriz de IDs de contato do cliente.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Especifica se a execução foi bem-sucedida.

DissociateTags

Dissocia uma tag com uma entidade específica em um projeto específico.

Informações Específicas do Procedimento

Um exemplo de consultar para executar este procedimento armazenado* é mostrado abaixo:

EXEC DissociateTags PortalId = '12345317133', ProjectId = '123456000000031899', TagId = '123456000000031977', EntityType = 'Task',  EntityId = '123456000000034087'
Entrada
Nome Tipo Obrigatório Descrição
PortalId String Verdade Especifique o ID do portal.
ProjectId String Verdade Especifique o ID do grupo.
TagId String Verdade Especifique o ID da etiqueta.
EntityType String Verdade Especifique o tipo de entidade para aprovar o horário do log. Os valores permitidos são Projeto, Marco, Lista de Tarefas, Tarefa, Bug, Fórum, Status.
EntityId String Verdade ID da entidade especificada pelo parâmetro 'EntityType'
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Especifica se a execução foi bem-sucedida.

FórumSeguir

Siga uma postagem no fórum.

Informações Específicas do Procedimento

Um exemplo de consultar para executar este procedimento armazenado* é mostrado abaixo:

EXEC ForumFollow PortalId = '12345317133', ProjectId = '123456000000031899', ForumId = '123456000000034053'
Entrada
Nome Tipo Obrigatório Descrição
PortalId String Verdade Especifique o ID do portal.
ProjectId String Verdade Especifique o ID do grupo.
ForumId String Verdade Especifique o ID da etiqueta.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Especifica se a execução foi bem-sucedida.

FórumSelecionarMelhorResposta

Deixar de seguir uma postagem no fórum.

Informações Específicas do Procedimento

Um exemplo de consultar para executar este procedimento armazenado* é mostrado abaixo:

EXEC ForumSelectBestAnswer PortalId = '12345317133', ProjectId = '123456000000031899', ForumId = '123456000000034053', CommentId = '123456000000039021'
Entrada
Nome Tipo Obrigatório Descrição
PortalId String Verdade Especifique o ID do portal.
ProjectId String Verdade Especifique o ID do grupo.
ForumId String Verdade Especifique o ID do fórum.
CommentId String Verdade Especifique o ID do comentário.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Especifica se a execução foi bem-sucedida.

Fórum Deixar de Seguir

Deixar de seguir uma postagem no fórum.

Informações Específicas do Procedimento

Um exemplo de consultar para executar este procedimento armazenado* é mostrado abaixo:

EXEC ForumUnfollow PortalId = '12345317133', ProjectId = '123456000000031899', ForumId = '123456000000034053'
Entrada
Nome Tipo Obrigatório Descrição
PortalId String Verdade Especifique o ID do portal.
ProjectId String Verdade Especifique o ID do grupo.
ForumId String Verdade Especifique o ID da etiqueta.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Especifica se a execução foi bem-sucedida.

FórumDesmarcarMelhorResposta

Deixar de seguir uma postagem no fórum.

Informações Específicas do Procedimento

Um exemplo de consultar para executar este procedimento armazenado* é mostrado abaixo:

EXEC ForumUnselectBestAnswer PortalId = '12345317133', ProjectId = '123456000000031899', ForumId = '123456000000034053', CommentId = '123456000000039021'
Entrada
Nome Tipo Obrigatório Descrição
PortalId String Verdade Especifique o ID do portal.
ProjectId String Verdade Especifique o ID do grupo.
ForumId String Verdade Especifique o ID do fórum.
CommentId String Verdade Especifique o ID do comentário.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Especifica se a execução foi bem-sucedida.

GetOAuthAccessToken

Obtém um token de autenticação de ZohoProjects.

Entrada
Nome Tipo Obrigatório Descrição
AuthMode String Falso O tipo de modo de autenticação a ser usado. Selecione App para obter tokens de autenticação por meio de um aplicativo de desktop. Selecione Web para obter tokens de autenticação por meio de um aplicativo Web. Os valores permitidos são APP, WEB. O valor padrão é APP.
Scope String Falso Uma lista separada por vírgulas de permissões a serem solicitadas ao usuário. Verifique a API ZohoProjects para obter uma lista de permissões disponíveis. O valor padrão é ZohoProjects.portals.ALL, ZohoProjects.projects.ALL, ZohoProjects.status.ALL, ZohoProjects.milestones.ALL, ZohoProjects.tasklists.ALL, ZohoProjects.tasks.ALL, ZohoProjects.tags.ALL, ZohoProjects.bugs .ALL, ZohoProjects.events.ALL, ZohoProjects.forums.ALL, ZohoProjects.users.ALL, ZohoProjects.clients.ALL, ZohoProjects.documents.ALL, ZohoProjects.search.READ, ZohoProjects.entity_properties.ALL, ZohoProjects.activities.READ, ZohoProjects.timesheets.ALL.
CallbackUrl String Falso A URL para a qual o usuário será redirecionado após autorizar seu aplicativo. Este valor deve corresponder ao URL de redirecionamento que você especificou nas configurações do aplicativo ZohoProjects. Necessário apenas quando o parâmetro Authmode for Web.
Verifier String Falso O verificador retornou do ZohoProjects depois que o usuário autorizou seu aplicativo a ter acesso aos seus dados. Esse valor será retornado como um parâmetro para a URL de retorno de chamada.
State String Falso 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 ao servidor de autorização ZohoProjects. Os usos incluem redirecionar o usuário para o recurso correto em seu site, nonces e mitigações de falsificação de solicitação entre sites.
AccountsServer String Falso O URL completo do servidor da conta que será usado para recuperar o token de acesso OAuth.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
OAuthAccessToken String O token de acesso usado para comunicação com ZohoProjects.
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. Um -1 denota que não irá expirar.
AccountsServer String O URL completo do servidor da conta.
APIDomain String A URL completa do domínio da API.

GetOAuthAuthorizationURL

Obtém a URL de autorização que deve ser aberta separadamente pelo usuário para conceder acesso ao seu aplicativo. Necessário apenas ao desenvolver aplicativos da Web. Você solicitará o OAuthAccessToken deste URL.

Entrada
Nome Tipo Obrigatório Descrição
CallbackUrl String Falso A URL para a qual o usuário será redirecionado após autorizar seu aplicativo. Este valor deve corresponder ao URL de redirecionamento nas configurações do aplicativo ZohoProjects.
Scope String Falso Uma lista separada por vírgulas de escopos a serem solicitados ao usuário. Verifique a documentação da API do ZohoProjects para obter uma lista de permissões disponíveis. O valor padrão é ZohoProjects.portals.ALL, ZohoProjects.projects.ALL, ZohoProjects.status.ALL, ZohoProjects.milestones.ALL, ZohoProjects.tasklists.ALL, ZohoProjects.tasks.ALL, ZohoProjects.tags.ALL, ZohoProjects.bugs .ALL, ZohoProjects.events.ALL, ZohoProjects.forums.ALL, ZohoProjects.users.ALL, ZohoProjects.clients.ALL, ZohoProjects.documents.ALL, ZohoProjects.search.READ, ZohoProjects.entity_properties.ALL, ZohoProjects.activities.READ, ZohoProjects.timesheets.ALL.
State String Falso 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 ao servidor de autorização ZohoProjects. Os usos incluem redirecionar o usuário para o recurso correto em seu site, nonces e mitigações de falsificação de solicitação entre sites.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
URL String O URL de autorização, inserido em um navegador da Web para obter o token do verificador e autorizar seu aplicativo.

RefreshOAuthAccessToken

Atualiza o token de acesso OAuth usado para autenticação com ZohoProjects.

Entrada
Nome Tipo Obrigatório Descrição
OAuthRefreshToken String Verdade O token de atualização retornado da troca do código de autorização original.
AccountsServer String Falso O URL completo do servidor de conta que será usado para recuperar um novo token de acesso.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
OAuthAccessToken String O token de acesso retornado de ZohoProjects. 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.

SelectTeamLead

Atualize o líder da equipe.

Informações Específicas do Procedimento

Um exemplo de consultar para executar este procedimento armazenado* é mostrado abaixo:

EXEC SelectTeamLead PortalId = '12345317133', ProjectId = '123456000000031899', UserId = '123456000000033053'
Entrada
Nome Tipo Obrigatório Descrição
PortalId String Falso Especifique o ID do portal.
TeamId String Falso Especifique o ID do grupo.
UserId String Falso ZPUID do líder da equipe.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Especifica se a atualização foi bem-sucedida.

Tarefa Seguir

Siga uma tarefa no projeto fornecido.

Informações Específicas do Procedimento

Um exemplo de consultar para executar este procedimento armazenado* é mostrado abaixo:

EXEC TaskFollow PortalId = '12345317133', ProjectId = '123456000000031899', TaskId = '123456000000034053', UserId = '123456000000039021'
Entrada
Nome Tipo Obrigatório Descrição
PortalId String Verdade Especifique o ID do portal.
ProjectId String Verdade Especifique o ID do grupo.
TaskId String Verdade Especifique o ID da tarefa.
UserId String Verdade O ID do usuário para vários seguidores deve ser separado por vírgulas.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Especifica se a execução foi bem-sucedida.

TaskMove

Move uma tarefa de uma lista de tarefas para outra lista de tarefas. A lista de tarefas de destino pode ser do mesmo projeto ou de um projeto diferente.

Informações Específicas do Procedimento

Um exemplo de consultar para executar este procedimento armazenado* é mostrado abaixo:

EXEC TaskMove PortalId = '12345317133', ProjectId = '123456000000031899', TaskId = '123456000000034053', FromTasklist = '123456000000031932', ToTasklist = '123456000000031941'
Entrada
Nome Tipo Obrigatório Descrição
PortalId String Verdade Especifique o ID do portal.
ProjectId String Verdade Especifique o ID do grupo.
TaskId String Verdade Especifique o ID da tarefa.
FromTasklist String Verdade ID da lista de tarefas na qual a tarefa existe.
ToTasklist String Verdade ID da lista de tarefas para a qual a tarefa deve ser movida.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Especifica se a execução foi bem-sucedida.

TaskReorder

Reordena as tarefas no projeto determinado. A tarefa será reordenada entre duas tarefas com base nos IDs de tarefa anterior e seguinte.

Informações Específicas do Procedimento

Um exemplo de consultar para executar este procedimento armazenado* é mostrado abaixo:

EXEC TaskReorder PortalId = '12345317133', ProjectId = '123456000000031899', TaskId = '123456000000034053', PreviousTaskId = '123456000000031932', NextTaskId = '123456000000031941'
Entrada
Nome Tipo Obrigatório Descrição
PortalId String Verdade Especifique o ID do portal.
ProjectId String Verdade Especifique o ID do grupo.
TaskId String Verdade Especifique o ID da tarefa.
PreviousTaskId String Verdade Especifique o ID da tarefa anterior.
NextTaskId String Verdade Especifique o próximo ID de tarefa.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Especifica se a atualização foi bem-sucedida.

TarefaParar de Seguir

Deixar de seguir uma tarefa no projeto fornecido.

Informações Específicas do Procedimento

Um exemplo de consultar para executar este procedimento armazenado* é mostrado abaixo:

EXEC TaskUnfollow PortalId = '12345317133', ProjectId = '123456000000031899', TaskId = '123456000000034053', UserId = '123456000000039021'
Entrada
Nome Tipo Obrigatório Descrição
PortalId String Verdade Especifique o ID do portal.
ProjectId String Verdade Especifique o ID do grupo.
TaskId String Verdade ZPUID do líder da equipe.
UserId String Verdade O ID do usuário para vários seguidores deve ser separado por vírgulas.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Especifica se a execução foi bem-sucedida.

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 metadados de banco de dados para Zoho Projects:

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 Portals:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Portals' 
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 ApproveTimelog:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='ApproveTimelog' 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 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 Portals:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Portals'
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_primarykeys

Descreve as chaves primárias. A consultar a seguir recupera as chaves primárias de todas as tabelas e exibições:

SELECT * FROM sys_primarykeys
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.
KeySeq String O número de sequência da chave primária.
KeyName String O nome da chave primária.

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:zohoprojects: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 está 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.

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
Region O domínio de nível superior na URL do servidor.

Conexão

Propriedade Descrição
PortalID Restrinja as entidades expostas com base no ID do Portal. Se deixado em branco, todos os portais disponíveis serão expostos.
ProjectID Restrinja as entidades expostas com base na ID do projeto. Se deixado em branco, todos os portais disponíveis serão expostos.

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.
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
AccountsServer O URL completo do servidor da conta.
APIDomain A URL completa do domínio da API.
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.
Pagesize O número máximo de resultados a serem retornados por página do Zoho Projects.
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.
UserDefinedViews Um caminho de arquivo apontando para o arquivo de configuração JSON que contém suas exibições personalizadas.

Autenticação

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

Propriedade Descrição
Region O domínio de nível superior na URL do servidor.

Região

O domínio de nível superior na URL do servidor.

Valores Possíveis

US, Europe, India, Australia

Tipo de Dados

string

Valor Padrão

"US"

Observações

Se sua conta residir em um domínio diferente, a região deverá ser alterada de acordo.

Região Domínio
US .com
Europe .eu
India .em
Australia .com.au

Conexão

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

Propriedade Descrição
PortalID Restrinja as entidades expostas com base no ID do Portal. Se deixado em branco, todos os portais disponíveis serão expostos.
ProjectID Restrinja as entidades expostas com base na ID do projeto. Se deixado em branco, todos os portais disponíveis serão expostos.

PortalID

Restrinja as entidades expostas com base no ID do Portal. Se deixado em branco, todos os portais disponíveis serão expostos.

Tipo de Dados

string

Valor Padrão

""

Observações

Restrinja as entidades expostas com base no ID do Portal. Se deixado em branco, todos os portais disponíveis serão expostos.

ProjectID

Restrinja as entidades expostas com base na ID do projeto. Se deixado em branco, todos os portais disponíveis serão expostos.

Tipo de Dados

string

Valor Padrão

""

Observações

Restrinja as entidades expostas com base na ID do projeto. Se deixado em branco, todos os portais disponíveis serão expostos.

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

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 para 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 exibiçõ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%\\\ZohoProjects 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.

Se não for especificado, o local padrão é "%APPDATA%\\ZohoProjects 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 muitos 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 visualizaçõ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
AccountsServer O URL completo do servidor da conta.
APIDomain A URL completa do domínio da API.
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.
Pagesize O número máximo de resultados a serem retornados por página do Zoho Projects.
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.
UserDefinedViews Um caminho de arquivo apontando para o arquivo de configuração JSON que contém suas exibições personalizadas.

AccountsServer

O URL completo do servidor da conta.

Tipo de Dados

string

Valor Padrão

""

Observações

Você só precisa fornecer isso ao executar o RefreshOAuthAccessToken procedimento armazenado* com InitiateOAuth=Desativado. Na maioria das vezes, o valor desta propriedade será https://accounts.zoho.com/, mas se sua conta residir em um local diferente, o domínio deverá ser alterado de acordo (.eu, .in, .com.au, ...).

APIDomain

A URL completa do domínio da API.

Tipo de Dados

string

Valor Padrão

""

Observações

Você só precisa fornecer isso ao usar seu próprio token de acesso OAuth com InitiateOAuth=Off. Caso contrário, o domínio da API será recuperado do fluxo OAuth. Na maioria das vezes, o valor desta propriedade será https://www.zohoapis.com, mas se sua conta residir em um local diferente, o domínio deverá ser alterado de acordo (.eu, .in, .com.au, ...).

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. Casos de uso de driver normal e funcionalidade 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.

Tamanho da Página

O número máximo de resultados a serem retornados por página do Zoho Projects.

Tipo de Dados

int

Valor Padrão

100

Observações

O Pagesize propriedade afeta o número máximo de resultados a serem retornados por página do Zoho Projects. Definir um valor mais alto pode resultar em melhor desempenho ao custo de memória adicional alocada por página consumida.

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.

UserDefinedViews

Um caminho de arquivo apontando para o arquivo de configuração JSON que contém suas exibições personalizadas.

Tipo de Dados

string

Valor Padrão

""

Observações

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 Portals 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"