Partilhar via


Finalcad One Connect 4.0 (Pré-visualização)

O Finalcad One é uma plataforma de gerenciamento de construção projetada para melhorar a colaboração, acompanhar o progresso e simplificar as operações de campo. Com esse conector, você pode integrar o Finalcad One com centenas de outros aplicativos para simplificar o acompanhamento de projetos, automatizar tarefas repetitivas e melhorar a eficiência geral.

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 Finalcad
URL https://www.finalcad.com/contact
Email support@finalcad.com
Metadados do conector
Editora FINALCAD
Sítio Web https://developer.finalcad.com/
Política de privacidade https://www.finalcad.com/apps-privacy-policy
Categorias Produtividade

Conector Fc1

Pré-requisitos

To use this connector, you need a Finalcad API key.

Acionadores

When a form is created or updated
When an observation is created or updated
When a document is created

Ações

Read form details
Read observation details
Read project information
Read current user information

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
Chave de API securestring A chave de API 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

Configuração - Idioma e fuso horário

Configurar a configuração de idioma e fuso horário

Espaço de trabalho - Adicionar membros

Adicionar membros a um espaço de trabalho

Media - Obter URL do recurso multimédia

Recuperar a URL para acessar um recurso de mídia

Multimédia - Iniciar carregamento de blocos

Inicie o processo de upload de um arquivo de mídia em partes.

Mídia - Abortar o upload de blocos

Cancele o processo atual de carregamento de partes e descarte todas as partes recebidas.

Mídia - Anexar parte do bloco

Anexe uma parte individual à sessão de upload de mídia em andamento.

Mídia - Validar upload de blocos

Confirme e finalize o upload verificando se todas as partes foram recebidas corretamente.

Obter idiomas

Obtenha todos os idiomas disponíveis para bibliotecas e itens

Obter lista de fusos horários

Obter a lista de fusos horários disponíveis

Organização - Adicionar membros

Adicionar membros a uma organização

Organização - Conecte-se ao usuário

Obtenha suas informações de usuário

Organização - Criar um projeto

Criar um projeto

Organização - Obter espaços de trabalho

Obter espaços de trabalho relacionados com a sua organização

Organização - Obter funções

Obter funções da organização

Organização - Obter lista de organizações

Obtenha a lista de todas as organizações onde é membro

Organização - Obter lista de projetos

Obter a lista de todos os seus projetos em uma determinada organização

Organização - Obter módulos sugeridos

Obter módulos sugeridos relacionados com a sua organização

Organização - Obter status de formulários

Obter o status dos formulários em um modelo

Project - Obter pastas de documentos

Obter pastas de documentos no seu projeto

Project - Obter planos ou pastas

Obter os planos ou pastas no seu projeto

Projeto - Adicionar usuários

Adicionar utilizadores ao seu projeto

Projeto - Criar um documento

Projeto - Criar um documento

Projeto - Criar um formulário

Criar um formulário

Projeto - Criar uma observação

Criar uma observação

Projeto - Obter categorias de formulário

Obter categorias de formulário

Projeto - Obter categorias de observação

Obter categorias de observação (anteriormente trades)

Projeto - Obter detalhes de observação

Obter os detalhes de uma determinada observação (descrição, status, cessionário,...)

Projeto - Obter detalhes do formulário

Obter os detalhes de um determinado formulário (descrição, nome do modelo, cessionário,...)

Projeto - Obter detalhes do projeto

Obter os detalhes de um determinado projeto (fuso horário, idioma, data de atualização,...)

Projeto - Obter documento ou pasta

Obter um documento ou pasta

Projeto - Obter empresas

Coloque as empresas no seu projeto

Projeto - Obter estados de observação

Obter o estado das observações no seu projeto

Projeto - Obter fases

Obtenha as fases do seu projeto

Projeto - Obter funções

Obter funções do projeto

Projeto - Obter grupos de discussão

Obter os grupos de discussão no seu projeto

Projeto - Obter modelos de formulários

Obter modelos de formulários

Projeto - Obter modelos de observação

Obtenha modelos de observação (A categoria era anteriormente chamada comércio)

Projeto - Obter módulos de formulário

Obter a lista de todos os módulos de formulário existentes para um determinado projeto

Projeto - Obter módulos de observação

Obter a lista de todos os módulos de observação existentes para um determinado projeto

Projeto - Obter prioridades de formulários

Obter as prioridades dos formulários no seu projeto

Projeto - Obter prioridades de observações

Obtenha as prioridades de observações no seu projeto

Projeto - Obter utilizadores

Obter os usuários em seu projeto

Setup - Projeto

Configurar a configuração do projeto

Configuração - Idioma e fuso horário

Configurar a configuração de idioma e fuso horário

Parâmetros

Name Chave Necessário Tipo Description
Linguagem
language string

Linguagem

Fuso horário
timezone string

O fuso horário do utilizador (no formato IANA)

Devoluções

Name Caminho Tipo Description
linguagem
language string
timezone
timezone string

Espaço de trabalho - Adicionar membros

Adicionar membros a um espaço de trabalho

Parâmetros

Name Chave Necessário Tipo Description
ID da Organização
organizationId True string

ID da Organização

ID do espaço de trabalho
workspaceId True string

ID do espaço de trabalho

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

ID do Utilizador
user_id string

ID do Utilizador

E-mail do usuário
user_email string

E-mail do usuário

Devoluções

Media - Obter URL do recurso multimédia

Recuperar a URL para acessar um recurso de mídia

Parâmetros

Name Chave Necessário Tipo Description
ID de mídia
mediaId True string

ID de mídia

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Multimédia - Iniciar carregamento de blocos

Inicie o processo de upload de um arquivo de mídia em partes.

Parâmetros

Name Chave Necessário Tipo Description
Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Nome do arquivo de mídia
file_name True string

Nome do arquivo de mídia

Tamanho total do media em bytes
total_bytes True integer

Tamanho total da mídia em bytes

Mídia MD5
md5 string

Mídia MD5

Devoluções

Mídia - Abortar o upload de blocos

Cancele o processo atual de carregamento de partes e descarte todas as partes recebidas.

Parâmetros

Name Chave Necessário Tipo Description
ID de mídia
mediaId True string

ID de mídia

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

ID do bloco
chunk_id True string

ID do bloco

Devoluções

Body
Media

Mídia - Anexar parte do bloco

Anexe uma parte individual à sessão de upload de mídia em andamento.

Parâmetros

Name Chave Necessário Tipo Description
ID de mídia
mediaId True string

ID de mídia

Linguagem
Accept-Language string

Linguagem

ID do bloco
chunk_id True string

ID do bloco

Número do segmento
segment_index True integer

Número de Blocos

Última chamada?
last_chunk boolean

Última chamada?

