Partilhar via


smapOne

Use este conector para recuperar dados sobre seus smaps da plataforma smapOne, atualizar fontes de dados ou criar tarefas para seus usuários.

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

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome smapOne AG [en]
URL https://www.smapone.com
Email support@smapone.com
Metadados do conector
Editora smapOne AG [en]
Sítio Web https://www.smapone.com
Política de privacidade https://en.smapone.com/privacy-policy/
Categorias Dados; Produtividade

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:

Predefinição Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: Todas as regiões

Parâmetros para criar conexão.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
Chave da API smapOne securestring A chave de api para sua conta smapOne Verdade

Limites de Limitação

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

Ações

Atribuir ou remover tarefa

Atribuir ou remover uma tarefa de um utilizador

Atualizar fonte de dados

Atualizar uma fonte de dados. As colunas devem ser iguais. Isso significa que os column-ids devem corresponder.

Atualizar todas as fontes de dados em um smap

Verifique todas as fontes de dados referenciadas para obter uma atualização. Se houver versões secundárias mais recentes das fontes de dados referenciadas, as referências foram atualizadas e uma nova versão deste smap será publicada. Se não houver atualizações disponíveis, nenhuma publicação será executada e a versão mais recente será devolvida.

Criar tarefa para uma versão do smap

Criar uma tarefa - um registro de dados pré-preenchido que pode ser atribuído a um usuário

Excluir registro de dados

Exclui um registro de dados específico da versão do smap fornecida.

Excluir registros de dados de uma versão do smap

Exclui todos os registros de dados para uma determinada versão do smap. Esteja ciente de que você exclui todos os seus registros se você não definir o filtro de estado!

Obter arquivo de registro de dados

Retorna um arquivo específico para o determinado recordId da versão smap fornecida.

Obter detalhes da fonte de dados

Retorna os detalhes para uma determinada fonte de dados.

Obter detalhes para um smap específico

Obter todos os metadados para um smap específico

Obter esquema para dataRecord

Obter o esquema json para os dados deste smap

Obter estatísticas sobre utilizador e subscrição

Esta operação fornece estatísticas sobre a sua subscrição, como a contagem de dados.

Obter fontes de dados

Retorna uma lista de fontes de dados disponíveis em sua assinatura. As entidades retornadas podem ser usadas para consultar versões de fonte de dados usando um determinado dataSourceId.

Obter informações sobre o usuário

Esta operação retorna informações sobre o usuário atual. Por exemplo, usuários e-mail e subscriptionId.

Obter o relatório de um registro de dados

Retorna o relatório de um registro de dados específico de uma determinada versão do smap.

Obter os relatórios para todos os registros de dados de todas as versões de um smap

Retorna os relatórios para todos os registros de um determinado smapId. Relatórios de todas as versões do smap são retornados.

Obter os relatórios para todos os registros de dados de uma versão específica do smap

Retorna os relatórios para todos os registros de uma versão específica do smap. Para todos os novos registos, a data de exportação será atualizada automaticamente. Você pode usar o parâmetro state para filtrar novos registros.

Obter registo de dados

Retorna um registro de dados específico de uma determinada versão do smap.

Obter todas as versões do smap

Retorna versões als que pertencem ao smapId fornecido. As entidades retornadas podem ser usadas para consultar registros de dados para uma determinada versão. A versão 0.0 é a versão atualmente editada, não a jato publicado verrsion de um smap.

Obter todos os metadados de arquivo para registro de dados

Retorna os metadados de todos os arquivos desse registro de dados.

Obter todos os registros de dados para a versão do smap

Retorna todos os registros para uma versão específica do smap usando um determinado smapId. Para todos os novos registos, a data de exportação será atualizada automaticamente. Você pode usar o parâmetro state para filtrar novos registros.

Obter todos os registros de dados para todas as versões de um smap

Retorna todos os registros para um determinado smapId. Os registros de dados de todas as versões do smap são retornados. Lembre-se de que os resultados podem não ser mutuamente compatíveis porque o esquema de dados pode ter sido alterado entre a versão do smap.

