Compartilhar via


smapOne

Use esse conector para recuperar dados sobre seus smaps do plattform smapOne, atualizar fontes de dados ou criar tarefas para seus usuários.

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

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome smapOne AG
URL https://www.smapone.com
Email support@smapone.com
Metadados do conector
Publicador smapOne AG
Site da Web https://www.smapone.com
Política de privacidade https://en.smapone.com/privacy-policy/
Categorias Dados; Produtividade

Criando uma conexão

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

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

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
chave de API smapOne secureString A chave de API para sua conta smapOne Verdade

Limitações

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

Ações

Atribuir ou remover tarefa

Atribuir ou remover uma tarefa de um usuário

Atualizar fonte de dados

Atualizar uma fonte de dados. As colunas devem ser iguais. Isso significa que as IDs de coluna 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 desse smap será publicada. Se não houver atualizações disponíveis, nenhuma publicação será executada e a versão mais recente será retornada.

Criar tarefa para uma versão de 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 de smap fornecida.

Excluir registros de dados de uma versão smap

Exclui todos os registros de dados para uma determinada versão do smap. Lembre-se de excluir 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 a recordId fornecida da versão de smap fornecida.

Obter detalhes da fonte de dados

Retorna os detalhes para uma determinada Fonte de Dados.

Obter detalhes de um smap específico

Obter todos os metadados de um smap específico

Obter esquema para dataRecord

Obter o esquema json para os dados deste smap

Obter estatísticas sobre usuário e assinatura

Essa operação fornece estatísticas sobre sua assinatura, 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 email 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 de 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. Os relatórios de todas as versões do smap são retornados.

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

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

Obter registro 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 especificado. 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 verrsão publicada a jato 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 de uma versão smap específica usando um determinado smapId. Para todos os novos registros, a data de exportação será atualizada automaticamente. Você pode usar o parâmetro de estado 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

Retorna todos os smaps de sua assinatura. As entidades retornadas podem ser usadas para consultar versões de smap disponíveis usando uma determinada smapId ou para consultar registros de dados de um smap.

Obter uma versão específica do smap

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

Obter valores de fonte de dados

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

Atribuir ou remover tarefa

Atribuir ou remover uma tarefa de um usuário

Parâmetros

Nome Chave Obrigatório Tipo Description
smapId
smapId True string

A ID do smap

smapVersion
version True string

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

recordId
taskId True string

A ID do registro

ação
action string
userEmail
userEmail string

Retornos

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 as IDs de coluna devem corresponder.

Parâmetros

Nome Chave Obrigatório Tipo Description
DatasourceId
dataSourceId True string

A ID da fonte de dados

Versão
dataSourceVersion True string

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

values
values object

Retornos

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 desse smap será publicada. Se não houver atualizações disponíveis, nenhuma publicação será executada e a versão mais recente será retornada.

Parâmetros

Nome Chave Obrigatório Tipo Description
smapId
smapId True string

A ID do smap

Atualizar versão do Designer
updateEditVersion boolean

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

Retornos

Informações para um Smap-Version

Criar tarefa para uma versão de smap

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

Parâmetros

Nome Chave Obrigatório Tipo Description
smapId
smapId True string

A ID do smap

smapVersion
version True string

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

userEmail
userEmail string
title
title True string

O nome da tarefa

comentário
comment string

Comentário do criador da tarefa

hasPriority
hasPriority boolean

A tarefa é priorizada

dados
data True object

Retornos

Modelo de API REST para registros de dados

Excluir registro de dados

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

Parâmetros

Nome Chave Obrigatório Tipo Description
smapId
smapId True string

A ID do smap

smapVersion
version True string

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

recordId
recordId True string

A ID do registro de dados

Excluir registros de dados de uma versão smap

Exclui todos os registros de dados para uma determinada versão do smap. Lembre-se de excluir todos os seus registros se você não definir o filtro de estado!

Parâmetros

Nome Chave Obrigatório Tipo Description
smapId
smapId True string

A ID do smap

smapVersion
version True string

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

Estado do registro
state string

filtrar os registros de estado novo, exportado ou incompleto

Obter arquivo de registro de dados

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

Parâmetros

Nome Chave Obrigatório Tipo Description
smapId
smapId True string

A ID do smap

smapVersion
version True string

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

recordId
recordId True string

A ID do registro

FileId
fileId True string

A ID do arquivo

Obter detalhes da fonte de dados

Retorna os detalhes para uma determinada Fonte de Dados.

Parâmetros

Nome Chave Obrigatório Tipo Description
DatasourceId
dataSourceId True string

A ID da fonte de dados

Retornos

Modelo de origem

Obter detalhes de um smap específico

Obter todos os metadados de um smap específico

Parâmetros

Nome Chave Obrigatório Tipo Description
smapId
smapId True string

O smapId de um smap a ser solicitado

Retornos

Informações básicas sobre um smap

Corpo
SmapModel

Obter esquema para dataRecord