filename
filename True string
TipoDeConteúdo
contentType True string
conteúdo
content True byte

Mídia - Validar upload de blocos

Confirme e finalize o upload verificando se todas as partes foram recebidas corretamente.

Parâmetros

Name Chave Necessário Tipo Description
ID de mídia
mediaId True string

ID de mídia

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

ID do bloco
chunk_id True string

ID do bloco

Devoluções

Body
Media

Obter idiomas

Obtenha todos os idiomas disponíveis para bibliotecas e itens

Parâmetros

Name Chave Necessário Tipo Description
Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Obter lista de fusos horários

Obter a lista de fusos horários disponíveis

Parâmetros

Name Chave Necessário Tipo Description
Número máximo de fusos horários para recuperar.
limit string

Número máximo de fusos horários para recuperar.

Enésimo fuso horário.
offset string

Enésimo fuso horário.

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Organização - Adicionar membros

Adicionar membros a uma organização

Parâmetros

Name Chave Necessário Tipo Description
ID da Organização
organizationId True string

ID da Organização

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

ID da função
role_id string

ID da função

E-mail dos usuários
users_info array of string

e-mail dos usuários

Organização - Conecte-se ao usuário

Obtenha suas informações de usuário

Parâmetros

Name Chave Necessário Tipo Description
Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Organização - Criar um projeto

Criar um projeto

Parâmetros

Name Chave Necessário Tipo Description
ID da Organização
organizationId True string

ID da Organização

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Nome do projeto
name True string

Nome do projeto

ID do espaço de trabalho do projeto
workspace_id string

ID do espaço de trabalho do projeto

Módulos de projeto ids
module_ids array of string

Módulos de projeto ids

Descrição do projeto
description string

Descrição do projeto

Linguagem do projeto
language string

Linguagem do projeto

Fuso horário do projeto
time_zone string

Fuso horário do projeto

Referência do projeto
case_number string

Referência do projeto

Endereço do projeto
address string

Endereço do projeto

Data de conclusão do projeto
end_date string

Data de Fim do Projeto

Devoluções

Organização - Obter espaços de trabalho

Obter espaços de trabalho relacionados com a sua organização

Parâmetros

Name Chave Necessário Tipo Description
ID da Organização
organizationId True string

ID da Organização

ID do espaço de trabalho principal
parent_id string

ID do espaço de trabalho principal

Incluir crianças
with_children string

Incluir crianças

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Organização - Obter funções

Obter funções da organização

Parâmetros

Name Chave Necessário Tipo Description
ID da Organização
organizationId True string

ID da Organização

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Body
GetRoles

Organização - Obter lista de organizações

Obtenha a lista de todas as organizações onde é membro

Parâmetros

Name Chave Necessário Tipo Description
Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Name Caminho Tipo Description
array of object
id
id string

id

nome
name string

nome

Organização - Obter lista de projetos

Obter a lista de todos os seus projetos em uma determinada organização

Parâmetros

Name Chave Necessário Tipo Description
ID da Organização
organizationId True string

ID da Organização

ID do espaço de trabalho
workspace_id string

ID do espaço de trabalho

Incluir espaços de trabalho para crianças
with_workspace_children boolean

Incluir espaços de trabalho para crianças

Termo de pesquisa
search_term string

Termo de pesquisa

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Organização - Obter módulos sugeridos

Obter módulos sugeridos relacionados com a sua organização

Parâmetros

Name Chave Necessário Tipo Description
ID da Organização
organizationId True string

ID da Organização

ID do espaço de trabalho
workspace_id string

ID do espaço de trabalho

Número máximo de módulos
limit string

Número máximo de módulos

Módulo N-ésimo
offset string

Módulo N-ésimo

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Organização - Obter status de formulários

Obter o status dos formulários em um modelo

Parâmetros

Name Chave Necessário Tipo Description
ID da Organização
organizationId True string

ID da Organização

ID do modelo de formulário
formId True string

ID do modelo de formulário

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Project - Obter pastas de documentos

Obter pastas de documentos no seu projeto

Parâmetros

Name Chave Necessário Tipo Description
ID do projeto
projectId True string

ID do projeto

ID da pasta principal
parent_id string

ID da pasta principal

Filtro Tipo de Conteúdo U'Pasta', 'documento', ou nada.
type string

Filtro Tipo de Conteúdo U'Pasta', 'documento', ou nada.

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Project - Obter planos ou pastas

Obter os planos ou pastas no seu projeto

Parâmetros

Name Chave Necessário Tipo Description
ID do projeto
projectId True string

ID do projeto

ID da pasta
folder_id string

ID da pasta

Inclua apenas planos ou pastas
type string

Inclua apenas planos ou pastas

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Projeto - Adicionar usuários

Adicionar utilizadores ao seu projeto

Parâmetros

Name Chave Necessário Tipo Description
ID do projeto
projectId True string

ID do projeto

Não envie emails aos utilizadores
doNotSendEmail boolean

Não envie emails aos utilizadores

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

E-mail do usuário
email True string

E-mail do usuário

ID da função do usuário
project_role_id True string

ID da função do usuário

Devoluções

Body
AddMembers

Projeto - Criar um documento

Projeto - Criar um documento

Parâmetros

Name Chave Necessário Tipo Description
ID do projeto
projectId True string

ID do projeto

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Nome do documento
name True string

Nome do documento

Documente o ID dos Pais
parent_id string

ID da pasta-mãe

ID de Media do Documento
media_id string

Se o campo não for preenchido, será criada uma pasta

Devoluções

Projeto - Criar um formulário

Criar um formulário

Parâmetros

Name Chave Necessário Tipo Description
ID do projeto
projectId True string

ID do projeto

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

ID do Módulo do Formulário
module_id True string

ID do módulo de formulário

Modelo de formulário
form_id True string

ID do modelo de formulário

Nome do Formulário
name True string

Nome do formulário

ID da Categoria do Formulário
category_id string

ID da categoria do formulário

ID de Estado do Formulário
status_id string

ID de status do formulário

Formulário ID da Empresa
company_id string

ID da empresa atribuído ao formulário

ID do Cesionário do Formulário
assignee_id string

ID de usuário atribuído ao formulário

ID do plano de formulário
plan_id string

ID do plano de formulário

Formulário X posição
position_x decimal

Posição da Forma X na planta entre 0 e 1

Posição do formulário Y
position_y decimal

Posição do Formulário Y no plano entre 0 e 1

Latitude do formulário
latitude decimal

Latitude do formulário

Longitude do formulário
longitude decimal

Longitude da forma

ID de Prioridade do Formulário
priority_id string

ID de prioridade do formulário

Data de vencimento do formulário
due_date string

Data de vencimento do formulário

ID de Fase da Forma
phase_id string

ID da fase do formulário

ID do formulário
id string

ID do formulário

