Partilhar via


Fulcrum (Pré-visualização)

O Fulcrum é uma solução orientada para o campo que capacita tanto especialistas em SIG como não membros da equipa SIG a capturar e partilhar facilmente dados geoespaciais. Este conector permite a integração com o Fulcrum para gerir dados de campo, fotografias, vídeos e muito mais.

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

Service Classe Regiões
Copilot Studio Premium Todas as regiões Power Automate 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 Azure Government
     - Regiões Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões 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)
Power Automate Premium Todas as regiões Power Automate 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 Suporte ao Fulcro
URL https://www.fulcrumapp.com/support
Email support@fulcrumapp.com
Metadados do conector
Publisher Spatial Networks, Inc.
Sítio Web https://www.fulcrumapp.com
Política de privacidade https://www.fulcrumapp.com/privacy
Categorias Produtividade; Dados

Fulcro

O Fulcrum é uma solução orientada para o campo que capacita tanto especialistas em SIG como não membros da equipa SIG a capturar e partilhar facilmente dados geoespaciais. Este conector permite a integração com o Fulcrum para gerir dados de campo, fotografias, vídeos e muito mais.

Publisher

Fulcro

Pré-requisitos

  • Subscrição ativa do Fulcrum com acesso à API ativado

Operações suportadas

Acionadores

Quando ocorre um evento Fulcrum

É ativado quando um recurso Fulcrum é criado, atualizado ou eliminado. Suporta eventos para registos, formulários, listas de escolhas e conjuntos de classificação. Configure o webhook na sua organização Fulcrum para especificar que eventos monitorizar.

Ações

Obtenha uma lista de metadados de anexos

Recolha uma lista de anexos.

Arranja um anexo

Recuperar metadados de um único anexo.

Obtenha uma lista de metadados de áudio

Recuperar metadados para uma lista de ficheiros de áudio.

Obtenha um ficheiro original de áudio

Descarregue o ficheiro áudio original.

Obtenha uma lista de metadados fotográficos

Recuperar metadados para uma lista de fotografias.

Obtenha um ficheiro original de fotografia

Descarregue o ficheiro fotográfico original.

Obtenha metadados fotográficos

Recuperar metadados de uma única fotografia.

Faça um pedido de POST de Consulta

Execute um pedido de API de consulta usando HTTP POST. Forneça uma consulta semelhante a SQL para consultar os dados da sua organização.

Obtenha uma lista de registos

Obtenha uma lista de registos da sua organização que possa ser filtrada por dimensões, como formulário, projeto, conjunto de alterações, caixa delimitadora e intervalos de datas.

Criar um registo

Crie um novo registo no formulário especificado usando os valores fornecidos do formulário, informações de localização e quaisquer metadados associados.

Eliminar um registo

Apague um registo da sua organização.

Obter um registo

Recupere informações detalhadas sobre um registo específico pelo seu ID. Isto inclui todos os valores dos campos do formulário, dados de localização, carimbos temporais e metadados associados.

Atualização parcial de um registo

Atualize campos específicos de um registo existente sem exigir o objeto de registo completo. Apenas os campos incluídos no corpo do pedido serão modificados, enquanto todos os outros campos permanecem inalterados. Isto é útil para atualizar valores individuais de campos ou metadados.

Atualizar um registo

Atualize um registo com um objeto de registo fornecido. Espera-se que o objeto do registo seja a representação completa do registo. Quaisquer campos não incluídos são assumidos nulos.

Obtenha o histórico de um registo

Recuperar o histórico completo de versões de um registo.

Criar um relatório

Gerar um novo relatório para um registo específico, opcionalmente usando um modelo de relatório.

Obtenha um relatório

Descarregue o ficheiro de relatório PDF gerado.

Obtenha uma lista de metadados de assinatura

Recuperar metadados para uma lista de assinaturas.

Obtenha metadados de assinatura

Recuperar metadados de uma única assinatura.

Obtenha um ficheiro original de assinatura

Descarregue o ficheiro original de assinatura.

Obtenha uma lista de metadados de esboços

Recuperar metadados para uma lista de esboços.

Obtenha um ficheiro original de esboço

Descarregue o ficheiro original do esboço.

Obtenha metadados de sketches

Recuperar metadados para um único esboço.

Obtenha uma lista de metadados de vídeo

Recuperar metadados para uma lista de vídeos.

Obtenha um ficheiro original em vídeo

Descarregue o ficheiro de vídeo original.

Obtenção de credenciais

Para usar o conector Fulcrum, precisa de um token API Fulcrum:

  1. Inicie sessão na sua conta Fulcrum em https://web.fulcrumapp.com
  2. Navegar até à API de Definições >
  3. Gerar um novo token API ou usar um já existente
  4. Copie o token e use-o ao criar uma ligação

Introdução

Crie uma nova ligação e introduza o seu token da API Fulcrum quando solicitado.

URLs de Host Personalizados

Por defeito, o conector utiliza a API Fulcrum de produção em api.fulcrumapp.com. Para outras regiões, pode especificar uma URL de host diferente ao criar a sua ligação.

Pontos Finais Regionais:

  • United States (padrão): api.fulcrumapp.com
  • Canadá: api.fulcrumapp-ca.com
  • Austrália: api.fulcrumapp-au.com
  • Europa: api.fulcrumapp-eu.com

