Timeneye (Pré-visualização)
Essa interface permite que os usuários integrem os recursos de rastreamento e gerenciamento de tempo do Timeneye com vários aplicativos e serviços no ecossistema da Microsoft. Ao aproveitar essa interface, os usuários podem automatizar fluxos de trabalho, sincronizar dados de controle de tempo e melhorar a produtividade por meio da integração perfeita com outras ferramentas.
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 | Support |
| URL | https://support.timeneye.com/ |
| info@timeneye.com |
| Metadados do conector | |
|---|---|
| Editora | DM Digital Software SRL |
Conector da API Timeneye
Timeneye é uma ferramenta de controle de tempo projetada para ajudá-lo a gerenciar seus projetos de forma eficiente. Este conector permite-lhe interagir com o Timeneye através da API, permitindo-lhe integrar os seus dados de controlo de tempo com vários serviços.
Pré-requisitos
Antes de utilizar este conector, irá necessitar de:
- Uma conta Timeneye. Se você não tiver um, você pode se inscrever aqui.
Introdução
Configure o conector:
- Abra a Power Platform e vá para a seção de conectores.
- Procure o conector Timeneye.
- Autentique-se usando o fluxo OAuth 2.0 quando solicitado.
Limitação de Velocidade
Para poder oferecer um serviço confiável a todos os nossos usuários e clientes, limitamos quantas solicitações podem ser realizadas por token a cada 5 minutos.
Cada token tem um número limitado de solicitações (na tabela abaixo) que podem ser executadas em uma determinada janela de tempo. A contagem de solicitações é redefinida a cada 5 minutos.
O número de solicitações que podem ser realizadas a cada 5 minutos muda de acordo com qual plano tem a conta do usuário, no momento da solicitação.
| Plan | Máximo de pedidos por 5 minutos |
|---|---|
| Gratuito | 500 |
| Business (qualquer nível)/PRO | 2000 |
Caso o limite seja atingido, as seguintes solicitações (para o token fornecido) receberão um 429 erro.
A resposta conterá os seguintes cabeçalhos: | Cabeçalho | Valor de exemplo | Descrição | |--|--|--| | X-RateLimit-Limit | 2000 | Quantos pedidos pode fazer | | X-RateLimit-Remaining | 0 | Quantos pedidos restantes restam | | Retry-After | 177º | Indica quantos segundos aguardar antes de fazer uma solicitação de acompanhamento.| | X-RateLimit-Reset | 1691677002 | Indica quando o limite é redefinido (carimbo de data/hora do UNIX) |
Errors
Todos os nossos endpoints de API retornam um código de status HTTP 200 quando tudo funciona como esperado, mas às vezes ele pode retornar um erro.
Nossas APIs retornam diferentes códigos de erro com base na causa da falha, variando de parâmetros ausentes a erros de servidor do nosso lado.
Na tabela abaixo você encontra uma lista de todos os nossos códigos de erro com uma descrição genérica da causa, caso o endpoint não retorne uma descrição do caso específico.
| Código | Meaning | Description |
|---|---|---|
| 400 | Solicitação inválida | Um ou vários parâmetros necessários estão ausentes ou são inválidos. |
| 401 | Não autorizado | O token de autorização está ausente, inválido ou expirado. |
| 403 | Proibido | A autenticação e a sintaxe da solicitação estão corretas, mas o recurso que você está tentando editar requer um nível de acesso que o usuário autorizado não tem. |
| 403 | Não encontrado | O recurso solicitado não está disponível. |
| 403 | Não encontrado | O recurso solicitado não está disponível. |
| 422 | Validation | Os parâmetros ou a carga útil passada não seguem a especificação exigida |
| 429 | Demasiados pedidos | Atingiu o seu limite de tarifa. |
| 500 | Erro interno do servidor | Houve um problema do nosso lado. |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Atualizar conta |
Atualiza uma conta |
| Atualizar Group-User relação |
Atualiza a relação entre um usuário e um grupo |
| Atualizar Project-Tag relação |
Atualizar relação de lista de marcas de projeto |
| Atualizar Project-User relação |
Atualiza a relação entre um projeto e um usuário |
| Atualizar relação Project-Tag Lista |
Atualizar relação de lista de marcas de projeto |
| Atualizar um cliente |
Atualiza um cliente |
| Atualizar um grupo |
Atualizar um grupo |
| Atualizar um orçamento |
Atualiza um orçamento |
| Atualizar um projeto |
Atualiza um projeto |
| Atualizar um temporizador |
Atualiza um temporizador |
| Atualizar um Todo |
Atualiza um todo |
| Atualizar um usuário |
Atualiza um usuário |
| Atualizar uma categoria de fase |
Atualizar uma categoria de fase |
| Atualizar uma entrada |
Atualiza uma entrada |
| Atualizar uma fase |
Atualiza uma fase |
| Atualizar uma lista completa |
Atualiza uma lista de tags |
| Atualizar uma lista de tags |
Atualiza uma lista de tags |
| Atualizar uma tag |
Atualiza uma tag |
| Criar Group-Project relação |
Anexar um projeto a um grupo |
| Criar Group-User relação |
Anexar um utilizador a um grupo |
| Criar Project-Tag relação |
Criar Project-Tag relação de lista |
| Criar Project-User relação |
Anexar um usuário a um projeto |
| Criar relação Project-Tag Lista |
Criar Project-Tag relação de lista |
| Criar um avatar |
Cria um avatar |
| Criar um cliente |
Cria um cliente |
| Criar um grupo |
Criar Grupo |
| Criar um orçamento |
Cria um orçamento |
| Criar um projeto |
Cria um projeto |
| Criar um temporizador |
Cria um temporizador |
| Criar um Todo |
Criar um todo |
| Criar uma categoria de fase |
Cria uma categoria de fase |
| Criar uma entrada |
Cria uma entrada |
| Criar uma fase |
Criar uma nova fase |
| Criar uma lista completa |
Criar uma lista de tarefas |
| Criar uma lista de tags |
Cria uma lista de tags |
| Criar uma tag |
Cria uma tag |
| Excluir Group-Project relação |
Removido um projeto de um grupo |
| Excluir Group-User relação |
Removido um utilizador de um grupo |
| Excluir Project-Tag relação |
Remover relação de marca de projeto |
| Excluir Project-Tag relação Lista |
Remover relação de lista de marcas de projeto |
| Excluir Project-User relação |
Removido um usuário de um projeto |
| Excluir um cliente |
Exclui um cliente |
| Excluir um grupo |
Eliminar um grupo |
| Excluir um orçamento |
Exclui um orçamento |
| Excluir um projeto |
Exclui um projeto |
| Excluir um temporizador |
Excluir um temporizador |
| Excluir um Todo |
Exclui um todo |
| Excluir um usuário |
Exclui um usuário |
| Excluir uma categoria de fase |
Excluir uma categoria de fase |
| Excluir uma entrada |
Eliminar uma entrada |
| Excluir uma fase |
Exclui uma fase |
| Excluir uma lista completa |
Exclui uma lista todo |
| Excluir uma lista de tags |
Exclui uma lista de tags |
| Excluir uma sugestão de entrada |
Exclui uma sugestão de entrada |
| Excluir uma tag |
Exclui uma tag |
| Lista de Utilizadores |
Obter uma lista de utilizadores |
| Listar categorias de fase |
Obter a lista das categorias de fase |
| Listar clientes |
Obter lista de clientes |
| Listar Entradas |
Obter lista de entradas |
| Listar fases |
Listar todas as fases |
| Listar Grupos |
Obter a lista de todos os grupos |
| Listar idiomas |
Obter lista de idiomas |
| Listar Listas Completas |
Obter uma lista de listas de tarefas |
| Listar listas de tags |
Obter lista de listas de tags |
| Listar moedas |
Obter lista de moedas |
| Listar Orçamentos |
Obter lista de orçamentos |
| Listar Países |
Obter lista de países |
| Listar Projetos |
Obter uma lista de projetos |
| Listar tags |
Obter lista de tags |
| Listar temporizadores |
Obter lista de temporizadores |
| Listar Todos |
Obter uma lista de todos |
| Listar Zonas |
Obter lista de zonas |
| Obter Conta |
Obtém as informações sobre a conta de usuário |
| Obter Inscrições |
Obter uma entrada |
| Obter um cliente |
Obter um cliente |
| Obter um grupo |
Obter um grupo |
| Obter um orçamento |
Obtenha um orçamento |
| Obter um projeto |
Obtém um projeto |
| Obter um temporizador |
Obter um temporizador |
| Obter um Todo |
Obtém um único todo |
| Obter um utilizador |
Obtém um único usuário |
| Obter uma categoria de fase |
Obter uma categoria de fase |
| Obter uma etiqueta |
Obter uma única etiqueta |
| Obter uma fase |
Obtém uma fase |
| Obter uma Lista Completa |
Obtém uma única lista de tarefas |
| Obter uma lista de tags |
Obtém uma única lista de tags |
| Sugestões de entrada de lista |
Obter uma lista de sugestões de entrada para um determinado período de tempo |
Atualizar conta
Atualiza uma conta
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
application/json |
|
|
account_name
|
account_name | string |
O nome da conta, geralmente o nome da empresa. |
|
|
adminNewEntryForOutros
|
adminNewEntryForOthers | boolean |
Possibilidade de adicionar entradas em nome de outros usuários |
|
|
allow_password_login
|
allow_password_login | boolean |
Se o login com e-mail + senha é permitido ou não |
|
|
idp_cert
|
idp_cert | string |
Certificado do provedor de identidade (usado com type = saml) |
|
|
idp_entity_id
|
idp_entity_id | string |
ID do provedor de identidade (usado com type = saml) |
|
|
idp_metadata_url
|
idp_metadata_url | string |
ID do provedor de identidade (usado com type = saml) |
|
|
idp_sso_url
|
idp_sso_url | string |
URL de Logon Único (usado com o tipo = saml) |
|
|
tipo
|
type | string |
Tipo de método de login |
|
|
código da moeda
|
currencyCode | string |
Código da moeda utilizada |
|
|
enabled
|
enabled | boolean |
Se a automação do bloqueio de entrada está habilitada ou não |
|
|
intervalo
|
interval | string |
Intervalo do bloqueio de entrada |
|
|
interval_target
|
interval_target | number |
Entre 1 e 31 se o intervalo for mensal (o dia do mês), Entre 0 e 6i se o intervalo for semanal |
|
|
membroAverageCost
|
memberAverageCost | number |
Indica o custo médio da mão de obra para os membros da conta |
|
|
showWorkingTime
|
showWorkingTime | boolean |
Se os usuários podem ou não ver seu tempo de trabalho em seu painel. (por exemplo, 7h de 8h) |
Atualizar Group-User relação
Atualiza a relação entre um usuário e um grupo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
agrupar
|
group | True | string | |
|
utilizador
|
user | True | string | |
|
Aceitar
|
Accept | string |
application/json |
|
|
is_gm
|
is_gm | boolean |
Informa se o usuário é gerente de grupo do grupo |
Atualizar Project-Tag relação
Atualizar relação de lista de marcas de projeto
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
projecto
|
project | True | string | |
|
etiqueta
|
tag | True | string | |
|
budget_amount
|
budget_amount | number |
O valor orçado alocado para esta tag neste projeto |
|
|
budget_minutes
|
budget_minutes | integer |
As atas orçamentadas atribuídas a esta etiqueta neste projeto |
|
|
budget_amount
|
budget_amount | number |
O valor orçado alocado para esta tag neste projeto |
|
|
budget_minutes
|
budget_minutes | integer |
As atas orçamentadas atribuídas a esta etiqueta neste projeto |
Atualizar Project-User relação
Atualiza a relação entre um projeto e um usuário
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
projecto
|
project | True | string | |
|
utilizador
|
user | True | string | |
|
budget_minutes
|
budget_minutes | integer |
As atas orçamentadas para este utilizador neste projeto |
|
|
hourly_rate
|
hourly_rate | number |
A taxa horária para este usuário neste projeto. Tem precedência sobre a taxa horária no nível do projeto e a taxa horária no nível da conta |
|
|
is_favorited
|
is_favorited | boolean |
Se o projeto é ou não favorito pelo usuário |
|
|
is_pm
|
is_pm | boolean |
Se o usuário é ou não gerente de projeto do projeto |
Atualizar relação Project-Tag Lista
Atualizar relação de lista de marcas de projeto
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
projecto
|
project | True | string | |
|
tag_list
|
tag_list | True | string | |
|
budget_amount
|
budget_amount | number |
O valor orçado alocado para esta lista de tags neste projeto |
|
|
budget_minutes
|
budget_minutes | integer |
As atas orçamentadas atribuídas a esta etiqueta de lista neste projeto |
|
|
budget_amount
|
budget_amount | number |
O valor orçado alocado para esta lista de tags neste projeto |
|
|
budget_minutes
|
budget_minutes | integer |
As atas orçamentadas atribuídas a esta lista de etiquetas neste projeto |
|
|
required
|
required | boolean |
Atualizar um cliente
Atualiza um cliente
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
cliente
|
client | True | string | |
|
Aceitar
|
Accept | string |
application/json |
|
|
color
|
color | True | string |
Cor usada em relatórios |
|
nome
|
name | True | string |
Cor usada em relatórios |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do cliente
|
client_id | integer |
Identificador exclusivo |
|
color
|
color | string |
Cor usada em relatórios |
|
is_active
|
is_active | boolean |
Se o cliente está ou não arquivado |
|
nome
|
name | string |
Nome do cliente |
Atualizar um grupo
Atualizar um grupo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
agrupar
|
group | True | string | |
|
Aceitar
|
Accept | string |
application/json |
|
|
color
|
color | string |
A cor usada para relatórios |
|
|
nome
|
name | string |
Nome do grupo |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
color
|
color | string |
A cor usada para relatórios |
|
group_id
|
group_id | integer |
Identificador exclusivo |
|
nome
|
name | string |
Nome do grupo |
Atualizar um orçamento
Atualiza um orçamento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
orçamento
|
budget | True | string | |
|
Aceitar
|
Accept | string |
application/json |
|
|
budget_minutes
|
budget_minutes | integer |
Dia de reposição do orçamento: 1 a 31 se o orçamento for mensal, 0 a 6 se o orçamento for semanal |
|
|
intervalo
|
interval | integer |
Dia de reposição do orçamento: 1 a 31 se o orçamento for mensal, 0 a 6 se o orçamento for semanal |
|
|
periodicidade
|
recurrence | integer |
Recorrência do orçamento: 0 = sem recorrência, 1 = semanal, 2 = mensal |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
budget_id
|
budget_id | integer |
Identificador único do orçamento |
|
budget_minutes
|
budget_minutes | integer |
A quantidade de minutos que o orçamento representa |
|
intervalo
|
interval | integer |
Dia de reposição do orçamento: 1 a 31 se o orçamento for mensal, 0 a 6 se o orçamento for semanal |
|
is_active
|
is_active | integer |
Se o orçamento está ativo ou não |
|
period_end
|
period_end | string |
Formato: AAAA-MM-DD |
|
period_start
|
period_start | string |
Formato: AAAA-MM-DD |
|
project_id
|
project_id | integer |
Identificador do projeto ao qual pertence o orçamento |
|
periodicidade
|
recurrence | integer |
Recorrência do orçamento: 0 = sem recorrência, 1 = semanal, 2 = mensal |
Atualizar um projeto
Atualiza um projeto
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
projecto
|
project | True | string | |
|
Aceitar
|
Accept | string |
application/json |
|
|
api_only
|
api_only | boolean |
Se o projeto é ou não utilizável para controlar o tempo usando apenas as apis. |
|
|
ID do cliente
|
client_id | integer |
Identificador exclusivo de um cliente ao qual o projeto pertence |
|
|
color
|
color | string |
A cor usada para relatórios |
|
|
descrição
|
description | string |
Uma descrição em texto do projeto |
|
|
hourly_rate
|
hourly_rate | number |
A cor usada para relatórios |
|
|
is_billable
|
is_billable | boolean |
Se o projeto é ou não faturável por hora |
|
|
is_public
|
is_public | boolean |
Se o projeto é público ou não, o que significa que ele é visível por todos os usuários no espaço de trabalho e todos podem controlar o tempo nele |
|
|
nome
|
name | string |
O nome do projeto |
Atualizar um temporizador
Atualiza um temporizador
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
temporizador
|
timer | True | string | |
|
Aceitar
|
Accept | string |
application/json |
|
|
date
|
date | string |
Data do temporizador |
|
|
entry_suggestion_id
|
entry_suggestion_id | integer |
Um identificador exclusivo da sugestão de entrada a partir da qual o temporizador é criado |
|
|
Observações
|
notes | string |
Notas sobre o temporizador |
|
|
origin_date
|
origin_date | string |
Formato Y-m-d necessário com repeatable_suggestion_id |
|
|
phase_id
|
phase_id | True | integer |
Identificador único da fase a que pertence o temporizador |
|
project_id
|
project_id | True | integer |
Identificador único do projeto |
|
repeatable_suggestion_id
|
repeatable_suggestion_id | integer |
Um identificador exclusivo da sugestão de entrada repetível a partir da qual o temporizador é criado |
|
|
segundos
|
seconds | integer | ||
|
origem
|
source | string |
Deve ser um dos integration_code disponíveis ou "consistência" |
|
|
source_text
|
source_text | string |
Um texto que descreve a origem do temporizador |
|
|
source_url
|
source_url | string |
Um texto que descreve a origem do temporizador |
|
|
tag_ids
|
tag_ids | array of integer |
Matriz de tag_id |
|
|
timer_status
|
timer_status | True | string | |
|
user_id
|
user_id | integer |
Identificador exclusivo do usuário que criou o temporizador |
Atualizar um Todo
Atualiza um todo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
todo
|
todo | True | string | |
|
descrição
|
description | string |
Descrição do todo |
|
|
due_date
|
due_date | string |
Os dados pelos quais o todo deve ser completado |
|
|
indexar
|
index | integer |
O índice do todo na lista (ordem) |
|
|
is_completed
|
is_completed | boolean |
Se o todo está ou não marcado como concluído |
|
|
nome
|
name | string |
Título do todo |
|
|
priority
|
priority | string |
Se o todo está ou não marcado como concluído |
|
|
project_id
|
project_id | integer |
Identificador único do projeto ao qual o todo pertence |
|
|
start_date
|
start_date | string |
A data em que o processo deve ser tomado a cargo |
|
|
estado
|
status | string |
O estado atual do todo |
|
|
tag_ids
|
tag_ids | array of integer |
Matriz de tag_id a ser vinculada ao todo |
|
|
todo_list_id
|
todo_list_id | integer |
Identificador exclusivo da lista todo à qual o todo pertence |
|
|
user_id
|
user_id | integer |
Identificador exclusivo do usuário atribuído ao todo |
|
|
user_ids
|
user_ids | array of integer |
Matriz de user_id representando os usuários atribuídos ao todo |
Devoluções
- response
- object
Atualizar um usuário
Atualiza um usuário
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
utilizador
|
user | True | string | |
|
group_id
|
group_id | integer |
Identificador exclusivo do grupo ao qual o usuário pertence |
|
|
user_hourly_cost
|
user_hourly_cost | integer |
O custo horário do usuário, expresso na moeda selecionada nas configurações da conta |
|
|
user_hourly_rate
|
user_hourly_rate | integer |
A taxa horária do usuário, expressa na moeda selecionada nas configurações da conta |
|
|
working_time
|
working_time | integer |
Quantas horas o usuário normalmente está trabalhando em um dia |
|
|
workspace_access_level
|
workspace_access_level | string |
O papel do usuário no Timeneye: proprietário, administrador ou membro |
Atualizar uma categoria de fase
Atualizar uma categoria de fase
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
phase_category
|
phase_category | True | string | |
|
Aceitar
|
Accept | string |
application/json |
|
|
color
|
color | string |
A cor usada para relatórios |
|
|
nome
|
name | string |
Nome da categoria de fase |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
color
|
color | string |
A cor usada para relatórios |
|
nome
|
name | string |
Nome da categoria de fase |
|
phase_category_id
|
phase_category_id | integer |
Identificador exclusivo |
Atualizar uma entrada
Atualiza uma entrada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
introdução
|
entry | True | string | |
|
Aceitar
|
Accept | string |
application/json |
|
|
faturado
|
billed | integer |
0 = Entrada faturável, 1 = Entrada faturada, 2 = Entrada não faturável |
|
|
date
|
date | string |
Data da inscrição |
|
|
entry_suggestion_id
|
entry_suggestion_id | integer |
Um identificador exclusivo da sugestão de entrada a partir da qual a entrada é criada |
|
|
minutes
|
minutes | integer |
Quantidade de tempo rastreado em minutos |
|
|
Observações
|
notes | string |
Notas sobre a entrada de hora |
|
|
origin_date
|
origin_date | string |
Formato Y-m-d necessário com repeatable_suggestion_id |
|
|
phase_id
|
phase_id | integer |
Identificador único da fase a que a entrada pertence |
|
|
project_id
|
project_id | integer |
Identificador único do projeto |
|
|
repeatable_suggestion_id
|
repeatable_suggestion_id | integer |
Um identificador exclusivo da sugestão de entrada repetível a partir da qual a entrada é criada |
|
|
origem
|
source | string |
Deve ser um dos integration_code disponíveis ou "consistência" |
|
|
source_text
|
source_text | string |
Um texto que descreve a origem da entrada |
|
|
source_url
|
source_url | string |
Um texto que descreve a origem da entrada |
|
|
tag_ids
|
tag_ids | array of integer |
Matriz de tag_id |
|
|
user_id
|
user_id | integer |
Identificador exclusivo do usuário que criou a entrada |
Atualizar uma fase
Atualiza uma fase
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
fase
|
phase | True | string | |
|
Aceitar
|
Accept | string |
application/json |
|
|
budget_minutes
|
budget_minutes | integer |
Quantidade de tempo orçado para a fase. A soma dos budget_minutes das fases não deve ser superior ao tempo orçamentado para o projeto |
|
|
is_open
|
is_open | integer |
Se a fase é arquivada ou não |
|
|
nome
|
name | string |
O nome da fase |
|
|
phase_category_id
|
phase_category_id | integer |
Identificador único da categoria de fase a que a fase pertence |
|
|
project_id
|
project_id | integer |
Identificador único do projeto ao qual a fase pertence |
Atualizar uma lista completa
Atualiza uma lista de tags
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
todo_list
|
todo_list | True | string | |
|
color
|
color | True | string |
A cor usada para relatórios |
|
indexar
|
index | integer |
A cor usada para relatórios |
|
|
nome
|
name | True | string |
Nome da lista todo |
|
project_id
|
project_id | True | integer |
Identificador exclusivo do projeto ao qual a lista todo pertence |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
color
|
color | string |
A cor usada para relatórios |
|
criado_em
|
created_at | string |
Data e hora de criação |
|
indexar
|
index | integer |
O índice da lista completa no quadro (ordem) |
|
nome
|
name | string |
Nome da lista todo |
|
project_id
|
project_id | integer |
Identificador exclusivo do projeto ao qual a lista todo pertence |
|
todo_list_id
|
todo_list_id | integer |
Identificador exclusivo |
|
updated_at
|
updated_at | string |
Data e hora atualizadas |
Atualizar uma lista de tags
Atualiza uma lista de tags
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
tag_list
|
tag_list | True | string | |
|
color
|
color | string |
A cor usada para relatórios |
|
|
nome
|
name | string |
O nome da lista de tags |
|
|
text_color
|
text_color | string |
A cor do texto usado para relatar |
Atualizar uma tag
Atualiza uma tag
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
etiqueta
|
tag | True | string | |
|
Aceitar
|
Accept | string |
application/json |
|
|
color
|
color | string |
A cor usada para relatórios |
|
|
nome
|
name | string |
O nome da tag |
|
|
tag_list_id
|
tag_list_id | integer |
Identificador exclusivo da lista de tags à qual a tag pertence |
Criar Group-Project relação
Anexar um projeto a um grupo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
agrupar
|
group | True | string | |
|
projecto
|
project | True | string | |
|
Aceitar
|
Accept | string |
application/json |
Criar Group-User relação
Anexar um utilizador a um grupo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
agrupar
|
group | True | string | |
|
utilizador
|
user | True | string | |
|
Aceitar
|
Accept | string |
application/json |
|
|
is_gm
|
is_gm | boolean |
Informa se o usuário é gerente de grupo do grupo |
Criar Project-Tag relação
Criar Project-Tag relação de lista
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
projecto
|
project | True | string | |
|
etiqueta
|
tag | True | string | |
|
budget_amount
|
budget_amount | number |
O valor orçado alocado para esta tag neste projeto |
|
|
budget_minutes
|
budget_minutes | integer |
As atas orçamentadas atribuídas a esta etiqueta neste projeto |
|
|
budget_amount
|
budget_amount | number |
O valor orçado alocado para esta tag neste projeto |
|
|
budget_minutes
|
budget_minutes | integer |
As atas orçamentadas atribuídas a esta etiqueta neste projeto |
Criar Project-User relação
Anexar um usuário a um projeto
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
projecto
|
project | True | string | |
|
utilizador
|
user | True | string | |
|
Aceitar
|
Accept | string |
application/json |
|
|
budget_minutes
|
budget_minutes | integer |
As atas orçamentadas para este utilizador neste projeto |
|
|
hourly_rate
|
hourly_rate | number |
A taxa horária para este usuário neste projeto. Tem precedência sobre a taxa horária no nível do projeto e a taxa horária no nível da conta |
|
|
is_favorited
|
is_favorited | boolean |
Se o projeto é ou não favorito pelo usuário |
|
|
is_pm
|
is_pm | boolean |
Se o usuário é ou não gerente de projeto do projeto |
Criar relação Project-Tag Lista
Criar Project-Tag relação de lista
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
projecto
|
project | True | string | |
|
tag_list
|
tag_list | True | string | |
|
budget_amount
|
budget_amount | number |
O valor orçado alocado para esta lista de tags neste projeto |
|
|
budget_minutes
|
budget_minutes | integer |
As atas orçamentadas atribuídas a esta lista de etiquetas neste projeto |
|
|
budget_amount
|
budget_amount | number |
O valor orçado alocado para esta lista de tags neste projeto |
|
|
budget_minutes
|
budget_minutes | integer |
As atas orçamentadas atribuídas a esta lista de etiquetas neste projeto |
|
|
required
|
required | boolean |
Se a tag é ou não necessária para entradas de tempo deste projeto |
Criar um avatar
Cria um avatar
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
application/json |
|
|
imagem
|
image | True | binary |
Um ficheiro que contém uma imagem |
|
user_id
|
user_id | integer |
Identificador do usuário que tem este avatar |
|
|
account_id
|
account_id | integer |
Identificador da conta que tem este avatar |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
account_id
|
account_id | integer |
Identificador da conta que tem este avatar |
|
avatar_name
|
avatar_name | string |
nome de arquivo exclusivo |
|
avatar_url
|
avatar_url | string |
URL da imagem |
|
user_id
|
user_id | integer |
Identificador do usuário que tem este avatar |
Criar um cliente
Cria um cliente
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
application/json |
|
|
color
|
color | True | string |
Cor usada em relatórios |
|
nome
|
name | True | string |
Nome do cliente |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do cliente
|
client_id | integer |
Identificador exclusivo |
|
color
|
color | string |
Cor usada em relatórios |
|
is_active
|
is_active | boolean |
Se o cliente está ou não arquivado |
|
nome
|
name | string |
Nome do cliente |
Criar um grupo
Criar Grupo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
application/json |
|
|
color
|
color | string |
A cor usada para relatórios |
|
|
nome
|
name | string |
Nome do grupo |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
color
|
color | string |
A cor usada para relatórios |
|
group_id
|
group_id | integer |
Identificador exclusivo |
|
nome
|
name | string |
Nome do grupo |
Criar um orçamento
Cria um orçamento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
application/json |
|
|
budget_minutes
|
budget_minutes | True | integer |
A quantidade de minutos que o orçamento representa |
|
intervalo
|
interval | integer |
Recorrência do orçamento: 0 = sem recorrência, 1 = semanal, 2 = mensal |
|
|
project_id
|
project_id | True | integer |
Identificador do projeto ao qual pertence o orçamento |
|
periodicidade
|
recurrence | True | integer |
Recorrência do orçamento: 0 = sem recorrência, 1 = semanal, 2 = mensal |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
budget_id
|
budget_id | integer |
Identificador único do orçamento |
|
budget_minutes
|
budget_minutes | integer |
A quantidade de minutos que o orçamento representa |
|
intervalo
|
interval | integer |
Dia de reposição do orçamento: 1 a 31 se o orçamento for mensal, 0 a 6 se o orçamento for semanal |
|
is_active
|
is_active | integer |
Se o orçamento está ativo ou não |
|
period_end
|
period_end | string |
Formato: AAAA-MM-DD |
|
period_start
|
period_start | string |
Formato: AAAA-MM-DD |
|
project_id
|
project_id | integer |
Identificador do projeto ao qual pertence o orçamento |
|
periodicidade
|
recurrence | integer |
Recorrência do orçamento: 0 = sem recorrência, 1 = semanal, 2 = mensal |
Criar um projeto
Cria um projeto
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
api_only
|
api_only | boolean |
Se o projeto é público ou não, o que significa que ele é visível por todos os usuários no espaço de trabalho e todos podem controlar o tempo nele |
|
|
ID do cliente
|
client_id | integer |
Se o projeto é público ou não, o que significa que ele é visível por todos os usuários no espaço de trabalho e todos podem controlar o tempo nele |
|
|
color
|
color | True | string |
A cor usada para relatórios |
|
descrição
|
description | string |
Uma descrição em texto do projeto |
|
|
hourly_rate
|
hourly_rate | number |
A cor usada para relatórios |
|
|
is_billable
|
is_billable | boolean |
Se o projeto é público ou não, o que significa que ele é visível por todos os usuários no espaço de trabalho e todos podem controlar o tempo nele |
|
|
is_public
|
is_public | boolean |
Se o projeto é público ou não, o que significa que ele é visível por todos os usuários no espaço de trabalho e todos podem controlar o tempo nele |
|
|
nome
|
name | True | string |
O nome do projeto |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
api_only
|
api_only | integer |
Se o projeto é ou não utilizável para controlar o tempo usando apenas as apis. |
|
ID do cliente
|
client_id | integer |
Identificador exclusivo de um cliente ao qual o projeto pertence |
|
color
|
color | string |
A cor usada para relatórios |
|
descrição
|
description | string |
Uma descrição em texto do projeto |
|
hourly_rate
|
hourly_rate | string |
A taxa horária geral do projeto. Uma hourly_rate específica pode ser definida na relação projeto-usuário |
|
is_active
|
is_active | integer |
Se o projeto está ou não arquivado |
|
is_billable
|
is_billable | integer |
Se o projeto é ou não faturável por hora |
|
is_public
|
is_public | integer |
Se o projeto é público ou não, o que significa que ele é visível por todos os usuários no espaço de trabalho e todos podem controlar o tempo nele |
|
nome
|
name | string |
O nome do projeto |
|
project_id
|
project_id | integer |
Identificador exclusivo |
Criar um temporizador
Cria um temporizador
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
application/json |
|
|
date
|
date | string |
Data do temporizador |
|
|
entry_suggestion_id
|
entry_suggestion_id | integer |
Um identificador exclusivo da sugestão de entrada a partir da qual o temporizador é criado |
|
|
Observações
|
notes | string |
Notas sobre o temporizador |
|
|
origin_date
|
origin_date | string |
Formato Y-m-d necessário com repeatable_suggestion_id |
|
|
phase_id
|
phase_id | True | integer |
Identificador único da fase a que pertence o temporizador |
|
project_id
|
project_id | True | integer |
Identificador único do projeto |
|
repeatable_suggestion_id
|
repeatable_suggestion_id | integer |
Um identificador exclusivo da sugestão de entrada repetível a partir da qual o temporizador é criado |
|
|
segundos
|
seconds | integer | ||
|
origem
|
source | string |
Deve ser um dos integration_code disponíveis ou "consistência" |
|
|
source_text
|
source_text | string |
Um texto que descreve a origem do temporizador |
|
|
source_url
|
source_url | string |
Um texto que descreve a origem do temporizador |
|
|
tag_ids
|
tag_ids | array of integer |
Matriz de tag_id |
|
|
timer_status
|
timer_status | True | string | |
|
user_id
|
user_id | integer |
Identificador exclusivo do usuário que criou o temporizador |
Devoluções
- response
- object
Criar um Todo
Criar um todo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
descrição
|
description | string |
Descrição do todo |
|
|
due_date
|
due_date | string |
Os dados pelos quais o todo deve ser completado |
|
|
indexar
|
index | integer |
O índice do todo na lista (ordem) |
|
|
is_completed
|
is_completed | boolean |
Se o todo está ou não marcado como concluído |
|
|
nome
|
name | True | string |
Título do todo |
|
priority
|
priority | string |
Se o todo está ou não marcado como concluído |
|
|
start_date
|
start_date | string |
A data em que o processo deve ser tomado a cargo |
|
|
estado
|
status | string |
O estado atual do todo |
|
|
tag_ids
|
tag_ids | array of integer |
Matriz de tag_id a ser vinculada ao todo |
|
|
todo_list_id
|
todo_list_id | True | integer |
Identificador exclusivo da lista todo à qual o todo pertence |
|
user_id
|
user_id | True | integer |
Identificador exclusivo do usuário atribuído ao todo |
|
user_ids
|
user_ids | array of integer |
Matriz de user_id representando os usuários atribuídos ao todo |
Devoluções
- response
- object
Criar uma categoria de fase
Cria uma categoria de fase
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
application/json |
|
|
color
|
color | string |
A cor usada para relatórios |
|
|
nome
|
name | True | string |
Nome da categoria de fase |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
color
|
color | string |
A cor usada para relatórios |
|
nome
|
name | string |
Nome da categoria de fase |
|
phase_category_id
|
phase_category_id | integer |
Identificador exclusivo |
Criar uma entrada
Cria uma entrada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
application/json |
|
|
faturado
|
billed | integer |
0 = Entrada faturável, 1 = Entrada faturada, 2 = Entrada não faturável |
|
|
date
|
date | True | string |
Data da inscrição |
|
entry_suggestion_id
|
entry_suggestion_id | integer |
Um identificador exclusivo da sugestão de entrada a partir da qual a entrada é criada |
|
|
minutes
|
minutes | True | integer |
Quantidade de tempo rastreado em minutos |
|
Observações
|
notes | string |
Notas sobre a entrada de hora |
|
|
origin_date
|
origin_date | string |
Formato Y-m-d necessário com repeatable_suggestion_id |
|
|
phase_id
|
phase_id | True | integer |
Identificador único da fase a que a entrada pertence |
|
project_id
|
project_id | True | integer |
Identificador único do projeto |
|
repeatable_suggestion_id
|
repeatable_suggestion_id | integer |
Um identificador exclusivo da sugestão de entrada repetível a partir da qual a entrada é criada |
|
|
origem
|
source | string |
Deve ser um dos integration_code disponíveis ou "consistência" |
|
|
source_text
|
source_text | string |
Um texto que descreve a origem da entrada |
|
|
source_url
|
source_url | string |
Um texto que descreve a origem da entrada |
|
|
tag_ids
|
tag_ids | array of integer |
Matriz de tag_id |
|
|
user_id
|
user_id | integer |
Identificador exclusivo do usuário que criou a entrada |
Devoluções
- response
- object
Criar uma fase
Criar uma nova fase
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
application/json |
|
|
budget_minutes
|
budget_minutes | True | integer |
Quantidade de tempo orçado para a fase. A soma dos budget_minutes das fases não deve ser superior ao tempo orçamentado para o projeto |
|
nome
|
name | True | string |
O nome da fase |
|
phase_category_id
|
phase_category_id | integer |
Identificador único da categoria de fase a que a fase pertence |
|
|
project_id
|
project_id | True | integer |
Quantidade de tempo orçado para a fase. A soma dos budget_minutes das fases não deve ser superior ao tempo orçamentado para o projeto |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
budget_minutes
|
budget_minutes | integer |
Quantidade de tempo orçado para a fase. A soma dos budget_minutes das fases não deve ser superior ao tempo orçamentado para o projeto |
|
is_open
|
is_open | integer |
Se a fase é arquivada ou não |
|
nome
|
name | string |
O nome da fase |
|
phase_category_id
|
phase_category_id | integer |
Identificador único da categoria de fase a que a fase pertence |
|
phase_id
|
phase_id | integer |
Identificador exclusivo |
|
project_id
|
project_id | integer |
Identificador único do projeto ao qual a fase pertence |
Criar uma lista completa
Criar uma lista de tarefas
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
color
|
color | True | string |
A cor usada para relatórios |
|
indexar
|
index | integer |
A cor usada para relatórios |
|
|
nome
|
name | True | string |
Nome da lista todo |
|
project_id
|
project_id | True | integer |
Identificador exclusivo do projeto ao qual a lista todo pertence |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
color
|
color | string |
A cor usada para relatórios |
|
criado_em
|
created_at | string |
Data e hora de criação |
|
indexar
|
index | integer |
O índice da lista completa no quadro (ordem) |
|
nome
|
name | string |
Nome da lista todo |
|
project_id
|
project_id | integer |
Identificador exclusivo do projeto ao qual a lista todo pertence |
|
todo_list_id
|
todo_list_id | integer |
Identificador exclusivo |
|
updated_at
|
updated_at | string |
Data e hora atualizadas |
Criar uma lista de tags
Cria uma lista de tags
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
application/json |
|
|
color
|
color | string |
A cor usada para relatórios |
|
|
nome
|
name | string |
O nome da lista de tags |
|
|
text_color
|
text_color | string |
A cor do texto usado para relatar |
Criar uma tag
Cria uma tag
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
application/json |
|
|
nome
|
name | True | string |
O nome da tag |
|
tag_list_id
|
tag_list_id | True | integer |
Identificador exclusivo da lista de tags à qual a tag pertence |
Excluir Group-Project relação
Removido um projeto de um grupo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
agrupar
|
group | True | string | |
|
projecto
|
project | True | string | |
|
Aceitar
|
Accept | string |
application/json |
Excluir Group-User relação
Removido um utilizador de um grupo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
agrupar
|
group | True | string | |
|
utilizador
|
user | True | string | |
|
Aceitar
|
Accept | string |
application/json |
Excluir Project-Tag relação
Remover relação de marca de projeto
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
projecto
|
project | True | string | |
|
etiqueta
|
tag | True | string |
Excluir Project-Tag relação Lista
Remover relação de lista de marcas de projeto
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
projecto
|
project | True | string | |
|
tag_list
|
tag_list | True | string |
Excluir Project-User relação
Removido um usuário de um projeto
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
projecto
|
project | True | string | |
|
utilizador
|
user | True | string | |
|
Aceitar
|
Accept | string |
application/json |
Excluir um cliente
Exclui um cliente
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
cliente
|
client | True | string | |
|
Aceitar
|
Accept | string |
application/json |
Excluir um grupo
Eliminar um grupo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
agrupar
|
group | True | string | |
|
Aceitar
|
Accept | string |
application/json |
Excluir um orçamento
Exclui um orçamento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
orçamento
|
budget | True | string | |
|
Aceitar
|
Accept | string |
application/json |
Excluir um projeto
Exclui um projeto
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
projecto
|
project | True | string | |
|
Aceitar
|
Accept | string |
application/json |
Excluir um temporizador
Excluir um temporizador
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
temporizador
|
timer | True | string | |
|
Aceitar
|
Accept | string |
application/json |
Excluir um Todo
Exclui um todo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
todo
|
todo | True | string | |
|
Aceitar
|
Accept | string |
application/json |
Excluir um usuário
Exclui um usuário
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
utilizador
|
user | True | string | |
|
Aceitar
|
Accept | string |
application/json |
Excluir uma categoria de fase
Excluir uma categoria de fase
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
phase_category
|
phase_category | True | string | |
|
Aceitar
|
Accept | string |
application/json |
Excluir uma entrada
Eliminar uma entrada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
introdução
|
entry | True | string | |
|
Aceitar
|
Accept | string |
application/json |
Excluir uma fase
Exclui uma fase
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
fase
|
phase | True | string | |
|
Aceitar
|
Accept | string |
application/json |
Excluir uma lista completa
Exclui uma lista todo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
todo_list
|
todo_list | True | string | |
|
Aceitar
|
Accept | string |
application/json |
Excluir uma lista de tags
Exclui uma lista de tags
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
tag_list
|
tag_list | True | string | |
|
Aceitar
|
Accept | string |
application/json |
Excluir uma sugestão de entrada
Exclui uma sugestão de entrada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
entry_suggestion
|
entry_suggestion | True | string | |
|
Aceitar
|
Accept | string |
application/json |
Excluir uma tag
Exclui uma tag
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
etiqueta
|
tag | True | string | |
|
Aceitar
|
Accept | string |
application/json |
Lista de Utilizadores
Obter uma lista de utilizadores
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
application/json |
|
|
página
|
page | integer |
A página exibida no momento |
|
|
per_page
|
per_page | integer |
Quantos itens por página |
|
|
sort_by
|
sort_by | string |
O atributo para classificar por |
|
|
direção
|
direction | string |
A direção de classificação |
|
|
enviar SMS
|
text | string |
Pesquisa em texto completo |
|
|
nome
|
name | string |
Pesquisar os utilizadores por nome |
|
|
e-mail
|
string |
Pesquisar os usuários por e-mail |
||
|
estado
|
status | string |
Pesquisar os usuários por status |
|
|
active
|
active | boolean |
Pesquisar os usuários por status ativo |
|
|
group_ids[]
|
group_ids[] | string |
Uma lista separada por vírgulas de ids de grupo para filtrar por |
|
|
group_id
|
group_id | string |
Pesquisar os usuários que pertencem a um grupo |
|
|
member_ids[]
|
member_ids[] | string |
Uma lista separada por vírgulas de IDs de usuário para filtrar por |
|
|
project_ids[]
|
project_ids[] | string |
Uma lista separada por vírgulas de ids de projeto para filtrar por |
|
|
client_ids[]
|
client_ids[] | string |
Uma lista separada por vírgulas de ids de cliente para filtrar por |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
current_page
|
current_page | integer | |
|
dados
|
data | array of | |
|
first_page_url
|
first_page_url | string | |
|
de
|
from | integer | |
|
last_page
|
last_page | integer | |
|
last_page_url
|
last_page_url | string | |
|
next_page_url
|
next_page_url | string | |
|
caminho
|
path | string | |
|
per_page
|
per_page | integer | |
|
prev_page_url
|
prev_page_url | string | |
|
Para
|
to | integer | |
|
total
|
total | integer |
Listar categorias de fase
Obter a lista das categorias de fase
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
application/json |
|
|
página
|
page | integer |
A página exibida no momento |
|
|
per_page
|
per_page | integer |
Quantos itens por página |
|
|
enviar SMS
|
text | string |
Cadeia de pesquisa de texto completo |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
current_page
|
current_page | integer | |
|
dados
|
data | array of | |
|
first_page_url
|
first_page_url | string | |
|
de
|
from | integer | |
|
last_page
|
last_page | integer | |
|
last_page_url
|
last_page_url | string | |
|
next_page_url
|
next_page_url | string | |
|
caminho
|
path | string | |
|
per_page
|
per_page | integer | |
|
prev_page_url
|
prev_page_url | string | |
|
Para
|
to | integer | |
|
total
|
total | integer |
Listar clientes
Obter lista de clientes
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
página
|
page | integer |
A página exibida no momento |
|
|
per_page
|
per_page | integer |
Quantos itens por página |
|
|
sort_by
|
sort_by | string |
O atributo para classificar por |
|
|
direção
|
direction | string |
A direção de classificação |
|
|
enviar SMS
|
text | string |
Pesquisas em nome do cliente |
|
|
member_ids[]
|
member_ids[] | string |
Uma lista separada por vírgulas de ids de cliente para filtrar os resultados |
|
|
Aceitar
|
Accept | string |
application/json |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
dados
|
data | array of object | |
|
ID do cliente
|
data.client_id | integer |
Identificador exclusivo |
|
color
|
data.color | string |
Cor usada em relatórios |
|
is_active
|
data.is_active | boolean |
Se o cliente está ou não arquivado |
|
nome
|
data.name | string |
Nome do cliente |
|
primeiro
|
links.first | string | |
|
último
|
links.last | string | |
|
next
|
links.next | string | |
|
anterior
|
links.prev | string | |
|
current_page
|
meta.current_page | integer | |
|
de
|
meta.from | integer | |
|
last_page
|
meta.last_page | integer | |
|
links
|
meta.links | array of object | |
|
active
|
meta.links.active | boolean | |
|
etiqueta
|
meta.links.label | string | |
|
URL
|
meta.links.url | string | |
|
caminho
|
meta.path | string | |
|
per_page
|
meta.per_page | integer | |
|
Para
|
meta.to | integer | |
|
total
|
meta.total | integer |
Listar Entradas
Obter lista de entradas
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
página
|
page | integer |
A página exibida no momento |
|
|
per_page
|
per_page | integer |
Quantos itens por página |
|
|
sort_by
|
sort_by | string |
O atributo para classificar por |
|
|
direção
|
direction | string |
A direção de classificação |
|
|
member_ids[]
|
member_ids[] | string |
Uma lista separada por vírgulas de IDs de usuário para filtrar os resultados |
|
|
entry_ids[]
|
entry_ids[] | string |
Uma lista separada por vírgulas de ids de entrada para filtrar os resultados |
|
|
project_ids[]
|
project_ids[] | string |
Uma lista separada por vírgulas de ids de projeto para filtrar os resultados |
|
|
phase_ids[]
|
phase_ids[] | string |
Uma lista separada por vírgulas de ids de fase para filtrar os resultados |
|
|
client_ids[]
|
client_ids[] | string |
Uma lista separada por vírgulas de ids de cliente para filtrar os resultados |
|
|
group_ids[]
|
group_ids[] | string |
Uma lista separada por vírgulas de ids de grupo para filtrar os resultados |
|
|
category_ids[]
|
category_ids[] | string |
Uma lista separada por vírgulas de ids de categoria de fase para filtrar os resultados |
|
|
tag_list_ids[]
|
tag_list_ids[] | string |
Uma lista separada por vírgulas de ids de lista de tags para filtrar os resultados |
|
|
tag_ids[]
|
tag_ids[] | string |
Uma lista separada por vírgulas de ids de tag para filtrar os resultados |
|
|
billed_status
|
billed_status | integer |
Obter apenas a entrada que tem um determinado status faturado: 0: Não faturado 1: Faturado 2: Não faturável 3: Faturável |
|
|
Calendário
|
timeframe | string |
Obter apenas as entradas em um determinado período de tempo |
|
|
date_from
|
date_from | string |
Obter apenas as entradas que têm ralador de data ou igual a esta data |
|
|
date_to
|
date_to | string |
Obter apenas as entradas que têm data menor ou igual a esta data |
|
|
enviar SMS
|
text | string |
Obter entradas que contenham este texto nas notas |
|
|
Aceitar
|
Accept | string |
application/json |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
dados
|
data | array of object | |
|
faturado
|
data.billed | integer |
Indica se a entrada foi cobrada |
|
ID do cliente
|
data.client_id | integer |
Identificador exclusivo do cliente que pertence ao projeto da entrada |
|
custo
|
data.cost | string |
O custo monetário da entrada de tempo com base no custo horário do usuário que a criou |
|
created_date
|
data.created_date | string |
Data e hora da criação |
|
entry_date
|
data.entry_date | string |
Data da inscrição |
|
entry_id
|
data.entry_id | integer |
Identificador exclusivo |
|
entry_minutes
|
data.entry_minutes | integer |
Quantidade de tempo rastreado em minutos |
|
bloqueado
|
data.locked | integer |
Se a entrada está bloqueada ou não |
|
locked_by_apionly
|
data.locked_by_apionly | integer |
Se a entrada está ou não bloqueada por restrição apenas em aplicativos de terceiros |
|
locked_by_date
|
data.locked_by_date | integer |
Se a entrada está ou não bloqueada por data |
|
locked_by_membership
|
data.locked_by_membership | integer |
Se a entrada está ou não bloqueada pela associação |
|
Observações
|
data.notes | string |
Notas sobre a entrada de hora |
|
phase_category_id
|
data.phase_category_id | integer |
Identificador único da categoria de fase a que pertence a fase da entrada |
|
phase_id
|
data.phase_id | integer |
Identificador único da fase a que a entrada pertence |
|
lucro
|
data.profit | string |
A diferença entre a receita e o custo |
|
project_id
|
data.project_id | integer |
Identificador único do projeto |
|
receitas
|
data.revenue | string |
A receita monetária da entrada de tempo com base na taxa horária geral, o projeto . |
|
origem
|
data.source | string |
Indica a origem da entrada (se houver) |
|
source_data
|
data.source_data | string |
Dados adicionais da fonte |
|
source_id
|
data.source_id | string |
Um identificador único da origem da entrada |
|
source_text
|
data.source_text | string |
Um texto que descreve a origem da entrada |
|
source_url
|
data.source_url | string |
Um URL para a origem da entrada |
|
suggested_phase_id
|
data.suggested_phase_id | string |
Um identificador opcional de uma fase sugerida se a entrada for criada a partir de uma EntrySuggestion |
|
suggested_project_id
|
data.suggested_project_id | string |
Um identificador opcional de um projeto sugerido se a entrada for criada a partir de um EntrySuggestion |
|
todo_id
|
data.todo_id | string |
O identificador exclusivo de um todo vinculado à entrada de tempo |
|
updated_date
|
data.updated_date | string |
Data e hora da atualização |
|
user_id
|
data.user_id | integer |
Identificador exclusivo do usuário que criou a entrada |
|
primeiro
|
links.first | string | |
|
último
|
links.last | string | |
|
next
|
links.next | string | |
|
anterior
|
links.prev | string | |
|
current_page
|
meta.current_page | integer | |
|
de
|
meta.from | integer | |
|
last_page
|
meta.last_page | integer | |
|
links
|
meta.links | array of object | |
|
active
|
meta.links.active | boolean | |
|
etiqueta
|
meta.links.label | string | |
|
URL
|
meta.links.url | string | |
|
caminho
|
meta.path | string | |
|
per_page
|
meta.per_page | integer | |
|
Para
|
meta.to | integer | |
|
total
|
meta.total | integer |
Listar fases
Listar todas as fases
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
application/json |
|
|
enviar SMS
|
text | string |
Obter fases contendo este texto no nome |
|
|
active
|
active | boolean |
Obter apenas fases ativas ou inativas |
|
|
página
|
page | integer |
A página exibida no momento |
|
|
per_page
|
per_page | integer |
Quantos itens por página |
|
|
project_id
|
project_id | integer |
Obter fases pertencentes a um projeto |
|
|
sort_by
|
sort_by | string |
O atributo para classificar por |
|
|
direção
|
direction | string |
A direção de classificação |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
current_page
|
current_page | integer | |
|
dados
|
data | array of | |
|
first_page_url
|
first_page_url | string | |
|
de
|
from | integer | |
|
last_page
|
last_page | integer | |
|
last_page_url
|
last_page_url | string | |
|
next_page_url
|
next_page_url | string | |
|
caminho
|
path | string | |
|
per_page
|
per_page | integer | |
|
prev_page_url
|
prev_page_url | string | |
|
Para
|
to | integer | |
|
total
|
total | integer |
Listar Grupos
Obter a lista de todos os grupos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
application/json |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
current_page
|
current_page | integer | |
|
dados
|
data | array of | |
|
first_page_url
|
first_page_url | string | |
|
de
|
from | integer | |
|
last_page
|
last_page | integer | |
|
last_page_url
|
last_page_url | string | |
|
next_page_url
|
next_page_url | string | |
|
caminho
|
path | string | |
|
per_page
|
per_page | integer | |
|
prev_page_url
|
prev_page_url | string | |
|
Para
|
to | integer | |
|
total
|
total | integer |
Listar idiomas
Obter lista de idiomas
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
application/json |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
language_code
|
language_code | string |
Identificador exclusivo |
|
nome
|
name | string |
Nome da língua |
Listar Listas Completas
Obter uma lista de listas de tarefas
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
application/json |
|
|
página
|
page | integer |
A página exibida no momento |
|
|
per_page
|
per_page | integer |
Quantos itens por página |
|
|
sort_by
|
sort_by | string |
O atributo para classificar por |
|
|
direção
|
direction | string |
A direção de classificação |
|
|
project_id
|
project_id | integer |
Identificador exclusivo do projeto ao qual a lista todo pertence |
|
|
carregar[]
|
load[] | string |
Uma lista separada por vírgulas de entidades a carregar. ''todos' é o único valor aceito' |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
current_page
|
current_page | integer | |
|
dados
|
data | array of object | |
|
items
|
data | object | |
|
first_page_url
|
first_page_url | string | |
|
de
|
from | integer | |
|
last_page
|
last_page | integer | |
|
last_page_url
|
last_page_url | string | |
|
next_page_url
|
next_page_url | string | |
|
caminho
|
path | string | |
|
per_page
|
per_page | integer | |
|
prev_page_url
|
prev_page_url | string | |
|
Para
|
to | integer | |
|
total
|
total | integer |
Listar listas de tags
Obter lista de listas de tags
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
página
|
page | integer |
A página exibida no momento |
|
|
per_page
|
per_page | integer |
Quantos itens por página |
|
|
sort_by
|
sort_by | string |
O atributo para classificar por |
|
|
direção
|
direction | string |
A direção de classificação |
|
|
project_id
|
project_id | integer |
Obter listas de tags pertencentes a um projeto |
|
|
Aceitar
|
Accept | string |
application/json |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
current_page
|
current_page | integer | |
|
dados
|
data | array of | |
|
first_page_url
|
first_page_url | string | |
|
de
|
from | integer | |
|
last_page
|
last_page | integer | |
|
last_page_url
|
last_page_url | string | |
|
next_page_url
|
next_page_url | string | |
|
caminho
|
path | string | |
|
per_page
|
per_page | integer | |
|
prev_page_url
|
prev_page_url | string | |
|
Para
|
to | integer | |
|
total
|
total | integer |
Listar moedas
Obter lista de moedas
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
application/json |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
currency_code
|
currency_code | string | |
|
nome
|
name | string |
Listar Orçamentos
Obter lista de orçamentos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
página
|
page | integer |
A página exibida no momento |
|
|
per_page
|
per_page | integer |
Quantos itens por página |
|
|
sort_by
|
sort_by | string |
O atributo para classificar por |
|
|
direção
|
direction | string |
A direção de classificação |
|
|
project_id
|
project_id | integer |
Identificador do projeto ao qual pertence o orçamento |
|
|
Aceitar
|
Accept | string |
application/json |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
dados
|
data | array of object | |
|
budget_id
|
data.budget_id | integer |
Identificador único do orçamento |
|
budget_minutes
|
data.budget_minutes | integer |
A quantidade de minutos que o orçamento representa |
|
intervalo
|
data.interval | integer |
Dia de reposição do orçamento: 1 a 31 se o orçamento for mensal, 0 a 6 se o orçamento for semanal |
|
is_active
|
data.is_active | integer |
Se o orçamento está ativo ou não |
|
period_end
|
data.period_end | string |
Formato: AAAA-MM-DD |
|
period_start
|
data.period_start | string |
Formato: AAAA-MM-DD |
|
project_id
|
data.project_id | integer |
Identificador do projeto ao qual pertence o orçamento |
|
periodicidade
|
data.recurrence | integer |
Recorrência do orçamento: 0 = sem recorrência, 1 = semanal, 2 = mensal |
|
primeiro
|
links.first | string | |
|
último
|
links.last | string | |
|
next
|
links.next | string | |
|
anterior
|
links.prev | string | |
|
current_page
|
meta.current_page | integer | |
|
de
|
meta.from | integer | |
|
last_page
|
meta.last_page | integer | |
|
links
|
meta.links | array of object | |
|
active
|
meta.links.active | boolean | |
|
etiqueta
|
meta.links.label | string | |
|
URL
|
meta.links.url | string | |
|
caminho
|
meta.path | string | |
|
per_page
|
meta.per_page | integer | |
|
Para
|
meta.to | integer | |
|
total
|
meta.total | integer |
Listar Países
Obter lista de países
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
application/json |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
company_tax
|
company_tax | string | |
|
country_code
|
country_code | string | |
|
nome
|
name | string | |
|
private_tax
|
private_tax | string | |
|
vat_required
|
vat_required | integer |
Listar Projetos
Obter uma lista de projetos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
application/json |
|
|
público
|
public | boolean |
Obtenha apenas projetos públicos |
|
|
active
|
active | boolean |
Obtenha apenas projetos ativos |
|
|
faturável
|
billable | boolean |
Obtenha apenas projetos faturáveis |
|
|
carregar[]
|
load[] | string |
Uma lista separada por vírgulas de entidades a carregar. Valores possíveis: usuários,orçamento,fases,grupos |
|
|
enviar SMS
|
text | string |
Pesquisa em texto completo |
|
|
ID do cliente
|
client_id | integer |
Obter projetos pertencentes a um cliente identificado por este parâmetro |
|
|
user_id
|
user_id | integer |
Projeto de pesquisa em que o usuário está na equipe |
|
|
página
|
page | integer |
A página exibida no momento |
|
|
per_page
|
per_page | integer |
Quantos itens por página |
|
|
sort_by
|
sort_by | string |
O atributo para classificar por |
|
|
direção
|
direction | string |
A direção de classificação |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
current_page
|
current_page | integer | |
|
dados
|
data | array of | |
|
first_page_url
|
first_page_url | string | |
|
de
|
from | integer | |
|
last_page
|
last_page | integer | |
|
last_page_url
|
last_page_url | string | |
|
next_page_url
|
next_page_url | string | |
|
caminho
|
path | string | |
|
per_page
|
per_page | integer | |
|
prev_page_url
|
prev_page_url | string | |
|
Para
|
to | integer | |
|
total
|
total | integer |
Listar tags
Obter lista de tags
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
application/json |
|
|
nome
|
name | string |
Pesquisa de texto no nome |
|
|
tag_list_id
|
tag_list_id | integer |
Id de uma TagList |
|
|
página
|
page | integer |
A página exibida no momento |
|
|
per_page
|
per_page | integer |
Quantos itens por página |
|
|
sort_by
|
sort_by | string |
O atributo para classificar por |
|
|
direção
|
direction | string |
A direção de classificação |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
current_page
|
current_page | integer | |
|
dados
|
data | array of object | |
|
color
|
data.color | string |
A cor usada para relatórios |
|
is_active
|
data.is_active | integer |
Se a tag está arquivada ou não |
|
nome
|
data.name | string |
O nome da tag |
|
tag_id
|
data.tag_id | integer |
Identificador exclusivo |
|
tag_list_id
|
data.tag_list_id | integer |
Identificador exclusivo da lista de tags à qual a tag pertence |
|
first_page_url
|
first_page_url | string | |
|
de
|
from | integer | |
|
last_page
|
last_page | integer | |
|
last_page_url
|
last_page_url | string | |
|
next_page_url
|
next_page_url | string | |
|
caminho
|
path | string | |
|
per_page
|
per_page | integer | |
|
prev_page_url
|
prev_page_url | string | |
|
Para
|
to | integer | |
|
total
|
total | integer |
Listar temporizadores
Obter lista de temporizadores
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
página
|
page | integer |
A página exibida no momento |
|
|
per_page
|
per_page | integer |
Quantos itens por página |
|
|
sort_by
|
sort_by | string |
O atributo para classificar por |
|
|
direção
|
direction | string |
A direção de classificação |
|
|
date_from
|
date_from | string |
Obtenha apenas os temporizadores que têm ralador de data ou igual a esta data |
|
|
date_to
|
date_to | string |
Obter apenas os temporizadores que têm data menor ou igual a esta data |
|
|
Aceitar
|
Accept | string |
application/json |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
current_page
|
current_page | integer | |
|
dados
|
data | array of | |
|
first_page_url
|
first_page_url | string | |
|
de
|
from | integer | |
|
last_page
|
last_page | integer | |
|
last_page_url
|
last_page_url | string | |
|
next_page_url
|
next_page_url | string | |
|
caminho
|
path | string | |
|
per_page
|
per_page | integer | |
|
prev_page_url
|
prev_page_url | string | |
|
Para
|
to | integer | |
|
total
|
total | integer |
Listar Todos
Obter uma lista de todos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
application/json |
|
|
página
|
page | integer |
A página exibida no momento |
|
|
per_page
|
per_page | integer |
Quantos itens por página |
|
|
sort_by
|
sort_by | string |
O atributo para classificar por |
|
|
direção
|
direction | string |
A direção de classificação |
|
|
project_id
|
project_id | integer |
Identificador único do projeto ao qual o todo pertence |
|
|
todo_list_id
|
todo_list_id | integer |
Identificador exclusivo de uma lista de tarefas |
|
|
user_ids[]
|
user_ids[] | string |
Uma lista separada por vírgulas de identificadores exclusivos de usuário atribuídos aos todos |
|
|
prioridade[]
|
priority[] | string |
Uma lista de prioridades separada por vírgula: Valores permitidos: baixo, médio, alto |
|
|
estado[]
|
status[] | string |
Uma lista de status separada por vírgula. Valores permitidos: todo, in_progress, concluído |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
current_page
|
current_page | integer | |
|
dados
|
data | array of object | |
|
items
|
data | object | |
|
first_page_url
|
first_page_url | string | |
|
de
|
from | integer | |
|
last_page
|
last_page | integer | |
|
last_page_url
|
last_page_url | string | |
|
next_page_url
|
next_page_url | string | |
|
caminho
|
path | string | |
|
per_page
|
per_page | integer | |
|
prev_page_url
|
prev_page_url | string | |
|
Para
|
to | integer | |
|
total
|
total | integer |
Listar Zonas
Obter lista de zonas
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
application/json |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
country_code
|
country_code | string |
Código do país a que pertence a zona |
|
nome
|
name | string |
Nome do fuso horário |
|
zone_id
|
zone_id | integer |
Identificador exclusivo |
Obter Conta
Obtém as informações sobre a conta de usuário
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
application/json |
Obter Inscrições
Obter uma entrada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
introdução
|
entry | True | string | |
|
Aceitar
|
Accept | string |
application/json |
Devoluções
- response
- object
Obter um cliente
Obter um cliente
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
cliente
|
client | True | string | |
|
Aceitar
|
Accept | string |
application/json |
Obter um grupo
Obter um grupo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
agrupar
|
group | True | string | |
|
Aceitar
|
Accept | string |
application/json |
Obter um orçamento
Obtenha um orçamento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
orçamento
|
budget | True | string | |
|
Aceitar
|
Accept | string |
application/json |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
budget_id
|
budget_id | integer |
Identificador único do orçamento |
|
budget_minutes
|
budget_minutes | integer |
A quantidade de minutos que o orçamento representa |
|
intervalo
|
interval | integer |
Dia de reposição do orçamento: 1 a 31 se o orçamento for mensal, 0 a 6 se o orçamento for semanal |
|
is_active
|
is_active | integer |
Se o orçamento está ativo ou não |
|
period_end
|
period_end | string |
Formato: AAAA-MM-DD |
|
period_start
|
period_start | string |
Formato: AAAA-MM-DD |
|
project_id
|
project_id | integer |
Identificador do projeto ao qual pertence o orçamento |
|
periodicidade
|
recurrence | integer |
Recorrência do orçamento: 0 = sem recorrência, 1 = semanal, 2 = mensal |
Obter um projeto
Obtém um projeto
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
projecto
|
project | True | string | |
|
Aceitar
|
Accept | string |
application/json |
Obter um temporizador
Obter um temporizador
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
temporizador
|
timer | True | string | |
|
Aceitar
|
Accept | string |
application/json |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
current_page
|
current_page | integer | |
|
dados
|
data | array of | |
|
first_page_url
|
first_page_url | string | |
|
de
|
from | integer | |
|
last_page
|
last_page | integer | |
|
last_page_url
|
last_page_url | string | |
|
next_page_url
|
next_page_url | string | |
|
caminho
|
path | string | |
|
per_page
|
per_page | integer | |
|
prev_page_url
|
prev_page_url | string | |
|
Para
|
to | integer | |
|
total
|
total | integer |
Obter um Todo
Obtém um único todo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
todo
|
todo | True | string |
Devoluções
- response
- object
Obter um utilizador
Obtém um único usuário
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
utilizador
|
user | True | string |
Obter uma categoria de fase
Obter uma categoria de fase
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
phase_category
|
phase_category | True | string | |
|
Aceitar
|
Accept | string |
application/json |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
color
|
color | string |
A cor usada para relatórios |
|
nome
|
name | string |
Nome da categoria de fase |
|
phase_category_id
|
phase_category_id | integer |
Identificador exclusivo |
Obter uma etiqueta
Obter uma única etiqueta
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
etiqueta
|
tag | True | string | |
|
Aceitar
|
Accept | string |
application/json |
Obter uma fase
Obtém uma fase
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
fase
|
phase | True | string | |
|
Aceitar
|
Accept | string |
application/json |
Obter uma Lista Completa
Obtém uma única lista de tarefas
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
todo_list
|
todo_list | True | string |
Obter uma lista de tags
Obtém uma única lista de tags
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
tag_list
|
tag_list | True | string |
Sugestões de entrada de lista
Obter uma lista de sugestões de entrada para um determinado período de tempo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
application/json |
|
|
página
|
page | integer |
A página exibida no momento |
|
|
per_page
|
per_page | integer |
Quantos itens por página |
|
|
no_paginate
|
no_paginate | boolean |
Obtenha uma lista completa de sugestões sem paginar os resultados |
|
|
Calendário
|
timeframe | string |
Obtenha apenas as sugestões num determinado período de tempo |
|
|
date_from
|
date_from | string |
Receba apenas as sugestões que tenham data raladora ou igual a esta data |
|
|
date_to
|
date_to | string |
Receba apenas as sugestões que tenham data menor ou igual a esta data |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
current_page
|
current_page | integer | |
|
dados
|
data | array of object | |
|
accepted
|
data.accepted | integer |
Se a sugestão é ou não aceite e transformada numa entrada |
|
created_datetime
|
data.created_datetime | string |
Data e hora de criação da sugestão |
|
entry_date
|
data.entry_date | string |
Data sugerida |
|
entry_minutes
|
data.entry_minutes | integer |
Quantidade de tempo sugerida em minutos |
|
entry_suggestion_id
|
data.entry_suggestion_id | integer |
Identificador exclusivo |
|
Observações
|
data.notes | string |
Notas relacionadas com a fonte da sugestão |
|
phase_id
|
data.phase_id | integer |
Identificador exclusivo da fase sugerida |
|
phase_name
|
data.phase_name | string |
Nome da fase sugerida |
|
project_id
|
data.project_id | integer |
Identificador único do projeto sugerido |
|
project_name
|
data.project_name | string |
Nome do projeto sugerido |
|
origem
|
data.source | string |
Identificador de origem |
|
source_data
|
data.source_data | string |
Outros dados relacionados com a fonte |
|
source_id
|
data.source_id | string |
Identificador único da fonte |
|
source_text
|
data.source_text | string |
Texto relacionado com a fonte |
|
source_url
|
data.source_url | string |
URL da fonte da sugestão |
|
todo_id
|
data.todo_id | integer | |
|
user_id
|
data.user_id | integer |
Identificador exclusivo do usuário proprietário da sugestão |
|
first_page_url
|
first_page_url | string | |
|
de
|
from | integer | |
|
last_page
|
last_page | integer | |
|
last_page_url
|
last_page_url | string | |
|
next_page_url
|
next_page_url | string | |
|
caminho
|
path | string | |
|
per_page
|
per_page | integer | |
|
prev_page_url
|
prev_page_url | string | |
|
Para
|
to | integer | |
|
total
|
total | integer |
Definições
objecto
Este é o tipo 'objeto'.