Devoluções

Projeto - Criar uma observação

Criar uma observação

Parâmetros

Name Chave Necessário Tipo Description
ID do projeto
projectId True string

ID do projeto

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

ID do Módulo de Observação
module_id True string

ID do módulo de observação

ID da Categoria de Observação
trade_id string

A categoria era anteriormente chamada de comércio

ID do Modelo de Observação
common_observation_id string

O modelo era anteriormente chamado observação comum

Descrição da Observação
description string

Descrição da observação

ID de Estado de Observação
status_id string

ID do estado de observação

ID da Companhia de Observação
company_id string

Identificação da empresa atribuída à observação

ID do Assignado de Observação
assignee_id string

ID de utilizador atribuído à observação

ID do Plano de Observação
plan_id string

ID do plano de observação

Observação X posição no plano
position_x decimal

Observação X posição entre 0 e 1

Observação Y posição no plano
position_y decimal

Observação Y posição entre 0 e 1

ID de Prioridade de Observação
priority_id string

ID de prioridade de observação

Data de Entrega da Observação
due_date string

Data de vencimento da observação

ID da Fase de Observação
phase_id string

ID da fase de observação

ID do Grupo de Discussão de Observação
group_id string

O grupo de discussão onde a observação deve ser partilhada aquando da sua criação

Latitude de observação
latitude decimal

Latitude de observação

Longitude de observação
longitude decimal

Longitude de observação

ID de observação
id string

ID de observação

Devoluções

Projeto - Obter categorias de formulário

Obter categorias de formulário

Parâmetros

Name Chave Necessário Tipo Description
ID do projeto
projectId True string

ID do projeto

ID do módulo
module_id string

ID do módulo

ID da categoria pai
category_id string

ID da categoria pai

Incluir deficientes
with_disabled string

Incluir deficientes

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Projeto - Obter categorias de observação

Obter categorias de observação (anteriormente trades)

Parâmetros

Name Chave Necessário Tipo Description
ID do projeto
projectId True string

ID do projeto

ID do módulo
module_id string

ID do módulo

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Projeto - Obter detalhes de observação

Obter os detalhes de uma determinada observação (descrição, status, cessionário,...)

Parâmetros

Name Chave Necessário Tipo Description
ID do projeto
projectId True string

ID do projeto

ID de observação
observationId True string

ID de observação

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Projeto - Obter detalhes do formulário

Obter os detalhes de um determinado formulário (descrição, nome do modelo, cessionário,...)

Parâmetros

Name Chave Necessário Tipo Description
ID do projeto
projectId True string

ID do projeto

ID do formulário
formId True string

ID do formulário

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Projeto - Obter detalhes do projeto

Obter os detalhes de um determinado projeto (fuso horário, idioma, data de atualização,...)

Parâmetros

Name Chave Necessário Tipo Description
ID do projeto
projectId True string

ID do projeto

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Body
GetProject

Projeto - Obter documento ou pasta

Obter um documento ou pasta

Parâmetros

Name Chave Necessário Tipo Description
ID do projeto
projectId True string

ID do projeto

ID do documento
documentId True string

ID do documento

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Body
Document

Projeto - Obter empresas

Coloque as empresas no seu projeto

Parâmetros

Name Chave Necessário Tipo Description
ID do projeto
projectId True string

ID do projeto

Token contínuo
continuous_token string

Token contínuo

Número máximo de empresas a recuperar
limit integer

Número máximo de empresas a recuperar

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Projeto - Obter estados de observação

Obter o estado das observações no seu projeto

Parâmetros

Name Chave Necessário Tipo Description
ID do projeto
projectId True string

ID do projeto

Token contínuo
continuous_token string

Token contínuo

Número máximo de estados a recuperar
limit integer

Número máximo de estados a recuperar

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Projeto - Obter fases

Obtenha as fases do seu projeto

Parâmetros

Name Chave Necessário Tipo Description
ID do projeto
projectId True string

ID do projeto

Token contínuo
continuous_token string

Token contínuo

N-ésima fase
offset string

N-ésima fase

Número máximo de fases a recuperar
limit integer

Número máximo de fases a recuperar

Incluir eliminado
with_deleted boolean

Incluir eliminado

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Body
GetPhases

Projeto - Obter funções

Obter funções do projeto

Parâmetros

Name Chave Necessário Tipo Description
ID do projeto
projectId True string

ID do projeto

Número máximo de funções de projeto a recuperar
limit string

Número máximo de funções de projeto a recuperar

Enésimo papel
offset string

Enésimo papel

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Projeto - Obter grupos de discussão

Obter os grupos de discussão no seu projeto

Parâmetros

Name Chave Necessário Tipo Description
ID do projeto
projectId True string

ID do projeto

Número máximo de grupos de discussão para recuperar
limit integer

Número máximo de grupos de discussão para recuperar

O enésimo grupo de discussão de onde desejo recuperar os grupos de discussão
offset integer

O enésimo grupo de discussão de onde desejo recuperar os grupos de discussão

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Body
GetGroups

Projeto - Obter modelos de formulários

Obter modelos de formulários

Parâmetros

Name Chave Necessário Tipo Description
ID do projeto
projectId True string

ID do projeto

ID do módulo
module_id string

ID do módulo

ID da categoria
category_id string

ID da categoria

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Body
GetForms

Projeto - Obter modelos de observação

Obtenha modelos de observação (A categoria era anteriormente chamada comércio)

Parâmetros

Name Chave Necessário Tipo Description
ID do projeto
projectId True string

ID do projeto

ID da categoria
tradeId True string

ID da categoria

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Projeto - Obter módulos de formulário

Obter a lista de todos os módulos de formulário existentes para um determinado projeto

Parâmetros

Name Chave Necessário Tipo Description
ID do projeto
projectId True string

ID do projeto

Token contínuo
continuous_token string

Token contínuo

Número máximo de módulos a recuperar
limit integer

Número máximo de módulos a recuperar

Incluir eliminado
with_deleted boolean

Incluir eliminado

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Projeto - Obter módulos de observação

Obter a lista de todos os módulos de observação existentes para um determinado projeto

Parâmetros

Name Chave Necessário Tipo Description
ID do projeto
projectId True string

ID do projeto

Token contínuo
continuous_token string

Token contínuo

Número máximo de módulos para recuperar
limit integer

Número máximo de módulos para recuperar

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Body
GetModules

Projeto - Obter prioridades de formulários

Obter as prioridades dos formulários no seu projeto

Parâmetros

Name Chave Necessário Tipo Description
ID do projeto
projectId True string

ID do projeto

Token contínuo
continuous_token string

Token contínuo

Número máximo de prioridades a recuperar
limit integer

Número máximo de prioridades a recuperar

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Projeto - Obter prioridades de observações

