Aqui você encontrará:
Endpoint GetAreas
Endpoint GetProjetosByFilter
Endpoint GetProjetosByFilteSync
Endpoint GetUpdatesSync
Endpoint GetFullDataProjeto
Endpoint GetMensagensAndNotesV3
Endpoint GetTarefaComentarios
Endpoint GetProjeto
Endpoint ActiveCF
Endpoint GetAreas
Descrição:
O endpoint retorna a lista de locais baseado no id do empreendimento. Para o sistema “locais/Áreas” é uma entidade utilizada para representar pavimentos, apartamentos ou qualquer estrutura física que pode ser representada na obra. Em algumas aplicações, pode ser vista como uma pasta.
Método:
POST
URL:
Entrada:
Exemplo
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \
"VAPP": 1, \
"AppKey": "5443c75b-8314-481b-a97b-c2ac057e54e7", \
"IntegrationToken": "3e8a96ab-798c-402d-9c26-7afdb96e22f3", \
"IDObra": 1310 \
Campo | Tipo | Obrigatório | Explicação |
VAPP | int | Não | Chave que identifica a versão do app, preencher com 1 por padrão |
appkey | string | Sim | Chave do aplicativo |
IntegrationToken | string | Sim | Token de autenticação da obra |
IDObra | int | Sim | id da obra que se deseja o retorno |
Saída Esperada (Resposta):
{
"Code": 1,
"Message": "OK",
"Result": [
{
"ID": 161873,
"IDC": "NxmSVOP%2bwjk%3d",
"IDObra": 1310,
"IDObraC": "ZfiJVEQeNBY%3d",
"Nome": "1º Pavimento",
"Data": "01/04/2025",
"QuantidadeAcessos": 0,
"NomeObra": null,
"Ordem": 1,
"Perfil": 0,
"IdTipo": 1,
"TotalDocumentos": 1
}]
}
Campo | Descrição |
id | Id do local |
IDC | id criptografado do local |
IDObraC | id criptografado da obra |
idObra | Id da obra |
Nome | Nome da área |
Data | Data de criação |
QuantidadeAcessos | Quantidade de acessos da obra |
NomeObra | Nome da obra |
Ordem | Ordem definida pelo usuário para listagem da área |
Perfil | Descontinuado |
IdTipo | Define o tipo de privacidade da área { “1”: “Área pública”, “2”: “Área apenas vinculados”, “3”: “Área Inativa” } |
TotalDocumentos | Quantidade de documentos vinculados a área |
Endpoint GetProjetosByFilter
Descrição:
O endpoint retorna a lista de documentos e seus atributos baseados em um conjunto de filtros opcionais.
Método:
POST
URL:
Entrada:
Exemplo
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \
"Filter": "teste", \
"VAPP": 1, \
"Disciplinas": [ \
2, 3, 4 \
], \
"Locais": [ \
161873 \
], \
"StatusDocumento": 1, \
"ApenasNovos": false, \
"ApenasRevisaoSuperior": false, \
"AppKey": "5443c75b-8314-481b-a97b-c2ac057e54e7", \
"IntegrationToken": "3e8a96ab-798c-402d-9c26-7afdb96e22f3", \
"IDObra": 1310 \
}' '
Campo | Tipo | Obrigatório | Explicação |
tp | string | Não | Descontinuado |
Filter | string | Não | Campo para aplicar buscar por texto no título, descrição e nome do documento |
Disciplinas | list<int> | Não | Lista dos ids disciplina que se deseja buscar |
Locais | list<int> | Não | Lista dos ids locais que se deseja buscar |
statusDocumento | int | Não | id status que deseja buscar |
ApenasNovos | Boolean | Não | Se não for definido vai ser considerado como falso. Essa parâmetro define se retorna apenas documentos enviados nos últimos 7 dias ou não. |
ApenasRevisaoSuperior |
|
|
|
VAPP | int | Não | Chave que identifica a versão do app, preencher com 1 por padrão |
appkey | string | Sim | Chave do aplicativo |
IntegrationToken | string | Sim | Token de autenticação da obra |
IDObra | int | Sim | id da obra que se deseja o retorno |
Saída Esperada (Resposta):
{
"Code": 1,
"Message": "OK",
"Result": {
"Projetos": [
{
"ID": 2881925,
"IDC": "%2b1xNfZIYXh4%3d",
"Nome": "ARQ-TESTE-EX-1PAV-R00",
"Data": "02/04/2025",
"Descricao": null,
"Tipo": "ARQ",
"PathURLOriginalFile": null,
"Filename": "S_4434_O_1310_638791854587406506_C_1.pdf",
"IDTipo": 2,
"Folhas": 1,
"Revisao": "R01",
"Fase": 4,
"IDObra": 1310,
"IDObraC": "ZfiJVEQeNBY%3d",
"NomeObra": "ADM 01 | Editado",
"Ordem": 0,
"Areas": [],
"Titulo": null,
"IdPlanta": null,
"IdPlantaC": null,
"nomePlanta": null,
"IdDisciplina": null,
"isUpdate": null,
"ManterObsoletarRevisao": false,
"isPrint": null,
"msg": null,
"IdArea": null,
"nomeArea": null,
"IdAreaC": null,
"Processing": false,
"Revisoes": null,
"Disciplina": null,
"Status": null,
"DataCriacao": "2025-04-02T02:41:59.0000000Z",
"DataUpdate": "2025-04-02T13:11:06.0000000Z",
"IDStatus": 1,
"StatusList": null,
"CanShare": false
}
],
"Disciplinas": [
{
"Nome": "Arquitetura",
"ID": 2,
"Cor": "#17A15E"
}
],
"alertaAnalise": false,
"StatusList": [
{
"ID": 1,
"Nome": "Liberado para obra",
"Ativo": false,
"Cor": "4caf50"
} ],
"Obra": {
"Nome": "ADM 01 | Editado",
}
},
"Success": true
}
Campo | Descrição |
id | Id do documento |
idc | Id criptografado do documento |
Processing | Estado que define se o documento está sendo processado pelo sistema (Gerando visualização em imagem) |
Nome | Nome do documento, sem a revisão |
Filename | Nome interno do documento |
PathURL | URL de acesso ao documento |
Título | Título do documento |
Descrição | Descrição do documento |
Folhas | Quantidade de folhas do documento |
Revisão | Revisão do documento |
Revisões | Lista de revisões do documento |
DataCriacao | Data de envio do primeiro documento daquela árvore de arquivos |
DataUpdate | Data de atualização do documento |
IDStatus | id status do documento
|
IDTipo | id disciplina do documento |
OriginalFileName | Nome original do documento |
Extensao | Extensão do documento |
Fase | Fase construtiva do documento
|
StatusList | Lista de status existentes na obra e os significados |
Obra | Objeto contendo os dados da obra |
Outros campos | Os demais campos foram descontinuados |
Endpoint GetProjetosByFilteSync
Descrição:
O endpoint retorna a lista de documentos e seus atributos baseados em um conjunto de filtros opcionais.
Método:
POST
URL:
Entrada:
Exemplo
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d ' \
{ \
"Tp": "2", \
"Filter": "ARQ", \
"VAPP": 1, \
"AppKey": "5443c75b-8314-481b-a97b-c2ac057e54e7", \
"IntegrationToken": "3e8a96ab-798c-402d-9c26-7afdb96e22f3", \
"IDObra": 1310 \
} \
\
Campo | Tipo | Obrigatório | Explicação |
Tp | string | Não | ID da disciplina que deseja buscar |
Filter | string | Não | Campo para aplicar buscar por texto no título, descrição e nome do documento |
VAPP | int | Não | Chave que identifica a versão do app, preencher com 1 por padrão |
appkey | string | Sim | Chave do aplicativo |
IntegrationToken | string | Sim | Token de autenticação da obra |
IDObra | int | Sim | id da obra que se deseja o retorno |
Saída Esperada (Resposta):
{
"Code": 1,
"Message": "OK",
"Result": {
"Projetos": [
{
"ID": 620122,
"IDC": "2XD48tjuEYg%3d",
"Nome": "1078-ARQ-PRO-003-2PAVIM-GER",
"Data": "25/04/2024",
"Descricao": null,
"Tipo": "ARQ",
"PathURL": "https://www.construcode.com.br/Content/projects/S_455_O_1310_638496644434504554_C_1.jpg",
"PathURLOriginalFile": null,
"Filename": "S_455_O_1310_638496644434504554_C_1.jpg",
"IDTipo": 2,
"Folhas": 0,
"Revisao": "R09",
"Fase": 4,
"IDObra": 1310,
"IDObraC": "ZfiJVEQeNBY%3d",
"NomeObra": "ADM 01 | Editado",
"Ordem": 0,
"Areas": [],
"Titulo": null,
"IdPlanta": null,
"IdPlantaC": null,
"nomePlanta": null,
"urlPlanta": "https://www.construcode.com.br/Content/projects/S_455_O_1310_638496644434504554_C_1.jpg",
"IdDisciplina": null,
"isUpdate": null,
"ManterObsoletarRevisao": false,
"isPrint": null,
"msg": null,
"IdArea": null,
"nomeArea": null,
"IdAreaC": null,
"Processing": false,
"Revisoes": null,
"Disciplina": null,
"Status": null,
"DataCriacao": "2022-10-27T14:05:02.0000000Z",
"DataUpdate": "2024-04-25T20:54:10.0000000Z",
"IDStatus": 1,
"StatusList": null,
"CanShare": false
}]
}
Campo | Descrição |
id | Id do documento |
idc | Id criptografado do documento |
Processing | Estado que define se o documento está sendo processado pelo sistema (Gerando visualização em imagem) |
Nome | Nome do documento, sem a revisão |
Filename | Nome interno do documento |
Areas | Lista de locais/áreas vinculadas ao documento |
PathURL | URL de acesso ao documento |
Título | Título do documento |
Descrição | Descrição do documento |
Folhas | Quantidade de folhas do documento |
Revisão | Revisão do documento |
Revisões | Lista de revisões do documento |
DataCriacao | Data de envio do primeiro documento daquela árvore de arquivos |
DataUpdate | Data de atualização do documento |
IDStatus | id status do documento
|
IDTipo | id disciplina do documento |
OriginalFileName | Nome original do documento |
Extensao | Extensão do documento |
Fase | Fase construtiva do documento
|
StatusList | Lista de status existentes na obra e os significados |
Obra | Objeto contendo os dados da obra |
Outros campos | Os demais campos foram descontinuados |
Endpoint GetUpdatesSync
Descrição:
O endpoint recebe por parâmetro uma data de corte e retorna todos os documentos que foram atualizados após a data especificada.
Método:
POST
URL:
Entrada:
Exemplo
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \
"Data": "2025-03-03T14:39:50.692Z", \
"AppKey": "5443c75b-8314-481b-a97b-c2ac057e54e7", \
"IntegrationToken": "3e8a96ab-798c-402d-9c26-7afdb96e22f3", \
"IDObra": 1310 \
Campo | Tipo | Obrigatório | Explicação |
Data | string | Sim | Campo para aplicar buscar por texto no título, descrição e nome do documento |
appkey | string | Sim | Chave do aplicativo |
IntegrationToken | string | Sim | Token de autenticação da obra |
IDObra | int | Sim | id da obra que se deseja o retorno |
Saída Esperada (Resposta):
{
"Code": 1,
"Message": "OK",
"Result": {
"Projetos": [
{
"idObra": 1310,
"idObraC": "ZfiJVEQeNBY%3d",
"nomeObra": "ADM 01 | Editado",
"nomeArea": "0088-ARQ-PE-200-DES-DET",
"IdArea": 0,
"IdAreaC": "",
"IdDisciplina": 1,
"IdPlanta": 2868763,
"IdPlantaC": "LpkL1apNn2w%3d",
"nomePlanta": "0088-ARQ-PE-200-DES-DET",
"urlPlanta": "https://eu2.contabostorage.com/21ee0bc011104d38817cb2e2e95a3bbe:s3files/S_13505_O_1310_638787732006662801_C_1-0.png",
"filename": "S_13505_O_1310_638787732006662801_C_1.pdf",
"msg": "",
"isUpdate": false,
"IsRetractedAPI": false,
"HasLeitorQRMobileEnable": false,
"HasAcessoOnlineOfflineMobileEnable": false,
"HasAcessoDevolucaoImpressos": false,
"isPrint": true,
"Ordem": 1,
"Fase": 4,
"Disciplina": "GER",
"Areas": [],
"Notes": null,
"IdCheckin": null,
"Copias": 0,
"Folhas": 1,
"Perfil": 0,
"Nome": "0088-ARQ-PE-200-DES-DET",
"Descricao": null,
"Revisao": "R18",
"RevisaoQr": null,
"StatusCorImpresso": null,
"CorStatus": null,
"Titulo": null,
"OriginalFileName": "0088-ARQ-PE-200-DES-DET-R18.pdf",
"Extensao": "PDF",
"IDAreas": null,
"Status": 0,
"Tipo": "Geral",
"IDStatus": 2,
"StatusDescricao": null,
"DisciplinaDescricao": null,
"HasRevisaoSuperiorEmAnalise": false,
"Processing": false,
"DataCriacao": "2025-03-28T18:40:03.0000000Z",
"DataUpdate": "2025-03-28T18:40:03.0000000Z",
"CanShare": false,
"Entregue": false,
"PathURLPlantaPai": null,
"RevisaoPlantaPai": null,
"StatusList": null,
"ResponsavelSolicitacao": null,
"Portadores": null,
"UsuarioPertenceObra": false
}]
}
Campo | Descrição |
id | Id do documento |
idc | Id criptografado do documento |
Processing | Estado que define se o documento está sendo processado pelo sistema (Gerando visualização em imagem) |
Nome | Nome do documento, sem a revisão |
Filename | Nome interno do documento |
Areas | Lista de locais/áreas vinculadas ao documento |
PathURL | URL de acesso ao documento |
Título | Título do documento |
Descrição | Descrição do documento |
Folhas | Quantidade de folhas do documento |
Revisão | Revisão do documento |
Revisões | Lista de revisões do documento |
DataCriacao | Data de envio do primeiro documento daquela árvore de arquivos |
DataUpdate | Data de atualização do documento |
IDStatus | id status do documento
|
IDTipo | id disciplina do documento |
OriginalFileName | Nome original do documento |
Extensao | Extensão do documento |
Fase | Fase construtiva do documento
|
StatusList | Lista de status existentes na obra e os significados |
Obra | Objeto contendo os dados da obra |
Outros campos | Os demais campos foram descontinuados |
Endpoint GetFullDataProjeto
Descrição:
O endpoint retorna os dados de um documento específico baseado no ID.
Método:
POST
URL:
Entrada:
Exemplo
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \
"IdProjeto": "2868763", \
"AppKey": "5443c75b-8314-481b-a97b-c2ac057e54e7", \
"IntegrationToken": "3e8a96ab-798c-402d-9c26-7afdb96e22f3", \
"IDObra": 1310 \
Campo | Tipo | Obrigatório | Explicação |
IdProjeto | string | Sim | ID documento |
appkey | string | Sim | Chave do aplicativo |
IntegrationToken | string | Sim | Token de autenticação da obra |
IDObra | int | Sim | id da obra que se deseja o retorno |
Saída Esperada (Resposta):
{
"Code": 1,
"Message": "OK",
"Result": {
"ID": 2868763,
"IDC": "LpkL1apNn2w%3d",
"Nome": "0088-ARQ-PE-200-DES-DET",
"Data": "28/03/2025",
"Descricao": null,
"Tipo": "GER",
"PathURL": "https://eu2.contabostorage.com/21ee0bc011104d38817cb2e2e95a3bbe:s3files/S_13505_O_1310_638787732006662801_C_1-0.png",
"PathURLOriginalFile": null,
"Filename": "S_13505_O_1310_638787732006662801_C_1.pdf",
"IDTipo": 1,
"Folhas": 1,
"Revisao": "R18",
"Fase": 4,
"IDObra": 1310,
"IDObraC": "ZfiJVEQeNBY%3d",
"NomeObra": null,
"Ordem": 0,
"Areas": [],
"Titulo": null,
"IdPlanta": null,
"IdPlantaC": null,
"nomePlanta": null,
"urlPlanta": "https://eu2.contabostorage.com/21ee0bc011104d38817cb2e2e95a3bbe:s3files/S_13505_O_1310_638787732006662801_C_1-0.png",
"IdDisciplina": null,
"isUpdate": null,
"ManterObsoletarRevisao": false,
"isPrint": null,
"msg": null,
"IdArea": null,
"nomeArea": null,
"IdAreaC": null,
"Processing": false,
"Revisoes": [
{
"Revisao": "R18",
"URLPath": "https://eu2.contabostorage.com/21ee0bc011104d38817cb2e2e95a3bbe:s3files/S_13505_O_1310_638787732006662801_C_1-0.png",
"IDRevisao": 0,
"Data": null,
"Descricao": null,
"Titulo": null,
"Filename": null,
"Fase": 0,
"IDStatus": 0
}
],
"Disciplina": null,
"Status": null,
"DataCriacao": null,
"DataUpdate": null,
"IDStatus": null,
"StatusList": null,
"CanShare": false
},
"Success": true
}
Campo | Descrição |
id | Id do documento |
idc | Id criptografado do documento |
Processing | Estado que define se o documento está sendo processado pelo sistema (Gerando visualização em imagem) |
Nome | Nome do documento, sem a revisão |
Filename | Nome interno do documento |
Areas | Lista de locais/áreas vinculadas ao documento |
PathURL | URL de acesso ao documento |
Título | Título do documento |
Descrição | Descrição do documento |
Folhas | Quantidade de folhas do documento |
Revisão | Revisão do documento |
Revisões | Lista de revisões do documento |
DataCriacao | Data de envio do primeiro documento daquela árvore de arquivos |
DataUpdate | Data de atualização do documento |
IDStatus | id status do documento
|
IDTipo | id disciplina do documento |
OriginalFileName | Nome original do documento |
Extensao | Extensão do documento |
Fase | Fase construtiva do documento
|
StatusList | Lista de status existentes na obra e os significados |
Obra | Objeto contendo os dados da obra |
Outros campos | Os demais campos foram descontinuados |
Endpoint GetMensagensAndNotesV3
/api/Legacy/GetMensagensAndNotesV3
Descrição:
O endpoint retorna todas as tarefas do documento passado por parâmetro e seus respectivos atributos.
Método:
POST
URL:
Entrada:
Exemplo
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \
"IdProjeto": "2789921", \
"AppKey": "5443c75b-8314-481b-a97b-c2ac057e54e7", \
"IntegrationToken": "3e8a96ab-798c-402d-9c26-7afdb96e22f3", \
"IDObra": 1310 \
Campo | Tipo | Obrigatório | Explicação |
IdProjeto | string | Sim | ID documento |
appkey | string | Sim | Chave do aplicativo |
IntegrationToken | string | Sim | Token de autenticação da obra |
IDObra | int | Sim | id da obra que se deseja o retorno |
Saída Esperada (Resposta):
{
"Code": 1,
"Message": "OK",
"Result": [
{
"ID": 68401,
"IDMensagemPai": null,
"mensagem": "Porjetista @LenoJunior preciso que você mude essa porta para 30cm a esqueda",
"Data": "0001-01-01T00:00:00",
"DataEnvio": "2025-03-25T11:27:56",
"DataFormatada": "25/03/2025 11:27",
"DataFormatadaOnlyDate": "25/03/2025",
"IDUsuarioOrigem": 0,
"DataResposta": "0001-01-01T00:00:00",
"DataRespostaFormatada": "",
"Resposta": null,
"Respondida": false,
"IDUsuarioResposta": null,
"IDSistema": 0,
"Tipo": "D",
"IDObra": 1310,
"IDProjeto": 0,
"IDPlanta": 2789921,
"Projeto": "TES-IMP-REN-DEV-6733",
"Obra": null,
"UsuarioOrigem": null,
"UsuarioResposta": null,
"UsuarioDestino": null,
"Fotos": null,
"Audios": null,
"HintUsuarios": null,
"Anotacao": true,
"Comentarios": 0,
"ComentarioList": null,
"MensagemList": null,
"Hora": "11:27:56",
"CanDelete": false,
"CanRead": false,
"CanUpdate": false,
"CanComment": false,
"CanComplete": false,
"corApp": null,
"NomeUsuario": "renato@construcode.com.br",
"FotoUsuario": "https://www.construcode.com.br/Content/account/2036a4d1-20e3-4fc5-98dd-9e4e9708afb4_638784488904949586_U5823_64.png",
"AudioPathUrl": null,
"ImagemPathUrl": null,
"IdTipoAnotacao": 4,
"UserListMarcados": "38528",
"TipoAnotacaoDescricao": null,
"CorWeb": null,
"Status": 1,
"DescricaoStatus": "Pendente",
"ComentarioPai": null,
"UserListParticipantes": "38528,5823",
"ListImagensPathUrl": null,
"ListAudiosPathUrl": null,
"Privada": true,
tulo": "Alteração de porta",
"IdRelevancia": 3,
"PrazoInicial": "2025-03-20T03:00:00",
"PrazoFinal": "2025-03-25T02:59:59",
"IdResponsavel": null,
"NomeResponsavel": "Leno Junior",
"FotoResponsavel": "https://eu2.contabostorage.com/21ee0bc011104d38817cb2e2e95a3bbe:s3files/2ef6ef5d-99f0-43af-abe7-a52c1d2aea10_638778883002320679_U38528_64.png",
"IdsDisciplinas": "2",
"DisciplinaNome": "Arquitetura",
"DisciplinaSigla": "ARQ",
"IdFase": 4,
"Vinculos": []
}]
}
Campo | Descrição |
ID | Id Tarefa |
Título | Título da tarefa |
mensagem | Descrição da tarefa |
Anotação | Sinaliza se é uma tarefa vinculada a documento ou uma tarefa geral. |
DataEnvio | Data que a tarefa foi criada |
IDObra | ID da obra que a tarefa está vinculada |
IDPlanta | ID do documento que a tarefa está vinculada |
UsuarioOrigem | Email do usuário que criou a tarefa |
NomeUsuario | Nome do usuário que criou a tarefa |
FotoUsuario | url da foto do usuário que criou a tarefa |
UserListMarcados | Lista dos usuários que foram marcados na tarefa |
UserListParticipantes | Lista dos usuário que participam da tarefa |
Status | Status da tarefa |
DescricaoStatus | Descrição do status da tarefa |
NomeResponsavel | Nome do responsável pela tarefa |
FotoResponsavel | Foto do responsável pela tarefa |
IdsDisciplinas | IDs das disciplinas vinculadas a tarefa |
idFase | ID da fase construtiva vinculada a tarefa |
IdRelevancia | Id relevância da tarefa (Tradução na guia de Dicionário ) |
PrazoInicial | Prazo inicial configurado na tarefa |
PrazoFinal | Prazo final configurado na tarefa |
idTipoAnotacao | idTipo da tarefa (Tradução na guia de Dicionário ) |
DisciplinaNome | Lista de nomes das disciplinas vinculadas |
DisciplinaSigla | Lista de siglas das disciplinas vinculadas |
Vinculos | Lista de vínculos entre tarefas |
DescricaoStatus | Descrição do status da tarefa |
Endpoint GetTarefaComentarios
Descrição:
O endpoint retorna os dados de determinada tarefa e seus comentários. Os dados da tarefa passado por parâmetro é o primeiro objeto da lista, todos os demais são comentários.
Método:
POST
URL:
Entrada:
Exemplo
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \
"IdTarefaPai": "69879", \
"AppKey": "5443c75b-8314-481b-a97b-c2ac057e54e7", \
"IntegrationToken": "3e8a96ab-798c-402d-9c26-7afdb96e22f3", \
"IDObra": 1310 \
Campo | Tipo | Obrigatório | Explicação |
IdTarefaPai | string | Sim | ID Tarefa |
appkey | string | Sim | Chave do aplicativo |
IntegrationToken | string | Sim | Token de autenticação da obra |
IDObra | int | Sim | id da obra que se deseja o retorno |
Saída Esperada (Resposta):
{
"Code": 1,
"Message": "OK",
"Result": [
{
"ID": 69879,
"IDMensagemPai": null,
"mensagem": "Teste descrição",
"Data": "0001-01-01T00:00:00",
"DataEnvio": "2025-03-31T18:18:16",
"DataFormatada": "31/03/2025 18:18",
"DataFormatadaOnlyDate": "31/03/2025",
"IDUsuarioOrigem": 457,
"DataResposta": "0001-01-01T00:00:00",
"DataRespostaFormatada": "",
"Resposta": null,
"Respondida": false,
"IDUsuarioResposta": null,
"IDSistema": 0,
"Tipo": "G",
"IDObra": 1310,
"IDProjeto": 2789921,
"IDPlanta": 2789921,
"Projeto": "TES-IMP-REN-DEV-6733",
"Obra": null,
"UsuarioOrigem": "vinicius@construcode.com.br",
"UsuarioResposta": null,
"UsuarioDestino": null,
"Fotos": null,
"Audios": null,
"HintUsuarios": null,
"Anotacao": true,
"Comentarios": 0,
"ComentarioList": null,
"MensagemList": null,
"Hora": "18:18:16",
"CanDelete": false,
"CanRead": false,
"CanUpdate": false,
"CanComment": false,
"CanComplete": false,
"corApp": null,
"NomeUsuario": "VINICIUS REIS",
"FotoUsuario": "https://www.construcode.com.br/Content/account/0ef3aad0-77fb-4d80-b2a8-2ff9e299bad9_638787711566079365_U457_64.png",
"AudioPathUrl": null,
"ImagemPathUrl": null,
"IdTipoAnotacao": 1,
"UserListMarcados": null,
"TipoAnotacaoDescricao": null,
"CorWeb": null,
"Status": 1,
"DescricaoStatus": "Pendente",
"ComentarioPai": null,
"UserListParticipantes": "457,461",
"ListImagensPathUrl": null,
"ListAudiosPathUrl": null,
"Privada": false,
"Titulo": "Teste",
"IdRelevancia": 3,
"PrazoInicial": "2025-04-03T00:00:00",
"PrazoFinal": "2025-05-03T00:00:00",
"IdResponsavel": 461,
"NomeResponsavel": "Vinicius Ferreira",
"FotoResponsavel": "https://www.construcode.com.br/content/account/3bfaa946-7980-4e30-98fc-233c69d78b08_637999620072027606_U461.png",
"IdsDisciplinas": "99,131",
"DisciplinaNome": null,
"DisciplinaSigla": null,
"IdFase": 6,
"Vinculos": []
},
{
"ID": 31469,
"IDMensagemPai": 69879,
"mensagem": "Validado! Vou seguir com a alteração",
"Data": "0001-01-01T00:00:00",
"DataEnvio": "2025-04-03T16:22:56",
"DataFormatada": "03/04/2025 16:22",
"DataFormatadaOnlyDate": "03/04/2025",
"IDUsuarioOrigem": 457,
"DataResposta": "0001-01-01T00:00:00",
"DataRespostaFormatada": "",
"Resposta": null,
"Respondida": false,
"IDUsuarioResposta": null,
"IDSistema": 0,
"Tipo": null,
"IDObra": 1310,
"IDProjeto": 0,
"IDPlanta": null,
"Projeto": null,
"Obra": null,
"UsuarioOrigem": "VINICIUS REIS",
"UsuarioResposta": null,
"UsuarioDestino": null,
"Fotos": [
{
"ID": 14514,
"IDMensagem": null,
"IDComentario": 31469,
"IDMensagemPai": 69879,
"Data": "2025-04-03T16:22:57",
"IDUsuario": 457,
"Resposta": false,
"FileName": "S_455_C_A_1310_457_638792941782969949.png"
}
],
"Audios": [],
"HintUsuarios": null,
"Anotacao": false,
"Comentarios": 0,
"ComentarioList": null,
"MensagemList": null,
"Hora": "16:22:56",
"CanDelete": false,
"CanRead": false,
"CanUpdate": false,
"CanComment": false,
"CanComplete": false,
"corApp": null,
"NomeUsuario": "VINICIUS REIS",
"FotoUsuario": "https://www.construcode.com.br/Content/account/0ef3aad0-77fb-4d80-b2a8-2ff9e299bad9_638787711566079365_U457_64.png",
"AudioPathUrl": null,
"ImagemPathUrl": "https://1310.fra1.digitaloceanspaces.com/S_455_C_A_1310_457_638792941782969949.png",
"IdTipoAnotacao": 0,
"UserListMarcados": null,
"TipoAnotacaoDescricao": null,
"CorWeb": null,
"Status": 0,
"DescricaoStatus": null,
"ComentarioPai": null,
"UserListParticipantes": null,
"ListImagensPathUrl": [
],
"ListAudiosPathUrl": null,
"Privada": false,
"Titulo": null,
"IdRelevancia": null,
"PrazoInicial": null,
"PrazoFinal": null,
"IdResponsavel": null,
"NomeResponsavel": null,
"FotoResponsavel": null,
"IdsDisciplinas": null,
"DisciplinaNome": null,
"DisciplinaSigla": null,
"IdFase": null,
"Vinculos": null
}
],
"Success": true
}
Campo | Descrição |
ID | Id Tarefa |
Título | Título da tarefa |
mensagem | Descrição da tarefa |
Anotação | Sinaliza se é uma tarefa vinculada a documento ou uma tarefa geral. |
DataEnvio | Data que a tarefa foi criada |
IDObra | ID da obra que a tarefa está vinculada |
IDPlanta | ID do documento que a tarefa está vinculada |
UsuarioOrigem | Email do usuário que criou a tarefa |
NomeUsuario | Nome do usuário que criou a tarefa |
FotoUsuario | url da foto do usuário que criou a tarefa |
UserListMarcados | Lista dos usuários que foram marcados na tarefa |
UserListParticipantes | Lista dos usuário que participam da tarefa |
Status | Status da tarefa |
DescricaoStatus | Descrição do status da tarefa |
NomeResponsavel | Nome do responsável pela tarefa |
FotoResponsavel | Foto do responsável pela tarefa |
IdsDisciplinas | IDs das disciplinas vinculadas a tarefa |
idFase | ID da fase construtiva vinculada a tarefa |
IdRelevancia | Id relevância da tarefa (Tradução na guia de Dicionário ) |
PrazoInicial | Prazo inicial configurado na tarefa |
PrazoFinal | Prazo final configurado na tarefa |
idTipoAnotacao | idTipo da tarefa (Tradução na guia de Dicionário ) |
DisciplinaNome | Lista de nomes das disciplinas vinculadas |
DisciplinaSigla | Lista de siglas das disciplinas vinculadas |
Vinculos | Lista de vínculos entre tarefas |
DescricaoStatus | Descrição do status da tarefa |
Endpoint GetProjeto
/api/Legacy/GetProjeto
Descrição:
O endpoint retorna os dados de determinado documento baseado no ID
Método:
POST
URL:
Entrada:
Exemplo
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \
"IdProjeto": "2789921", \
"VAPP": 1, \
"AppKey": "5443c75b-8314-481b-a97b-c2ac057e54e7", \
"IntegrationToken": "3e8a96ab-798c-402d-9c26-7afdb96e22f3", \
"IDObra": 1310 \
Campo | Tipo | Obrigatório | Explicação |
idProjeto | string | Sim | ID do documento |
VAPP | int | Não | Chave que identifica a versão do app, preencher com 1 por padrão |
appkey | string | Sim | Chave do aplicativo |
IntegrationToken | string | Sim | Token de autenticação da obra |
IDObra | int | Sim | id da obra que se deseja o retorno |
Saída Esperada (Resposta):
{
"Code": 1,
"Message": "OK",
"Result": {
"Projetos": [
{
"ID": 2881925,
"IDC": "%2b1xNfZIYXh4%3d",
"Nome": "ARQ-TESTE-EX-1PAV-R00",
"Data": "02/04/2025",
"Descricao": null,
"Tipo": "ARQ",
"PathURLOriginalFile": null,
"Filename": "S_4434_O_1310_638791854587406506_C_1.pdf",
"IDTipo": 2,
"Folhas": 1,
"Revisao": "R01",
"Fase": 4,
"IDObra": 1310,
"IDObraC": "ZfiJVEQeNBY%3d",
"NomeObra": "ADM 01 | Editado",
"Ordem": 0,
"Areas": [],
"Titulo": null,
"IdPlanta": null,
"IdPlantaC": null,
"nomePlanta": null,
"IdDisciplina": null,
"isUpdate": null,
"ManterObsoletarRevisao": false,
"isPrint": null,
"msg": null,
"IdArea": null,
"nomeArea": null,
"IdAreaC": null,
"Processing": false,
"Revisoes": null,
"Disciplina": null,
"Status": null,
"DataCriacao": "2025-04-02T02:41:59.0000000Z",
"DataUpdate": "2025-04-02T13:11:06.0000000Z",
"IDStatus": 1,
"StatusList": null,
"CanShare": false
}
],
"Disciplinas": [
{
"Nome": "Arquitetura",
"ID": 2,
"Cor": "#17A15E"
}
],
"alertaAnalise": false,
"StatusList": [
{
"ID": 1,
"Nome": "Liberado para obra",
"Ativo": false,
"Cor": "4caf50"
} ],
"Obra": {
"Nome": "ADM 01 | Editado",
}
},
"Success": true
}
Campo | Descrição |
id | Id do documento |
idc | Id criptografado do documento |
Processing | Estado que define se o documento está sendo processado pelo sistema (Gerando visualização em imagem) |
Nome | Nome do documento, sem a revisão |
Filename | Nome interno do documento |
PathURL | URL de acesso ao documento |
Título | Título do documento |
Descrição | Descrição do documento |
Folhas | Quantidade de folhas do documento |
Revisão | Revisão do documento |
Revisões | Lista de revisões do documento |
DataCriacao | Data de envio do primeiro documento daquela árvore de arquivos |
DataUpdate | Data de atualização do documento |
IDStatus | id status do documento
|
IDTipo | id disciplina do documento |
OriginalFileName | Nome original do documento |
Extensao | Extensão do documento |
Fase | Fase construtiva do documento
|
StatusList | Lista de status existentes na obra e os significados |
Obra | Objeto contendo os dados da obra |
Outros campos | Os demais campos foram descontinuados |
Endpoint ActiveCF
/api/Legacy/ActiveCF
Descrição:
O endpoint tem a finalidade de ativar no sistema os fluxos de integração com a ConstruFlow. Ele necessita do IdCF que deve ser disponibilizado pela equipe do software terceiro.
Método:
POST
URL:
Entrada:
Exemplo
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \
"IdCF": 321, \
"AppKey": "5443c75b-8314-481b-a97b-c2ac057e54e7", \
"IntegrationToken": "3e8a96ab-798c-402d-9c26-7afdb96e22f3", \
"IDObra": 1310 \
Campo | Tipo | Obrigatório | Explicação |
IdCF | int | Sim | ID ConstruFlow disponibilizado pela equipe da empresa |
appkey | string | Sim | Chave do aplicativo |
IntegrationToken | string | Sim | Token de autenticação da obra |
IDObra | int | Sim | id da obra que se deseja o retorno |
Saída Esperada (Resposta):
{
"Code": 1,
"Message": "OK",
"Result": {
"Success": true
},
"Success": true
}