Compartilhar via


Fulcrum (versão prévia)

Fulcrum é uma solução de primeiro campo que capacita especialistas em GIS e membros da equipe não GIS a capturar e compartilhar facilmente dados geoespaciais. Esse conector permite a integração com o Fulcrum para gerenciar dados de campo, fotos, vídeos e muito mais.

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

Service Classe Regions
Copilot Studio Premium Todas as regiões 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:
     – Azure Government regiões
     - Azure regiões da China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões 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 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 Suporte ao Fulcrum
URL https://www.fulcrumapp.com/support
Email support@fulcrumapp.com
Metadados do conector
Publicador Redes Espaciais, Inc.
Site https://www.fulcrumapp.com
Política de privacidade https://www.fulcrumapp.com/privacy
Categorias Produtividade; Dados

Fulcro

Fulcrum é uma solução de primeiro campo que capacita especialistas em GIS e membros da equipe não GIS a capturar e compartilhar facilmente dados geoespaciais. Esse conector permite a integração com o Fulcrum para gerenciar dados de campo, fotos, vídeos e muito mais.

Publicador

Fulcro

Pré-requisitos

  • Assinatura do Fulcrum ativo com acesso à API habilitado

Operações com suporte

Triggers

Quando ocorre um evento Fulcrum

Dispara quando um recurso fulcrum é criado, atualizado ou excluído. Dá suporte a eventos para registros, formulários, listas de opções e conjuntos de classificação. Configure o webhook em sua organização Fulcrum para especificar quais eventos monitorar.

Ações

Obter uma lista de metadados de anexo

Recupere uma lista de anexos.

Obter um anexo

Recuperar metadados de um único anexo.

Obter uma lista de metadados de áudio

Recupere metadados para uma lista de arquivos de áudio.

Obter um arquivo original de áudio

Baixe o arquivo de áudio original.

Obter uma lista de metadados de fotos

Recupere metadados para uma lista de fotos.

Obter um arquivo original de foto

Baixe o arquivo de fotos original.

Obter metadados de foto

Recupere metadados para uma única foto.

Fazer uma solicitação POST de consulta

Execute uma solicitação de API de Consulta usando HTTP POST. Forneça uma consulta sql semelhante à consulta em relação aos dados da sua organização.

Obter uma lista de registros

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

Criar um registro

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

Excluir um registro

Exclua um registro de sua organização.

Obter um registro

Recupere informações detalhadas sobre um registro específico por sua ID. Isso inclui todos os valores de campo de formulário, dados de localização, carimbos de data/hora e metadados associados.

Atualizar parcialmente um registro

Atualize campos específicos de um registro existente sem exigir o objeto de registro completo. Somente os campos incluídos no corpo da solicitação serão modificados, enquanto todos os outros campos permanecem inalterados. Isso é útil para atualizar valores de campo individuais ou metadados.

Atualizar um registro

Atualize um registro com um objeto de registro fornecido. Espera-se que o objeto de registro seja a representação completa do registro. Todos os campos não incluídos são considerados nulos.

Obter o histórico de um registro

Recupere o histórico de versão completo de um registro.

Criar um relatório

Gere um novo relatório para um registro específico, opcionalmente usando um modelo de relatório.

Obter um arquivo de relatório

Baixe o arquivo de relatório PDF gerado.

Obter uma lista de metadados de assinatura

Recupere metadados para uma lista de assinaturas.

Obter metadados de assinatura

Recupere metadados para uma única assinatura.

Obter um arquivo original de assinatura

Baixe o arquivo de assinatura original.

Obter uma lista de metadados de esboço

Recupere metadados para uma lista de esboços.

Obter um arquivo original de esboço

Baixe o arquivo de esboço original.

Obter metadados de esboço

Recuperar metadados para um único esboço.

Obter uma lista de metadados de vídeo

Recupere metadados para uma lista de vídeos.

Obter um arquivo original de vídeo

Baixe o arquivo de vídeo original.

Obtendo credenciais

Para usar o conector fulcrum, você precisa de um token de API fulcrum:

  1. Faça logon em sua conta do Fulcrum em https://web.fulcrumapp.com
  2. Navegar até a API de Configurações >
  3. Gerar um novo token de API ou usar um existente
  4. Copiar o token e usá-lo ao criar uma conexão

Introdução

Crie uma nova conexão e insira seu token de API fulcrum quando solicitado.

URLs de host personalizadas

Por padrão, o conector usa a API fulcrum de produção em api.fulcrumapp.com. Para outras regiões, você pode especificar uma URL de host diferente ao criar sua conexão.