Formato: Introduza apenas o nome do anfitrião sem protocolo ou caminho. O conector usará automaticamente HTTPS e o caminho correto da API.

Resolução de problemas:

  • Garanta que o seu alojamento personalizado está acessível a partir da sua rede
  • Verifica se o nome do host está correto (sem erros tipográficos)
  • Confirme que o seu token API é válido para o host especificado

Problemas conhecidos e limitações

  • A limitação de taxa aplica-se com base no seu plano Fulcrum

Instruções de implantação

Por favor, utilize estas instruções para implementar este conector como um conector personalizado no Microsoft Power Automate e Power Apps.

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 Descrição Obrigatório
Chave de API securestring O seu token API Fulcrum para autenticação Verdade
URL do anfitrião cadeia (de caracteres) O alojamento da API para a sua instância Fulcrum

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Arranja um anexo

Recuperar metadados de um único anexo.

Atualizar um registo

Atualize um registo com um objeto de registo fornecido. Espera-se que o objeto do registo seja a representação completa do registo. Quaisquer campos não incluídos são assumidos nulos.

Atualização parcial de um registo

Atualize campos específicos de um registo existente sem exigir o objeto de registo completo. Apenas os campos incluídos no corpo do pedido serão modificados, enquanto todos os outros campos permanecem inalterados. Isto é útil para atualizar valores individuais de campos ou metadados.

Criar um registo

Crie um novo registo no formulário especificado usando os valores fornecidos do formulário, informações de localização e quaisquer metadados associados.

Criar um relatório

Gerar um novo relatório para um registo específico, opcionalmente usando um modelo de relatório.

Eliminar um registo

Apague um registo da sua organização.

Faça um pedido de POST de Consulta

Execute um pedido de API de consulta usando HTTP POST. Forneça uma consulta semelhante a SQL para consultar os dados da sua organização.

Obtenha metadados de assinatura

Recuperar metadados de uma única assinatura.

Obtenha metadados de sketches

Recuperar metadados para um único esboço.

Obtenha metadados fotográficos

Recuperar metadados de uma única fotografia.

Obtenha o histórico de um registo

Recuperar o histórico completo de versões de um registo.

Obtenha um ficheiro original de assinatura

Descarregue o ficheiro original de assinatura.

Obtenha um ficheiro original de esboço

Descarregue o ficheiro original do esboço.

Obtenha um ficheiro original de fotografia

Descarregue o ficheiro fotográfico original.

Obtenha um ficheiro original de áudio

Descarregue o ficheiro áudio original.

Obtenha um ficheiro original em vídeo

Descarregue o ficheiro de vídeo original.

Obtenha um relatório

Descarregue o ficheiro de relatório PDF gerado.

Obtenha uma lista de metadados de anexos

Recolha uma lista de anexos.

Obtenha uma lista de metadados de assinatura

Recuperar metadados para uma lista de assinaturas.

Obtenha uma lista de metadados de esboços

Recuperar metadados para uma lista de esboços.

Obtenha uma lista de metadados de vídeo

Recuperar metadados para uma lista de vídeos.

Obtenha uma lista de metadados de áudio

Recuperar metadados para uma lista de ficheiros de áudio.

Obtenha uma lista de metadados fotográficos

Recuperar metadados para uma lista de fotografias.

Obtenha uma lista de registos

Obtenha uma lista de registos da sua organização que possa ser filtrada por dimensões, como formulário, projeto, conjunto de alterações, caixa delimitadora e intervalos de datas.

Obter um registo

Recupere informações detalhadas sobre um registo específico pelo seu ID. Isto inclui todos os valores dos campos do formulário, dados de localização, carimbos temporais e metadados associados.

Arranja um anexo

Recuperar metadados de um único anexo.

Parâmetros

Name Chave Necessário Tipo Description
ID do anexo
attachment_id True string

O identificador único do anexo.

Devoluções

Corpo
Attachment

Atualizar um registo

Atualize um registo com um objeto de registo fornecido. Espera-se que o objeto do registo seja a representação completa do registo. Quaisquer campos não incluídos são assumidos nulos.

Parâmetros

Name Chave Necessário Tipo Description
Tipo de conteúdo
Content-Type string

Tipo de conteúdo

ID do registo
record_id True string

ID do Registo

X Skipworkflows
X-SkipWorkflows boolean

Ignora todos os fluxos de trabalho da aplicação

X Skipwebhooks
X-SkipWebhooks boolean

Ignora todos os webhooks da aplicação

assigned_to_id
assigned_to_id string

ID do utilizador atribuído a este registo

form_id
form_id True string

ID da forma a que este registo pertence

form_values
form_values object

Valores de campo codificados por chave de campo

coordenadas
coordinates True

Coordenadas para a geometria. O formato varia consoante o tipo: Point usa [longitude, latitude], LineString usa array de posições, Polygon usa array de anéis lineares (o primeiro é exterior, o resto são buracos), os Multi* tipos usam arrays das respetivas estruturas de coordenadas.

tipo
type True string

Tipo de geometria GeoJSON

latitude
latitude number

Coordenada Latitude

longitude
longitude number

Coordenada de longitude

project_id
project_id string

ID do projeto

estado
status string

Estado do disco

Atualização parcial de um registo