Obter o esquema json para os dados deste smap

Parâmetros

Nome Chave Obrigatório Tipo Description
smapId
smapId True string

A ID do smap

smapVersion
version True string

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

Retornos

response
object

Obter estatísticas sobre usuário e assinatura

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

Retornos

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.

Retornos

Obter informações sobre o usuário

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

Retornos

Informações para um usuário

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

Nome Chave Obrigatório Tipo Description
smapId
smapId True string

A ID do smap

smapVersion
version True string

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

recordId
recordId True string

A ID do registro de dados

Formato
format True string

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

Marcar Exportado
markAsExported boolean

Marcar registro como exportado

Usar o modelo padrão
useDefault boolean

Se true um novo modelo for gerado e o modelo de relatório carregado for ignorado.

Retornos

response
binary

Obter os relatórios de 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. Os relatórios de todas as versões do smap são retornados.

Parâmetros

Nome Chave Obrigatório Tipo Description
smapId
smapId True string

A ID do smap

Marcar Exportado
markAsExported boolean

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

Estado do registro
state string

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

Retornos

response
binary

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

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

Parâmetros

Nome Chave Obrigatório Tipo Description
smapId
smapId True string

A ID do smap

smapVersion
version True string

A versão do smap no formato principal ou principal.minor

Marcar Exportado
markAsExported boolean

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

Estado do registro
state string

Filtrar os registros de estado novo, exportado ou incompleto

Retornos

response
binary

Obter registro de dados

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

Parâmetros

Nome Chave Obrigatório Tipo Description
smapId
smapId True string

A ID do smap

smapVersion
version True string

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

recordId
recordId True string

A ID do registro de dados

Formato
format string

Json, Xml

Marcar Exportado
markAsExported boolean

Marcar o registro como exportado

Retornos

Modelo de API REST para registros de dados

Obter todas as versões do smap

Retorna versões als que pertencem ao smapId especificado. 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 verrsão publicada a jato de um smap.

Parâmetros

Nome Chave Obrigatório Tipo Description
smapId
smapId True string

A ID do smap

Retornos

Obter todos os metadados de arquivo para registro de dados

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

Parâmetros

Nome Chave Obrigatório Tipo Description
smapId
smapId True string

A ID do smap

smapVersion
version True string

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

recordId
recordId True string

A ID do registro de dados

Retornos

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

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

Parâmetros

Nome Chave Obrigatório Tipo Description
smapId
smapId True string

A ID do smap

smapVersion
version True string

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

Marcar Exportado
markAsExported boolean

Marcar todos os registros solicitados como exportados

Formato
format string

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

Estado do registro
state string

filtrar os registros de estado novo, exportado ou incompleto

Retornos

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

Nome Chave Obrigatório Tipo Description
smapId
smapId True string

A ID do smap

Marcar Exportado
markAsExported boolean

Marcar todos os registros solicitados como exportados

Formato
format True string

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

Estado do registro
state string

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

Retornos

Obter todos os smaps

Retorna todos os smaps de sua assinatura. As entidades retornadas podem ser usadas para consultar versões de smap disponíveis usando uma determinada smapId ou para consultar registros de dados de um smap.

Retornos

Obter uma versão específica do smap

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

Parâmetros

Nome Chave Obrigatório Tipo Description
smapId
smapId True string

A ID do smap

smapVersion
version True string

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

Retornos

Informações para um Smap-Version

Obter valores de fonte de dados

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

Parâmetros

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

Retornos

Nome Caminho Tipo Description
array of object
items
object

Definições

UserInfoModel

Informações para um usuário

Nome Caminho Tipo Description
accountIsActivated
accountIsActivated boolean

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

subscriptionId
subscriptionId string

A ID da assinatura do usuário

userName
userName string

O nome do usuário

CompanyName
companyName string

O nome da empresa registrado para a assinatura

email
email string

O endereço de email do usuário

originalMail
originalMail string

Se a conta atual foi acessada usando a representação, isso mostra o endereço de email do usuário original.

contrato
contract string

O tipo de contrato

funções
roles array of string

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

smapLimit
smapLimit integer

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

desenvolvedor
publisher string

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

fonte
source string

A origem da assinatura.

éInterno
isInternal boolean

Indica que essa conta é usada internamente pelo smapOne.

userLimit
userLimit integer

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

publishedSmaps
publishedSmaps integer

Número de smaps publicados dessa conta

availableFeatures
availableFeatures array of string

Uma lista de recursos disponíveis para essa conta

configurações
settings object

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

cultura
culture string

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

AccountStatistics

