Toggl Track (Editora Independente) (Visualização)
O único software de controle de tempo que cria relatórios personalizados a partir dos dados de tempo da sua equipe para maximizar a produtividade e a receita. Nossa solução de controle de tempo registra uma linha do tempo de calendário de todas as suas atividades de trabalho ao longo do dia.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Troia Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Metadados do conector | |
|---|---|
| Editora | Troystaylor |
| Sítio Web | https://toggl.com/track/automated-time-tracker/ |
| Política de privacidade | https://toggl.com/legal/track/privacy/ |
| Categorias | Produtividade |
Pista Toggl
O único software de controle de tempo que cria relatórios personalizados a partir dos dados de tempo da sua equipe para maximizar a produtividade e a receita. Nossa solução de controle de tempo registra uma linha do tempo de calendário de todas as suas atividades de trabalho ao longo do dia.
Editora: Troy Taylor, Hitachi Solutions
Pré-requisitos
Você deve se inscrever para uma conta com Toggl.
Obtenção de credenciais
Este conector utiliza autenticação básica com o seu endereço de e-mail e palavra-passe.
Operações suportadas
Obter usuário atual
Retorna detalhes para o usuário atual.
Atualizar usuário atual
Atualiza os detalhes para o usuário atual.
Obter clientes de usuário
Obter clientes para o usuário atual.
Obter recursos do usuário
Obtenha recursos disponíveis para o usuário atual.
Obter localização do usuário
Retorna o local baseado em IP do cliente. Se nenhum dado estiver presente, a resposta vazia será produzida.
Verificar autenticação
Usado para verificar se a autenticação funciona.
Obter organizações de usuários
Obtenha todas as organizações das quais um determinado usuário faz parte.
Obter projetos de usuário
Obtenha projetos para o usuário atual.
Obter projetos de usuário paginados
Obtenha projetos paginados para o usuário atual.
Obter tags de usuário
Retorna tags para o usuário atual.
Obter tarefas do usuário
Retorna tarefas de projetos nos quais o usuário está participando.
Receba lembretes de faixas
Retorna uma lista de lembretes de faixa.
Obter temporizador web
Obtenha a configuração do temporizador da Web.
Obter espaços de trabalho de usuário
Lista espaços de trabalho para determinado usuário.
Obter entradas de tempo
Lista as entradas mais recentes.
Obter entrada de hora atual
Carregue a entrada de tempo de execução para ID de usuário.
Obter entrada de tempo por ID
Entrada de tempo de carregamento por ID acessível pelo usuário atual.
Obter usuários do espaço de trabalho (nível da organização)
Retorna todos os usuários que pertencem ao espaço de trabalho diretamente ou por meio de pelo menos um grupo.
Obter usuários do espaço de trabalho
Liste todos os usuários de um determinado espaço de trabalho.
Obter usuários do projeto de espaço de trabalho
Liste todos os usuários de projetos para um determinado espaço de trabalho.
Obter clientes de usuário
Obter clientes para o usuário atual.
Obter organizações de usuários
Obtenha todas as organizações das quais um determinado usuário faz parte.
Obter usuários do espaço de trabalho (nível da organização)
Retorna todos os usuários que pertencem ao espaço de trabalho diretamente ou por meio de pelo menos um grupo.
Obter projetos de usuário
Obtenha projetos para o usuário atual.
Obter projetos de usuário paginados
Obtenha projetos paginados para o usuário atual.
Obter usuários do projeto de espaço de trabalho
Liste todos os usuários de projetos para um determinado espaço de trabalho.
Obter projetos de espaço de trabalho
Obtenha projetos para um determinado espaço de trabalho.
Obter projeto de espaço de trabalho
Obter projeto para determinado espaço de trabalho.
Obter tags de usuário
Retorna tags para o usuário atual.
Obter tarefas do usuário
Retorna tarefas de projetos nos quais o usuário está participando.
Obter espaços de trabalho de usuário
Lista espaços de trabalho para determinado usuário.
Criar entrada de tempo
Cria uma nova entrada de tempo do espaço de trabalho.
Excluir entrada de tempo
Exclui uma entrada de tempo do espaço de trabalho.
Entrada de tempo de atualização
Atualiza uma entrada de tempo do espaço de trabalho.
Entradas de tempo de edição em massa
Entradas de tempo de edição em massa. O patch será executado parcialmente quando houver erros com alguns registros. Sem transação, sem reversão.
Entrada de tempo de parada
Interrompe uma entrada de tempo do espaço de trabalho.
Obter usuários do espaço de trabalho (nível da organização)
Retorna todos os usuários que pertencem ao espaço de trabalho diretamente ou por meio de pelo menos um grupo.
Obter espaço de trabalho único
Obtenha informações de um único espaço de trabalho.
Obter lista de tarifas
Obtenha taxas por nível (workspace|project|task|user).
Obter estatísticas do espaço de trabalho
Retorna a lista de administradores do espaço de trabalho, a contagem de membros e a contagem de grupos.
Obter restrições de entrada de tempo do espaço de trabalho
Obtenha as restrições de entrada de tempo para um determinado espaço de trabalho.
Obter lembretes de rastreamento do espaço de trabalho
Retorna uma lista de lembretes de faixa.
Obter usuários do espaço de trabalho
Liste todos os usuários de um determinado espaço de trabalho.
Obter usuários do projeto de espaço de trabalho
Liste todos os usuários de projetos para um determinado espaço de trabalho.
Obter projetos de espaço de trabalho
Obtenha projetos para um determinado espaço de trabalho.
Obter projeto de espaço de trabalho
Obter projeto para determinado espaço de trabalho.
Obter entradas de tempo
Lista as entradas mais recentes.
Obter entrada de hora atual
Carregue a entrada de tempo de execução para ID de usuário.
Obter entrada de tempo por ID
Entrada de tempo de carregamento por ID acessível pelo usuário atual.
Quando uma entrada de tempo é criada
Aciona quando uma nova entrada de hora é criada no espaço de trabalho.
Quando uma entrada de hora é atualizada
Aciona quando uma entrada de hora existente é modificada no espaço de trabalho.
Quando uma entrada de hora é excluída
Aciona quando uma entrada de hora é excluída do espaço de trabalho.
Quando uma entrada de hora é iniciada
Aciona quando uma entrada de hora é iniciada (o temporizador começa) no espaço de trabalho.
Quando uma entrada de tempo é interrompida
Aciona quando uma entrada de tempo de execução é interrompida no espaço de trabalho.
Problemas conhecidos e limitações
Não há problemas conhecidos no momento.
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: Todas as regiões
Parâmetros para criar conexão.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Nome de utilizador | securestring | O nome de usuário para esta api | Verdade |
| Palavra-passe | securestring | A senha para esta api | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Atualizar usuário atual |
Atualiza os detalhes para o usuário atual. |
| Criar entrada de tempo |
Cria um novo espaço de trabalho TimeEntry. |
| Entrada de tempo de atualização |
Atualiza uma entrada de tempo do espaço de trabalho. |
| Entrada de tempo de parada |
Interrompe uma entrada de tempo do espaço de trabalho. |
| Entradas de tempo de edição em massa |
Entradas de tempo de edição em massa. O patch será executado parcialmente quando houver erros com alguns registros. Sem transação, sem reversão. |
| Excluir entrada de tempo |
Exclui uma entrada de tempo do espaço de trabalho. |
| Obter clientes de usuário |
Obter clientes para o usuário atual. |
| Obter entrada de hora atual |
Carregue a entrada de tempo de execução para ID de usuário. |
| Obter entrada de tempo por ID |
Entrada de tempo de carregamento por ID acessível pelo usuário atual. |
| Obter entradas de tempo |
Lista as entradas mais recentes. |
| Obter espaço de trabalho único |
Obtenha informações de um único espaço de trabalho. |
| Obter espaços de trabalho de usuário |
Lista espaços de trabalho para determinado usuário. |
| Obter estatísticas do espaço de trabalho |
Retorna a lista de administradores do espaço de trabalho, a contagem de membros e a contagem de grupos. |
| Obter lembretes de rastreamento do espaço de trabalho |
Retorna uma lista de lembretes de faixa. |
| Obter lista de tarifas |
Obtenha taxas por nível (workspace|project|task|user). |
| Obter localização do usuário |
Retorna o local baseado em IP do cliente. Se nenhum dado estiver presente, a resposta vazia será produzida. |
| Obter organizações de usuários |
Obtenha todas as organizações das quais um determinado usuário faz parte. |
| Obter projeto de espaço de trabalho |
Obter projeto para determinado espaço de trabalho. |
| Obter projetos de espaço de trabalho |
Obtenha projetos para um determinado espaço de trabalho. |
| Obter projetos de usuário |
Obtenha projetos para o usuário atual. |
| Obter projetos de usuário paginados |
Obtenha projetos paginados para o usuário atual. |
| Obter recursos do usuário |
Obtenha recursos disponíveis para o usuário atual. |
| Obter restrições de entrada de tempo do espaço de trabalho |
Obtenha as restrições de entrada de tempo para um determinado espaço de trabalho. |
| Obter tags de usuário |
Retorna tags para o usuário atual. |
| Obter tarefas do usuário |
Retorna tarefas de projetos nos quais o usuário está participando. |
| Obter temporizador web |
Obtenha a configuração do temporizador da Web. |
| Obter usuário atual |
Retorna detalhes para o usuário atual. |
| Obter usuários do espaço de trabalho |
Liste todos os usuários de um determinado espaço de trabalho. |
| Obter usuários do espaço de trabalho (nível da organização) |
Retorna todos os usuários que pertencem ao espaço de trabalho diretamente ou por meio de pelo menos um grupo. |
| Obter usuários do projeto de espaço de trabalho |
Liste todos os usuários de projetos para um determinado espaço de trabalho. |
| Receba lembretes de faixas |
Retorna uma lista de lembretes de faixa. |
| Verificar autenticação |
Usado para verificar se a autenticação funciona. |
Atualizar usuário atual
Atualiza os detalhes para o usuário atual.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Início da Semana
|
beginning_of_week | integer |
Primeiro dia da semana do utilizador. Domingo: 0, Segunda-feira: 1, etc. |
|
|
ID do país
|
country_id | integer |
ID do país do utilizador. |
|
|
Palavra-passe atual
|
current_password | string |
Senha atual do usuário (usada para alterar a senha atual). |
|
|
ID do espaço de trabalho padrão
|
default_workspace_id | integer |
ID de espaço de trabalho padrão do usuário. |
|
|
Email
|
string |
Endereço de e-mail do usuário. |
||
|
Nome Completo
|
fullname | string |
Nome completo do usuário. |
|
|
Nova palavra-passe
|
password | string |
A nova senha do usuário (atual também deve ser fornecida). |
|
|
Timezone
|
timezone | string |
Fuso horário do usuário. |
Devoluções
- Body
- UserBasicResponse
Criar entrada de tempo
Cria um novo espaço de trabalho TimeEntry.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço de trabalho
|
workspace_id | True | integer |
ID numérica do espaço de trabalho. |
|
Incluir metadados
|
meta | boolean |
Se a resposta contiver dados para metaentidades. |
|
|
A Cobrar
|
billable | boolean |
Se a entrada de hora está marcada como faturável, opcional, padrão false. |
|
|
Criado com
|
created_with | string |
Deve ser fornecido ao criar uma entrada de tempo e deve identificar o serviço/aplicativo usado para criá-la. |
|
|
Description
|
description | string |
Descrição da entrada de tempo, opcional. |
|
|
Duração
|
duration | integer |
Duração da entrada de tempo. Para entradas em execução deve ser negativo, preferível -1. |
|
|
Apenas duração
|
duronly | boolean |
Preterido: usado para criar uma entrada de hora com uma duração, mas sem uma hora de parada. Este parâmetro pode ser ignorado. |
|
|
Característica Origin
|
origin_feature | string |
Nome do recurso de origem. |
|
|
Contagem de gols visíveis
|
visible_goals_count | integer |
Número de golos visíveis. |
|
|
IDs de despesas
|
expense_ids | array of integer |
Despesas de Trabalho associadas à Entrada de Tempo. |
|
|
ID do Projeto (Legado)
|
pid | integer |
ID do projeto, campo legado. |
|
|
ID do projeto
|
project_id | integer |
ID do projeto, opcional. |
|
|
Compartilhado com IDs de usuário
|
shared_with_user_ids | array of integer |
Lista de IDs de usuário com os quais compartilhar essa entrada de tempo. |
|
|
Hora de Início
|
start | string |
Hora de início em UTC, necessária para a criação. Formato: 2006-01-02T15:04:05Z. |
|
|
Data de início
|
start_date | string |
Se fornecida durante a criação, a parte da data terá precedência sobre a parte da data de "início". Formato: 2006-11-07. |
|
|
Tempo de paragem
|
stop | string |
O tempo de paragem em UTC pode ser omitido se ainda estiver em execução ou criado com 'duração'. Se 'stop' e 'duration' forem fornecidos, os valores devem ser consistentes (start + duration == stop). |
|
|
Ação de tag
|
tag_action | string |
Pode ser 'adicionar' ou 'excluir'. Usado ao atualizar uma entrada de tempo existente. |
|
|
IDs de etiqueta
|
tag_ids | array of integer |
IDs de tags para adicionar/remover. |
|
|
Etiquetas
|
tags | array of string |
Nomes de tags a serem adicionadas/removidas. Se o nome não existir como tag, um será criado automaticamente. |
|
|
ID da tarefa
|
task_id | integer |
ID da tarefa, opcional. |
|
|
ID da Tarefa (Legado)
|
tid | integer |
ID da tarefa, campo herdado. |
|
|
ID de usuário (legado)
|
uid | integer |
ID do criador da entrada de tempo, campo herdado. |
|
|
ID de utilizador
|
user_id | integer |
O ID do criador do Time Entry, se omitido, usará o ID de usuário do solicitante. |
|
|
ID do espaço de trabalho (Legado)
|
wid | integer |
ID do espaço de trabalho, campo herdado. |
|
|
ID do espaço de trabalho
|
workspace_id | integer |
ID do espaço de trabalho, obrigatório. |
Devoluções
- Body
- TimeEntry
Entrada de tempo de atualização
Atualiza uma entrada de tempo do espaço de trabalho.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço de trabalho
|
workspace_id | True | integer |
ID numérica do espaço de trabalho. |
|
ID de entrada de tempo
|
time_entry_id | True | integer |
ID TimeEntry. |
|
Incluir metadados
|
meta | boolean |
Se a resposta contiver dados para metaentidades. |
|
|
Incluir compartilhamento
|
include_sharing | boolean |
Inclua detalhes de compartilhamento na resposta. |
|
|
A Cobrar
|
billable | boolean |
Se a entrada de hora está marcada como faturável, opcional, padrão false. |
|
|
Criado com
|
created_with | string |
Deve ser fornecido ao criar uma entrada de tempo e deve identificar o serviço/aplicativo usado para criá-la. |
|
|
Description
|
description | string |
Descrição da entrada de tempo, opcional. |
|
|
Duração
|
duration | integer |
Duração da entrada de tempo. Para entradas em execução deve ser negativo, preferível -1. |
|
|
Apenas duração
|
duronly | boolean |
Preterido: usado para criar uma entrada de hora com uma duração, mas sem uma hora de parada. Este parâmetro pode ser ignorado. |
|
|
Característica Origin
|
origin_feature | string |
Nome do recurso de origem. |
|
|
Contagem de gols visíveis
|
visible_goals_count | integer |
Número de golos visíveis. |
|
|
IDs de despesas
|
expense_ids | array of integer |
Despesas de Trabalho associadas à Entrada de Tempo. |
|
|
ID do Projeto (Legado)
|
pid | integer |
ID do projeto, campo legado. |
|
|
ID do projeto
|
project_id | integer |
ID do projeto, opcional. |
|
|
Compartilhado com IDs de usuário
|
shared_with_user_ids | array of integer |
Lista de IDs de usuário com os quais compartilhar essa entrada de tempo. |
|
|
Hora de Início
|
start | string |
Hora de início em UTC, necessária para a criação. Formato: 2006-01-02T15:04:05Z. |
|
|
Data de início
|
start_date | string |
Se fornecida durante a criação, a parte da data terá precedência sobre a parte da data de "início". Formato: 2006-11-07. |
|
|
Tempo de paragem
|
stop | string |
O tempo de paragem em UTC pode ser omitido se ainda estiver em execução ou criado com 'duração'. Se 'stop' e 'duration' forem fornecidos, os valores devem ser consistentes (start + duration == stop). |
|
|
Ação de tag
|
tag_action | string |
Pode ser 'adicionar' ou 'excluir'. Usado ao atualizar uma entrada de tempo existente. |
|
|
IDs de etiqueta
|
tag_ids | array of integer |
IDs de tags para adicionar/remover. |
|
|
Etiquetas
|
tags | array of string |
Nomes de tags a serem adicionadas/removidas. Se o nome não existir como tag, um será criado automaticamente. |
|
|
ID da tarefa
|
task_id | integer |
ID da tarefa, opcional. |
|
|
ID da Tarefa (Legado)
|
tid | integer |
ID da tarefa, campo herdado. |
|
|
ID de usuário (legado)
|
uid | integer |
ID do criador da entrada de tempo, campo herdado. |
|
|
ID de utilizador
|
user_id | integer |
O ID do criador do Time Entry, se omitido, usará o ID de usuário do solicitante. |
|
|
ID do espaço de trabalho (Legado)
|
wid | integer |
ID do espaço de trabalho, campo herdado. |
|
|
ID do espaço de trabalho
|
workspace_id | integer |
ID do espaço de trabalho, obrigatório. |
Devoluções
- Body
- TimeEntry
Entrada de tempo de parada
Interrompe uma entrada de tempo do espaço de trabalho.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço de trabalho
|
workspace_id | True | integer |
ID numérica do espaço de trabalho. |
|
ID de entrada de tempo
|
time_entry_id | True | integer |
ID TimeEntry. |
Devoluções
- Body
- TimeEntry
Entradas de tempo de edição em massa
Entradas de tempo de edição em massa. O patch será executado parcialmente quando houver erros com alguns registros. Sem transação, sem reversão.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço de trabalho
|
workspace_id | True | integer |
ID numérica do espaço de trabalho. |
|
IDs de entrada de tempo
|
time_entry_ids | True | string |
IDs numéricos de time_entries, separados por vírgula. Por exemplo: 204301830,202700150,202687559. O limite é de 100 IDs por solicitação. |
|
Incluir metadados
|
meta | boolean |
Se a resposta contiver dados para metaentidades. |
|
|
Funcionamento
|
op | True | string |
Operação (adicionar/remover/substituir). |
|
Caminho
|
path | True | string |
O caminho para a entidade a ser corrigida (por exemplo, /description). |
|
Valor
|
value | object |
O novo valor para a entidade no caminho. |
Devoluções
- Body
- BulkEditResponse
Excluir entrada de tempo
Exclui uma entrada de tempo do espaço de trabalho.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço de trabalho
|
workspace_id | True | integer |
ID numérica do espaço de trabalho. |
|
ID de entrada de tempo
|
time_entry_id | True | integer |
ID TimeEntry. |
Obter clientes de usuário
Obter clientes para o usuário atual.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Desde a data
|
since | integer |
Recupere itens criados/modificados/excluídos desde essa data usando o carimbo de data/hora do UNIX. |
Devoluções
- response
- array of Client
Obter entrada de hora atual
Obter entrada de tempo por ID
Entrada de tempo de carregamento por ID acessível pelo usuário atual.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de entrada de tempo
|
time_entry_id | True | integer |
ID TimeEntry. |
|
Incluir metadados
|
meta | boolean |
Se a resposta contiver dados para metaentidades. |
|
|
Incluir compartilhamento
|
include_sharing | boolean |
Inclua detalhes de compartilhamento na resposta. |
Devoluções
- Body
- TimeEntry
Obter entradas de tempo
Lista as entradas mais recentes.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Incluir metadados
|
meta | boolean |
Se a resposta contiver dados para metaentidades. |
|
|
Incluir compartilhamento
|
include_sharing | boolean |
Inclua detalhes de compartilhamento na resposta. |
|
|
Desde a data
|
since | integer |
Recupere itens criados/modificados/excluídos desde essa data usando o carimbo de data/hora do UNIX. |
|
|
Antes da data
|
before | string |
Obter entradas com hora de início, antes de determinada data (AAAA-MM-DD) ou com hora em formato RFC3339. |
|
|
Data de início
|
start_date | string |
Obtenha entradas com hora de início, a partir de start_date AAAA-MM-DD ou com o tempo em formato RFC3339. A utilizar com end_date. |
|
|
Data de fim
|
end_date | string |
Obtenha entradas com hora de início, até end_date AAAA-MM-DD ou com o tempo em formato RFC3339. A utilizar com start_date. |
Devoluções
- response
- array of TimeEntry
Obter espaço de trabalho único
Obtenha informações de um único espaço de trabalho.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço de trabalho
|
workspace_id | True | integer |
ID numérica do espaço de trabalho. |
Devoluções
- Body
- Workspace
Obter espaços de trabalho de usuário
Lista espaços de trabalho para determinado usuário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Desde a data
|
since | integer |
Recupere itens criados/modificados/excluídos desde essa data usando o carimbo de data/hora do UNIX. |
Devoluções
- response
- array of Workspace
Obter estatísticas do espaço de trabalho
Retorna a lista de administradores do espaço de trabalho, a contagem de membros e a contagem de grupos.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço de trabalho
|
workspace_id | True | integer |
ID numérica do espaço de trabalho. |
Devoluções
- Body
- WorkspaceStatistics
Obter lembretes de rastreamento do espaço de trabalho
Retorna uma lista de lembretes de faixa.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço de trabalho
|
workspace_id | True | integer |
ID numérica do espaço de trabalho. |
Devoluções
Obter lista de tarifas
Obtenha taxas por nível (workspace|project|task|user).
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço de trabalho
|
workspace_id | True | integer |
ID numérica do espaço de trabalho. |
|
Nível
|
level | True | string |
Nível de taxas: espaço de trabalho, projeto, tarefa ou usuário. |
|
ID de nível
|
level_id | True | integer |
ID numérico do nível da entidade. |
|
Tipo de Tarifa
|
type | string |
Tipo de valores de taxa a serem retornados: billable_rates ou labor_costs. O padrão é billable_rates. |
Devoluções
- response
- array of Rate
Obter localização do usuário
Retorna o local baseado em IP do cliente. Se nenhum dado estiver presente, a resposta vazia será produzida.
Devoluções
- Body
- LocationResponse
Obter organizações de usuários
Obtenha todas as organizações das quais um determinado usuário faz parte.
Devoluções
- response
- array of Organization
Obter projeto de espaço de trabalho
Obter projeto para determinado espaço de trabalho.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço de trabalho
|
workspace_id | True | integer |
ID numérica do espaço de trabalho. |
|
ID do projeto
|
project_id | True | integer |
ID numérico do projeto. |
Devoluções
- Body
- Project
Obter projetos de espaço de trabalho
Obtenha projetos para um determinado espaço de trabalho.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço de trabalho
|
workspace_id | True | integer |
ID numérica do espaço de trabalho. |
|
Ordenar Fixo
|
sort_pinned | True | boolean |
Coloque os projetos fixados na parte superior da resposta. |
|
Somente usuários ativos
|
active | boolean |
Retorna apenas usuários ativos. |
|
|
Desde a data
|
since | integer |
Recupere itens criados/modificados/excluídos desde essa data usando o carimbo de data/hora do UNIX. |
|
|
A Cobrar
|
billable | boolean |
Filtrar por status faturável. |
|
|
IDs de utilizador
|
user_ids | array |
IDs de usuário pelos quais filtrar. |
|
|
IDs do cliente
|
client_ids | array |
IDs de cliente pelos quais filtrar. |
|
|
IDs de grupo
|
group_ids | array |
IDs de grupo pelos quais filtrar. |
|
|
IDs do projeto
|
project_ids | string |
IDs numéricos de projetos, separados por vírgula. |
|
|
Estatutos
|
statuses | array |
Status do projeto pelo qual filtrar. |
|
|
Filtro de nome
|
name | string |
Nome de usuário do espaço de trabalho pelo qual filtrar. |
|
|
Número da página
|
page | integer |
Número da página. |
|
|
Campo de classificação
|
sort_field | True | string |
Campo para ordenar por. |
|
Ordem de classificação
|
sort_order | True | string |
Ordem de classificação (asc/desc). |
|
Apenas modelos
|
only_templates | True | boolean |
Retornar somente modelos de projeto. |
|
Apenas os Meus Projetos
|
only_me | boolean |
Obtenha apenas projetos atribuídos ao usuário atual. |
|
|
Itens por página
|
per_page | integer |
Número de itens por página, padrão 201. |
Devoluções
- response
- array of Project
Obter projetos de usuário
Obtenha projetos para o usuário atual.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Incluir arquivado
|
include_archived | string |
Inclua projetos arquivados. |
|
|
Desde a data
|
since | integer |
Recupere itens criados/modificados/excluídos desde essa data usando o carimbo de data/hora do UNIX. |
Devoluções
- response
- array of Project
Obter projetos de usuário paginados
Obtenha projetos paginados para o usuário atual.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Iniciar ID do Projeto
|
start_project_id | integer |
ID do projeto para retomar a próxima paginação. |
|
|
Desde a data
|
since | integer |
Recupere itens criados/modificados/excluídos desde essa data usando o carimbo de data/hora do UNIX. |
|
|
Itens por página
|
per_page | integer |
Número de itens por página, padrão 201. |
Devoluções
- response
- array of Project
Obter recursos do usuário
Obter restrições de entrada de tempo do espaço de trabalho
Obtenha as restrições de entrada de tempo para um determinado espaço de trabalho.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço de trabalho
|
workspace_id | True | integer |
ID numérica do espaço de trabalho. |
Devoluções
- Body
- TimeEntryConstraints
Obter tags de usuário
Retorna tags para o usuário atual.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Desde a data
|
since | integer |
Recupere itens criados/modificados/excluídos desde essa data usando o carimbo de data/hora do UNIX. |
Devoluções
- response
- array of Tag
Obter tarefas do usuário
Retorna tarefas de projetos nos quais o usuário está participando.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Incluir metadados
|
meta | boolean |
Se a resposta contiver dados para metaentidades. |
|
|
Desde a data
|
since | integer |
Recupere itens criados/modificados/excluídos desde essa data usando o carimbo de data/hora do UNIX. |
|
|
Incluir tarefas inativas
|
include_not_active | string |
Inclua tarefas marcadas como concluídas. |
|
|
Deslocamento de paginação
|
offset | integer |
Deslocamento para retomar a próxima paginação de. |
|
|
Itens por página
|
per_page | integer |
Número de itens por página, padrão 201. |
Devoluções
- response
- array of Task
Obter temporizador web
Obtenha a configuração do temporizador da Web.
Obter usuário atual
Retorna detalhes para o usuário atual.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Incluir dados relacionados
|
with_related_data | boolean |
Recupere dados relacionados ao usuário (clientes, projetos, tarefas, tags, espaços de trabalho, entradas de tempo, etc.). |
Devoluções
- Body
- UserResponse
Obter usuários do espaço de trabalho
Liste todos os usuários de um determinado espaço de trabalho.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço de trabalho
|
workspace_id | True | integer |
ID numérica do espaço de trabalho. |
|
Excluir excluído
|
exclude_deleted | boolean |
Excluir registros excluídos na resposta. |
Devoluções
- response
- array of WorkspaceUserSimple
Obter usuários do espaço de trabalho (nível da organização)
Retorna todos os usuários que pertencem ao espaço de trabalho diretamente ou por meio de pelo menos um grupo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Organização
|
organization_id | True | integer |
ID numérico da organização. |
|
ID do espaço de trabalho
|
workspace_id | True | integer |
ID numérica do espaço de trabalho. |
|
Número da página
|
page | integer |
Número da página. |
|
|
Itens por página
|
per_page | integer |
Número de itens por página, padrão 201. |
|
|
Filtro de tarifas personalizadas
|
custom_rates | boolean |
Retorna apenas usuários com ou sem uma taxa horária personalizada, respectivamente. |
|
|
Somente usuários ativos
|
active | boolean |
Retorna apenas usuários ativos. |
|
|
Filtro de nome
|
name | string |
Nome de usuário do espaço de trabalho pelo qual filtrar. |
|
|
Filtro de pesquisa
|
search | string |
Filtro de espaço de trabalho por nome ou e-mail. |
Devoluções
- response
- array of WorkspaceUser
Obter usuários do projeto de espaço de trabalho
Liste todos os usuários de projetos para um determinado espaço de trabalho.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço de trabalho
|
workspace_id | True | integer |
ID numérica do espaço de trabalho. |
|
IDs do projeto
|
project_ids | string |
IDs numéricos de projetos, separados por vírgula. |
|
|
ID de utilizador
|
user_id | string |
A ID numérica do usuário, se aprovada, retorna apenas os usuários do projeto para os projetos desse usuário. |
|
|
Incluir membros do grupo
|
with_group_members | boolean |
Inclua membros do grupo. |
Devoluções
- response
- array of ProjectUser
Receba lembretes de faixas
Verificar autenticação
Usado para verificar se a autenticação funciona.
Acionadores
| Quando uma entrada de hora é atualizada |
Aciona quando uma entrada de hora existente é modificada no espaço de trabalho. |
| Quando uma entrada de hora é excluída |
Aciona quando uma entrada de hora é excluída do espaço de trabalho. |
| Quando uma entrada de hora é iniciada |
Aciona quando uma entrada de hora é iniciada (o temporizador começa) no espaço de trabalho. |
| Quando uma entrada de tempo é criada |
Aciona quando uma nova entrada de hora é criada no espaço de trabalho. |
| Quando uma entrada de tempo é interrompida |
Aciona quando uma entrada de tempo de execução é interrompida no espaço de trabalho. |
Quando uma entrada de hora é atualizada
Aciona quando uma entrada de hora existente é modificada no espaço de trabalho.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço de trabalho
|
workspace_id | True | integer |
ID numérica do espaço de trabalho. |
|
Entidade
|
entity | string |
Toggl Rastreie a entidade comercial para filtrar. |
|
|
Ação
|
action | string |
Tipo de modificação aplicada à entidade. |
Devoluções
Quando uma entrada de hora é excluída
Aciona quando uma entrada de hora é excluída do espaço de trabalho.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço de trabalho
|
workspace_id | True | integer |
ID numérica do espaço de trabalho. |
|
Entidade
|
entity | string |
Toggl Rastreie a entidade comercial para filtrar. |
|
|
Ação
|
action | string |
Tipo de modificação aplicada à entidade. |
Devoluções
Quando uma entrada de hora é iniciada
Aciona quando uma entrada de hora é iniciada (o temporizador começa) no espaço de trabalho.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço de trabalho
|
workspace_id | True | integer |
ID numérica do espaço de trabalho. |
|
Entidade
|
entity | string |
Toggl Rastreie a entidade comercial para filtrar. |
|
|
Ação
|
action | string |
Tipo de modificação aplicada à entidade. |
Devoluções
Quando uma entrada de tempo é criada
Aciona quando uma nova entrada de hora é criada no espaço de trabalho.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço de trabalho
|
workspace_id | True | integer |
ID numérica do espaço de trabalho. |
|
Entidade
|
entity | string |
Toggl Rastreie a entidade comercial para filtrar. |
|
|
Ação
|
action | string |
Tipo de modificação aplicada à entidade. |
Devoluções
Quando uma entrada de tempo é interrompida
Aciona quando uma entrada de tempo de execução é interrompida no espaço de trabalho.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço de trabalho
|
workspace_id | True | integer |
ID numérica do espaço de trabalho. |
|
Entidade
|
entity | string |
Toggl Rastreie a entidade comercial para filtrar. |
|
|
Ação
|
action | string |
Tipo de modificação aplicada à entidade. |
Devoluções
Definições
Resposta do usuário
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
2FA ativado
|
2fa_enabled | boolean |
Status habilitado para autenticação de dois fatores. |
|
Chave de API
|
api_token | string |
O token da API, será omitido se estiver vazio. |
|
Última atualização
|
at | string |
Carimbo de data/hora da última atualização. |
|
Autorização atualizada
|
authorization_updated_at | string |
Carimbo de data/hora quando o objeto de sessão do usuário de autorização foi atualizado pela última vez. |
|
Início da Semana
|
beginning_of_week | integer |
Primeiro dia da semana do utilizador (0=domingo, 1=segunda-feira, etc.). |
|
Clients
|
clients | array of Client |
Clientes, null se with_related_data não foi definido como true. |
|
ID do país
|
country_id | integer |
ID do país do utilizador. |
|
Criado em
|
created_at | string |
Carimbo de data/hora de criação de usuário. |
|
ID do espaço de trabalho padrão
|
default_workspace_id | integer |
ID de espaço de trabalho padrão do usuário. |
|
Email
|
string |
Endereço de e-mail do usuário. |
|
|
Nome Completo
|
fullname | string |
Nome completo do usuário. |
|
Tem palavra-passe
|
has_password | boolean |
Se o usuário tem uma senha definida. |
|
ID de utilizador
|
id | integer |
ID de Utilizador. |
|
URL da imagem
|
image_url | string |
URL da imagem de perfil do utilizador. |
|
Hash de intercomunicação
|
intercom_hash | string |
Hash de interfone, será omitido se estiver vazio. |
|
Provedores OAuth
|
oauth_providers | array of string |
Provedores OAuth disponíveis para o usuário. |
|
E-mail OpenID
|
openid_email | string |
Endereço de e-mail OpenID. |
|
OpenID ativado
|
openid_enabled | boolean |
Status habilitado para autenticação OpenID. |
|
Opções
|
options | object |
As opções do usuário serão omitidas se estiverem vazias. |
|
Projetos
|
projects | array of Project |
Projects, null se with_related_data não foi definido como true. |
|
Etiquetas
|
tags | array of Tag |
Tags, null se with_related_data não foi definido como true. |
|
Tasks
|
tasks | array of Task |
Tasks, null se with_related_data não foi definido como true. |
|
Entradas de Tempo
|
time_entries | array of TimeEntry |
Entradas de tempo, null se with_related_data não foi definido como true. |
|
Timezone
|
timezone | string |
Fuso horário do usuário. |
|
Atualizado em
|
updated_at | string |
Carimbo de data/hora da última atualização do usuário. |
|
Espaços de trabalho
|
workspaces | array of Workspace |
Espaços de trabalho, nulo se with_related_data não foi definido como true. |
UserBasicResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
2FA ativado
|
2fa_enabled | boolean |
Status habilitado para autenticação de dois fatores. |
|
Chave de API
|
api_token | string |
O token da API, será omitido se estiver vazio. |
|
Última atualização
|
at | string |
Carimbo de data/hora da última atualização. |
|
Início da Semana
|
beginning_of_week | integer |
Primeiro dia da semana do utilizador. |
|
ID do país
|
country_id | integer |
ID do país do utilizador. |
|
Criado em
|
created_at | string |
Carimbo de data/hora de criação de usuário. |
|
ID do espaço de trabalho padrão
|
default_workspace_id | integer |
ID de espaço de trabalho padrão do usuário. |
|
Email
|
string |
Endereço de e-mail do usuário. |
|
|
Nome Completo
|
fullname | string |
Nome completo do usuário. |
|
Tem palavra-passe
|
has_password | boolean |
Se o usuário tem uma senha definida. |
|
ID de utilizador
|
id | integer |
ID de Utilizador. |
|
URL da imagem
|
image_url | string |
URL da imagem de perfil do utilizador. |
|
E-mail OpenID
|
openid_email | string |
Endereço de e-mail OpenID. |
|
OpenID ativado
|
openid_enabled | boolean |
Status habilitado para autenticação OpenID. |
|
Opções
|
options | object |
As opções do usuário serão omitidas se estiverem vazias. |
|
Timezone
|
timezone | string |
Fuso horário do usuário. |
|
Atualizado em
|
updated_at | string |
Carimbo de data/hora da última atualização do usuário. |
Client
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Arquivado
|
archived | boolean |
É verdadeiro se o cliente estiver arquivado. |
|
Última atualização
|
at | string |
Quando foi a última atualização. |
|
ID do criador
|
creator_id | integer |
ID do usuário que criou o cliente. |
|
Referência externa
|
external_reference | string |
Referência externa à entidade Track Client. |
|
ID do Cliente
|
id | integer |
ID de Cliente. |
|
ID Externo de Integração
|
integration_ext_id | string |
ID externa da entidade vinculada no sistema externo. |
|
Tipo Externo de Integração
|
integration_ext_type | string |
Tipo externo da entidade vinculada no sistema externo. |
|
Provedor de Integração
|
integration_provider | object |
Provedor que tem uma entidade vinculada a essa entidade Toggl Track. |
|
Nome do Cliente
|
name | string |
Nome do cliente. |
|
Observações
|
notes | string |
Notas do cliente. |
|
Permissions
|
permissions | array of string |
Lista de permissões de autorização para este cliente. |
|
Contagem Total
|
total_count | integer |
Campo total para armazenar a contagem total. |
|
ID do espaço de trabalho
|
wid | integer |
ID do espaço de trabalho. |
Projeto
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Active
|
active | boolean |
Se o projeto está ativo ou arquivado. |
|
Horas reais
|
actual_hours | integer |
Horas reais gastas no projeto. |
|
Segundos reais
|
actual_seconds | integer |
Segundos reais gastos no projeto. |
|
Última atualização
|
at | string |
Data da última atualização. |
|
Estimativas automáticas
|
auto_estimates | boolean |
Estimativas automáticas ativadas. |
|
A Cobrar
|
billable | boolean |
Se o projeto é faturável. |
|
Pode controlar o tempo
|
can_track_time | boolean |
Se o tempo pode ser rastreado para este projeto. |
|
ID do Cliente (Legado)
|
cid | integer |
Campo herdado da ID do cliente. |
|
ID do Cliente
|
client_id | integer |
ID de Cliente. |
|
Nome do Cliente
|
client_name | string |
Nome do cliente. |
|
Cor
|
color | string |
Cor do projeto. |
|
Criado em
|
created_at | string |
Data de criação. |
|
Moeda
|
currency | string |
Moeda do projeto. |
|
Período Atual
|
current_period | object |
Período atual do projeto, recurso premium. |
|
Data de fim
|
end_date | string |
Data de conclusão do projeto. |
|
Horas estimadas
|
estimated_hours | integer |
Horas estimadas para o projeto. |
|
Segundos estimados
|
estimated_seconds | integer |
Segundos estimados para o projeto. |
|
Referência externa
|
external_reference | string |
Referência externa à Entidade do Projeto de Rastreamento. |
|
Taxa fixa
|
fixed_fee | double |
Taxa fixa, recurso premium. |
|
ID do projeto
|
id | integer |
ID do projeto. |
|
ID Externo de Integração
|
integration_ext_id | string |
ID externa da entidade vinculada no sistema externo. |
|
Tipo Externo de Integração
|
integration_ext_type | string |
Tipo externo da entidade vinculada no sistema externo. |
|
Provedor de Integração
|
integration_provider | object |
Provedor que tem uma entidade vinculada a essa entidade Toggl Track. |
|
É privado
|
is_private | boolean |
Se o projeto é privado. |
|
Nome do Projeto
|
name | string |
Nome do projeto. |
|
Permissions
|
permissions | array of string |
Permissões do projeto. |
|
Afixado
|
pinned | boolean |
Se o projeto está fixado. |
|
Tarifa Horária
|
rate | double |
Taxa horária para o projeto. |
|
Última atualização da tarifa
|
rate_last_updated | string |
Quando a tarifa foi atualizada pela última vez. |
|
Recorrente
|
recurring | boolean |
Se o projeto é recorrente, recurso premium. |
|
Parâmetros recorrentes
|
recurring_parameters | array of RecurringParameter |
Parâmetros recorrentes do projeto, recurso premium. |
|
Data de início
|
start_date | string |
Data de início do projeto. |
|
Situação
|
status | string |
Status do projeto (futuro, ativo, encerrado, arquivado, excluído). |
|
Template
|
template | boolean |
Se o projeto é um modelo. |
|
ID do modelo
|
template_id | integer |
ID do modelo se o projeto for baseado no modelo. |
|
Contagem Total
|
total_count | integer |
Número total de projetos encontrados. |
|
ID do espaço de trabalho (Legado)
|
wid | integer |
Campo herdado ID do espaço de trabalho. |
|
ID do espaço de trabalho
|
workspace_id | integer |
ID do espaço de trabalho. |
RecurringParameter
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Período Personalizado
|
custom_period | integer |
Período personalizado, usado quando o campo de período é 'personalizado'. |
|
Segundos estimados
|
estimated_seconds | integer |
Segundos estimados. |
|
Data de fim do parâmetro
|
parameter_end_date | string |
Data de término do parâmetro. |
|
Data de início do parâmetro
|
parameter_start_date | string |
Data de início recorrente. |
|
Período
|
period | string |
Período recorrente. |
|
Data de Início do Projeto
|
project_start_date | string |
Data de início do projeto. |
Tag
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Última modificação
|
at | string |
Quando foi criado/modificado pela última vez. |
|
ID do criador
|
creator_id | integer |
ID do usuário que criou a tag. |
|
Suprimido em
|
deleted_at | string |
Quando foi excluído. |
|
ID da etiqueta
|
id | integer |
ID da etiqueta. |
|
ID Externo de Integração
|
integration_ext_id | string |
ID externa da entidade vinculada no sistema externo. |
|
Tipo Externo de Integração
|
integration_ext_type | string |
Tipo externo da entidade vinculada no sistema externo. |
|
Provedor de Integração
|
integration_provider | object |
Provedor que tem uma entidade vinculada a essa entidade Toggl Track. |
|
Nome da tag
|
name | string |
Nome da tag. |
|
Permissions
|
permissions | array of string |
Permissões de tag. |
|
ID do espaço de trabalho
|
workspace_id | integer |
ID do espaço de trabalho. |
Tarefa
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Active
|
active | boolean |
Falso quando a tarefa foi concluída. |
|
Última modificação
|
at | string |
Quando a tarefa foi criada/modificada pela última vez. |
|
Avatar URL
|
avatar_url | string |
URL do avatar. |
|
Nome do Cliente
|
client_name | string |
Nome do cliente. |
|
Segundos estimados
|
estimated_seconds | integer |
Segundos estimados para a tarefa. |
|
ID da tarefa
|
id | integer |
ID da tarefa. |
|
ID Externo de Integração
|
integration_ext_id | string |
ID externa da entidade vinculada no sistema externo. |
|
Tipo Externo de Integração
|
integration_ext_type | string |
Tipo externo da entidade vinculada no sistema externo. |
|
Provedor de Integração
|
integration_provider | object |
Provedor que tem uma entidade vinculada a essa entidade Toggl Track. |
|
Nome da Tarefa
|
name | string |
Nome da tarefa. |
|
Permissions
|
permissions | array of string |
Permissões de tarefas. |
|
Projeto faturável
|
project_billable | boolean |
Se o projeto é faturável. |
|
Cor do projeto
|
project_color | string |
Metadados de cores do projeto. |
|
ID do projeto
|
project_id | integer |
ID do projeto. |
|
O projeto é privado
|
project_is_private | boolean |
Se o projeto é privado. |
|
Nome do Projeto
|
project_name | string |
Nome do projeto. |
|
Tarifa
|
rate | double |
Classifique para esta tarefa. |
|
Última atualização da tarifa
|
rate_last_updated | string |
Quando a tarifa foi atualizada pela última vez. |
|
Recorrente
|
recurring | boolean |
Se esta é uma tarefa recorrente. |
|
ID de Contas Toggl
|
toggl_accounts_id | string |
ID de contas Toggl. |
|
Segundos rastreados
|
tracked_seconds | integer |
O valor tracked_seconds é em milissegundos, não em segundos. |
|
ID de utilizador
|
user_id | integer |
ID de Utilizador. |
|
Nome de Utilizador
|
user_name | string |
Nome de usuário. |
|
ID do espaço de trabalho
|
workspace_id | integer |
ID do espaço de trabalho. |
TimeEntry
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Última atualização
|
at | string |
Quando foi atualizado pela última vez, segue o formato ISO 8601. |
|
A Cobrar
|
billable | boolean |
Se a entrada de hora está marcada como faturável. |
|
Nome do Cliente
|
client_name | string |
Metacampos de entidades relacionadas. |
|
Description
|
description | string |
Descrição da entrada de tempo. |
|
Duração
|
duration | integer |
Duração da entrada de tempo. Para entradas em execução deve ser negativo, preferível -1. |
|
Apenas duração
|
duronly | boolean |
Usado para criar um TE com uma duração, mas sem um tempo de parada. |
|
IDs de despesas
|
expense_ids | array of integer |
Despesas de trabalho. |
|
ID de entrada de tempo
|
id | integer |
ID de entrada de tempo. |
|
Permissions
|
permissions | array of string |
Lista de permissões. |
|
ID do Projeto (Legado)
|
pid | integer |
ID do projeto, campo legado. |
|
Projeto Ativo
|
project_active | boolean |
Se o projeto está ativo. |
|
Projeto faturável
|
project_billable | boolean |
Se o projeto é faturável. |
|
Cor do projeto
|
project_color | string |
Cor do projeto. |
|
ID do projeto
|
project_id | integer |
ID do projeto. |
|
Nome do Projeto
|
project_name | string |
Nome do projeto. |
|
Compartilhado com
|
shared_with | array of SharedWith |
Indica com quem a entrada de tempo foi compartilhada. |
|
Hora de Início
|
start | string |
Hora de início em UTC. |
|
Tempo de paragem
|
stop | string |
O tempo de parada no UTC pode ser nulo se ainda estiver em execução. |
|
IDs de etiqueta
|
tag_ids | array of integer |
IDs de tag, nulos se as tags não foram fornecidas ou foram excluídas posteriormente. |
|
Etiquetas
|
tags | array of string |
Nomes de tags, nulos se as tags não foram fornecidas ou foram excluídas posteriormente. |
|
ID da tarefa
|
task_id | integer |
ID da tarefa. |
|
Nome da Tarefa
|
task_name | string |
Nome da tarefa. |
|
ID da Tarefa (Legado)
|
tid | integer |
ID da tarefa, campo herdado. |
|
ID de usuário (legado)
|
uid | integer |
ID do criador da entrada de tempo, campo herdado. |
|
URL do avatar do usuário
|
user_avatar_url | string |
URL do avatar do usuário. |
|
ID de utilizador
|
user_id | integer |
ID do criador do Time Entry. |
|
Nome de Utilizador
|
user_name | string |
Nome de usuário. |
|
ID do espaço de trabalho (Legado)
|
wid | integer |
ID do espaço de trabalho, campo herdado. |
|
ID do espaço de trabalho
|
workspace_id | integer |
ID do espaço de trabalho. |
Partilhado com
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Aceito
|
accepted | boolean |
Se a partilha foi aceite. |
|
ID de utilizador
|
user_id | integer |
ID de usuário da pessoa compartilhada com. |
|
Nome de Utilizador
|
user_name | string |
Nome de usuário da pessoa compartilhada com. |
Espaço de trabalho
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem ativa de projetos
|
active_project_count | integer |
Número de projetos ativos. |
|
Administrador
|
admin | boolean |
O usuário atual é administrador do espaço de trabalho (Preterido). |
|
Chave de API
|
api_token | string |
Token de API (preterido). |
|
Última alteração
|
at | string |
Carimbo de data/hora da última alteração do espaço de trabalho. |
|
Espaço de trabalho de negócios
|
business_ws | boolean |
Espaço de trabalho na assinatura Premium. |
|
CSV Upload
|
csv_upload | object |
Dados de upload CSV. |
|
Moeda padrão
|
default_currency | string |
Moeda padrão, recurso premium. |
|
Taxa horária padrão
|
default_hourly_rate | double |
A taxa horária padrão, recurso premium. |
|
Desativar aprovações
|
disable_approvals | boolean |
Desative as aprovações no espaço de trabalho. |
|
Desativar a Vista de Quadro de Horários
|
disable_timesheet_view | boolean |
Desative o modo de exibição de quadro de horários no espaço de trabalho. |
|
Ocultar Horários de Início e Fim
|
hide_start_end_times | boolean |
Oculte as horas de início e fim. |
|
iCal ativado
|
ical_enabled | boolean |
Integração de calendário ativada. |
|
URL do iCal
|
ical_url | string |
URL do calendário. |
|
ID do espaço de trabalho
|
id | integer |
Identificador do espaço de trabalho. |
|
Última modificação
|
last_modified | string |
Última modificação de dados no espaço de trabalho. |
|
Limitar dados públicos do projeto
|
limit_public_project_data | boolean |
Limite os dados de projetos públicos em relatórios aos administradores. |
|
URL do logótipo
|
logo_url | string |
URL do logotipo do espaço de trabalho. |
|
Máximo de dias de retenção de dados
|
max_data_retention_days | object |
Até que ponto os espaços de trabalho gratuitos podem acessar os dados. |
|
Nome do espaço de trabalho
|
name | string |
Nome do espaço de trabalho. |
|
Somente administradores podem criar projetos
|
only_admins_may_create_projects | boolean |
Apenas os administradores poderão criar projetos. |
|
Somente administradores podem criar tags
|
only_admins_may_create_tags | boolean |
Apenas os administradores poderão criar tags. |
|
Somente administradores veem o Painel da Equipe
|
only_admins_see_team_dashboard | boolean |
Somente os administradores poderão ver o painel da equipe. |
|
ID da Organização
|
organization_id | integer |
Identificador da organização. |
|
Permissions
|
permissions | array of string |
Lista de permissões. |
|
Premium
|
premium | boolean |
Espaço de trabalho na assinatura Starter. |
|
Projetos faturáveis por padrão
|
projects_billable_by_default | boolean |
Novos projetos faturáveis por padrão. |
|
Projetos Enforce Billable
|
projects_enforce_billable | boolean |
Se o acompanhamento do tempo para os projetos imporá uma configuração faturável a ser respeitada. |
|
Projetos privados por padrão
|
projects_private_by_default | boolean |
Configuração do espaço de trabalho para visibilidade padrão do projeto. |
|
Última atualização da tarifa
|
rate_last_updated | string |
Carimbo de data/hora da última atualização da taxa do espaço de trabalho. |
|
Relatórios Fechar
|
reports_collapse | boolean |
Se os relatórios devem ser recolhidos por padrão. |
|
Funções
|
role | string |
Função do usuário atual no espaço de trabalho. |
|
Arredondamento
|
rounding | integer |
Arredondamento padrão, recurso premium. 0 - mais perto, 1 - arredondar para cima, -1 - arredondar para baixo. |
|
Minutos de arredondamento
|
rounding_minutes | integer |
Arredondamento padrão em minutos, recurso premium. |
|
Subscription
|
subscription | object |
Detalhes da subscrição (preterido). |
|
Suspenso em
|
suspended_at | string |
Carimbo de data/hora da suspensão. |
|
Restrições de entrada de tempo
|
te_constraints | object |
Definição de restrições de entrada de tempo. |
|
Horas de trabalho em minutos
|
working_hours_in_minutes | integer |
Horas de trabalho em minutos. |
Característica
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Ativado(a)
|
enabled | boolean |
Se a caraterística está ativada. |
|
ID de Funcionalidade
|
feature_id | integer |
ID do recurso. |
|
Nome do recurso
|
name | string |
Nome do recurso. |
WorkspaceCaracterísticas
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Caraterísticas
|
features | array of Feature |
Lista de recursos. |
|
ID do espaço de trabalho
|
workspace_id | integer |
ID do espaço de trabalho. |
LocalizaçãoResposta
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
City
|
city | string |
Nome da cidade. |
|
Coordenadas da cidade
|
city_lat_long | string |
Latitude e longitude da cidade. |
|
Código do país
|
country_code | string |
Código do país. |
|
Nome do país
|
country_name | string |
Nome do país. |
|
Estado
|
state | string |
Estado ou região. |
Organização
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Administrador
|
admin | boolean |
Se o solicitante é um administrador da organização. |
|
Última modificação
|
at | string |
Data da última modificação da organização. |
|
Criado em
|
created_at | string |
Data de criação da organização. |
|
ID da Organização
|
id | integer |
ID da organização. |
|
Multi Workspace Ativado
|
is_multi_workspace_enabled | boolean |
É true quando a opção de organização is_multi_workspace_enabled é definida. |
|
É unificado
|
is_unified | boolean |
É uma organização unificada. |
|
Máximo de dias de retenção de dados
|
max_data_retention_days | object |
Até que ponto os espaços de trabalho gratuitos nesta organização podem aceder aos dados. |
|
Máximo de espaços de trabalho
|
max_workspaces | integer |
Número máximo de espaços de trabalho permitidos para a organização. |
|
Nome da Organização
|
name | string |
Nome da Organização. |
|
Proprietário
|
owner | boolean |
Se o solicitante é o proprietário da organização. |
|
Permissions
|
permissions | array of string |
Permissões da organização. |
|
Plano de Preços Enterprise
|
pricing_plan_enterprise | boolean |
O plano de subscrição é um plano empresarial. |
|
ID do Plano de Preços
|
pricing_plan_id | integer |
ID do plano de organização. |
|
Nome do plano de preços
|
pricing_plan_name | string |
O nome do plano de assinatura em que a organização está no momento. |
|
Suspenso em
|
suspended_at | string |
Se a organização está suspensa no momento. |
|
trial_info
|
trial_info | TrialInfo | |
|
Contagem de usuários
|
user_count | integer |
Número de usuários da organização. |
TrialInfo
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Pode ter julgamento
|
can_have_trial | boolean |
É verdade se nem a organização nem o proprietário nunca tiveram um julgamento antes. |
|
ID do Último Plano de Preços
|
last_pricing_plan_id | integer |
ID do último plano de preços. |
|
Próxima Data de Pagamento
|
next_payment_date | string |
Próxima data de pagamento. |
|
Ensaio
|
trial | boolean |
Se a subscrição da organização está atualmente em fase de avaliação. |
|
Versão experimental disponível
|
trial_available | boolean |
Quando uma versão de avaliação estiver disponível para esta organização (Preterido). |
|
Data de Fim do Período Experimental
|
trial_end_date | string |
Data de fim do período experimental. |
|
ID do plano de avaliação
|
trial_plan_id | integer |
ID do plano de avaliação. |
Lembrete da faixa
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
created_at | string |
Tempo de criação do lembrete. |
|
Frequência
|
frequency | integer |
A frequência do lembrete em dias, deve ser de 1 ou 7. |
|
IDs de grupo
|
group_ids | array of integer |
IDs de grupos para os quais enviar o lembrete. |
|
ID do lembrete
|
reminder_id | integer |
ID do lembrete. |
|
Limite
|
threshold | integer |
Limite é o número de horas após as quais o lembrete será enviado. |
|
IDs de utilizador
|
user_ids | array of integer |
IDs de usuário para os quais enviar o lembrete. |
|
ID do espaço de trabalho
|
workspace_id | integer |
ID do espaço de trabalho. |
TrackLembretesResposta
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Lembretes de rastreamento
|
items | array of TrackReminder |
Retorna uma lista de lembretes de faixa. |
BulkEditResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Falhas
|
failure | array of BulkEditFailure |
Lista de operações falhadas. |
|
IDs de sucesso
|
success | array of integer |
Os IDs para os quais o patch foi bem-sucedido. |
BulkEditFailure
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID com falha
|
id | integer |
O ID para o qual a operação de patch falhou. |
|
Mensagem de erro
|
message | string |
O motivo da falha da operação. |
WorkspaceUser
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
2FA ativado
|
2fa_enabled | boolean |
Sinalizador que indica se o uso tem 2FA habilitado ou não. |
|
Active
|
active | boolean |
Sinalizador que indica se o usuário aceitou o convite. |
|
Administrador
|
admin | boolean |
Sinalizador que indica se o usuário é administrador. |
|
Última atualização
|
at | string |
Carimbo de data/hora da última atualização. |
|
Avatar URL
|
avatar_file_name | string |
URL do avatar. |
|
Email
|
string |
E-mail do usuário. |
|
|
IDs de grupo
|
group_ids | array of integer |
Lista de grupos aos quais o usuário pertence. |
|
ID do espaço de trabalho do usuário
|
id | integer |
Identificador do espaço de trabalho do usuário. |
|
Inativos
|
inactive | boolean |
Sinalizador que indica se o usuário foi desativado pelo administrador do espaço de trabalho. |
|
Código de convite
|
invitation_code | string |
Código de convite interno. |
|
URL do convite
|
invite_url | string |
URL de convite interno. |
|
É Membro Direto
|
is_direct | boolean |
Sinalizador que indica se o usuário é um membro direto do espaço de trabalho (não é atribuído ao espaço de trabalho usando o grupo). |
|
Custo da mão de obra
|
labor_cost | double |
Custo de mão de obra atribuído ao usuário. |
|
Custo da mão de obra atualizado pela última vez
|
labor_cost_last_updated | string |
Carimbo de data/hora da última atualização do custo da mão de obra. |
|
Nome
|
name | string |
Nome do usuário. |
|
Administrador da Organização
|
organization_admin | boolean |
Sinalizador que indica se o usuário é administrador dentro da organização. |
|
Tarifa
|
rate | double |
Taxa atribuída ao utilizador. |
|
Última atualização da tarifa
|
rate_last_updated | string |
Carimbo de data/hora da última atualização de tarifa. |
|
Funções
|
role | string |
Papel do utilizador. |
|
ID da função
|
role_id | integer |
ID da função. |
|
Timezone
|
timezone | string |
Fuso horário do usuário. |
|
ID de utilizador global
|
uid | integer |
Identificador de utilizador global. |
|
ID de utilizador
|
user_id | integer |
Campo JSON alternativo de UserID, usado apenas por get-organization-workspaces-workspaceusers. |
|
Ver Editar Taxas Faturáveis
|
view_edit_billable_rates | boolean |
Sinalizadores de permissão de taxa granular. Só entra em vigor em funções com permissões de taxa condicional. |
|
Ver Editar Custos de Mão de obra
|
view_edit_labor_costs | boolean |
Ver permissão de edição de custos de mão de obra. |
|
ID do espaço de trabalho
|
wid | integer |
Identificador do espaço de trabalho. |
|
Horas de trabalho em minutos
|
working_hours_in_minutes | integer |
As horas de trabalho são valorizadas em minutos. |
|
Administrador do espaço de trabalho
|
workspace_admin | boolean |
Sinalizador que indica se o usuário é administrador dentro do espaço de trabalho. |
|
ID do espaço de trabalho
|
workspace_id | integer |
Campo JSON alternativo de UserID, usado apenas por get-organization-workspaces-workspaceusers. |
Tarifa
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Montante
|
amount | double |
Montante da taxa. |
|
Criado em
|
created_at | string |
Data de criação da taxa. |
|
ID do criador
|
creator_id | integer |
ID do criador. |
|
Suprimido em
|
deleted_at | string |
Data de exclusão da taxa, caso seja nula, significa que as taxas estão ativas. |
|
Data de fim
|
end | string |
Data de término da tarifa. |
|
ID da taxa
|
id | integer |
Identificador da taxa. |
|
ID da Tarefa Planeada
|
planned_task_id | integer |
ID da tarefa planejada na qual a taxa é aplicada. |
|
ID do projeto
|
project_id | integer |
ID do projeto em que a taxa é aplicada. |
|
ID de utilizador do projeto
|
project_user_id | integer |
ID de usuário do projeto que a taxa é aplicada. |
|
Modo de Alteração de Tarifa
|
rate_change_mode | string |
Modo de mudança de taxa. |
|
Data de início
|
start | string |
Data de início hora da tarifa. |
|
Tipo
|
type | string |
Tipo de taxa. |
|
Atualizado em
|
updated_at | string |
Data da última atualização da tarifa. |
|
ID do espaço de trabalho
|
workspace_id | integer |
ID do espaço de trabalho em que a taxa é aplicada. |
|
ID de usuário do espaço de trabalho
|
workspace_user_id | integer |
ID de usuário do espaço de trabalho ao qual a taxa é aplicada. |
WorkspaceStatistics
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Administradores
|
admins | array of WorkspaceAdmin |
Lista de administradores de espaço de trabalho. |
|
Contagem de grupos
|
groups_count | integer |
Número de grupos no espaço de trabalho. |
|
Contagem de Membros
|
members_count | integer |
Número de membros no espaço de trabalho. |
WorkspaceAdmin
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
name | string |
Nome do administrador. |
|
ID de utilizador
|
user_id | integer |
ID de usuário do administrador. |
TimeEntryConstraints
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Descrição Necessária
|
description_present | boolean |
A descrição é necessária para entradas de tempo. |
|
Projeto Necessário
|
project_present | boolean |
O projeto é necessário para entradas de tempo. |
|
Tag Obrigatório
|
tag_present | boolean |
A tag é necessária para entradas de tempo. |
|
Tarefa necessária
|
task_present | boolean |
A tarefa é necessária para entradas de tempo. |
|
Restrições ativadas
|
time_entry_constraints_enabled | boolean |
As restrições de entrada de tempo estão habilitadas. |
WorkspaceUserSimple
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Email
|
string |
E-mail do usuário. |
|
|
Nome Completo
|
fullname | string |
Nome do usuário. |
|
ID de utilizador
|
id | integer |
Identificador de utilizador global. |
|
Inativos
|
inactive | boolean |
Inativo indica se o usuário está desativado ou não no espaço de trabalho. |
|
Está ativo
|
is_active | boolean |
IsActive indica se o usuário ingressou no espaço de trabalho. |
|
É Admin (Preterido)
|
is_admin | boolean |
Sinalizador que indica se o usuário é administrador (Preterido). |
|
Funções
|
role | string |
Papel do utilizador. |
ProjectUser
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Última modificação
|
at | string |
Quando foi modificado pela última vez. |
|
ID do Grupo (Legado)
|
gid | integer |
ID do grupo, campo herdado. |
|
ID do grupo
|
group_id | integer |
ID do grupo. |
|
ID de utilizador do projeto
|
id | integer |
ID de usuário do projeto. |
|
Custo da mão de obra
|
labor_cost | double |
Custo de mão de obra para este usuário do projeto. |
|
Custo da mão de obra atualizado pela última vez
|
labor_cost_last_updated | string |
Data da última atualização do custo da mão de obra. |
|
Gestor
|
manager | boolean |
Se o usuário é o gerente do projeto. |
|
ID do projeto
|
project_id | integer |
ID do projeto. |
|
Tarifa
|
rate | double |
Taxa para este usuário do projeto. |
|
Última atualização da tarifa
|
rate_last_updated | string |
Data da última atualização da tarifa. |
|
ID de utilizador
|
user_id | integer |
ID de Utilizador. |
|
ID do espaço de trabalho
|
workspace_id | integer |
ID do espaço de trabalho. |
TimeEntryWebhookEvent
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do Evento
|
event_id | integer |
Identificador exclusivo para o evento webhook. |
|
ID da subscrição
|
subscription_id | integer |
ID da assinatura do webhook que disparou esse evento. |
|
Evento criado em
|
created_at | string |
Quando o evento foi criado. |
|
Carimbo de data/hora do evento
|
timestamp | string |
Quando o evento foi enviado. |
|
ID do criador
|
creator_id | integer |
ID do usuário que disparou o evento. |
|
URL de retorno de chamada
|
url_callback | string |
A URL de retorno de chamada para este evento. |
|
Tipo de Pedido
|
metadata.request_type | string |
Tipo de solicitação que disparou o evento. |
|
ID de usuário do evento
|
metadata.event_user_id | integer |
ID do usuário associado ao evento. |
|
Ação
|
metadata.action | string |
Ação executada (criada, atualizada, excluída, iniciada, interrompida). |
|
payload
|
payload | TimeEntry |