Atualize campos específicos de um registo existente sem exigir o objeto de registo completo. Apenas os campos incluídos no corpo do pedido serão modificados, enquanto todos os outros campos permanecem inalterados. Isto é útil para atualizar valores individuais de campos ou metadados.

Parâmetros

Name Chave Necessário Tipo Description
Tipo de conteúdo
Content-Type string

Tipo de conteúdo

ID do registo
record_id True string

ID do Registo

X Skipworkflows
X-SkipWorkflows boolean

Ignora todos os fluxos de trabalho da aplicação

X Skipwebhooks
X-SkipWebhooks boolean

Ignora todos os webhooks da aplicação

assigned_to_id
assigned_to_id string

ID do utilizador atribuído a este registo

form_values
form_values object

Valores de campo codificados por chave de campo

coordenadas
coordinates True

Coordenadas para a geometria. O formato varia consoante o tipo: Point usa [longitude, latitude], LineString usa array de posições, Polygon usa array de anéis lineares (o primeiro é exterior, o resto são buracos), os Multi* tipos usam arrays das respetivas estruturas de coordenadas.

tipo
type True string

Tipo de geometria GeoJSON

latitude
latitude number

Coordenada Latitude

longitude
longitude number

Coordenada de longitude

project_id
project_id string

ID do projeto

estado
status string

Estado do disco

Devoluções

Criar um registo

Crie um novo registo no formulário especificado usando os valores fornecidos do formulário, informações de localização e quaisquer metadados associados.

Parâmetros

Name Chave Necessário Tipo Description
Tipo de conteúdo
Content-Type string

Tipo de conteúdo

X Skipworkflows
X-SkipWorkflows boolean

Ignora todos os fluxos de trabalho da aplicação

X Skipwebhooks
X-SkipWebhooks boolean

Ignora todos os webhooks da aplicação

assigned_to_id
assigned_to_id string

ID do utilizador atribuído a este registo

form_id
form_id True string

ID da forma a que este registo pertence

form_values
form_values object

Valores de campo codificados por chave de campo

coordenadas
coordinates True

Coordenadas para a geometria. O formato varia consoante o tipo: Point usa [longitude, latitude], LineString usa array de posições, Polygon usa array de anéis lineares (o primeiro é exterior, o resto são buracos), os Multi* tipos usam arrays das respetivas estruturas de coordenadas.

tipo
type True string

Tipo de geometria GeoJSON

latitude
latitude number

Coordenada Latitude

longitude
longitude number

Coordenada de longitude

project_id
project_id string

ID do projeto

estado
status string

Estado do disco

Devoluções

Criar um relatório

Gerar um novo relatório para um registo específico, opcionalmente usando um modelo de relatório.

Parâmetros

Name Chave Necessário Tipo Description
record_id
record_id True uuid

O ID do registo para gerar um relatório para

template_id
template_id uuid

O ID do modelo de relatório a usar (opcional)

Devoluções

Eliminar um registo

Apague um registo da sua organização.

Parâmetros

Name Chave Necessário Tipo Description
ID do registo
record_id True string

O identificador único do registo a eliminar.

X Skipworkflows
X-SkipWorkflows boolean

Ignora todos os fluxos de trabalho da aplicação

X Skipwebhooks
X-SkipWebhooks boolean

Ignora todos os webhooks da aplicação

Devoluções

Faça um pedido de POST de Consulta

Execute um pedido de API de consulta usando HTTP POST. Forneça uma consulta semelhante a SQL para consultar os dados da sua organização.

Parâmetros

Name Chave Necessário Tipo Description
Página
page integer

O número da página solicitado.

Por Página
per_page integer

O número de itens a devolver por página.

format
format string

Formato da resposta

q
q True string

Consulta SQL para execução

nome_da_tabela
table_name string

Nome da tabela a consultar

Obtenha metadados de assinatura

Recuperar metadados de uma única assinatura.

Parâmetros

Name Chave Necessário Tipo Description
ID da assinatura
signature_id True string

O identificador único da assinatura.

Devoluções

Obtenha metadados de sketches

Recuperar metadados para um único esboço.

Parâmetros

Name Chave Necessário Tipo Description
Identificação do Sketch
sketch_id True string

ID do esboço

Devoluções

Obtenha metadados fotográficos

Recuperar metadados de uma única fotografia.

Parâmetros

Name Chave Necessário Tipo Description
Identificação da foto
photo_id True string

O identificador único da fotografia.

Devoluções

Obtenha o histórico de um registo

Recuperar o histórico completo de versões de um registo.

Parâmetros

Name Chave Necessário Tipo Description
ID do registo
record_id True string

O identificador único do registo cujo histórico pretende recuperar.

Devoluções

Obtenha um ficheiro original de assinatura

Descarregue o ficheiro original de assinatura.

Parâmetros

Name Chave Necessário Tipo Description
ID da assinatura
signature_id True string

O identificador único da assinatura.

Devoluções

response
binary

Obtenha um ficheiro original de esboço

Descarregue o ficheiro original do esboço.

Parâmetros

Name Chave Necessário Tipo Description
Identificação do Sketch
sketch_id True string

ID do esboço

Devoluções

response
binary

Obtenha um ficheiro original de fotografia

Descarregue o ficheiro fotográfico original.

Parâmetros

Name Chave Necessário Tipo Description
Identificação da foto
photo_id True string