Pontos de extremidade 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: Insira apenas o nome do host sem protocolo ou caminho. O conector usará automaticamente HTTPS e o caminho correto da API.

Solução de problemas:

  • Verifique se o host personalizado está acessível na rede
  • Verifique se o nome do host está correto (sem erros de digitação)
  • Confirme se o token de API é válido para o host especificado

Problemas e limitações conhecidos

  • A limitação de taxa se aplica com base em seu plano fulcrum

Instruções de implantação

Use as instruções these para implantar esse conector como um conector personalizado no Microsoft Power Automate e Power Apps.

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 Descrição Obrigatório
Token API secureString Seu token de API fulcrum para autenticação Verdade
URL do host cadeia O host de API para sua instância do Fulcrum

Limitações

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

Ações

Atualizar parcialmente um registro

Atualize campos específicos de um registro existente sem exigir o objeto de registro completo. Somente os campos incluídos no corpo da solicitação serão modificados, enquanto todos os outros campos permanecem inalterados. Isso é útil para atualizar valores de campo individuais ou metadados.

Atualizar um registro

Atualize um registro com um objeto de registro fornecido. Espera-se que o objeto de registro seja a representação completa do registro. Todos os campos não incluídos são considerados nulos.

Criar um registro

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

Criar um relatório

Gere um novo relatório para um registro específico, opcionalmente usando um modelo de relatório.

Excluir um registro

Exclua um registro de sua organização.

Fazer uma solicitação POST de consulta

Execute uma solicitação de API de Consulta usando HTTP POST. Forneça uma consulta sql semelhante à consulta em relação aos dados da sua organização.

Obter metadados de assinatura

Recupere metadados para uma única assinatura.

Obter metadados de esboço

Recuperar metadados para um único esboço.

Obter metadados de foto

Recupere metadados para uma única foto.

Obter o histórico de um registro

Recupere o histórico de versão completo de um registro.

Obter um anexo

Recuperar metadados de um único anexo.

Obter um arquivo de relatório

Baixe o arquivo de relatório PDF gerado.

Obter um arquivo original de assinatura

Baixe o arquivo de assinatura original.

Obter um arquivo original de esboço

Baixe o arquivo de esboço original.

Obter um arquivo original de foto

Baixe o arquivo de fotos original.

Obter um arquivo original de vídeo

Baixe o arquivo de vídeo original.

Obter um arquivo original de áudio

Baixe o arquivo de áudio original.

Obter um registro

Recupere informações detalhadas sobre um registro específico por sua ID. Isso inclui todos os valores de campo de formulário, dados de localização, carimbos de data/hora e metadados associados.

Obter uma lista de metadados de anexo

Recupere uma lista de anexos.

Obter uma lista de metadados de assinatura

Recupere metadados para uma lista de assinaturas.

Obter uma lista de metadados de esboço

Recupere metadados para uma lista de esboços.

Obter uma lista de metadados de fotos

Recupere metadados para uma lista de fotos.

Obter uma lista de metadados de vídeo

Recupere metadados para uma lista de vídeos.

Obter uma lista de metadados de áudio

Recupere metadados para uma lista de arquivos de áudio.

Obter uma lista de registros

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

Atualizar parcialmente um registro

Atualize campos específicos de um registro existente sem exigir o objeto de registro completo. Somente os campos incluídos no corpo da solicitação serão modificados, enquanto todos os outros campos permanecem inalterados. Isso é útil para atualizar valores de campo individuais ou metadados.

Parâmetros

Nome Chave Obrigatório Tipo Description
Tipo de conteúdo
Content-Type string

Tipo de conteúdo

ID do registro
record_id True string

ID do Registro

X Skipworkflows
X-SkipWorkflows boolean

Ignora todos os fluxos de trabalho do aplicativo

X Skipwebhooks
X-SkipWebhooks boolean

Ignora todos os webhooks de aplicativo

assigned_to_id
assigned_to_id string

ID do usuário atribuído a este registro

form_values
form_values object

Valores de campo chaveados por chave de campo

coordenadas
coordinates True

Coordenadas para a geometria. O formato varia de acordo com o tipo: o ponto usa [longitude, latitude], LineString usa matriz de posições, Polygon usa matriz de anéis lineares (primeiro é exterior, rest são orifícios), tipos multi* usam matrizes de suas respectivas estruturas de coordenadas.

tipo
type True string

Tipo de geometria GeoJSON

latitude
latitude number

Coordenadas de latitude

longitude
longitude number

Coordenada de longitude

project_id
project_id string