Nome Caminho Tipo Description
id
id string
subscriptionType
subscriptionType string
subscriptionTypeChanged
subscriptionTypeChanged date-time
subscriptionTypeTitle
subscriptionTypeTitle string
subscriptionTypeValue
subscriptionTypeValue integer
isMasterSubscription
isMasterSubscription boolean
smapLimit
smapLimit integer
groupCount
groupCount integer
trialDurationInDays
trialDurationInDays integer
daysLeftForTrial
daysLeftForTrial integer
createdDate
createdDate date-time
contagemDeUsuários
userCount integer
userLimit
userLimit integer
daysSinceCreation
daysSinceCreation integer
cultura
culture string
langCode
langCode string
éInterno
isInternal boolean
Versão do sistema
systemVersion string
domínio
domain string
isChildSubscription
isChildSubscription boolean
isImpersonating
isImpersonating boolean
dataCount
dataCount integer
smapCount
smapCount integer
publishedSmapCount
publishedSmapCount integer
notPublishedSmapCount
notPublishedSmapCount integer
distributedSmapCount
distributedSmapCount integer
installedSmapsCount
installedSmapsCount integer
groupLicenseCount
groupLicenseCount integer
lastSmapId
lastSmapId string
previewSmapCount
previewSmapCount integer

DataSourceListModel

Modelo de origem

Nome Caminho Tipo Description
createdDate
createdDate date-time

Data em que a fonte de dados foi criada

latestVersion
latestVersion string

A versão mais recente 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

Nome Caminho Tipo Description
definição
definition AbstractDataSourceDefinition

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

createdDate
createdDate date-time

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

versão
version string

O número de versão dessa 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 dessa versão da fonte de dados

Nome 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

Nome Caminho Tipo Description
dataSourceId
dataSourceId string

A ID da fonte de dados

tipo
type string

O tipo da fonte de dados

nome
name string

O nome da fonte de dados

createdDate
createdDate date-time

Data em que a fonte de dados foi criada

latestVersion
latestVersion string

A versão mais recente disponível para esta fonte de dados

usedInSmaps
usedInSmaps array of DataSourceSmapModel

smaps que usam essa fonte de dados

DataSourceSmapModel

Descreve um smap

Nome Caminho Tipo Description
smapName
smapName string

Nome de um smap

smapId
smapId string

ID de um smap

SmapModel

Informações básicas sobre um smap

Nome 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 usuário

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

installationsCount
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 smap

tasksActivated
tasksActivated boolean

Indica que a opção de criar tarefas a partir de registros de dados é ativada para esse smap.

isCompanyTemplate
isCompanyTemplate boolean

Indica se esse smap foi disponibilizado como modelo da empresa

nome
name string

Nome de um smap

smapId
smapId string

ID de um smap

logoId
logoId string

ID do logotipo de um smap

SmapVersionModel

Informações para um Smap-Version

Nome Caminho Tipo Description
lastChanged
lastChanged date-time

Data em que essa versão foi publicada. Para a versão 0.0 (versão de edição), ela 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 registros de dados para esta versão do smap

smapVersionId
smapVersionId string

A ID desta versão de um smap

versão
version string

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

DataRecordApi

Modelo de API REST para registros de dados

Nome Caminho Tipo Description
versãoDoEsquema
schemaVersion integer

Versão do formato de dados

id
id string

Identificador do registro de dados

recordType
recordType string

Descreve o tipo do registro de dados. É uma tarefa ou um registro de dados auto-criado.

subscriptionId
subscriptionId string

Identificador da assinatura à qual o registro de dados e o smap de acordo pertencem.

smapId
smapId string

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

smapVersionId
smapVersionId string

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

versão
version string

Versão do smap legível por humanos à qual o registro de dados pertence.

ID do token
tokenId string

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

userId
userId string

Identificador do usuário que criou o registro de dados

userEmail
userEmail string

Endereço de email do usuário que criou o registro de dados

userName
userName string

Nome do usuário que criou o registro de dados. Atenção: quando o registro de dados foi criado por meio de uma licença anônima, esse campo tem um identificador exclusivo ilegível nele.

sendDate
sendDate date-time

Carimbo de data/hora quando o registro de dados foi concluído pelo usuário e enfileirado para enviar para o 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.

receivedDate
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 talvez ainda não tenham sido transferidos. Esse carimbo de data/hora será posterior ao 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.

deletedDate
deletedDate date-time

Carimbo de data/hora em que o registro de dados foi excluído

lastExportDate
lastExportDate date-time

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

toCompleteOn
toCompleteOn date-time

A data em que o registro de dados deve ser publicado

title
title string

Nome da tarefa ou registro de dados.

comentário
comment string

Comentário único em uma tarefa

dados
data

Os dados coletados do smap. Uma lista de pares de valores de chave em que a chave é a ID de cada módulo de um smap e o valor são os dados reais desse módulo.

SingleFileValue

Nome Caminho Tipo Description
fileId
fileId string
fileName
fileName string
carimbo de data/hora
timestamp date-time
checksum
checkSum string
tipo de conteúdo
contentType string
size
size integer
meta
meta FileMetaData
url
url string

FileMetaData

Nome Caminho Tipo Description
audioDuration
audioDuration string

objeto

Esse é o tipo 'object'.

binário

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