O identificador único da fotografia.

Devoluções

response
binary

Obtenha um ficheiro original de áudio

Descarregue o ficheiro áudio original.

Parâmetros

Name Chave Necessário Tipo Description
Áudio Id
audio_id True string

O identificador único do ficheiro de áudio.

Devoluções

response
binary

Obtenha um ficheiro original em vídeo

Descarregue o ficheiro de vídeo original.

Parâmetros

Name Chave Necessário Tipo Description
ID do Vídeo
video_id True string

O identificador único do vídeo.

Devoluções

response
binary

Obtenha um relatório

Descarregue o ficheiro de relatório PDF gerado.

Parâmetros

Name Chave Necessário Tipo Description
ID do relatório
report_id True uuid

O identificador único do relatório.

Devoluções

response
binary

Obtenha uma lista de metadados de anexos

Recolha uma lista de anexos.

Parâmetros

Name Chave Necessário Tipo Description
ID do registo
record_id string

O ID do registo com o qual o anexo está associado. Isto é obrigatório ao listar anexos de registos.

ID do formulário
form_id string

O ID da forma com que o anexo está associado. Este parâmetro permite-lhe obter todos os ficheiros de referência dentro de um formulário, NÃO todos os anexos de registo num formulário

Tipo de Proprietário
owner_type string

O tipo de apego a procurar. Deve ser ou form .record

Ordenar
sort string

O campo por qual ordenar os resultados.

Direção da Ordenação
sort_direction string

A direção de ordenação (asc, desc). O padrão é asc.

Devoluções

Obtenha uma lista de metadados de assinatura

Recuperar metadados para uma lista de assinaturas.

Parâmetros

Name Chave Necessário Tipo Description
ID do registo
record_id string

A identificação do registo com que a fotografia está associada.

ID do formulário
form_id string

O documento de identificação do formulário com que a fotografia está associada. Deixar isto em branco fará uma consulta em todas as tuas fotos.

Estreia mais recente
newest_first boolean

Se estiverem presentes, as fotos serão ordenadas por updated_at data.

Processada
processed boolean

Filtre as assinaturas que já foram completamente processadas.

Conservado
stored boolean

Filtre as assinaturas que foram completamente armazenadas.

Carregado
uploaded boolean

Filtre assinaturas que já foram completamente carregadas.

Página
page integer

O número da página solicitado.

Por Página
per_page integer

O número de itens a devolver por página.

Devoluções

Obtenha uma lista de metadados de esboços

Recuperar metadados para uma lista de esboços.

Parâmetros

Name Chave Necessário Tipo Description
ID do registo
record_id string

O ID do registo com o qual o esboço está associado.

ID do formulário
form_id string

O ID da forma com que o esboço está associado. Deixar isto em branco fará perguntas em relação a todos os teus esboços.

Estreia mais recente
newest_first boolean

Se existirem, os esboços serão organizados por updated_at data.

Processada
processed boolean

O esboço foi completamente processado.

Conservado
stored boolean

O esboço foi completamente armazenado.

Carregado
uploaded boolean

O Sketch foi completamente carregado.

Página
page integer

O número de página pedido

Por Página
per_page integer

Número de itens por página

Devoluções

Obtenha uma lista de metadados de vídeo

Recuperar metadados para uma lista de vídeos.

Parâmetros

Name Chave Necessário Tipo Description
ID do registo
record_id string

O ID do disco com o qual o vídeo está associado.

ID do formulário
form_id string

O ID da forma com que o vídeo está associado. Deixar esta mensagem em branco fará consultas para todos os teus vídeos.

Estreia mais recente
newest_first boolean

Se houver, os vídeos serão organizados por updated_at data.

Processada
processed boolean

Filtre vídeos que já foram completamente processados.

Conservado
stored boolean

Filtre para vídeos que foram completamente guardados.

Carregado
uploaded boolean

Filtre vídeos que foram completamente carregados.

Página
page integer

O número da página solicitado.

Por Página
per_page integer

O número de itens a devolver por página.

Devoluções

Obtenha uma lista de metadados de áudio

Recuperar metadados para uma lista de ficheiros de áudio.

Parâmetros

Name Chave Necessário Tipo Description
ID do registo
record_id string

O ID do disco com o qual o ficheiro áudio está associado.

ID do formulário
form_id string

O ID do formulário com o qual o ficheiro áudio está associado. Deixar isto em branco irá consultar todos os teus ficheiros de áudio.

Estreia mais recente
newest_first boolean

Se presente, os ficheiros de áudio serão organizados por updated_at data.

Processada
processed boolean

Filtre os ficheiros de áudio que foram completamente processados.

Conservado
stored boolean

Filtre os ficheiros de áudio que foram completamente armazenados.

Carregado
uploaded boolean

Filtre os ficheiros de áudio que foram completamente carregados.

Página
page integer

O número da página solicitado.

Por Página
per_page integer

O número de itens a devolver por página.

Devoluções

Obtenha uma lista de metadados fotográficos

Recuperar metadados para uma lista de fotografias.

Parâmetros

Name Chave Necessário Tipo Description
ID do registo
record_id string

A identificação do registo com que a fotografia está associada.

ID do formulário
form_id string

O documento de identificação do formulário com que a fotografia está associada. Deixar isto em branco fará uma consulta em todas as tuas fotos.