ID do projeto

status
status string

Status do registro

Retornos

Atualizar um registro

Atualize um registro com um objeto de registro fornecido. Espera-se que o objeto de registro seja a representação completa do registro. Todos os campos não incluídos são considerados nulos.

Parâmetros

Nome Chave Obrigatório Tipo Description
Tipo de conteúdo
Content-Type string

Tipo de conteúdo

ID do registro
record_id True string

ID do Registro

X Skipworkflows
X-SkipWorkflows boolean

Ignora todos os fluxos de trabalho do aplicativo

X Skipwebhooks
X-SkipWebhooks boolean

Ignora todos os webhooks de aplicativo

assigned_to_id
assigned_to_id string

ID do usuário atribuído a este registro

form_id
form_id True string

ID do formulário ao qual este registro pertence

form_values
form_values object

Valores de campo chaveados por chave de campo

coordenadas
coordinates True

Coordenadas para a geometria. O formato varia de acordo com o tipo: o ponto usa [longitude, latitude], LineString usa matriz de posições, Polygon usa matriz de anéis lineares (primeiro é exterior, rest são orifícios), tipos multi* usam matrizes de suas respectivas estruturas de coordenadas.

tipo
type True string

Tipo de geometria GeoJSON

latitude
latitude number

Coordenadas de latitude

longitude
longitude number

Coordenada de longitude

project_id
project_id string

ID do projeto

status
status string

Status do registro

Criar um registro

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

Parâmetros

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

X Skipwebhooks
X-SkipWebhooks boolean

Ignora todos os webhooks de aplicativo

assigned_to_id
assigned_to_id string

ID do usuário atribuído a este registro

form_id
form_id True string

ID do formulário ao qual este registro pertence

form_values
form_values object

Valores de campo chaveados por chave de campo

coordenadas
coordinates True

Coordenadas para a geometria. O formato varia de acordo com o tipo: o ponto usa [longitude, latitude], LineString usa matriz de posições, Polygon usa matriz de anéis lineares (primeiro é exterior, rest são orifícios), tipos multi* usam matrizes de suas respectivas estruturas de coordenadas.

tipo
type True string

Tipo de geometria GeoJSON

latitude
latitude number

Coordenadas de latitude

longitude
longitude number

Coordenada de longitude

project_id
project_id string

ID do projeto

status
status string

Status do registro

Retornos

Criar um relatório

Gere um novo relatório para um registro específico, opcionalmente usando um modelo de relatório.

Parâmetros

Nome Chave Obrigatório Tipo Description
record_id
record_id True uuid

A ID do registro para gerar um relatório para

template_id
template_id uuid

A ID do modelo de relatório a ser usado (opcional)

Retornos

Excluir um registro

Exclua um registro de sua organização.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do registro
record_id True string

O identificador exclusivo do registro a ser excluído.

X Skipworkflows
X-SkipWorkflows boolean

Ignora todos os fluxos de trabalho do aplicativo

X Skipwebhooks
X-SkipWebhooks boolean

Ignora todos os webhooks de aplicativo

Retornos

Fazer uma solicitação POST de consulta

Execute uma solicitação de API de Consulta usando HTTP POST. Forneça uma consulta sql semelhante à consulta em relação aos dados da sua organização.

Parâmetros

Nome Chave Obrigató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 serem retornados por página.

format
format string

Formato da resposta

q
q True string

Consulta SQL a ser executada

nome_da_tabela
table_name string

Nome da tabela a ser consultada

Obter metadados de assinatura

Recupere metadados para uma única assinatura.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da assinatura
signature_id True string

O identificador exclusivo da assinatura.

Retornos

Obter metadados de esboço

Recuperar metadados para um único esboço.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do esboço
sketch_id True string

ID do esboço

Retornos

Obter metadados de foto

Recupere metadados para uma única foto.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da foto
photo_id True string

O identificador exclusivo da foto.

Retornos

Obter o histórico de um registro

Recupere o histórico de versão completo de um registro.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do registro
record_id True string

O identificador exclusivo do registro cujo histórico você deseja recuperar.

Retornos

Obter um anexo

Recuperar metadados de um único anexo.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do anexo
attachment_id True string

O identificador exclusivo do anexo.

Retornos

Corpo
Attachment

Obter um arquivo de relatório

Baixe o arquivo de relatório PDF gerado.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do relatório
report_id True uuid

O identificador exclusivo do relatório.

Retornos

response
binary

Obter um arquivo original de assinatura

Baixe o arquivo de assinatura original.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da assinatura
signature_id True string