Obter todos os smaps

Devolve todos os mapas da sua subscrição. As entidades retornadas podem ser usadas para consultar versões smap disponíveis usando um determinado smapId ou para consultar registros de dados de um smap.

Obter valores de fonte de dados

Retorna os valores de uma versão específica da fonte de dados.

Obter versão específica do smap

Obter metadados para uma versão específica de um smap

Atribuir ou remover tarefa

Atribuir ou remover uma tarefa de um utilizador

Parâmetros

Name Chave Necessário Tipo Description
smapId
smapId True string

O id do smap

smapVersão
version True string

O número da versão do smap (por exemplo, 1.0)

recordId
taskId True string

O ID do registo

ação
action string
usuárioE-mail
userEmail string

Devoluções

Modelo de API REST para registros de dados

Atualizar fonte de dados

Atualizar uma fonte de dados. As colunas devem ser iguais. Isso significa que os column-ids devem corresponder.

Parâmetros

Name Chave Necessário Tipo Description
DatasourceId
dataSourceId True string

A ID da fonte de dados

Versão
dataSourceVersion True string

O número da versão da fonte de dados atual (por exemplo, 1.0)

values
values object

Devoluções

Modelo de versão da fonte de dados

Atualizar todas as fontes de dados em um smap

Verifique todas as fontes de dados referenciadas para obter uma atualização. Se houver versões secundárias mais recentes das fontes de dados referenciadas, as referências foram atualizadas e uma nova versão deste smap será publicada. Se não houver atualizações disponíveis, nenhuma publicação será executada e a versão mais recente será devolvida.

Parâmetros

Name Chave Necessário Tipo Description
smapId
smapId True string

O id do smap

Versão do Update Designer
updateEditVersion boolean

Se a versão atual do designer também deve ser atualizada

Devoluções

Informações para um Smap-Version

Criar tarefa para uma versão do smap

Criar uma tarefa - um registro de dados pré-preenchido que pode ser atribuído a um usuário

Parâmetros

Name Chave Necessário Tipo Description
smapId
smapId True string

O id do smap

smapVersão
version True string

O número da versão do smap (por exemplo, 1.0)

usuárioE-mail
userEmail string
title
title True string

O nome da tarefa

comentário
comment string

Comentário do criador da tarefa

temPrioridade
hasPriority boolean

A tarefa é priorizada

dados
data True object

Devoluções

Modelo de API REST para registros de dados

Excluir registro de dados

Exclui um registro de dados específico da versão do smap fornecida.

Parâmetros

Name Chave Necessário Tipo Description
smapId
smapId True string

O id do smap

smapVersão
version True string

O número da versão do smap (por exemplo, 1.0)

recordId
recordId True string

O ID do registo de dados

Excluir registros de dados de uma versão do smap

Exclui todos os registros de dados para uma determinada versão do smap. Esteja ciente de que você exclui todos os seus registros se você não definir o filtro de estado!

Parâmetros

Name Chave Necessário Tipo Description
smapId
smapId True string

O id do smap

smapVersão
version True string

O número da versão do smap (por exemplo, 1.0)

Estado de Registo
state string

filtrar os registros para estado novo, exportado ou incompleto

Obter arquivo de registro de dados

Retorna um arquivo específico para o determinado recordId da versão smap fornecida.

Parâmetros

Name Chave Necessário Tipo Description
smapId
smapId True string

O id do smap

smapVersão
version True string

O número da versão do smap (por exemplo, 1.0)

recordId
recordId True string

O ID do registo

Id do arquivo
fileId True string

O ID do ficheiro

Obter detalhes da fonte de dados

Retorna os detalhes para uma determinada fonte de dados.

Parâmetros

Name Chave Necessário Tipo Description
DatasourceId
dataSourceId True string

A id da fonte de dados

Devoluções

Modelo de origem

Obter detalhes para um smap específico

Obter todos os metadados para um smap específico

Parâmetros