Estreia mais recente
newest_first boolean

Se estiverem presentes, as fotos serão ordenadas por updated_at data.

Processada
processed boolean

Filtre as fotos que foram completamente processadas.

Conservado
stored boolean

Filtre as fotos que foram completamente armazenadas.

Carregado
uploaded boolean

Filtre as fotos que foram totalmente carregadas.

Página
page integer

O número da página solicitado.

Por Página
per_page integer

O número de itens a devolver por página.

Devoluções

Obtenha uma lista de registos

Obtenha uma lista de registos da sua organização que possa ser filtrada por dimensões, como formulário, projeto, conjunto de alterações, caixa delimitadora e intervalos de datas.

Parâmetros

Name Chave Necessário Tipo Description
Estreia mais recente
newest_first boolean

Se presente, os registos serão organizados por updated_at data.

Caixa delimitadora
bounding_box string

Caixa delimitadora dos registos solicitados. O formato deve ser: lat, longo, lat, longo (inferior, esquerda, cima, direita).

ID do conjunto de alterações
changeset_id string

O id do conjunto de alterações associado ao registo.

ID do formulário
form_id string

O id da forma com que o registo está associado. Deixar esta ficha em branco irá consultar todos os seus registos.

ID do projeto
project_id string

O id do projeto com o qual o disco está associado. Deixar esta ficha em branco irá consultar todos os seus registos.

Cliente Criado Antes
client_created_before date-time

Devolva apenas os registos criados pelo cliente (dispositivo) antes do tempo indicado.

Cliente criado desde
client_created_since date-time

Devolve apenas os registos criados pelo cliente (dispositivo) após o tempo indicado.

Cliente Atualizado Antes
client_updated_before date-time

Devolva apenas os registos que foram atualizados pelo cliente (dispositivo) antes do tempo indicado.

Cliente atualizado desde
client_updated_since date-time

Devolva apenas os registos que foram atualizados pelo cliente (dispositivo) após o tempo indicado.

Criado antes
created_before date-time

Devolva apenas os registos que foram criados (no servidor) antes do tempo indicado.

Criado desde
created_since date-time

Devolve apenas os registos que foram criados (no servidor) após o tempo indicado.

Atualizado antes
updated_before date-time

Devolva apenas registos que foram atualizados (no servidor) antes do horário indicado.

Atualizado desde
updated_since date-time

Devolve apenas registos que foram atualizados (no servidor) após o tempo indicado.

Página
page integer

O número de página pedido

Por Página
per_page integer

Número de itens por página

Devoluções

Obter um registo

Recupere informações detalhadas sobre um registo específico pelo seu ID. Isto inclui todos os valores dos campos do formulário, dados de localização, carimbos temporais e metadados associados.

Parâmetros

Name Chave Necessário Tipo Description
ID do registo
record_id True string

O identificador único do registo a recuperar.

Devoluções

Acionadores

Quando ocorre um evento Fulcrum

É ativado quando um recurso Fulcrum é criado, atualizado ou eliminado. Suporta eventos para registos, formulários, listas de escolhas e conjuntos de classificação. Configure o webhook na sua organização Fulcrum para especificar que eventos monitorizar.

Quando ocorre um evento Fulcrum

É ativado quando um recurso Fulcrum é criado, atualizado ou eliminado. Suporta eventos para registos, formulários, listas de escolhas e conjuntos de classificação. Configure o webhook na sua organização Fulcrum para especificar que eventos monitorizar.

Parâmetros

Name Chave Necessário Tipo Description
Tipo de conteúdo
Content-Type string

Tipo de conteúdo

ativo
active boolean

Se o webhook está ativado

Nome do Webhook
name True string

Nome de exibição para o webhook

run_for_bulk_actions
run_for_bulk_actions boolean

Se o webhook corre para ações de registo em massa

Devoluções

Carga útil de eventos Webhook a partir do Fulcrum

Definições

Anexo

Name Caminho Tipo Description
attached_to_id
attached_to_id string

ID do recurso a que este anexo está ligado

attached_to_type
attached_to_type string

Tipo de recurso a que este anexo está ligado

Concluída
complete boolean

Se o carregamento do anexo está completo

file_size
file_size integer

Tamanho do ficheiro anexo em bytes

id
id string

Identificador único para o anexo

nome
name string

Nome do ficheiro do anexo

proprietários
owners array of object

Lista de referências de proprietários para o anexo

id
owners.id string

Identificação do proprietário

tipo
owners.type string

Tipo de proprietário (por exemplo, 'registo' ou 'formulário')

estado
status string

Estado do anexo

uploaded_at
uploaded_at date-time

Carimbo temporal quando o anexo foi carregado

url
url uri

URL para aceder ao anexo

AttachmentsResponse

Name Caminho Tipo Description
attachments
attachments array of Attachment
total
total integer

Número total de anexos devolvidos

total_count
total_count integer

Contagem total de anexos disponíveis

Áudio

Name Caminho Tipo Description
access_key
access_key string

Identificador único para o recurso áudio

content_type
content_type string

Tipo MIME do ficheiro áudio

criado_em
created_at date-time

Carimbo temporal em que o áudio foi criado

criado_por
created_by string

Nome de exibição do utilizador que criou o áudio

created_by_id
created_by_id string

ID do utilizador que criou o áudio