O identificador exclusivo da assinatura.

Retornos

response
binary

Obter um arquivo original de esboço

Baixe o arquivo de esboço original.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do esboço
sketch_id True string

ID do esboço

Retornos

response
binary

Obter um arquivo original de foto

Baixe o arquivo de fotos original.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da foto
photo_id True string

O identificador exclusivo da foto.

Retornos

response
binary

Obter um arquivo original de vídeo

Baixe o arquivo de vídeo original.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do vídeo
video_id True string

O identificador exclusivo do vídeo.

Retornos

response
binary

Obter um arquivo original de áudio

Baixe o arquivo de áudio original.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de áudio
audio_id True string

O identificador exclusivo do arquivo de áudio.

Retornos

response
binary

Obter um registro

Recupere informações detalhadas sobre um registro específico por sua ID. Isso inclui todos os valores de campo de formulário, dados de localização, carimbos de data/hora e metadados associados.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do registro
record_id True string

O identificador exclusivo do registro a ser recuperado.

Retornos

Obter uma lista de metadados de anexo

Recupere uma lista de anexos.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do registro
record_id string

A ID do registro ao qual o anexo está associado. Isso é necessário ao listar anexos de registro.

ID de Formulário
form_id string

A ID do formulário ao qual o anexo está associado. Esse parâmetro permitirá que você obtenha todos os arquivos de referência em um formulário, NÃO todos os anexos de registro em um formulário

Tipo de Proprietário
owner_type string

O tipo de anexo para o qual consultar. Deve ser um form ou record.

Classificar
sort string

O campo pelo qual classificar os resultados.

Direção da Ordenação
sort_direction string

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

Retornos

Obter uma lista de metadados de assinatura

Recupere metadados para uma lista de assinaturas.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do registro
record_id string

A ID do registro ao qual a foto está associada.

ID de Formulário
form_id string

A ID do formulário ao qual a foto está associada. Deixar isso em branco consultará todas as suas fotos.

Primeiro mais recente
newest_first boolean

Se presente, as fotos serão classificadas por updated_at data.

Processadas
processed boolean

Filtrar assinaturas que foram completamente processadas.

Armazenado
stored boolean

Filtrar assinaturas que foram completamente armazenadas.

Enviado
uploaded boolean

Filtrar assinaturas que 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 serem retornados por página.

Retornos

Obter uma lista de metadados de esboço

Recupere metadados para uma lista de esboços.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do registro
record_id string

A ID do registro ao qual o esboço está associado.

ID de Formulário
form_id string

A ID do formulário ao qual o esboço está associado. Deixar isso em branco consultará todos os seus esboços.

Primeiro mais recente
newest_first boolean

Se estiverem presentes, os esboços serão classificados por updated_at data.

Processadas
processed boolean

O esboço foi completamente processado.

Armazenado
stored boolean

O esboço foi completamente armazenado.

Enviado
uploaded boolean

O esboço foi completamente carregado.

Página
page integer

O número de página solicitado

Por Página
per_page integer

Número de itens por página

Retornos

Obter uma lista de metadados de fotos

Recupere metadados para uma lista de fotos.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do registro
record_id string

A ID do registro ao qual a foto está associada.

ID de Formulário
form_id string

A ID do formulário ao qual a foto está associada. Deixar isso em branco consultará todas as suas fotos.

Primeiro mais recente
newest_first boolean

Se presente, as fotos serão classificadas por updated_at data.

Processadas
processed boolean

Filtrar fotos que foram completamente processadas.

Armazenado
stored boolean

Filtro para fotos que foram completamente armazenadas.

Enviado
uploaded boolean

Filtre para fotos que 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 serem retornados por página.

Retornos

Obter uma lista de metadados de vídeo

Recupere metadados para uma lista de vídeos.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do registro
record_id string

A ID do registro ao qual o vídeo está associado.

ID de Formulário
form_id string

A ID do formulário ao qual o vídeo está associado. Deixar isso em branco consultará todos os seus vídeos.

Primeiro mais recente
newest_first boolean

Se estiverem presentes, os vídeos serão classificados por updated_at data.

Processadas
processed boolean

Filtrar vídeos que foram completamente processados.

Armazenado
stored boolean

Filtrar vídeos que foram completamente armazenados.

Enviado
uploaded boolean

Filtrar 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 serem retornados por página.

Retornos

Obter uma lista de metadados de áudio

Recupere metadados para uma lista de arquivos de áudio.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do registro
record_id string

A ID do registro ao qual o arquivo de áudio está associado.

ID de Formulário
form_id string