Obtenha as prioridades de observações no seu projeto

Parâmetros

Name Chave Necessário Tipo Description
ID do projeto
projectId True string

ID do projeto

Token contínuo
continuous_token string

Token contínuo

N-ésima prioridade
offset string

N-ésima prioridade

Número máximo de prioridades a recuperar
limit integer

Número máximo de prioridades a recuperar

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Projeto - Obter utilizadores

Obter os usuários em seu projeto

Parâmetros

Name Chave Necessário Tipo Description
ID do projeto
projectId True string

ID do projeto

Token contínuo
continuous_token string

Token contínuo

Número máximo de membros a recuperar
limit integer

Número máximo de membros a recuperar

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Devoluções

Body
GetMembers

Setup - Projeto

Configurar a configuração do projeto

Parâmetros

Name Chave Necessário Tipo Description
ID da Organização
business_organization_id string

ID da Organização

ID do projeto
project_id string

ID do projeto

Devoluções

Name Caminho Tipo Description
business_organization_id
business_organization_id string
project_id
project_id string

Acionadores

Gatilho - Formulário atualizado

Acionar o fluxo quando um formulário é atualizado

Gatilho - Observação atualizada

Acionar o fluxo quando uma observação é atualizada

Gatilho - Observação criada

Acionar o fluxo quando uma observação é criada

Trigger - Documento criado

Acionar o fluxo quando um documento é criado

Trigger - Formulário criado

Acionar o fluxo quando um formulário é criado

Gatilho - Formulário atualizado

Acionar o fluxo quando um formulário é atualizado

Parâmetros

Name Chave Necessário Tipo Description
business_organization_id
business_organization_id True string

ID da Organização

project_id
project_id True string

ID do projeto

Devoluções

Name Caminho Tipo Description
parent_id
parent_id string

parent_id

evento
event integer

evento

element_id
element_id string

element_id

dados1
data1 string

dados1

dados2
data2 string

dados2

dados3
data3 string

dados3

Gatilho - Observação atualizada

Acionar o fluxo quando uma observação é atualizada

Parâmetros

Name Chave Necessário Tipo Description
business_organization_id
business_organization_id True string

ID da Organização

project_id
project_id True string

ID do projeto

Devoluções

Name Caminho Tipo Description
parent_id
parent_id string

parent_id

evento
event integer

evento

element_id
element_id string

element_id

dados1
data1 string

dados1

dados2
data2 string

dados2

dados3
data3 string

dados3

Gatilho - Observação criada

Acionar o fluxo quando uma observação é criada

Parâmetros

Name Chave Necessário Tipo Description
business_organization_id
business_organization_id True string

ID da Organização

project_id
project_id True string

ID do projeto

Devoluções

Name Caminho Tipo Description
parent_id
parent_id string

parent_id

evento
event integer

evento

element_id
element_id string

element_id

dados1
data1 string

dados1

dados2
data2 string

dados2

dados3
data3 string

dados3

Trigger - Documento criado

Acionar o fluxo quando um documento é criado

Parâmetros

Name Chave Necessário Tipo Description
business_organization_id
business_organization_id True string

ID da Organização

project_id
project_id True string

ID do projeto

Devoluções

Name Caminho Tipo Description
parent_id
parent_id string

parent_id

evento
event integer

evento

element_id
element_id string

element_id

dados1
data1 string

dados1

dados2
data2 string

dados2

dados3
data3 string

dados3

Trigger - Formulário criado

Acionar o fluxo quando um formulário é criado

Parâmetros

Name Chave Necessário Tipo Description
business_organization_id
business_organization_id True string

ID da Organização

project_id
project_id True string

ID do projeto

Devoluções

Name Caminho Tipo Description
parent_id
parent_id string

parent_id

evento
event integer

evento

element_id
element_id string

element_id

dados1
data1 string

dados1

dados2
data2 string

dados2

dados3
data3 string

dados3

Definições

AddMembers

Name Caminho Tipo Description
Lista de utilizadores
project_roles array of ProjectRole

Lista de utilizadores

Empresa

Name Caminho Tipo Description
ID da Empresa
id string

ID da Empresa

Nome da empresa
name string

Nome da empresa

A empresa está habilitada
enabled boolean

A empresa está habilitada

Membros da empresa
user_ids array of string

Membros da empresa

Referência da empresa
reference string

Referência da empresa

Data de criação
created_at string

Data de criação

Criado por
created_by string

Criado por

Data de atualização
updated_at string

Data de atualização

Atualizado por
updated_by string

Atualizar por

CreateDocument

Name Caminho Tipo Description
ID do documento
id string

ID do documento

Tipo de documento
type string

Tipo de documento

Nome do documento
name string

Nome do documento

ID da pasta pai do documento
parent_id string

ID da pasta pai do documento

media_resource
media_resource Media
O documento está ativado
enabled boolean

O documento está ativado

Tipo de documento
file_type string

Tipo de documento

Fonte do documento
item_source string

Fonte do documento

Data de criação
created_at string

Data de criação

Criado por
created_by string

Criado por

Data de atualização
updated_at string

Data de atualização

Atualizado por
updated_by string

Atualizar por

CreateFormInstance

Name Caminho Tipo Description
ID do formulário
id string

ID do formulário

Nome do formulário
name string

Nome do formulário

ID do modelo de formulário
form_id string

ID do modelo de formulário

ID de status do formulário
status_id string

ID de status do formulário

ID de prioridade do formulário
priority_id string

ID de prioridade do formulário

ID do plano de formulário
plan_id string

ID do plano de formulário

Formulário X posição
position_x decimal

Formulário X posição

Formulário Y Posição
position_y decimal

Posição do formulário Y

Latitude do formulário
latitude decimal

Latitude do formulário

Longitude da forma
longitude decimal

Longitude da forma

ID de usuário do formulário
assignee_id string

ID de usuário atribuído ao formulário

Formulário de identificação da empresa
company_id string

ID da empresa atribuído ao formulário

Data de vencimento do formulário
due_date string

Data de vencimento do formulário

Data de criação do formulário
client_created_at string

ID de criação do formulário

Data de atualização do formulário
client_updated_at string

ID de atualização do formulário

ID do módulo de formulário
module_id string

ID do módulo de formulário

ID da fase do formulário
phase_id string

ID da fase do formulário

ID da categoria do formulário
category_id string

ID da categoria do formulário

Data de criação
created_at string

Data de criação

Criado por
created_by string

Criado por

Data de atualização
updated_at string

Data de atualização

Atualizado por
updated_by string

Atualizar por

CreateObservation