Name Chave Necessário Tipo Description
smapId
smapId True string

O smapId de um smap a ser solicitado

Devoluções

Informações básicas sobre um smap

Body
SmapModel

Obter esquema para dataRecord

Obter o esquema json para os dados deste smap

Parâmetros

Name Chave Necessário Tipo Description
smapId
smapId True string

O id do smap

smapVersão
version True string

O número da versão do smap (por exemplo, 1.0)

Devoluções

response
object

Obter estatísticas sobre utilizador e subscrição

Esta operação fornece estatísticas sobre a sua subscrição, como a contagem de dados.

Devoluções

Obter fontes de dados

Retorna uma lista de fontes de dados disponíveis em sua assinatura. As entidades retornadas podem ser usadas para consultar versões de fonte de dados usando um determinado dataSourceId.

Devoluções

Obter informações sobre o usuário

Esta operação retorna informações sobre o usuário atual. Por exemplo, usuários e-mail e subscriptionId.

Devoluções

Informação a um utilizador

Obter o relatório de um registro de dados

Retorna o relatório de um registro de dados específico de uma determinada versão do smap.

Parâmetros

Name Chave Necessário Tipo Description
smapId
smapId True string

O id do smap

smapVersão
version True string

O número da versão do smap (por exemplo, 1.0)

recordId
recordId True string

O ID do registo de dados

Formato
format True string

Pdf, Docx, Doc, Html, Xml, Txt (para fins de teste)

Marca exportada
markAsExported boolean

Marcar registro como exportado

Usar modelo padrão
useDefault boolean

Se verdadeiro, um novo modelo é gerado e o modelo de relatório carregado será ignorado.

Devoluções

response
binary

Obter os relatórios para todos os registros de dados de todas as versões de um smap

Retorna os relatórios para todos os registros de um determinado smapId. Relatórios de todas as versões do smap são retornados.

Parâmetros

Name Chave Necessário Tipo Description
smapId
smapId True string

O id do smap

Marca exportada
markAsExported boolean

Marcar os registros de dados de todos os relatórios solicitados como exportados

Estado de Registo
state string

Filtrar registos para o seu estado: novo, exportado ou incompleto (Tarefa)

Devoluções

response
binary

Obter os relatórios para todos os registros de dados de uma versão específica do smap

Retorna os relatórios para todos os registros de uma versão específica do smap. Para todos os novos registos, a data de exportação será atualizada automaticamente. Você pode usar o parâmetro state para filtrar novos registros.

Parâmetros

Name Chave Necessário Tipo Description
smapId
smapId True string

O id do smap

smapVersão
version True string

A versão smap no formato major ou major.minor

Marca exportada
markAsExported boolean

Marcar os registros de dados de todos os relatórios solicitados como exportados

Estado de Registo
state string

Filtrar os registos por estado novo, exportado ou incompleto

Devoluções

response
binary

Obter registo de dados

Retorna um registro de dados específico de uma determinada versão do smap.

Parâmetros

Name Chave Necessário Tipo Description
smapId
smapId True string

O id do smap

smapVersão
version True string

O número da versão do smap (por exemplo, 1.0)

recordId
recordId True string

O ID do registo de dados

Formato
format string

Json, Xml

Marca exportada
markAsExported boolean

Marcar o registo como exportado

Devoluções

Modelo de API REST para registros de dados

Obter todas as versões do smap

Retorna versões als que pertencem ao smapId fornecido. As entidades retornadas podem ser usadas para consultar registros de dados para uma determinada versão. A versão 0.0 é a versão atualmente editada, não a jato publicado verrsion de um smap.

Parâmetros

Name Chave Necessário Tipo Description
smapId
smapId True string

O id do smap

Devoluções

Obter todos os metadados de arquivo para registro de dados

Retorna os metadados de todos os arquivos desse registro de dados.

Parâmetros

Name Chave Necessário Tipo Description
smapId
smapId True string

O id do smap

smapVersão
version True string

O número da versão do smap (por exemplo, 1.0)