A ID do formulário ao qual o arquivo de áudio está associado. Deixar isso em branco consultará todos os seus arquivos de áudio.

Primeiro mais recente
newest_first boolean

Se estiverem presentes, os arquivos de áudio serão classificados por updated_at data.

Processadas
processed boolean

Filtrar arquivos de áudio que foram completamente processados.

Armazenado
stored boolean

Filtrar arquivos de áudio que foram completamente armazenados.

Enviado
uploaded boolean

Filtrar arquivos 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 serem retornados por página.

Retornos

Obter uma lista de registros

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Primeiro mais recente
newest_first boolean

Se presente, os registros serão classificados por updated_at data.

Caixa delimitadora
bounding_box string

Caixa delimitadora dos registros solicitados. O formato deve ser: lat, long, lat, long (inferior, esquerda, superior, direita).

ID do conjunto de alterações
changeset_id string

A ID do conjunto de alterações associado ao registro.

ID de Formulário
form_id string

A ID do formulário ao qual o registro está associado. Deixar isso em branco consultará todos os seus registros.

ID do projeto
project_id string

A ID do projeto ao qual o registro está associado. Deixar isso em branco consultará todos os seus registros.

Cliente criado antes
client_created_before date-time

Retornar somente registros que foram criados pelo cliente (dispositivo) antes do horário determinado.

Cliente criado desde então
client_created_since date-time

Retornar somente registros que foram criados pelo cliente (dispositivo) após o horário determinado.

Cliente atualizado antes
client_updated_before date-time

Retornar somente registros que foram atualizados pelo cliente (dispositivo) antes do horário determinado.

Cliente atualizado desde então
client_updated_since date-time

Retornar somente registros que foram atualizados pelo cliente (dispositivo) após o horário determinado.

Criado antes
created_before date-time

Retornar somente registros que foram criados (no servidor) antes do horário determinado.

Criado desde então
created_since date-time

Retornar somente registros que foram criados (no servidor) após o horário determinado.

Atualizado antes
updated_before date-time

Retornar somente registros que foram atualizados (no servidor) antes do horário determinado.

Atualizado desde então
updated_since date-time

Retornar somente registros que foram atualizados (no servidor) após o horário determinado.

Página
page integer

O número de página solicitado

Por Página
per_page integer

Número de itens por página

Retornos

Gatilhos

Quando ocorre um evento Fulcrum

Dispara quando um recurso fulcrum é criado, atualizado ou excluído. Dá suporte a eventos para registros, formulários, listas de opções e conjuntos de classificação. Configure o webhook em sua organização Fulcrum para especificar quais eventos monitorar.

Quando ocorre um evento Fulcrum

Dispara quando um recurso fulcrum é criado, atualizado ou excluído. Dá suporte a eventos para registros, formulários, listas de opções e conjuntos de classificação. Configure o webhook em sua organização Fulcrum para especificar quais eventos monitorar.

Parâmetros

Nome Chave Obrigatório Tipo Description
Tipo de conteúdo
Content-Type string

Tipo de conteúdo

ativo
active boolean

Se o webhook está habilitado

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 é executado para ações de registro em massa

Retornos

Conteúdo do evento webhook do Fulcrum

Definições

Anexo

Nome Caminho Tipo Description
attached_to_id
attached_to_id string

ID do recurso ao qual este anexo está anexado

attached_to_type
attached_to_type string

Tipo de recurso ao qual esse anexo está anexado

complete
complete boolean

Se o upload do anexo está concluído

file_size
file_size integer

Tamanho do arquivo de anexo em bytes

id
id string

Identificador exclusivo para o anexo

nome
name string

Nome do arquivo do anexo

owners
owners array of object

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

id
owners.id string

ID do proprietário

tipo
owners.type string

Tipo de proprietário (por exemplo, 'record' ou 'form')

status
status string

Status do anexo

uploaded_at
uploaded_at date-time

Carimbo de data/hora quando o anexo foi carregado

url
url uri

URL para acessar o anexo

AttachmentsResponse

Nome Caminho Tipo Description
anexos
attachments array of Attachment
total
total integer

Número total de anexos retornados

total_count
total_count integer

Contagem total de anexos disponíveis

Áudio

Nome Caminho Tipo Description
access_key
access_key string

Identificador exclusivo para o recurso de áudio

content_type
content_type string

Tipo MIME do arquivo de áudio

criado_em
created_at date-time

Carimbo de data/hora quando o áudio foi criado

created_by
created_by string

Nome de exibição do usuário que criou o áudio

created_by_id
created_by_id string