Name Caminho Tipo Description
id
id string
project_id
project_id string
descrição
description string
status_id
status_id string
priority_id
priority_id string
plan_id
plan_id string
position_x
position_x decimal
position_y
position_y decimal
latitude
latitude decimal
longitude
longitude decimal
assignee_id
assignee_id string
company_id
company_id string
trade_id
trade_id string
common_observation_id
common_observation_id string
due_date
due_date string
client_created_at
client_created_at string
client_updated_at
client_updated_at string
module_id
module_id string
phase_id
phase_id string
Data de criação
created_at string

Data de criação

Criado por
created_by string

Criado por

Data de atualização
updated_at string

Data de atualização

Atualizado por
updated_by string

Atualizar por

CreateProject

Name Caminho Tipo Description
Endereço do projeto
address string

Endereço do projeto

Fuso horário do projeto
time_zone string

Fuso horário IANA do projeto

Linguagem do projeto
language string

Linguagem do projeto

ID do projeto
project_id string

ID do projeto

ID da organização do projeto
organization_id string

ID da organização do projeto

Nome do projeto
name string

Nome do projeto

Caso de projeto
case_number string

Caso de projeto

ID do espaço de trabalho do projeto
workspace_id string

ID do espaço de trabalho do projeto

Descrição do projeto
description string

Descrição do projeto

Data de conclusão do projeto
end_date string

Data de conclusão do projeto

Contagem de membros do projeto
member_count integer

Contagem de membros do projeto

O projeto foi arquivado
is_archived boolean

O projeto foi arquivado

media_resource
media_resource Media
É usuário atual no projeto
current_user_in_project boolean

O usuário atual está no projeto?

Projeto está ativo
is_active boolean

Projeto está ativo

Estado do projeto
status string

Estado do projeto

Data de criação
created_at string

Data de criação

Criado por
created_by string

Criado por

Data de atualização
updated_at string

Data de atualização

Atualizado por
updated_by string

Atualizar por

Documento

Name Caminho Tipo Description
ID do documento
id string

ID do documento

Tipo de documento
type string

Tipo de documento

Nome do documento
name string

Nome do documento

ID da pasta pai do documento
parent_id string

ID da pasta pai do documento

media_resource
media_resource Media
O documento está ativado
enabled boolean

O documento está ativado

Tipo de documento
file_type string

Tipo de documento

Fonte do documento
item_source string

Fonte do documento

Data de criação
created_at string

Data de criação

Criado por
created_by string

Criado por

Data de atualização
updated_at string

Data de atualização

Atualizado por
updated_by string

Atualizar por

FolderContent

Name Caminho Tipo Description
ID de conteúdo da pasta
id string

ID de conteúdo da pasta

Tipo de conteúdo da pasta
type string

Tipo de conteúdo da pasta

Nome do conteúdo da pasta
name string

Nome do conteúdo da pasta

Ordem do conteúdo da pasta
order double

Ordem do conteúdo da pasta

Data de criação do conteúdo da pasta
created_at string

Data de criação do conteúdo da pasta

Data de atualização do conteúdo da pasta
updated_at string

Data de atualização do conteúdo da pasta

Fonte de conteúdo da pasta
source string

Conteúdo da pasta Isourced

Foldersource de conteúdo da pasta
sources_contained string

Foldersource de conteúdo da pasta

O conteúdo da pasta está ativado
enabled boolean

O conteúdo da pasta está ativado

Formulário

Name Caminho Tipo Description
ID do modelo
id string

ID do modelo

Nome do modelo
name string

Nome do modelo

Modelo ativado
enabled boolean

Modelo ativado sim/não

Número da versão do modelo
version integer

Número da versão do modelo

ID do módulo de modelo
module_id string

ID do módulo de modelo

ID da categoria do modelo
category_id string

ID da categoria do modelo

Data de criação do modelo
created_at string

Data de criação do modelo

Data de atualização do modelo
updated_at string

Data de atualização do modelo

GetCommonObsByTrade

Name Caminho Tipo Description
CommonObs
common_observations array of ObservationCommonObservation

CommonObs

GetEmpresas

Name Caminho Tipo Description
Companhias
companies array of Company

Companhias

A lista está incompleta
need_to_relaunch boolean

A lista está incompleta

Token contínuo
continuous_token string

Token para obter os próximos itens

Contagem de itens
count integer

Contagem de itens

Contagem total de itens
total_count integer

Contagem total de itens

GetDocumentsFiltered

Name Caminho Tipo Description
Documentação
documents array of Document
count
count integer

GetFolderContent

Name Caminho Tipo Description
Conteúdo da pasta
contents array of FolderContent

Conteúdo da pasta

count
count integer

GetFormFull

Name Caminho Tipo Description
ID do formulário
id string

ID do formulário

Número do formulário
legacy_id integer

Número do formulário

Formulário ativado
enabled boolean

Formulário ativado

ID do modelo de formulário
form_id string

ID do modelo de formulário

ID da Organização
organization_id string

ID da Organização

Nome da organização
organization_name string

Nome da organização

ID do projeto
project_id string

ID do projeto

Nome do projeto
project_name string

Nome do projeto

Descrição do formulário
description string

Descrição do formulário

Nome do modelo de formulário
template_name string

Nome do modelo de formulário

ID de status do formulário
status_id string

ID de status do formulário

Nome do status do formulário
status_name string

Nome do status do formulário

ID de prioridade do formulário
priority_id string

ID de prioridade do formulário

Nome de prioridade do formulário
priority_name string

Nome de prioridade do formulário

ID de usuário do formulário
assignee_id string

ID de usuário atribuído ao formulário

Nome de usuário do formulário
assignee_name string

Nome de utilizador atribuído ao formulário

Formulário de identificação da empresa
company_id string

Formulário de identificação da empresa

Formulário nome da empresa
company_name string

Formulário Nome da empresa atribuída

Data de vencimento do formulário
due_date string

Data de vencimento do formulário

ID do plano de formulário
plan_id string

ID do plano de formulário

Nome do plano de formulário
plan_name string

Nome do plano de formulário

Formulário X Posição
position_x string

Formulário X posição

Posição do formulário Y
position_y string

Posição do formulário Y

Latitude do formulário
latitude string

Latitude do formulário

Longitude da forma
longitude string

Longitude da forma

ID do módulo de formulário
module_id string

ID do módulo de formulário

Nome do módulo de formulário
module_name string

Nome do módulo de formulário

Id da fase do formulário
phase_id string

ID da fase do formulário

Nome da fase do formulário
phase_name string

Nome da fase do formulário

Id da categoria do formulário
category_id string

ID da categoria do formulário

Nome da categoria do formulário
category_name string

Nome da categoria do formulário

Data de exclusão do formulário
deleted_at string

Data de exclusão do formulário

Formulário suprimido por
deleted_by string

Formulário excluído pelo ID do usuário

Data de criação do formulário
client_created_at string

Data de criação do formulário

Data de atualização do formulário
client_updated_at string

Data de atualização do formulário