recordId
recordId True string

O ID do registo de dados

Devoluções

Obter todos os registros de dados para a versão do smap

Retorna todos os registros para uma versão específica do smap usando um determinado smapId. Para todos os novos registos, a data de exportação será atualizada automaticamente. Você pode usar o parâmetro state para filtrar novos registros.

Parâmetros

Name Chave Necessário Tipo Description
smapId
smapId True string

O id do smap

smapVersão
version True string

A versão smap no formato major (por exemplo, 1) ou major.minor (por exemplo, 1.1)

Marca exportada
markAsExported boolean

Marcar todos os registros solicitados como exportados

Formato
format string

Formato de saída (.json oder .xml), o padrão é Json

Estado de Registo
state string

filtrar os registros para estado novo, exportado ou incompleto

Devoluções

Obter todos os registros de dados para todas as versões de um smap

Retorna todos os registros para um determinado smapId. Os registros de dados de todas as versões do smap são retornados. Lembre-se de que os resultados podem não ser mutuamente compatíveis porque o esquema de dados pode ter sido alterado entre a versão do smap.

Parâmetros

Name Chave Necessário Tipo Description
smapId
smapId True string

O id do smap

Marca exportada
markAsExported boolean

Marcar todos os registros solicitados como exportados

Formato
format True string

Formato de saída (.json, .xml), o padrão é Json

Estado de Registo
state string

Filtrar registos para o seu estado: novo, exportado ou incompleto (Tarefa)

Devoluções

Obter todos os smaps

Devolve todos os mapas da sua subscrição. As entidades retornadas podem ser usadas para consultar versões smap disponíveis usando um determinado smapId ou para consultar registros de dados de um smap.

Devoluções

Obter valores de fonte de dados

Retorna os valores de uma versão específica da fonte de dados.

Parâmetros

Name Chave Necessário Tipo Description
DatasourceId
dataSourceId True string

A ID da fonte de dados

Versão da fonte de dados
dataSourceVersion True string

O número da versão da fonte de dados (por exemplo, 1.0)

Devoluções

Name Caminho Tipo Description
array of object
items
object

Obter versão específica do smap

Obter metadados para uma versão específica de um smap

Parâmetros

Name Chave Necessário Tipo Description
smapId
smapId True string

O id do smap

smapVersão
version True string

O número da versão do smap (por exemplo, 1.0)

Devoluções

Informações para um Smap-Version

Definições

UserInfoModel

Informação a um utilizador

Name Caminho Tipo Description
accountIsActivated
accountIsActivated boolean

Indica se a conta foi ativada. Caso contrário, o utilizador ainda não verificou a conta.

ID de subscrição
subscriptionId string

O ID de subscrição do utilizador

nome de utilizador
userName string

O nome do utilizador

companyName
companyName string

O nome da empresa registado para a subscrição

e-mail
email string

O endereço de e-mail do usuário

Correio original
originalMail string

Se a conta atual foi acessada usando falsificação de identidade, isso mostra o endereço de e-mail do usuário original.

contrato
contract string

O tipo de contrato

roles
roles array of string

Uma lista de funções que se aplicam ao usuário

smapLimite
smapLimit integer

Número máximo de smaps que este usuário tem permissão para publicar. Um valor nulo significa ilimitado.

editor
publisher string

Um texto que descreve o editor para seus usuários.

origem
source string

A origem da subscrição.

isInterno
isInternal boolean

Indica que essa conta é usada internamente pelo smapOne.

userLimit
userLimit integer

O máximo de usuários que o criador pode criar

publicadosSmaps
publishedSmaps integer

Número de mapas publicados desta conta

disponívelFuncionalidades
availableFeatures array of string

Uma lista de recursos disponíveis para esta conta

definições
settings object

Configurações personalizadas armazenadas nesta conta. Só será saída se o parâmetro "embed" estiver definido na solicitação.

cultura
culture string

Cultura atualmente selecionada para esta conta. Dado como código de cultura de dois dígitos, por exemplo, "en".