ID do usuário que criou o áudio

deleted_at
deleted_at date-time

Carimbo de data/hora quando o áudio foi excluído

file_size
file_size integer

Tamanho do arquivo de áudio em bytes

form_id
form_id string

ID do formulário associado

meio
medium uri

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

metadados
metadata object

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

original
original uri

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

Processados
processed boolean

Se o áudio foi processado

record_id
record_id string

ID do registro associado

pequeno
small uri

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

status
status string

Status de processamento do áudio

Armazenado
stored boolean

Se o áudio foi armazenado

acompanhar
track uri

URL para acessar a faixa de áudio (se disponível)

updated_at
updated_at date-time

Carimbo de data/hora quando o áudio foi atualizado pela última vez

updated_by
updated_by string

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

updated_by_id
updated_by_id string

ID do usuário que atualizou o áudio pela última vez

Carregado
uploaded boolean

Se o áudio foi carregado

url
url uri

URL para acessar o recurso de áudio

AudiosResponse

Nome Caminho Tipo Description
audio
audio array of Audio
current_page
current_page integer
per_page
per_page integer
total_count
total_count integer
total_pages
total_pages integer

AuditLocation

Metadados de localização capturados na hora de criação ou atualização.

Nome 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

Nome Caminho Tipo Description
coordenadas
coordinates

Coordenadas para a geometria. O formato varia de acordo com o tipo: o ponto usa [longitude, latitude], LineString usa matriz de posições, Polygon usa matriz de anéis lineares (primeiro é exterior, rest são orifícios), tipos multi* usam matrizes de suas respectivas estruturas de coordenadas.

tipo
type string

Tipo de geometria GeoJSON

Foto

Nome Caminho Tipo Description
access_key
access_key string

Identificador exclusivo para a foto

content_type
content_type string

Tipo MIME da foto

criado_em
created_at date-time

Quando a foto foi criada

created_by
created_by string

Nome de exibição do usuário que criou a foto

created_by_id
created_by_id string

ID do usuário que criou a foto

deleted_at
deleted_at date-time

Quando a foto foi excluída

exif
exif object

Metadados EXIF da foto

file_size
file_size integer

Tamanho do arquivo de fotos em bytes

form_id
form_id string

ID do formulário associado

large
large uri

URL para uma versão grande da foto

latitude
latitude double

Coordenada de latitude onde a foto foi tirada

longitude
longitude double

Coordenada longitude onde a foto foi tirada

original
original uri

URL para a versão original da foto

Processados
processed boolean

Se a foto foi processada

record_id
record_id string

ID do registro associado

Armazenado
stored boolean

Se a foto foi armazenada

miniatura
thumbnail uri

URL para a 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 usuário que atualizou a foto pela última vez

updated_by_id
updated_by_id string

ID do usuário que atualizou a foto pela última vez

Carregado
uploaded boolean

Se a foto foi carregada

url
url uri

URL da API para este recurso de foto

PhotosResponse

Nome Caminho Tipo Description
current_page
current_page integer
per_page
per_page integer
fotos
photos array of Photo
total_count
total_count integer
total_pages
total_pages integer

Registro

Nome 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
created_by
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 na hora de criação ou atualização.

edited_duration
edited_duration number
form_id
form_id string
form_values
form_values object

Valores de campo chaveados por chave de campo - os valores podem ser cadeias de caracteres, objetos ou matrizes, 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
status
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 na hora de criação ou atualização.

versão
version integer
vertical_accuracy
vertical_accuracy number

RecordHistoryItem

Nome Caminho Tipo Description
altitude
altitude double

Registrar altitude de localização em medidores

assigned_to
assigned_to string

Nome de exibição do usuário atribuído

assigned_to_id
assigned_to_id string

ID do usuário atribuído

changeset_id
changeset_id string

ID do conjunto de alterações

client_created_at
client_created_at date-time

Carimbo de data/hora de criação do lado do cliente

client_updated_at
client_updated_at date-time

Carimbo de data/hora de atualização do lado do cliente

curso
course double

Curso/título em graus

criado_em
created_at date-time

Carimbo de data/hora de criação de registro

created_by
created_by string

Nome de exibição do usuário que criou o registro

created_by_id
created_by_id string

ID do usuário que criou o registro

created_duration
created_duration integer

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

created_location
created_location AuditLocation

Metadados de localização capturados na hora de 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 de campo de formulário (processados)

form_version
form_version integer

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

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

Tipo de alteração (c=create, u=update, d=delete)

history_changed_by
history_changed_by string

Nome de exibição do usuário que fez essa alteração