URL do formulário
web_url string

URL do formulário

Data de criação
created_at string

Data de criação

Criado por
created_by string

Criado por

Data de atualização
updated_at string

Data de atualização

Atualizado por
updated_by string

Atualizar por

GetFormStatuses

Name Caminho Tipo Description
Estatutos
statuses array of StatusResponseWithoutLanguage

Estatutos

count
count integer

GetForms

Name Caminho Tipo Description
Lista de modelos
forms array of Form

Lista de modelos

count
count integer

GetGroup

Name Caminho Tipo Description
ID do grupo
id string

ID do grupo

Nome do grupo
name string

Nome do grupo

GetGroups

Name Caminho Tipo Description
Groups
groups array of GetGroup

Groups

count
count integer
total_count
total_count integer
limit
limit integer
offset
offset integer

GetLanguage

Name Caminho Tipo Description
Código de idioma
code string

Código de idioma

Descrição da língua
name string

Descrição da língua

GetLanguages

Name Caminho Tipo Description
Lista de línguas
langs array of GetLanguage

Lista de línguas

Contagem de línguas
count integer

Contagem de línguas

GetMembros

Name Caminho Tipo Description
Membros do projeto
project_members array of Member

Membros do projeto

A lista está incompleta
need_to_relaunch boolean

A lista está incompleta

Token contínuo
continuous_token string

Token para obter os próximos itens

Contagem de itens
count integer

Contagem de itens

Contagem total de itens
total_count integer

Contagem total de itens

GetModules

Name Caminho Tipo Description
Lista de módulos
modules array of Module

Lista de módulos do projeto

need_to_relaunch
need_to_relaunch boolean
continuous_token
continuous_token string
offset
offset string
count
count integer

GetModulesCategorias

Name Caminho Tipo Description
Categorias
categories array of ModuleCategory

Categorias

count
count integer

GetModulesForm

Name Caminho Tipo Description
Lista de módulos
modules array of ModuleForm

Lista de módulos

A lista está incompleta
need_to_relaunch boolean

A lista está incompleta

Token contínuo
continuous_token string

Token para obter os próximos itens

Contagem de itens
count integer

Contagem de itens

Contagem total de itens
total_count integer

Contagem total de itens

GetModulesOrgaSugestão

Name Caminho Tipo Description
Suggestions
suggestions array of ModuleOrgaSuggestion

Suggestions

count
count integer
total_count
total_count integer
limit
limit integer
offset
offset integer

GetObservationFull

Name Caminho Tipo Description
ID de observação
id string

ID de observação

Um número de observação
legacy_id integer

Um número de observação

A observação está habilitada
enabled boolean

A observação está habilitada

ID do projeto de observação
project_id string

ID do projeto de observação

Nome do projeto de observação
project_name string

Nome do projeto de observação

ID da organização de observação
organization_id string

ID da organização de observação

Nome da organização de observação
organization_name string

Nome da organização de observação

Descrição da observação
description string

Descrição da observação

ID do estado de observação
status_id string

ID do estado de observação

Nome do estado de observação
status_name string

Nome do estado de observação

ID de prioridade de observação
priority_id string

ID de prioridade de observação

Nome da prioridade de observação
priority_name string

Nome da prioridade de observação

ID do plano de observação
plan_id string

ID do plano de observação

Nome do plano de observação
plan_name string

Nome do plano de observação

Observação X posição
position_x decimal

Observação X posição

Observação Y posição
position_y decimal

Observação Y posição

Latitude de observação
latitude decimal

Latitude de observação

Longitude de observação
longitude decimal

Longitude de observação

ID de utilizador da observação
assignee_id string

ID de utilizador atribuído à observação

Nome de utilizador da observação
assignee_name string

Nome de utilizador atribuído à observação

ID da empresa de observação
company_id string

Identificação da empresa atribuída à observação

Nome da empresa de observação
company_name string

Observação atribuída nome da empresa

Identificação comercial de observação
trade_id string

Identificação comercial de observação

Designação comercial de observação
trade_name string

Designação comercial de observação

Observação commonobs id
common_observation_id string

ID de observação comum de observação

Observação nome commonobs
common_observation_name string

Nome comum da observação

Data de vencimento da observação
due_date string

Data de vencimento da observação

ID do módulo de observação
module_id string

ID do módulo de observação

Nome do módulo de observação
module_name string

Nome do módulo de observação

deleted_at
deleted_at string
deleted_by
deleted_by string
ID da fase de observação
phase_id string

ID da fase de observação

Nome da fase de observação
phase_name string

Nome da fase de observação

Imagens de observação
photos array of ObservationMediaResource

Imagens de observação

Data de criação da observação
client_created_at string

Data de criação da observação

Data de atualização da observação
client_updated_at string

Data de atualização da observação

URL de observação
web_url string

URL de observação

Data de criação
created_at string

Data de criação

Criado por
created_by string

Criado por

Data de atualização
updated_at string

Data de atualização

Atualizado por
updated_by string

Atualizar por

GetPhases

Name Caminho Tipo Description
Fases
phases array of Phase

Fases

A lista está incompleta
need_to_relaunch boolean

A lista está incompleta

Token contínuo
continuous_token string

Token para obter os próximos itens

Contagem de itens
count integer

Contagem de itens

Contagem total de itens
total_count integer

Contagem total de itens

GetPriorities

Name Caminho Tipo Description
Prioridades
priorities array of Priority

Prioridades

A lista está incompleta
need_to_relaunch boolean

A lista está incompleta

Token contínuo
continuous_token string

Token para obter os próximos itens

Contagem de itens
count integer

Contagem de itens

Contagem total de itens
total_count integer

Contagem total de itens

GetProject

Name Caminho Tipo Description
Endereço do projeto
address string

Endereço do projeto

Fuso horário do projeto
time_zone string

Fuso horário IANA do projeto

Linguagem do projeto
language string

Linguagem do projeto

ID do projeto
project_id string

ID do projeto

ID da organização do projeto
organization_id string

ID da organização do projeto

Nome do projeto
name string

Nome do projeto

Caso de projeto
case_number string

Caso de projeto

ID do espaço de trabalho do projeto
workspace_id string

ID do espaço de trabalho do projeto

Descrição do projeto
description string

Descrição do projeto

Data de conclusão do projeto
end_date string

Data de conclusão do projeto

Contagem de membros do projeto
member_count integer

Contagem de membros do projeto

O projeto foi arquivado
is_archived boolean

O projeto foi arquivado

media_resource
media_resource Media
É usuário atual no projeto
current_user_in_project boolean

O usuário atual está no projeto?

Projeto está ativo
is_active boolean

Projeto está ativo

Estado do projeto
status string

Estado do projeto

Data de criação
created_at string

Data de criação

Criado por
created_by string