deleted_at
deleted_at date-time

Carimbo temporal em que o áudio foi apagado

file_size
file_size integer

Tamanho do ficheiro de áudio em bytes

form_id
form_id string

ID da forma associada

meio
medium uri

URL para a versão média do áudio (se processada)

metadados
metadata object

Metadados de áudio (por exemplo, duração, detalhes do formato)

Original
original uri

URL para o ficheiro de áudio original (se armazenado)

processado
processed boolean

Se o áudio foi processado

record_id
record_id string

ID do registo associado

pequeno
small uri

URL para uma versão pequena do áudio (se processada)

estado
status string

Estado de processamento do áudio

Armazenado
stored boolean

Se o áudio foi armazenado

controlar
track uri

URL para aceder à faixa áudio (se disponível)

updated_at
updated_at date-time

Carimbo temporal quando o áudio foi atualizado pela última vez

updated_by
updated_by string

Nome de exibição do utilizador que atualizou o áudio pela última vez

updated_by_id
updated_by_id string

ID do utilizador que atualizou o áudio pela última vez

carregado
uploaded boolean

Se o áudio foi carregado

url
url uri

URL para aceder ao recurso áudio

AudiosResponse

Name Caminho Tipo Description
audio
audio array of Audio
current_page
current_page integer
per_page
per_page integer
total_count
total_count integer
total de páginas
total_pages integer

AuditLocalização

Metadados de localização capturados no momento da criação ou atualização.

Name Caminho Tipo Description
altitude
altitude double

A altitude em metros.

horizontal_accuracy
horizontal_accuracy double

A precisão horizontal em metros.

latitude
latitude double

A coordenada de latitude.

longitude
longitude double

A coordenada de longitude.

Geometria

Name Caminho Tipo Description
coordenadas
coordinates

Coordenadas para a geometria. O formato varia consoante o tipo: Point usa [longitude, latitude], LineString usa array de posições, Polygon usa array de anéis lineares (o primeiro é exterior, o resto são buracos), os Multi* tipos usam arrays das respetivas estruturas de coordenadas.

tipo
type string

Tipo de geometria GeoJSON

Fotografia

Name Caminho Tipo Description
access_key
access_key string

Identificador único para a fotografia

content_type
content_type string

Tipo MIME da foto

criado_em
created_at date-time

Quando a fotografia foi criada

criado_por
created_by string

Nome de exibição do utilizador que criou a fotografia

created_by_id
created_by_id string

ID do utilizador que criou a fotografia

deleted_at
deleted_at date-time

Quando a foto foi apagada

Exif
exif object

Metadados EXIF da foto

file_size
file_size integer

Tamanho do ficheiro fotográfico em bytes

form_id
form_id string

ID da forma associada

grande
large uri

URL para uma versão ampliada da foto

latitude
latitude double

Coordenada de latitude onde a fotografia foi tirada

longitude
longitude double

Coordenada de longitude onde a fotografia foi tirada

Original
original uri

URL da versão original da foto

processado
processed boolean

Se a foto foi processada

record_id
record_id string

ID do registo associado

Armazenado
stored boolean

Se a fotografia foi guardada

miniatura
thumbnail uri

URL da versão em miniatura da foto

updated_at
updated_at date-time

Quando a foto foi atualizada pela última vez

updated_by
updated_by string

Nome de exibição do utilizador que atualizou a foto pela última vez

updated_by_id
updated_by_id string

ID do utilizador que atualizou a foto pela última vez

carregado
uploaded boolean

Se a foto foi carregada

url
url uri

URL da API para este recurso fotográfico

FotosResposta

Name Caminho Tipo Description
current_page
current_page integer
per_page
per_page integer
Fotografias
photos array of Photo
total_count
total_count integer
total de páginas
total_pages integer

Registo

Name Caminho Tipo Description
altitude
altitude number
assigned_to
assigned_to string
assigned_to_id
assigned_to_id string
client_created_at
client_created_at date-time
client_updated_at
client_updated_at date-time
curso
course number
criado_em
created_at date-time
criado_por
created_by string
created_by_id
created_by_id string
created_duration
created_duration number
created_location
created_location AuditLocation

Metadados de localização capturados no momento da criação ou atualização.

edited_duration
edited_duration number
form_id
form_id string
form_values
form_values object

Valores de campo indexados por chave de campo - os valores podem ser cadeias, objetos ou arrays dependendo do tipo de campo

geometria
geometry Geometry
horizontal_accuracy
horizontal_accuracy number
id
id string
latitude
latitude number
longitude
longitude number
project_id
project_id string
record_series_id
record_series_id string
speed
speed number
estado
status string
system_status
system_status string
updated_at
updated_at date-time
updated_by
updated_by string
updated_by_id
updated_by_id string
updated_duration
updated_duration number
updated_location
updated_location AuditLocation

Metadados de localização capturados no momento da criação ou atualização.

versão
version integer
vertical_accuracy
vertical_accuracy number

RecordarHistóriaItem

Name Caminho Tipo Description
altitude
altitude double

Registo da altitude de localização em metros

assigned_to
assigned_to string

Nome de exibição do utilizador atribuído

assigned_to_id
assigned_to_id string

ID do utilizador atribuído

changeset_id
changeset_id string

ID do conjunto de alterações

client_created_at
client_created_at date-time