history_changed_by_id
history_changed_by_id string

ID do usuário que fez essa alteração

history_created_at
history_created_at date-time

Carimbo de data/hora quando essa entrada de histórico foi criada

history_id
history_id string

ID da entrada do histórico

horizontal_accuracy
horizontal_accuracy double

Precisão horizontal em medidores

id
id string

ID do Registro

latitude
latitude double

Latitude do local do registro

longitude
longitude double

Longitude do local do registro

project_id
project_id string

ID do projeto

record_key
record_key string

Chave de registro opcional

record_sequence
record_sequence integer

Número de sequência de registros opcional

sequência
sequence integer

Número de sequência (ao usar paginação baseada em sequência)

speed
speed double

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

status
status string

Status do registro

updated_at
updated_at date-time

Registrar o carimbo de data/hora da última atualização

updated_by
updated_by string

Nome de exibição do usuário que atualizou o registro pela última vez

updated_by_id
updated_by_id string

ID do usuário que atualizou o registro pela última vez

updated_duration
updated_duration integer

Duração da atualização de registro em segundos

updated_location
updated_location AuditLocation

Metadados de localização capturados na hora de criação ou atualização.

versão
version integer

Número de versão do registro

vertical_accuracy
vertical_accuracy double

Precisão vertical em medidores

RecordHistoryResponse

Nome Caminho Tipo Description
current_page
current_page integer

Número da página atual (ao usar paginação)

next_sequence
next_sequence integer

Próximo número de sequência (ao usar paginação baseada em sequência)

per_page
per_page integer

Número de registros por página (ao usar paginação)

arquivo
records array of RecordHistoryItem
total_count
total_count integer

Número total de registros (ao usar paginação)

total_pages
total_pages integer

Número total de páginas (ao usar paginação)

RecordsResponse

Nome Caminho Tipo Description
current_page
current_page integer
per_page
per_page integer
arquivo
records array of Record
total_count
total_count integer
total_pages
total_pages integer

ReportResponse

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

O carimbo de data/hora quando a geração de relatório foi concluída

criado_em
report.created_at date-time

O carimbo de data/hora quando o relatório foi criado

failed_at
report.failed_at date-time

O carimbo de data/hora em que a geração de relatório falhou (nulo, se bem-sucedido)

id
report.id uuid

O identificador exclusivo do relatório

record_id
report.record_id uuid

A ID do registro para o qual o relatório foi gerado

started_at
report.started_at date-time

O carimbo de data/hora quando a geração de relatório foi iniciada

estado
report.state string

O estado do relatório

template_id
report.template_id uuid

A ID do modelo usado para gerar o relatório

updated_at
report.updated_at date-time

O carimbo de data/hora em que o relatório foi atualizado pela última vez

url
report.url uri

A URL para baixar o relatório gerado

Signature

Nome Caminho Tipo Description
access_key
access_key string

Identificador exclusivo para a assinatura

content_type
content_type string

Tipo MIME do arquivo de assinatura

criado_em
created_at date-time

Carimbo de data/hora quando a assinatura foi criada

created_by
created_by string

Nome de exibição do usuário que criou a assinatura

created_by_id
created_by_id string

ID do usuário que criou a assinatura

deleted_at
deleted_at date-time

Carimbo de data/hora quando a assinatura foi excluída

file_size
file_size integer

Tamanho do arquivo de assinatura em bytes

form_id
form_id string

ID do formulário associado

large
large uri

URL para a versão grande da assinatura

original
original uri

URL para o arquivo de assinatura original

Processados
processed boolean

Se a assinatura foi processada

record_id
record_id string

ID do registro associado

Armazenado
stored boolean

Se a assinatura foi armazenada

miniatura
thumbnail uri

URL para a versão em miniatura da assinatura

updated_at
updated_at date-time

Carimbo de data/hora quando a assinatura foi atualizada pela última vez

updated_by
updated_by string

Nome de exibição do usuário que atualizou a assinatura pela última vez

updated_by_id
updated_by_id string

ID do usuário que atualizou a assinatura pela última vez

Carregado
uploaded boolean

Se a assinatura foi carregada

url
url uri

URL da API para recuperar essa assinatura

SignaturesResponse

Nome Caminho Tipo Description
current_page
current_page integer
per_page
per_page integer
Assinaturas
signatures array of Signature
total_count
total_count integer
total_pages
total_pages integer

SinglePhotoResponse

Nome Caminho Tipo Description
photo
photo Photo

SingleRecordResponse

Nome Caminho Tipo Description
registro
record Record