Criado por

Data de atualização
updated_at string

Data de atualização

Atualizado por
updated_by string

Atualizar por

GetProjectRoles

Name Caminho Tipo Description
project_roles
project_roles array of ProjectRole
count
count integer
total_count
total_count integer
limit
limit integer
offset
offset integer

GetProjects

Name Caminho Tipo Description
Lista de projetos
projects array of Project

Lista de projetos

count
count integer
total_count
total_count integer
limit
limit integer
offset
offset integer

GetRole

Name Caminho Tipo Description
ID da função
id string

ID da função

Nome da função
name string

Nome da função

Descrição da função
description string

Descrição da função

names
names LocalizedLabelFallback
descrições
descriptions LocalizedLabelFallback
A função é padrão
is_default boolean

A função é padrão

is_default_invitation_role
is_default_invitation_role boolean
user_count
user_count integer
posição
position integer
authorization_role_id
authorization_role_id string
higher_role_id
higher_role_id string
is_lower_role
is_lower_role boolean

GetRoles

Name Caminho Tipo Description
organization_roles
organization_roles array of GetRole

GetStatuses

Name Caminho Tipo Description
Estatutos
statuses array of StatusResponseWithoutFlow

Estatutos

A lista está incompleta
need_to_relaunch boolean

A lista está incompleta

Token contínuo
continuous_token string

Token para obter os próximos itens

Contagem de itens
count integer

Contagem de itens

Contagem total de itens
total_count integer

Contagem total de itens

GetTimeZones

Name Caminho Tipo Description
Lista de fusos horários
time_zones array of TimeZones

Lista de fusos horários

count
count integer
total_count
total_count integer
limit
limit integer
offset
offset integer

GetTradesByModule

Name Caminho Tipo Description
Ofícios
trades array of ProjectTrade

Ofícios

GetUserInfo

Name Caminho Tipo Description
ID de utilizador
id string

ID de utilizador

Nome do utilizador
first_name string

Nome do utilizador

Apelido do utilizador
last_name string

Apelido do utilizador

E-mail de utilizador
email string

E-mail de utilizador

Nome da empresa de utilizador
company string

Nome da empresa de utilizador

está ativo
is_active string

está ativo

email_validated
email_validated string
Data de criação do utilizador
created_at string

Data de criação do utilizador

updated_at
updated_at string
deleted_at
deleted_at string
media_resource
media_resource Media
Localidade do usuário
locale string

Localidade do usuário

GetWorkspaceMembros

Name Caminho Tipo Description
workspace_members
workspace_members array of OrgaMemberResponses
count
count integer
total_count
total_count integer
limit
limit integer
offset
offset integer

GetWorkspaces

Name Caminho Tipo Description
Espaços de trabalho
workspaces array of Workspace

Espaços de trabalho

IconTypeParameters

LocalizedLabel

Name Caminho Tipo Description
linguagem
language string
Tradução
translation string

LocalizedLabelFallback

Name Caminho Tipo Description
translation_fallback
translation_fallback string
traduções
translations array of LocalizedLabel

MÍDIA

Name Caminho Tipo Description
ID de mídia
id string

ID de mídia

Nome do arquivo de mídia
file_name string

Nome do arquivo de mídia

Tipo MIME de mídia
mime_type string

Tipo MIME de mídia

Data de criação dos meios de comunicação social
created_at string

Data de criação dos meios de comunicação social

MediaResourceUrl

Name Caminho Tipo Description
URL de mídia
url string

URL de mídia

Membro

Name Caminho Tipo Description
ID de Membro
user_id string

ID de Membro

Nome próprio do membro
first_name string

Nome próprio do membro

Apelido do membro
last_name string

Apelido do membro

E-mail do membro
email string

E-mail do membro

ID da função de membro
project_role_id string

ID da função de membro

imagem
picture Media
O membro está habilitado
enabled boolean

O membro está habilitado

Data de criação
created_at string

Data de criação

Criado por
created_by string

Criado por

Data de atualização
updated_at string

Data de atualização

Atualizado por
updated_by string

Atualizar por

Módulo

Name Caminho Tipo Description
ID do módulo
id string

ID do módulo

project_id
project_id string
Nome do módulo
name string

Nome do módulo

Ordem de exibição do módulo
order double

Ordem de exibição do módulo

Ícone do módulo
icon string

Ícone do módulo

Cor do módulo
color string

Cor do módulo

Tipo de módulo
type string

Tipo de módulo

names
names array of LocalizedLabel
Data de criação do módulo
created_at string

Data de criação do módulo

Data de atualização do módulo
updated_at string

Data de atualização do módulo

O módulo está ativado
enabled boolean

O módulo está ativado

definições
settings ModuleSettings

ModuleCategory

Name Caminho Tipo Description
ID da categoria
id string

ID da categoria

ID do módulo de categoria
module_id string

ID do módulo de categoria

ID do contêiner da categoria
container_id string

ID do contêiner da categoria

Nome da categoria
name string

Nome da categoria

ID da categoria pai
parent_id string

ID da categoria pai

Data de criação da categoria
created_at string

Data de criação da categoria

Data de atualização da categoria
updated_at string

Data de atualização da categoria

Data de eliminação da categoria
deleted_at string

Data de eliminação da categoria

A categoria está ativada
enabled boolean

A categoria está ativada

ModuleForm

Name Caminho Tipo Description
ID do módulo
id string

ID do módulo

ID do projeto
project_id string

ID do projeto

Nome do módulo
name string

Nome do módulo

Ordem dos módulos
order double

Ordem de exibição do módulo

Ícone do módulo
icon string

Ícone do módulo

Cor do módulo
color string

Cor do módulo

Tipo de módulo
type string

Tipo de módulo

names
names array of LocalizedLabel
Data de criação do módulo
created_at string

Configurações do módulo

Data de atualização do módulo
updated_at string

Configurações do módulo

O módulo está ativado
enabled boolean

Configurações do módulo

MóduloOrgaSugestão

Name Caminho Tipo Description
Sugestão padrão
is_default boolean

Sugestão padrão

Nomes de sugestões
names array of LocalizedLabel

Nomes de sugestões

id
id string
container_id
container_id string
container_type
container_type string
Nome da sugestão
name string

Nome da sugestão

icon
icon string
color
color string
Tipo de sugestão
type string

Tipo de sugestão

Visibilidade da sugestão
visibility string

Visibilidade da sugestão

criado_em
created_at string
updated_at
updated_at string

Configurações do módulo

Name Caminho Tipo Description
is_observation_library_mandatory
is_observation_library_mandatory boolean
is_description_mandatory
is_description_mandatory boolean
is_photo_mandatory
is_photo_mandatory boolean
is_company_mandatory
is_company_mandatory boolean
is_group_mandatory
is_group_mandatory boolean
due_date_days_offset
due_date_days_offset string