Estatísticas da Conta

Name Caminho Tipo Description
id
id string
tipo de subscrição
subscriptionType string
subscriptionTypeChanged
subscriptionTypeChanged date-time
subscriptionTypeTitle
subscriptionTypeTitle string
subscriptionTypeValue
subscriptionTypeValue integer
isMasterSubscription
isMasterSubscription boolean
smapLimite
smapLimit integer
groupCount
groupCount integer
trialDurationInDays
trialDurationInDays integer
diasLeftForTrial
daysLeftForTrial integer
createdDate (Data de criação)
createdDate date-time
numeroDeUtilizadores
userCount integer
userLimit
userLimit integer
diasdesdeCriação
daysSinceCreation integer
cultura
culture string
langCode
langCode string
isInterno
isInternal boolean
systemVersion
systemVersion string
domínio
domain string
isChildSubscription
isChildSubscription boolean
isPersonificando
isImpersonating boolean
dataCount
dataCount integer
smapContagem
smapCount integer
publicadoSmapCount
publishedSmapCount integer
notPublishedSmapCount
notPublishedSmapCount integer
distributedSmapCount
distributedSmapCount integer
instaladoSmapsCount
installedSmapsCount integer
groupLicenseCount
groupLicenseCount integer
lastSmapId
lastSmapId string
pré-visualizaçãoSmapCount
previewSmapCount integer

DataSourceListModel

Modelo de origem

Name Caminho Tipo Description
createdDate (Data de criação)
createdDate date-time

Data em que a fonte de dados foi criada

versão mais recente
latestVersion string

A última versão disponível para esta fonte de dados

tipo
type string

O tipo da fonte de dados

dataSourceId
dataSourceId string

A id da fonte de dados

nome
name string

O nome da fonte de dados.

DataSourceVersionModel

Modelo de versão da fonte de dados

Name Caminho Tipo Description
Definição
definition AbstractDataSourceDefinition

A definição desta versão da fonte de dados

createdDate (Data de criação)
createdDate date-time

A data em que esta versão da fonte de dados foi criada

versão
version string

O número da versão desta versão da fonte de dados

dataSourceId
dataSourceId string

A id da fonte de dados

nome
name string

O nome da fonte de dados.

AbstractDataSourceDefinition

A definição desta versão da fonte de dados

Name Caminho Tipo Description
title
title string
tipo
type string
id
id string
dataSourceId
dataSourceId string

A id da fonte de dados

DataSourceModel

Modelo de origem

Name Caminho Tipo Description
dataSourceId
dataSourceId string

A id da fonte de dados

tipo
type string

O tipo de fonte de dados

nome
name string

O nome da fonte de dados

createdDate (Data de criação)
createdDate date-time

Data em que a fonte de dados foi criada

versão mais recente
latestVersion string

A última versão disponível para esta fonte de dados

usadoInSmaps
usedInSmaps array of DataSourceSmapModel

smaps que usam essa fonte de dados

DataSourceSmapModel

Descreve um smap

Name Caminho Tipo Description
smapNome
smapName string

Nome de um smap

smapId
smapId string

Id de um smap

Modelo SmapModel

Informações básicas sobre um smap

Name Caminho Tipo Description
groupLicenseCount
groupLicenseCount integer

Contagem de licenças de grupo

changeType
changeType string

Indica que tipo de alterações foram feitas no smap em comparação com a última versão publicada.

userLicenseCount
userLicenseCount integer

Contagem de licenças de utilizador

lastChanged
lastChanged date-time

Data em que a última alteração foi feita no smap

isUpToDate
isUpToDate boolean

Indica que o smap não foi alterado desde a última publicação

instalaçõesContagem
installationsCount integer

Número de instalações do smap

lastPublishedVersion
lastPublishedVersion SmapVersionModel

Informações para um Smap-Version

totalDataCount
totalDataCount integer

Contagem de todos os registros de dados para todas as versões de um smap

totalOpenTasksCount
totalOpenTasksCount integer