SingleSignatureResponse

Nome Caminho Tipo Description
assinatura
signature Signature

SingleSketchResponse

Nome Caminho Tipo Description
Esboço
sketch Sketch

Esboço

Nome Caminho Tipo Description
access_key
access_key string

Identificador exclusivo para o esboço

content_type
content_type string

Tipo MIME do arquivo de esboço

criado_em
created_at date-time

Carimbo de data/hora quando o esboço foi criado

created_by
created_by string

Nome de exibição do usuário que criou o esboço

created_by_id
created_by_id string

ID do usuário que criou o esboço

exif
exif object

Metadados EXIF do esboço

file_size
file_size integer

Tamanho do arquivo de esboço em bytes

form_id
form_id string

ID do formulário associado

large
large uri

URL para uma versão grande do esboço

meio
medium uri

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

original
original uri

URL para a versão original do esboço

Processados
processed boolean

Se o esboço foi processado

record_id
record_id string

ID do registro associado

pequeno
small uri

URL para versão pequena do esboço

Armazenado
stored boolean

Se o esboço foi armazenado

miniatura
thumbnail uri

URL para a versão em miniatura do esboço

updated_at
updated_at date-time

Carimbo de data/hora quando o esboço foi atualizado pela última vez

updated_by
updated_by string

Nome de exibição do usuário que atualizou o esboço pela última vez

updated_by_id
updated_by_id string

ID do usuário que atualizou o esboço pela última vez

Carregado
uploaded boolean

Se o esboço foi carregado

url
url uri

URL da API para acessar esse recurso de esboço

SketchesResponse

Nome Caminho Tipo Description
current_page
current_page integer
per_page
per_page integer
Esboços
sketches array of Sketch
total_count
total_count integer
total_pages
total_pages integer

Vídeo

Nome Caminho Tipo Description
access_key
access_key string

Identificador exclusivo para o vídeo

content_type
content_type string

Tipo MIME do arquivo de vídeo

criado_em
created_at date-time

Carimbo de data/hora quando o vídeo foi criado

created_by
created_by string

Nome de exibição do usuário que criou o vídeo

created_by_id
created_by_id string

ID do usuário que criou o vídeo

deleted_at
deleted_at date-time

Carimbo de data/hora quando o vídeo foi excluído

file_size
file_size integer

Tamanho do arquivo de vídeo em bytes

form_id
form_id string

ID do formulário associado

meio
medium uri

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

metadados
metadata object

Metadados adicionais sobre o vídeo

original
original uri

URL para o arquivo de vídeo original

Processados
processed boolean

Se o vídeo foi processado

record_id
record_id string

ID do registro associado

pequeno
small uri

URL para versão pequena do vídeo

status
status string

Status de processamento do vídeo

Armazenado
stored boolean

Se o vídeo foi armazenado

thumbnail_huge
thumbnail_huge uri

URL para uma imagem em miniatura enorme

thumbnail_huge_square
thumbnail_huge_square uri

URL para uma imagem em miniatura quadrada enorme

thumbnail_large
thumbnail_large uri

URL para imagem em miniatura grande

thumbnail_large_square
thumbnail_large_square uri

Url para imagem em miniatura quadrada grande

thumbnail_medium
thumbnail_medium uri

Imagem de URL para miniatura média

thumbnail_medium_square
thumbnail_medium_square uri

Imagem de miniatura de URL para quadrado médio

thumbnail_small
thumbnail_small uri

URL para imagem em miniatura pequena

thumbnail_small_square
thumbnail_small_square uri

URL para imagem em miniatura quadrada pequena

acompanhar
track uri

URL para os dados da faixa de vídeo no formato JSON, se disponível

updated_at
updated_at date-time

Carimbo de data/hora quando o vídeo foi atualizado pela última vez

updated_by
updated_by string

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

updated_by_id
updated_by_id string

ID do usuário que atualizou o vídeo pela última vez

Carregado
uploaded boolean

Se o vídeo foi carregado

url
url uri

URL da API para acessar este recurso de vídeo

VideosResponse

Nome Caminho Tipo Description
current_page
current_page integer
per_page
per_page integer
total_count
total_count integer
total_pages
total_pages integer
videos
videos array of Video

FulcrumWebhookPayload

Conteúdo do evento webhook do Fulcrum

Nome 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

A ID da organização que possui esse webhook

Dados do evento
data object

Os dados de registro ou de recurso associados ao evento

Criado em
created_at date-time

O carimbo de data/hora em que o evento ocorreu

binário

Esse é o tipo de dados básico 'binary'.