Carimbo temporal da criação do lado do cliente

client_updated_at
client_updated_at date-time

Carimbo temporal da atualização do lado do cliente

curso
course double

Curso/orientação nos graus

criado_em
created_at date-time

Carimbo temporal da criação do registo

criado_por
created_by string

Nome de exibição do utilizador que criou o registo

created_by_id
created_by_id string

ID do utilizador que criou o registo

created_duration
created_duration integer

Duração da criação do registo em segundos

created_location
created_location AuditLocation

Metadados de localização capturados no momento da criação ou atualização.

edited_duration
edited_duration integer

Duração total da edição em segundos

form_id
form_id string

ID do formulário

form_values
form_values object

Valores dos campos de formulário (processados)

form_version
form_version integer

Versão do formulário no momento da criação/atualização do registo

coordenadas
geometry.coordinates array of number
tipo
geometry.type string
history_change_type
history_change_type string

Tipo de alteração (c=criar, u=atualizar, d=eliminar)

history_changed_by
history_changed_by string

Nome de exibição do utilizador que fez esta alteração

history_changed_by_id
history_changed_by_id string

ID do utilizador que fez esta alteração

history_created_at
history_created_at date-time

Carimbo temporal em que esta entrada de história foi criada

history_id
history_id string

ID de entrada de história

horizontal_accuracy
horizontal_accuracy double

Precisão horizontal em metros

id
id string

ID do Registo

latitude
latitude double

Registo da latitude de localização

longitude
longitude double

Registo de localização longitude

project_id
project_id string

ID do projeto

record_key
record_key string

Tecla de gravação opcional

record_sequence
record_sequence integer

Número opcional de sequência de registo

sequência
sequence integer

Número de sequência (quando utilização de paginação baseada em sequência)

speed
speed double

Velocidade no momento da criação do registo em m/s

estado
status string

Estado do recorde

updated_at
updated_at date-time

Registar o carimbo temporal da última atualização

updated_by
updated_by string

Nome de exibição do utilizador que atualizou o registo pela última vez

updated_by_id
updated_by_id string

ID do utilizador que atualizou o registo pela última vez

updated_duration
updated_duration integer

Duração da atualização do registo em segundos

updated_location
updated_location AuditLocation

Metadados de localização capturados no momento da criação ou atualização.

versão
version integer

Número da versão do disco

vertical_accuracy
vertical_accuracy double

Precisão vertical em medidores

RecordHistóriaResposta

Name Caminho Tipo Description
current_page
current_page integer

Número de página atual (quando se usa paginação)

next_sequence
next_sequence integer

Próximo número de sequência (quando se usa paginação baseada em sequência)

per_page
per_page integer

Número de registos por página (quando se usa paginação)

registos
records array of RecordHistoryItem
total_count
total_count integer

Número total de registos (quando usando paginação)

total de páginas
total_pages integer

Número total de páginas (quando se utiliza paginação)

RecordsResposta

Name Caminho Tipo Description
current_page
current_page integer
per_page
per_page integer
registos
records array of Record
total_count
total_count integer
total de páginas
total_pages integer

ReportResponse

Name Caminho Tipo Description
concluído_em
report.completed_at date-time

O carimbo temporal quando a geração do relatório foi concluída

criado_em
report.created_at date-time

O carimbo temporal em que o relatório foi criado

falhou_em
report.failed_at date-time

O carimbo temporal quando a geração do relatório falhou (nulo se bem-sucedido)

id
report.id uuid

O identificador único para o relatório

record_id
report.record_id uuid

O ID do registo para o qual o relatório foi gerado

started_at
report.started_at date-time

O carimbo temporal quando a geração de relatórios começou

state
report.state string

O estado do relatório

template_id
report.template_id uuid

O ID do modelo usado para gerar o relatório

updated_at
report.updated_at date-time

O carimbo temporal quando o relatório foi atualizado pela última vez

url
report.url uri

O URL para descarregar o relatório gerado

Signature

Name Caminho Tipo Description
access_key
access_key string

Identificador único para a assinatura

content_type
content_type string

Tipo MIME do ficheiro de assinatura

criado_em
created_at date-time

Carimbo temporal em que a assinatura foi criada

criado_por
created_by string

Nome de exibição do utilizador que criou a assinatura

created_by_id
created_by_id string

ID do utilizador que criou a assinatura

deleted_at
deleted_at date-time

Carimbo temporal quando a assinatura foi apagada

file_size
file_size integer

Tamanho do ficheiro de assinatura em bytes

form_id
form_id string

ID da forma associada

grande
large uri

URL para a versão maior da assinatura

Original
original uri

URL para o ficheiro de assinatura original

processado
processed boolean

Se a assinatura foi processada

record_id
record_id string

ID do registo associado

Armazenado
stored boolean

Se a assinatura foi armazenada

miniatura
thumbnail uri

URL para a versão miniatura da assinatura

updated_at
updated_at date-time

Carimbo temporal quando a assinatura foi atualizada pela última vez

updated_by
updated_by string

Nome de exibição do utilizador que atualizou a assinatura pela última vez

updated_by_id
updated_by_id string

ID do utilizador que atualizou a assinatura pela última vez

carregado
uploaded boolean

Se a assinatura foi carregada

url
url uri

URL da API para recuperar esta assinatura

