Compartilhar via


Finalcad One Connect 4.0 (versão prévia)

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 a centenas de outros aplicativos para simplificar o acompanhamento de projetos, automatizar tarefas repetitivas e aumentar a eficiência geral.

Esse conector está disponível nos seguintes produtos e regiões:

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – 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
Publicador FINALCAD
Site 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.

Triggers

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

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:

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

Essa não é uma conexão compartilhável. Se o aplicativo de energia 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

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 100 60 segundos

Ações

Configuração – Idioma e fuso horário

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

Configuração – Projeto

Configurar a configuração do projeto

Mídia - Parte da parte de acréscimo

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

Mídia – Anular upload de partes

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

Mídia – Iniciar carregamento de parte

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

Mídia – Obter URL do recurso de mídia

Recuperar a URL para acessar um recurso de mídia

Mídia – Validar upload de partes

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

Obter linguagens

Obter 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 – Criar um projeto

Criar um projeto

Organização – Obter funções

Obter funções de organização

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

Obter a lista de todas as organizações em que você é 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 à sua organização

Organização – Obter o status dos formulários

Obter o status dos formulários em um modelo

Organização – Obter usuário conectado

Obter informações do usuário

Organização – Obter workspaces

Obter workspaces relacionados à sua organização

Projeto – Adicionar usuários

Adicionar usuários em 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 negociações)

Projeto – Obter detalhes de observação

Obter os detalhes de uma determinada observação (descrição, status, atribuído,...)

Projeto – Obter detalhes do formulário

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

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

Obter as empresas em seu projeto

Projeto – Obter fases

Obter as fases em seu projeto

Projeto – Obter funções

Obter funções de projeto

Projeto – Obter grupos de discussão

Obter os grupos de discussão em seu projeto

Projeto – Obter modelos de formulários

Obter modelos de formulários

Projeto – Obter modelos de observação