Número de tarefas abertas para este mapa

tarefasAtivado
tasksActivated boolean

Indica que a opção para criar tarefas a partir de registros de dados está ativada para este smap.

isCompanyTemplate
isCompanyTemplate boolean

Indica se este smap foi disponibilizado como modelo de empresa

nome
name string

Nome de um smap

smapId
smapId string

Id de um smap

logoId
logoId string

Id para o logotipo de um smap

SmapVersionModel

Informações para um Smap-Version

Name Caminho Tipo Description
lastChanged
lastChanged date-time

Data de publicação desta versão. Para a versão 0.0 (editar versão) mostra quando a última alteração foi feita no smap.

lastRecordReceived
lastRecordReceived date-time

Data em que o último registro de dados foi recebido para esta versão de um smap

dataCount
dataCount integer

Número de registos de dados para esta versão smap

smapVersionId
smapVersionId string

O id desta versão de um smap

versão
version string

O número da versão desta versão de um smap

DataRecordApi

Modelo de API REST para registros de dados

Name Caminho Tipo Description
schemaVersion
schemaVersion integer

Versão do formato de dados

id
id string

Identificador do registo de dados

Tipo de registo
recordType string

Descreve o tipo de registro de dados. É uma tarefa ou um registro de dados criado por si mesmo.

ID de subscrição
subscriptionId string

Identificador da subscrição a que pertence o registo de dados e o smap correspondente.

smapId
smapId string

Identificador de um smap ao qual o registro de dados pertence.

smapVersionId
smapVersionId string

Identificador de uma versão do smap à qual o registro de dados pertence.

versão
version string

Versão do smap legível por humanos a que pertence o registo de dados.

tokenId
tokenId string

Identificador de um token smap com o qual o registro de dados foi criado.

userId
userId string

Identificador do utilizador que criou o registo de dados

usuárioE-mail
userEmail string

Endereço de e-mail do usuário que criou o registro de dados

nome de utilizador
userName string

Nome do usuário que criou o registro de dados. Atenção: Quando o registo de dados foi criado através de uma licença anónima, este campo tem um identificador único ilegível.

sendDate
sendDate date-time

Carimbo de data/hora quando o registro de dados foi concluído pelo usuário e enfileirado para envio ao servidor no aplicativo smapOne.

clientCreatedDate
clientCreatedDate date-time

Carimbo de data/hora de quando um registro de dados foi encaminhado pelo usuário e, portanto, tornou-se uma tarefa.

recebidoData de recebimento
receivedDate date-time

Carimbo de data/hora no qual o registro de dados foi recebido pelo servidor. Isso será definido quando o registro em si tiver sido transferido para o servidor, mas os arquivos associados podem ainda não ter sido transferidos. Este carimbo de data/hora será posterior a sendDate, mas antes de completedDate.

completedDate
completedDate date-time

Carimbo de data/hora no qual o próprio registro de dados concluído e todos os arquivos referenciados foram completamente transferidos e recebidos pelo servidor.

suprimidoData
deletedDate date-time

Carimbo de data/hora no qual o registro de dados foi excluído

lastExportDate
lastExportDate date-time

Carimbo de data/hora quando o registro de dados foi exportado pela última vez

toCompleteOn
toCompleteOn date-time

A data em que o registo de dados deve ser publicado

title
title string

Nome da tarefa ou registo de dados.

comentário
comment string

Comentário único a uma tarefa

dados
data

Os dados recolhidos do smap. Uma lista de pares de valores de chave onde a chave é o id de cada módulo de um smap e o valor são os dados reais desse módulo.

SingleFileValue

Name Caminho Tipo Description
fileId
fileId string
fileName
fileName string
carimbo de data/hora
timestamp date-time
soma de verificação
checkSum string
TipoDeConteúdo
contentType string
size
size integer
meta
meta FileMetaData
URL
url string

FileMetaData

Name Caminho Tipo Description
audioDuração
audioDuration string

objecto

Este é o tipo 'objeto'.

binário

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