AssinaturasResposta

Name Caminho Tipo Description
current_page
current_page integer
per_page
per_page integer
Assinaturas
signatures array of Signature
total_count
total_count integer
total de páginas
total_pages integer

SinglePhotoResponse

Name Caminho Tipo Description
foto
photo Photo

SingleRecordResponse

Name Caminho Tipo Description
registo
record Record

SingleSignatureResponse

Name Caminho Tipo Description
assinatura
signature Signature

SingleSketchResponse

Name Caminho Tipo Description
Sketch
sketch Sketch

Desenho

Name Caminho Tipo Description
access_key
access_key string

Identificador único para o esboço

content_type
content_type string

Tipo MIME do ficheiro de esboço

criado_em
created_at date-time

Carimbo temporal em que o esboço foi criado

criado_por
created_by string

Nome de exibição do utilizador que criou o esboço

created_by_id
created_by_id string

ID do utilizador que criou o esboço

Exif
exif object

Metadados EXIF do esboço

file_size
file_size integer

Tamanho do ficheiro de esboço em bytes

form_id
form_id string

ID da forma associada

grande
large uri

URL para uma versão ampliada do esboço

meio
medium uri

URL da versão média do esboço

Original
original uri

URL da versão original do esboço

processado
processed boolean

Se o esboço foi processado

record_id
record_id string

ID do registo associado

pequeno
small uri

URL para uma versão pequena do esboço

Armazenado
stored boolean

Se o esboço foi guardado

miniatura
thumbnail uri

URL da versão miniatura do esboço

updated_at
updated_at date-time

Carimbo temporal quando o esboço foi atualizado pela última vez

updated_by
updated_by string

Nome de exibição do utilizador que atualizou o esboço pela última vez

updated_by_id
updated_by_id string

ID do utilizador que atualizou o esboço pela última vez

carregado
uploaded boolean

Se o esboço foi carregado

url
url uri

URL da API para aceder a este recurso de esboços

SketchesResposta

Name Caminho Tipo Description
current_page
current_page integer
per_page
per_page integer
Sketches
sketches array of Sketch
total_count
total_count integer
total de páginas
total_pages integer

Vídeos

Name Caminho Tipo Description
access_key
access_key string

Identificador único para o vídeo

content_type
content_type string

Tipo MIME do ficheiro de vídeo

criado_em
created_at date-time

Carimbo temporal em que o vídeo foi criado

criado_por
created_by string

Nome de exibição do utilizador que criou o vídeo

created_by_id
created_by_id string

ID do utilizador que criou o vídeo

deleted_at
deleted_at date-time

Carimbo temporal em que o vídeo foi apagado

file_size
file_size integer

Tamanho do ficheiro de vídeo em bytes

form_id
form_id string

ID da forma associada

meio
medium uri

URL para a versão média do vídeo

metadados
metadata object

Metadados adicionais sobre o vídeo

Original
original uri

URL do ficheiro de vídeo original

processado
processed boolean

Se o vídeo foi processado

record_id
record_id string

ID do registo associado

pequeno
small uri

URL para uma versão pequena do vídeo

estado
status string

Estado de processamento do vídeo

Armazenado
stored boolean

Se o vídeo foi armazenado

thumbnail_huge
thumbnail_huge uri

URL para uma grande miniatura

thumbnail_huge_square
thumbnail_huge_square uri

URL para uma grande miniatura quadrada

thumbnail_large
thumbnail_large uri

URL para uma imagem em miniatura grande

thumbnail_large_square
thumbnail_large_square uri

URL para uma miniatura quadrada grande

thumbnail_medium
thumbnail_medium uri

URL para uma imagem em miniatura média

thumbnail_medium_square
thumbnail_medium_square uri

URL para uma miniatura quadrada média

thumbnail_small
thumbnail_small uri

URL para uma pequena miniatura

thumbnail_small_square
thumbnail_small_square uri

URL para uma miniatura quadrada pequena

controlar
track uri

URL dos dados da faixa de vídeo em formato JSON, se disponível

updated_at
updated_at date-time

Carimbo temporal quando o vídeo foi atualizado pela última vez

updated_by
updated_by string

Nome de exibição do utilizador que atualizou o vídeo pela última vez

updated_by_id
updated_by_id string

ID do utilizador que atualizou o vídeo pela última vez

carregado
uploaded boolean

Se o vídeo foi carregado

url
url uri

URL da API para aceder a este recurso de vídeo

VídeoResposta

Name Caminho Tipo Description
current_page
current_page integer
per_page
per_page integer
total_count
total_count integer
total de páginas
total_pages integer
videos
videos array of Video

FulcrumWebhookPayload

Carga útil de eventos Webhook a partir do Fulcrum

Name Caminho Tipo Description
ID do Evento
id string

O identificador exclusivo do evento

Tipo de Evento
type string

O tipo de evento (por exemplo, record.create, record.update, record.delete, form.create, form.update, form.delete, choice_list.create, choice_list.update, choice_list.delete, classification_set.create, classification_set.update, classification_set.delete)

ID do Proprietário
owner_id string

O ID da organização que detém este webhook

Dados do Evento
data object

O registo ou os dados de recursos associados ao evento

Criado em
created_at date-time

O carimbo temporal em que o evento ocorreu

binário

Este é o tipo de dados básico 'binário'.