Obter modelos de observação (a categoria anteriormente era chamada de 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 pastas de documento

Obter pastas de documento em seu projeto

Projeto – Obter planos ou pastas

Obter os planos ou pastas em seu projeto

Projeto – Obter prioridades de formulários

Obter as prioridades dos formulários em seu projeto

Projeto – Obter prioridades de observações

Obter as prioridades de observações em seu projeto

Projeto – Obter status de observação

Obter o status de observações em seu projeto

Projeto – Obter usuários

Obter os usuários em seu projeto

Workspace – Adicionar membros

Adicionar membros a um workspace

Configuração – Idioma e fuso horário

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Linguagem
language string

Linguagem

Fuso horário
timezone string

Fuso horário do usuário (no formato IANA)

Retornos

Nome Caminho Tipo Description
linguagem
language string
timezone
timezone string

Configuração – Projeto

Configurar a configuração do projeto

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da organização
business_organization_id string

ID da organização

ID do projeto
project_id string

ID do projeto

Retornos

Nome Caminho Tipo Description
business_organization_id
business_organization_id string
project_id
project_id string

Mídia - Parte da parte de acréscimo

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

Parâmetros

Nome Chave Obrigató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 da Parte

Última chamada?
last_chunk boolean

Última chamada?

filename
filename True string
tipo de conteúdo
contentType True string
conteúdo
content True byte

Mídia – Anular upload de partes

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

Parâmetros

Nome Chave Obrigató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

Retornos

Corpo
Media

Mídia – Iniciar carregamento de parte

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

Parâmetros

Nome Chave Obrigató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 da mídia em bytes
total_bytes True integer

Tamanho total da mídia em bytes

MD5 de mídia
md5 string

MD5 de mídia

Retornos

Mídia – Obter URL do recurso de mídia

Recuperar a URL para acessar um recurso de mídia

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de mídia
mediaId True string

ID de mídia

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Retornos

Mídia – Validar upload de partes

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

Parâmetros

Nome Chave Obrigató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

Retornos

Corpo
Media

Obter linguagens

Obter todos os idiomas disponíveis para bibliotecas e itens

Parâmetros

Nome Chave Obrigatório Tipo Description
Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Retornos

Corpo
GetLanguages

Obter lista de fusos horários

Obter a lista de fusos horários disponíveis

Parâmetros

Nome Chave Obrigatório Tipo Description
Número máximo de fusos horários a serem recuperados.
limit string

Número máximo de fusos horários a serem recuperados.

Nº fuso horário.
offset string

Nº fuso horário.

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Retornos

Corpo
GetTimeZones

Organização – Adicionar membros

Adicionar membros a uma organização

Parâmetros

Nome Chave Obrigató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

Email dos usuários
users_info array of string

email dos usuários

Organização – Criar um projeto

Criar um projeto

Parâmetros

Nome Chave Obrigató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 workspace do projeto
workspace_id string

ID do workspace do projeto

IDs de módulos do projeto
module_ids array of string

IDs de módulos do projeto

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 término do projeto
end_date string

Data de término do projeto

Retornos

Organização – Obter funções

Obter funções de organização

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da organização
organizationId True string

ID da organização

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Retornos

Corpo
GetRoles

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

Obter a lista de todas as organizações em que você é membro

Parâmetros

Nome Chave Obrigatório Tipo Description
Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Retornos

Nome 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

Nome Chave Obrigatório Tipo Description
ID da organização
organizationId True string

ID da organização

ID do workspace
workspace_id string

ID do workspace

Incluir workspaces filho
with_workspace_children boolean

Incluir workspaces filho

Termo de pesquisa
search_term string

Termo de pesquisa

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Retornos

Corpo
GetProjects

Organização – Obter módulos sugeridos

Obter módulos sugeridos relacionados à sua organização

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da organização
organizationId True string

ID da organização

ID do workspace
workspace_id string

ID do workspace

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

Número máximo de módulos

Nth module
offset string

Nth module

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Retornos

Organização – Obter o status dos formulários

Obter o status dos formulários em um modelo

Parâmetros

Nome Chave Obrigató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

Retornos

Organização – Obter usuário conectado

Obter informações do usuário

Parâmetros

Nome Chave Obrigatório Tipo Description
Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Retornos

Corpo
GetUserInfo

Organização – Obter workspaces

Obter workspaces relacionados à sua organização

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da organização
organizationId True string

ID da organização

ID do workspace pai
parent_id string

ID do workspace pai

Incluir filhos
with_children string

Incluir filhos

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Retornos

Projeto – Adicionar usuários

Adicionar usuários em seu projeto

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do projeto
projectId True string

ID do projeto

Não enviar email aos usuários
doNotSendEmail boolean

Não enviar email aos usuários

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Email do Usuário
email True string

Email do Usuário

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

ID da função de usuário

Retornos

Corpo
AddMembers

Projeto – Criar um documento

Projeto – Criar um documento

Parâmetros

Nome Chave Obrigató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

ID pai do documento
parent_id string

ID da pasta principal

ID de mídia do documento
media_id string

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

Retornos

Projeto – Criar um formulário

Criar um formulário

Parâmetros

Nome Chave Obrigató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 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 de formulário

ID do status do formulário
status_id string

ID do status do formulário

ID da Empresa de Formulários
company_id string

ID da empresa atribuída ao formulário

ID do Atribuídor de Formulários
assignee_id string

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

ID do plano de formulário
plan_id string

ID do plano de formulário

Posição do Formulário X
position_x decimal

Posição do Formulário X no plano 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 de Formulário
longitude decimal

Longitude de formulário

ID de prioridade do formulário
priority_id string

ID de prioridade do formulário

Data de conclusão do formulário
due_date string

Data de conclusão do formulário

ID da fase do formulário
phase_id string

ID da fase do formulário

ID do formulário
id string

ID do formulário

Retornos

Projeto – Criar uma observação

Criar uma observação

Parâmetros

Nome Chave Obrigató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 anteriormente era chamado de observação comum

Descrição da observação
description string

Descrição da observação

ID do Status de Observação
status_id string

ID do status da observação

ID da empresa de observação
company_id string

ID da empresa atribuída à observação

ID do Atribuídor de Observação
assignee_id string

ID de usuário atribuída à 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

Posição de Observação Y 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 conclusão da observação
due_date string

Data de conclusão 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 no qual a observação deve ser compartilhada após 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

Retornos

Projeto – Obter categorias de formulário

Obter categorias de formulário

Parâmetros

Nome Chave Obrigató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 desabilitado
with_disabled string

Incluir desabilitado

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Retornos

Projeto – Obter categorias de observação

Obter categorias de observação (anteriormente negociações)

Parâmetros

Nome Chave Obrigató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

Retornos

Projeto – Obter detalhes de observação

Obter os detalhes de uma determinada observação (descrição, status, atribuído,...)

Parâmetros

Nome Chave Obrigató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

Retornos

Projeto – Obter detalhes do formulário

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

Parâmetros

Nome Chave Obrigató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

Retornos

Corpo
GetFormFull

Projeto – Obter detalhes do projeto

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do projeto
projectId True string

ID do projeto

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Retornos

Corpo
GetProject

Projeto – Obter documento ou pasta

Obter um documento ou pasta

Parâmetros

Nome Chave Obrigató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

Retornos

Corpo
Document

Projeto – Obter empresas

Obter as empresas em seu projeto

Parâmetros

Nome Chave Obrigató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 serem recuperadas
limit integer

Número máximo de empresas a serem recuperadas

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Retornos

Corpo
GetCompanies

Projeto – Obter fases

Obter as fases em seu projeto

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do projeto
projectId True string

ID do projeto

Token contínuo
continuous_token string

Token contínuo

Nth phase
offset string

Nth phase

Número máximo de fases a serem recuperadas
limit integer

Número máximo de fases a serem recuperadas

Incluir excluído
with_deleted boolean

Incluir excluído

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Retornos

Corpo
GetPhases

Projeto – Obter funções

Obter funções de projeto

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do projeto
projectId True string

ID do projeto

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

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

Nth role
offset string

Nth role

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Retornos

Projeto – Obter grupos de discussão

Obter os grupos de discussão em seu projeto

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do projeto
projectId True string

ID do projeto

Número máximo de grupos de discussão a serem recuperados
limit integer

Número máximo de grupos de discussão a serem recuperados

O nº grupo de discussão do qual desejo recuperar os grupos de discussão
offset integer

O nº grupo de discussão do qual desejo recuperar os grupos de discussão

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Retornos

Corpo
GetGroups

Projeto – Obter modelos de formulários

Obter modelos de formulários

Parâmetros

Nome Chave Obrigató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

Retornos

Corpo
GetForms

Projeto – Obter modelos de observação

Obter modelos de observação (a categoria anteriormente era chamada de comércio)

Parâmetros

Nome Chave Obrigató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

Retornos

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

Nome Chave Obrigató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 serem recuperados
limit integer

Número máximo de módulos a serem recuperados

Incluir excluído
with_deleted boolean

Incluir excluído

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Retornos

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

Nome Chave Obrigató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 serem recuperados
limit integer

Número máximo de módulos a serem recuperados

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Retornos

Corpo
GetModules

Projeto – Obter pastas de documento

Obter pastas de documento em seu projeto

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do projeto
projectId True string

ID do projeto

ID da pasta pai
parent_id string

ID da pasta pai

Filtrar tipo de conteúdo ÔÇÿfolder', 'documentÔÇÖ ou nada.
type string

Filtrar tipo de conteúdo ÔÇÿfolder', 'documentÔÇÖ ou nada.

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Retornos

Projeto – Obter planos ou pastas

Obter os planos ou pastas em seu projeto

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do projeto
projectId True string

ID do projeto

ID da pasta
folder_id string

ID da pasta

Incluir apenas planos ou pastas
type string

Incluir apenas planos ou pastas

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Retornos

Projeto – Obter prioridades de formulários

Obter as prioridades dos formulários em seu projeto

Parâmetros

Nome Chave Obrigató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 serem recuperadas
limit integer

Número máximo de prioridades a serem recuperadas

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Retornos

Projeto – Obter prioridades de observações

Obter as prioridades de observações em seu projeto

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do projeto
projectId True string

ID do projeto

Token contínuo
continuous_token string

Token contínuo

Prioridade de Nth
offset string

Prioridade de Nth

Número máximo de prioridades od a serem recuperadas
limit integer

Número máximo de prioridades od a serem recuperadas

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Retornos

Projeto – Obter status de observação

Obter o status de observações em seu projeto

Parâmetros

Nome Chave Obrigató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 status a ser recuperado
limit integer

Número máximo de status a ser recuperado

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Retornos

Corpo
GetStatuses

Projeto – Obter usuários

Obter os usuários em seu projeto

Parâmetros

Nome Chave Obrigató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 serem recuperados
limit integer

Número máximo de membros a serem recuperados

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Retornos

Corpo
GetMembers

Workspace – Adicionar membros

Adicionar membros a um workspace

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da organização
organizationId True string

ID da organização

ID do workspace
workspaceId True string

ID do workspace

Linguagem
Accept-Language string

Linguagem

TimeZone
X-TimeZone string

TimeZone

Identificação de usuário
user_id string

Identificação de usuário

Email do Usuário
user_email string

Email do Usuário

Retornos

Gatilhos

Gatilho – Documento criado

Disparar o fluxo quando um documento é criado

Gatilho – Formulário atualizado

Disparar o fluxo quando um formulário for atualizado

Gatilho – Formulário criado

Disparar o fluxo quando um formulário é criado

Gatilho – Observação atualizada

Disparar o fluxo quando uma observação for atualizada

Gatilho – Observação criada

Disparar o fluxo quando uma observação é criada

Gatilho – Documento criado

Disparar o fluxo quando um documento é criado

Parâmetros

Nome Chave Obrigatório Tipo Description
business_organization_id
business_organization_id True string

ID da organização

project_id
project_id True string

ID do projeto

Retornos

Nome Caminho Tipo Description
parent_id
parent_id string

parent_id

evento
event integer

evento

element_id
element_id string

element_id

data1
data1 string

data1

data2
data2 string

data2

data3
data3 string

data3

Gatilho – Formulário atualizado

Disparar o fluxo quando um formulário for atualizado

Parâmetros

Nome Chave Obrigatório Tipo Description
business_organization_id
business_organization_id True string

ID da organização

project_id
project_id True string

ID do projeto

Retornos

Nome Caminho Tipo Description
parent_id
parent_id string

parent_id

evento
event integer

evento

element_id
element_id string

element_id

data1
data1 string

data1

data2
data2 string

data2

data3
data3 string

data3

Gatilho – Formulário criado

Disparar o fluxo quando um formulário é criado

Parâmetros

Nome Chave Obrigatório Tipo Description
business_organization_id
business_organization_id True string

ID da organização

project_id
project_id True string

ID do projeto

Retornos

Nome Caminho Tipo Description
parent_id
parent_id string

parent_id

evento
event integer

evento

element_id
element_id string

element_id

data1
data1 string

data1

data2
data2 string

data2

data3
data3 string

data3

Gatilho – Observação atualizada

Disparar o fluxo quando uma observação for atualizada

Parâmetros

Nome Chave Obrigatório Tipo Description
business_organization_id
business_organization_id True string

ID da organização

project_id
project_id True string

ID do projeto

Retornos

Nome Caminho Tipo Description
parent_id
parent_id string

parent_id

evento
event integer

evento

element_id
element_id string

element_id

data1
data1 string

data1

data2
data2 string

data2

data3
data3 string

data3

Gatilho – Observação criada

Disparar o fluxo quando uma observação é criada

Parâmetros

Nome Chave Obrigatório Tipo Description
business_organization_id
business_organization_id True string

ID da organização

project_id
project_id True string

ID do projeto

Retornos

Nome Caminho Tipo Description
parent_id
parent_id string

parent_id

evento
event integer

evento

element_id
element_id string

element_id

data1
data1 string

data1

data2
data2 string

data2

data3
data3 string

data3

Definições

AddMembers

Nome Caminho Tipo Description
Lista de usuários
project_roles array of ProjectRole

Lista de usuários

Empresa

Nome 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 da atualização
updated_at string

Data da atualização

Atualizado por
updated_by string

Atualizar por

CreateDocument

Nome 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á habilitado
enabled boolean

O documento está habilitado

Tipo de documento
file_type string

Tipo de documento

Origem do documento
item_source string

Origem do documento

Data de criação
created_at string

Data de criação

Criado por
created_by string

Criado por

Data da atualização
updated_at string

Data da atualização

Atualizado por
updated_by string

Atualizar por

CreateFormInstance

Nome 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 do status do formulário
status_id string

ID do 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

Posição do Formulário X
position_x decimal

Posição do Formulário X

Posição do Formulário Y
position_y decimal

Posição do Formulário Y

Latitude do formulário
latitude decimal

Latitude do formulário

Longitude de formulário
longitude decimal

Longitude de formulário

ID do usuário do formulário
assignee_id string

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

ID da empresa de formulário
company_id string

ID da empresa atribuída ao formulário

Data de conclusão do formulário
due_date string

Data de conclusão do formulário

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

ID de criação de 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 de formulário
category_id string

ID da categoria de formulário

Data de criação
created_at string

Data de criação

Criado por
created_by string

Criado por

Data da atualização
updated_at string

Data da atualização

Atualizado por
updated_by string

Atualizar por

CreateObservation

Nome 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 da atualização
updated_at string

Data da atualização

Atualizado por
updated_by string

Atualizar por

CreateProject

Nome Caminho Tipo Description
Endereço do projeto
address string

Endereço do projeto

Fuso horário do projeto
time_zone string

Fuso horário do Project IANA

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 do projeto
case_number string

Caso do projeto

ID do workspace do projeto
workspace_id string

ID do workspace do projeto

Descrição do projeto
description string

Descrição do projeto

Data de término do projeto
end_date string

Data de término do projeto

Contagem de membros do projeto
member_count integer

Contagem de membros do projeto

O projeto é arquivado
is_archived boolean

O projeto é arquivado

media_resource
media_resource Media
O usuário atual está no projeto
current_user_in_project boolean

O usuário atual está no projeto?

O Project está ativo
is_active boolean

O Project está ativo

Status do projeto
status string

Status do projeto

Data de criação
created_at string

Data de criação

Criado por
created_by string

Criado por

Data da atualização
updated_at string

Data da atualização

Atualizado por
updated_by string

Atualizar por

Documento

Nome 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á habilitado
enabled boolean

O documento está habilitado

Tipo de documento
file_type string

Tipo de documento

Origem do documento
item_source string

Origem do documento

Data de criação
created_at string

Data de criação

Criado por
created_by string

Criado por

Data da atualização
updated_at string

Data da atualização

Atualizado por
updated_by string

Atualizar por

FolderContent

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

ID de conteúdo da pasta

Tipo de conteúdo de pasta
type string

Tipo de conteúdo de pasta

Nome do conteúdo da pasta
name string

Nome do conteúdo da pasta

Ordem de conteúdo da pasta
order double

Ordem de 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

Isourced de conteúdo da pasta

Pasta de conteúdo da pasta
sources_contained string

Pasta de conteúdo da pasta

O conteúdo da pasta está habilitado
enabled boolean

O conteúdo da pasta está habilitado

Formulário

Nome Caminho Tipo Description
ID do Modelo
id string

ID do Modelo

Nome do modelo
name string

Nome do modelo

Modelo habilitado
enabled boolean

Modelo habilitado 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 de modelo
category_id string

ID da categoria de 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

Nome Caminho Tipo Description
CommonObs
common_observations array of ObservationCommonObservation

CommonObs

GetCompanies

Nome Caminho Tipo Description
Empresas
companies array of Company

Empresas

A lista é incomplet
need_to_relaunch boolean

A lista é incomplet

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

Nome Caminho Tipo Description
Documentos
documents array of Document
count
count integer

GetFolderContent

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

Conteúdo da pasta

count
count integer

GetFormFull

Nome 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 habilitado
enabled boolean

Formulário habilitado

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 do status do formulário
status_id string

ID do 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 da prioridade do formulário
priority_name string

Nome da prioridade do formulário

ID do usuário do formulário
assignee_id string

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

Nome de usuário do formulário
assignee_name string

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

ID da empresa de formulário
company_id string

ID da empresa de formulário

Nome da empresa do formulário
company_name string

Nome da empresa atribuída ao formulário

Data de conclusão do formulário
due_date string

Data de conclusão 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

Posição do Formulário X
position_x string

Posição do Formulário X

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 de formulário
longitude string

Longitude de formulário

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 de formulário
category_id string

ID da categoria de 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 excluído por
deleted_by string

Formulário excluído pela 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 da atualização
updated_at string

Data da atualização

Atualizado por
updated_by string

Atualizar por

GetFormStatuses

Nome Caminho Tipo Description
Estados
statuses array of StatusResponseWithoutLanguage

Estados

count
count integer

GetForms

Nome Caminho Tipo Description
Lista de modelos
forms array of Form

Lista de modelos

count
count integer

GetGroup

Nome Caminho Tipo Description
ID do grupo
id string

ID do grupo

Nome do grupo
name string

Nome do grupo

GetGroups

Nome Caminho Tipo Description
Groups
groups array of GetGroup

Groups

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

GetLanguage

Nome Caminho Tipo Description
Código de idioma
code string

Código de idioma

Descrição da linguagem
name string

Descrição da linguagem

GetLanguages

Nome Caminho Tipo Description
Lista de idiomas
langs array of GetLanguage

Lista de idiomas

Contagem de idiomas
count integer

Contagem de idiomas

GetMembers

Nome Caminho Tipo Description
Membros do projeto
project_members array of Member

Membros do projeto

A lista é incomplet
need_to_relaunch boolean

A lista é incomplet

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

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

lista de módulos de projeto

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

GetModulesCategories

Nome Caminho Tipo Description
Categorias
categories array of ModuleCategory

Categorias

count
count integer

GetModulesForm

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

Lista de módulos

A lista é incomplet
need_to_relaunch boolean

A lista é incomplet

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

GetModulesOrgaSuggestion

Nome Caminho Tipo Description
Sugestões
suggestions array of ModuleOrgaSuggestion

Sugestões

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

GetObservationFull

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

ID de observação

Número de observação
legacy_id integer

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 status da observação
status_id string

ID do status da observação

Nome do status da observação
status_name string

Nome do status da 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

Posição de Observação Y
position_y decimal

Posição de Observação Y

Latitude de observação
latitude decimal

Latitude de observação

Longitude de observação
longitude decimal

Longitude de observação

ID do usuário de observação
assignee_id string

ID de usuário atribuída à observação

Nome de usuário de observação
assignee_name string

Nome de usuário atribuído à observação

ID da empresa de observação
company_id string

ID da empresa atribuída à observação

Nome da empresa de observação
company_name string

Nome da empresa atribuído à observação

ID do comércio de observação
trade_id string

ID do comércio de observação

Nome do comércio de observação
trade_name string

Nome do comércio de observação

ID de commonobs de observação
common_observation_id string

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

Nome commonobs de observação
common_observation_name string

Observação de nome de observação comum

Data de conclusão da observação
due_date string

Data de conclusão 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 da atualização da observação
client_updated_at string

Data da 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 da atualização
updated_at string

Data da atualização

Atualizado por
updated_by string

Atualizar por

GetPhases

Nome Caminho Tipo Description
Fases
phases array of Phase

Fases

A lista é incomplet
need_to_relaunch boolean

A lista é incomplet

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

Nome Caminho Tipo Description
Prioridades
priorities array of Priority

Prioridades

A lista é incomplet
need_to_relaunch boolean

A lista é incomplet

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

Nome Caminho Tipo Description
Endereço do projeto
address string

Endereço do projeto

Fuso horário do projeto
time_zone string

Fuso horário do Project IANA

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 do projeto
case_number string

Caso do projeto

ID do workspace do projeto
workspace_id string

ID do workspace do projeto

Descrição do projeto
description string

Descrição do projeto

Data de término do projeto
end_date string

Data de término do projeto

Contagem de membros do projeto
member_count integer

Contagem de membros do projeto

O projeto é arquivado
is_archived boolean

O projeto é arquivado

media_resource
media_resource Media
O usuário atual está no projeto
current_user_in_project boolean

O usuário atual está no projeto?

O Project está ativo
is_active boolean

O Project está ativo

Status do projeto
status string

Status do projeto

Data de criação
created_at string

Data de criação

Criado por
created_by string

Criado por

Data da atualização
updated_at string

Data da atualização

Atualizado por
updated_by string

Atualizar por

GetProjectRoles

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

GetProjects

Nome Caminho Tipo Description
Lista de projetos
projects array of Project

Lista de projetos

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

GetRole

Nome 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

Nome Caminho Tipo Description
organization_roles
organization_roles array of GetRole

GetStatuses

Nome Caminho Tipo Description
Estados
statuses array of StatusResponseWithoutFlow

Estados

A lista é incomplet
need_to_relaunch boolean

A lista é incomplet

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

Nome 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
deslocamento
offset integer

GetTradesByModule

Nome Caminho Tipo Description
Serviços
trades array of ProjectTrade

Serviços

GetUserInfo

Nome Caminho Tipo Description
ID do Usuário
id string

ID do Usuário

Nome do usuário
first_name string

Nome do usuário

Sobrenome do usuário
last_name string

Sobrenome do usuário

Email do usuário
email string

Email do usuário

Nome da empresa de usuário
company string

Nome da empresa de usuário

está ativo
is_active string

está ativo

email_validated
email_validated string
Data de criação do usuário
created_at string

Data de criação do usuário

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

GetWorkspaceMembers

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

GetWorkspaces

Nome Caminho Tipo Description
Workspaces
workspaces array of Workspace

Workspaces

IconTypeParameters

LocalizedLabel

Nome Caminho Tipo Description
linguagem
language string
tradução
translation string

LocalizedLabelFallback

Nome Caminho Tipo Description
translation_fallback
translation_fallback string
Traduções
translations array of LocalizedLabel

Mídia

Nome 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 da mídia
created_at string

Data de criação da mídia

MediaResourceUrl

Nome Caminho Tipo Description
URL de mídia
url string

URL de mídia

Membro

Nome Caminho Tipo Description
ID do membro
user_id string

ID do membro

Nome do membro
first_name string

Nome do membro

Sobrenome do membro
last_name string

Sobrenome do membro

Email do membro
email string

Email 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 da atualização
updated_at string

Data da atualização

Atualizado por
updated_by string

Atualizar por

Módulo

Nome 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á habilitado
enabled boolean

O módulo está habilitado

configurações
settings ModuleSettings

ModuleCategory

Nome 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 de categoria
container_id string

ID do contêiner de 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 exclusão da categoria
deleted_at string

Data de exclusão da categoria

A categoria está habilitada
enabled boolean

A categoria está habilitada

ModuleForm

Nome 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 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

Configurações do módulo

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

Configurações do módulo

O módulo está habilitado
enabled boolean

Configurações do módulo

ModuleOrgaSuggestion

Nome Caminho Tipo Description
Padrão de sugestão
is_default boolean

Padrão de sugestão

Nomes de sugestão
names array of LocalizedLabel

Nomes de sugestão

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

ModuleSettings

Nome 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

ObservationCommonObservation

Nome 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

CommonObs está habilitado
enabled boolean

CommonObs está habilitado

Data de criação
created_at string

Data de criação

Criado por
created_by string

Criado por

Data da atualização
updated_at string

Data da atualização

Atualizado por
updated_by string

Atualizar por

ObservationMediaResource

Nome Caminho Tipo Description
ID de mídia
id string

ID de mídia

Ordem de mídia
position string

Ordem de mídia

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

Nome Caminho Tipo Description
id_do_usuário
user_id string
email
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

Nome 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á habilitada
enabled boolean

A fase está habilitada

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 exclusão da fase
deleted_at string

Data de exclusão da fase

Priority

Nome 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 da prioridade
color string

Cor da prioridade

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á habilitada
enabled boolean

A prioridade está habilitada

Data de criação
created_at string

Data de criação

Criado por
created_by string

Criado por

Data da atualização
updated_at string

Data da atualização

Atualizado por
updated_by string

Atualizar por

Projeto

Nome 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 do projeto
case_number string

Caso do projeto

ID do workspace do projeto
workspace_id string

ID do workspace do projeto

Descrição do projeto
description string

Descrição do projeto

Data de término do projeto
end_date string

Data de término do projeto

Contagem de membros do projeto
member_count integer

Contagem de membros do projeto

O projeto é arquivado
is_archived boolean

O projeto é arquivado

media_resource
media_resource Media
O usuário atual está no projeto
current_user_in_project boolean

O usuário atual está no projeto?

O Project está ativo
is_active boolean

O Project está ativo

Status do projeto
status string

Status do projeto

Data de criação
created_at string

Data de criação

Criado por
created_by string

Criado por

Data da atualização
updated_at string

Data da atualização

Atualizado por
updated_by string

Atualizar por

ProjectRole

Nome Caminho Tipo Description
Lista de usuários
user_ids array of string

Lista de usuários

ID da função
id string

ID da função

Nome da Função
name string

Nome da Função

Nomes de função
names array of LocalizedLabel

Nomes de função

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

Descrições de função

Data de criação
created_at string

Data de criação

Criado por
created_by string

Criado por

Data da atualização
updated_at string

Data da atualização

Atualizado por
updated_by string

Atualizar por

ProjectTrade

Nome Caminho Tipo Description
ID de negociação
id string

ID de negociações

Está habilitado
enabled boolean

Está habilitado

Nome comercial
name string

Nome comercial

Nomes comerciais
names array of LocalizedLabel

Nomes 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 da atualização
updated_at string

Data da atualização

Atualizado por
updated_by string

Atualizar por

StatusResponseWithoutFlow

Nome 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 do status
color string

Cor do status

O status é padrão
is_default boolean

O status é padrão

O status está habilitado
enabled boolean

O status está habilitado

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 da atualização
updated_at string

Data da atualização

Atualizado por
updated_by string

Atualizar por

StatusResponseWithoutLanguage

Nome 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 do status
color string

Cor do status

O status está habilitado
enabled boolean

O status está habilitado

TimeZones

Nome Caminho Tipo Description
ID do fuso horário
id string

ID do 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

Nome Caminho Tipo Description
Atraso de expiração de upload
expires_after_secs double

Atraso de expiração de upload

ID do bloco
chunk_id string

ID do bloco

ID de mídia
media_id string

ID de mídia

Tamanho mínimo da parte
min_chunk_size integer

Tamanho mínimo da parte

Workspace

Nome Caminho Tipo Description
ID do workspace
workspace_id string

ID do workspace

Nome do espaço de trabalho
name string

Nome do espaço de trabalho

ID pai do workspace
parent_id string

ID pai do workspace

Referência do workspace
client_reference string

Referência do workspace

media_resource
media_resource Media
Data de exclusão do workspace
deleted_by string

Data de exclusão do workspace

Workspace excluído por
deleted_at string

Workspace excluído por

Data de criação
created_at string

Data de criação

Criado por
created_by string

Criado por

Data da atualização
updated_at string

Data da atualização

Atualizado por
updated_by string

Atualizar por