ObservaçãoObservação ComumObservação

Name Caminho Tipo Description
CommonObs Id
id string

CommonObs Id

CommonObs Trade Id
trade_id string

CommonObs Trade Id

Nome CommonObs
name string

Nome CommonObs

Nomes CommonObs
names array of LocalizedLabel

Nomes CommonObs

O CommonObs está ativado
enabled boolean

O CommonObs está ativado

Data de criação
created_at string

Data de criação

Criado por
created_by string

Criado por

Data de atualização
updated_at string

Data de atualização

Atualizado por
updated_by string

Atualizar por

ObservationMediaResource

Name Caminho Tipo Description
ID de mídia
id string

ID de mídia

Ordem dos meios de comunicação social
position string

Ordem dos meios de comunicação social

Tipo MIME de mídia
mime_type string

Tipo MIME de mídia

Nome do arquivo de mídia
file_name string

Nome do arquivo de mídia

OrgaMemberResponses

Name Caminho Tipo Description
ID de utilizador
user_id string
e-mail
email string
primeiro_nome
first_name string
sobrenome
last_name string
is_admin
is_admin boolean
is_pending
is_pending boolean
media_resource
media_resource Media

Phase

Name Caminho Tipo Description
ID da fase
id string

ID da fase

Ordem de fase
order double

Ordem de fase

Nome da fase
name string

Nome da fase

Nomes de fase
names array of LocalizedLabel

Nomes de fase

A fase está ativada
enabled boolean

A fase está ativada

Data de criação da fase
created_at string

Data de criação da fase

Data de atualização da fase
updated_at string

Data de atualização da fase

Data de eliminação da fase
deleted_at string

Data de eliminação da fase

Priority

Name Caminho Tipo Description
ID de prioridade
id string

ID de prioridade

Nome da prioridade
name string

Nome da prioridade

Ordem de prioridade
position integer

Ordem de prioridade

Cor prioritária
color string

Cor prioritária

icon
icon IconTypeParameters
ID de prioridade
is_default boolean

ID de prioridade

A prioridade é padrão
names array of LocalizedLabel

A prioridade é padrão

A prioridade está ativada
enabled boolean

A prioridade está ativada

Data de criação
created_at string

Data de criação

Criado por
created_by string

Criado por

Data de atualização
updated_at string

Data de atualização

Atualizado por
updated_by string

Atualizar por

Projeto

Name Caminho Tipo Description
ID do projeto
project_id string

ID do projeto

ID da organização do projeto
organization_id string

ID da organização do projeto

Nome do projeto
name string

Nome do projeto

Caso de projeto
case_number string

Caso de projeto

ID do espaço de trabalho do projeto
workspace_id string

ID do espaço de trabalho do projeto

Descrição do projeto
description string

Descrição do projeto

Data de conclusão do projeto
end_date string

Data de conclusão do projeto

Contagem de membros do projeto
member_count integer

Contagem de membros do projeto

O projeto foi arquivado
is_archived boolean

O projeto foi arquivado

media_resource
media_resource Media
É usuário atual no projeto
current_user_in_project boolean

O usuário atual está no projeto?

Projeto está ativo
is_active boolean

Projeto está ativo

Estado do projeto
status string

Estado do projeto

Data de criação
created_at string

Data de criação

Criado por
created_by string

Criado por

Data de atualização
updated_at string

Data de atualização

Atualizado por
updated_by string

Atualizar por

ProjectRole

Name Caminho Tipo Description
Lista de utilizadores
user_ids array of string

Lista de utilizadores

ID da função
id string

ID da função

Nome do Direito de Acesso
name string

Nome do Direito de Acesso

Nomes de funções
names array of LocalizedLabel

Nomes de funções

Descrições de funções
descriptions array of LocalizedLabel

Descrições de funções

Data de criação
created_at string

Data de criação

Criado por
created_by string

Criado por

Data de atualização
updated_at string

Data de atualização

Atualizado por
updated_by string

Atualizar por

ProjectTrade

Name Caminho Tipo Description
ID comercial
id string

ID de Negociações

Está ativado
enabled boolean

Está ativado

Designação comercial
name string

Designação comercial

Denominações comerciais
names array of LocalizedLabel

Denominações comerciais

ID do módulo
module_id string

ID do módulo

Data de criação
created_at string

Data de criação

Criado por
created_by string

Criado por

Data de atualização
updated_at string

Data de atualização

Atualizado por
updated_by string

Atualizar por

StatusResponseWithoutFlow

Name Caminho Tipo Description
ID de status
id string

ID de status

Nome do status
name string

Nome do status

Ordem de status
position integer

Ordem de status

Cor de status
color string

Cor de status

O status é padrão
is_default boolean

O status é padrão

O status está ativado
enabled boolean

O status está ativado

Nomes de status
names array of LocalizedLabel

Nomes de status

Data de criação
created_at string

Data de criação

Criado por
created_by string

Criado por

Data de atualização
updated_at string

Data de atualização

Atualizado por
updated_by string

Atualizar por

StatusResponseWithoutLanguage

Name Caminho Tipo Description
ID de status
id string

ID de status

Nome do status
name string

Nome do status

Ordem de status
position integer

Ordem de status

Cor de status
color string

Cor de status

O status está ativado
enabled boolean

O status está ativado

TimeZones

Name Caminho Tipo Description
ID de fuso horário
id string

ID de fuso horário

Nome do fuso horário
display_name string

Nome do fuso horário

Nome padrão de fuso horário
standard_name string

Nome padrão de fuso horário

Deslocamento UTC de fuso horário
utc_offset string

Deslocamento UTC de fuso horário

UploadChunkInit

Name Caminho Tipo Description
Atraso de expiração do carregamento
expires_after_secs double

Atraso de expiração do carregamento

ID do bloco
chunk_id string

ID do bloco

ID de mídia
media_id string

ID de mídia

Tamanho mínimo do bloco
min_chunk_size integer

Tamanho mínimo do bloco

Espaço de trabalho

Name Caminho Tipo Description
ID do espaço de trabalho
workspace_id string

ID do espaço de trabalho

Nome do espaço de trabalho
name string

Nome do espaço de trabalho

ID pai do espaço de trabalho
parent_id string

ID pai do espaço de trabalho

Referência do espaço de trabalho
client_reference string

Referência do espaço de trabalho

media_resource
media_resource Media
Data de exclusão do espaço de trabalho
deleted_by string

Data de exclusão do espaço de trabalho

Espaço de trabalho excluído por
deleted_at string

Espaço de trabalho excluído por

Data de criação
created_at string

Data de criação

Criado por
created_by string

Criado por

Data de atualização
updated_at string

Data de atualização

Atualizado por
updated_by string

Atualizar por