Dela via


smapOne (Preview)

Use this connector to retrieve data regarding your smaps from the smapOne plattform, update datasources or create tasks for your users.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name smapOne AG
URL https://www.smapone.com
Email support@smapone.com
Connector Metadata
Publisher smapOne AG
Website https://www.smapone.com
Privacy policy https://en.smapone.com/privacy-policy/
Categories Data;Productivity

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
smapOne API key securestring The Api Key for your smapOne Account True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Assign or remove task

Assign or remove a task from a user

Create Task for a smap version

Create a task - a prefilled data record that can be assigned to a user

Delete data record

Deletes a specific data record of the given smap version.

Delete data records of a smap version

Deletes all data records to a given smap version. Be aware that you delete all of your records if you do no set the state filter!

Get all data records for all versions of a smap

Returns all records to a given smapId. Data records of all smap versions are returned. Be aware that the results may not be mutually compatible because the data schema may have changed between smap version.

Get all data records for smap version

Returns all records for a specific smap version using a given smapId. For all new records the export date will be updated automatically. You can use the state parameter to filter for new records.

Get all file meta data for data record

Returns the meta data for all files of this data record.

Get all smap versions

Returns als versions that belong to the given smapId. The returned entities can be used to query for data records to a given version. The Version 0.0 is the version currently edited, not jet published verrsion of a smap.

Get all smaps

Returns all smaps of your subscription. The returned entities can be used to query for available smap versions using a given smapId or to query for data records of a smap.

Get data record

Returns a specific data record of a given smap version.

Get datasource details

Returns the details to a given Datasource.

Get datasource values

Returns the values of a specific datasource version.

Get datasources

Returns a list of datasources available in your subscription. The returned entities can be used to query for datasource versions using a given dataSourceId.

Get details for a specific smap

Get all the metadata for a specific smap

Get file of data record

Returns a specific file for the given recordId of the given smap version.

Get information about user

This operation returns information about the current user. For example users e-mail and subscriptionId.

Get schema for dataRecord

Get the json schema for the data of this smap

Get specific smap version

Get metadata for a specific version of a smap

Get statistics about user and subscription

This operation gives you statistics about your subscription like the data count.

Get the report of a data record

Returns the report of a specific data record of a given smap version.

Get the reports for all data records from a specific smap version

Returns the reports for all records of a specific smap version. For all new records the export date will be updated automatically. You can use the state parameter to filter for new records.

Get the reports for all data records of all versions of a smap

Returns the reports for all record of a given smapId. Reports of all smap versions are returned.

Update all datasources in a smap

Check all referenced datasources for an update. If there are newer minor versions of the referenced datasources the references were updated and a new version of this smap is published. If their are no updates available no publish will be executed and the latest version will be returned.

Update datasource

Update a datasource. The columns must be equal. That means that the column-ids must match.

Assign or remove task

Assign or remove a task from a user

Parameters

Name Key Required Type Description
smapId
smapId True string

The smap id

smapVersion
version True string

The smap version number (e.g. 1.0)

recordId
taskId True string

The record id

action
action string
userEmail
userEmail string

Returns

REST API model for data records

Create Task for a smap version

Create a task - a prefilled data record that can be assigned to a user

Parameters

Name Key Required Type Description
smapId
smapId True string

The smap id

smapVersion
version True string

The smap version number (e.g. 1.0)

userEmail
userEmail string
title
title True string

The name of the task

comment
comment string

Comment from the creator of the task

hasPriority
hasPriority boolean

Task is prioritized

data
data True object

Returns

REST API model for data records

Delete data record

Deletes a specific data record of the given smap version.

Parameters

Name Key Required Type Description
smapId
smapId True string

The smap id

smapVersion
version True string

The smap version number (e.g. 1.0)

recordId
recordId True string

The data record id

Delete data records of a smap version

Deletes all data records to a given smap version. Be aware that you delete all of your records if you do no set the state filter!

Parameters

Name Key Required Type Description
smapId
smapId True string

The smap id

smapVersion
version True string

The smap version number (e.g. 1.0)

State of Record
state string

filter the records for state new, exported or incomplete

Get all data records for all versions of a smap

Returns all records to a given smapId. Data records of all smap versions are returned. Be aware that the results may not be mutually compatible because the data schema may have changed between smap version.

Parameters

Name Key Required Type Description
smapId
smapId True string

The smap id

Mark Exported
markAsExported boolean

Mark all requested records as exported

Format
format True string

Output format (.json, .xml), Default is Json

State of Record
state string

Filter records for their state: new, exported or incomplete (Task)

Returns

Get all data records for smap version

Returns all records for a specific smap version using a given smapId. For all new records the export date will be updated automatically. You can use the state parameter to filter for new records.

Parameters

Name Key Required Type Description
smapId
smapId True string

The smap id

smapVersion
version True string

The smap version in major (e.g. 1) or major.minor (e.g. 1.1) format

Mark Exported
markAsExported boolean

Mark all requested records as exported

Format
format string

Output format (.json oder .xml), Default is Json

State of Record
state string

filter the records for state new, exported or incomplete

Returns

Get all file meta data for data record

Returns the meta data for all files of this data record.

Parameters

Name Key Required Type Description
smapId
smapId True string

The smap id

smapVersion
version True string

The smap version number (e.g. 1.0)

recordId
recordId True string

The data record id

Returns

Get all smap versions

Returns als versions that belong to the given smapId. The returned entities can be used to query for data records to a given version. The Version 0.0 is the version currently edited, not jet published verrsion of a smap.

Parameters

Name Key Required Type Description
smapId
smapId True string

The smap id

Returns

Get all smaps

Returns all smaps of your subscription. The returned entities can be used to query for available smap versions using a given smapId or to query for data records of a smap.

Returns

Get data record

Returns a specific data record of a given smap version.

Parameters

Name Key Required Type Description
smapId
smapId True string

The smap id

smapVersion
version True string

The smap version number (e.g. 1.0)

recordId
recordId True string

The data record id

Format
format string

Json, Xml

Mark Exported
markAsExported boolean

Mark the record as exported

Returns

REST API model for data records

Get datasource details

Returns the details to a given Datasource.

Parameters

Name Key Required Type Description
DatasourceId
dataSourceId True string

The id of the datasource

Returns

Source Model

Get datasource values

Returns the values of a specific datasource version.

Parameters

Name Key Required Type Description
DatasourceId
dataSourceId True string

The datasource id

Datasource version
dataSourceVersion True string

The datasource version number (e.g. 1.0)

Returns

Name Path Type Description
array of object
items
object

Get datasources

Returns a list of datasources available in your subscription. The returned entities can be used to query for datasource versions using a given dataSourceId.

Returns

Get details for a specific smap

Get all the metadata for a specific smap

Parameters

Name Key Required Type Description
smapId
smapId True string

The smapId of a smap to be requested

Returns

Basic information about a smap

Body
SmapModel

Get file of data record

Returns a specific file for the given recordId of the given smap version.

Parameters

Name Key Required Type Description
smapId
smapId True string

The smap id

smapVersion
version True string

The smap version number (e.g. 1.0)

recordId
recordId True string

The record id

FileId
fileId True string

The file Id

Get information about user

This operation returns information about the current user. For example users e-mail and subscriptionId.

Returns

Information to a user

Get schema for dataRecord

Get the json schema for the data of this smap

Parameters

Name Key Required Type Description
smapId
smapId True string

The smap id

smapVersion
version True string

The smap version number (e.g. 1.0)

Returns

response
object

Get specific smap version

Get metadata for a specific version of a smap

Parameters

Name Key Required Type Description
smapId
smapId True string

The smap id

smapVersion
version True string

The smap version number (e.g. 1.0)

Returns

Info to a Smap-Version

Get statistics about user and subscription

This operation gives you statistics about your subscription like the data count.

Returns

Get the report of a data record

Returns the report of a specific data record of a given smap version.

Parameters

Name Key Required Type Description
smapId
smapId True string

The smap id

smapVersion
version True string

The smap version number (e.g. 1.0)

recordId
recordId True string

The data record id

Format
format True string

Pdf, Docx, Doc, Html, Xml, Txt (for testing purposes)

Mark Exported
markAsExported boolean

Mark record as exported

Use default template
useDefault boolean

If true a new template is generated and the uploaded report template will be ignored.

Returns

response
binary

Get the reports for all data records from a specific smap version

Returns the reports for all records of a specific smap version. For all new records the export date will be updated automatically. You can use the state parameter to filter for new records.

Parameters

Name Key Required Type Description
smapId
smapId True string

The smap id

smapVersion
version True string

The smap version in major or major.minor format

Mark Exported
markAsExported boolean

Mark the data records of all requested reports as exported

State of Record
state string

Filter the records for state new, exported or incomplete

Returns

response
binary

Get the reports for all data records of all versions of a smap

Returns the reports for all record of a given smapId. Reports of all smap versions are returned.

Parameters

Name Key Required Type Description
smapId
smapId True string

The smap id

Mark Exported
markAsExported boolean

Mark the data records of all requested reports as exported

State of Record
state string

Filter records for their state: new, exported or incomplete (Task)

Returns

response
binary

Update all datasources in a smap

Check all referenced datasources for an update. If there are newer minor versions of the referenced datasources the references were updated and a new version of this smap is published. If their are no updates available no publish will be executed and the latest version will be returned.

Parameters

Name Key Required Type Description
smapId
smapId True string

The smap id

Update Designer Version
updateEditVersion boolean

If the current designer version should be updated too

Returns

Info to a Smap-Version

Update datasource

Update a datasource. The columns must be equal. That means that the column-ids must match.

Parameters

Name Key Required Type Description
DatasourceId
dataSourceId True string

The datasource id

Version
dataSourceVersion True string

The version number of the current datasource version (e.g. 1.0)

values
values object

Returns

Data Source Version Model

Definitions

UserInfoModel

Information to a user

Name Path Type Description
accountIsActivated
accountIsActivated boolean

Indicates if the account has been activated. If not, the user has not yet verified the account.

subscriptionId
subscriptionId string

The subscription id of the user

userName
userName string

The user's name

companyName
companyName string

The company name registered for the subscription

email
email string

The email address of the user

originalMail
originalMail string

If the current account was accessed using impersonation then this shows the email address of the original user.

contract
contract string

The contract type

roles
roles array of string

A list of roles that apply to the user

smapLimit
smapLimit integer

Maximum number of smaps that this user is allowed to publish. A value of null means unlimited.

publisher
publisher string

A text describing the publisher to its users.

source
source string

The origin of the subscription.

isInternal
isInternal boolean

Indicates that this account is internally used by smapOne.

userLimit
userLimit integer

The maximum of users that the creator can create

publishedSmaps
publishedSmaps integer

Number of published smaps of this account

availableFeatures
availableFeatures array of string

A list of available features for this account

settings
settings object

Custom settings stored on this account. Will only be output if the "embed" parameter is set on the request.

culture
culture string

Currently selected culture for this account. Given as two digit culture code, e.g. "en".

AccountStatistics

Name Path Type 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
userCount
userCount integer
userLimit
userLimit integer
daysSinceCreation
daysSinceCreation integer
culture
culture string
langCode
langCode string
isInternal
isInternal boolean
systemVersion
systemVersion string
domain
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

Source Model

Name Path Type Description
createdDate
createdDate date-time

Date when the datasource was created

latestVersion
latestVersion string

The latest version available for this datasource

type
type string

The type of the datasource

dataSourceId
dataSourceId string

The id of the datasource

name
name string

The name of the datasource.

DataSourceVersionModel

Data Source Version Model

Name Path Type Description
definition
definition AbstractDataSourceDefinition

The definition of this data source version

createdDate
createdDate date-time

The date when this version of the data source was created

version
version string

The version number of this data source version

dataSourceId
dataSourceId string

The id of the data source

name
name string

The name of the data source.

AbstractDataSourceDefinition

The definition of this data source version

Name Path Type Description
title
title string
type
type string
id
id string
dataSourceId
dataSourceId string

The id of the data source

DataSourceModel

Source Model

Name Path Type Description
dataSourceId
dataSourceId string

The id of the data source

type
type string

The type of the data source

name
name string

The name of the data source

createdDate
createdDate date-time

Date when the data source was created

latestVersion
latestVersion string

The latest version available for this data source

usedInSmaps
usedInSmaps array of DataSourceSmapModel

smaps that use this data source

DataSourceSmapModel

Describes a smap

Name Path Type Description
smapName
smapName string

Name of a smap

smapId
smapId string

Id of a smap

SmapModel

Basic information about a smap

Name Path Type Description
groupLicenseCount
groupLicenseCount integer

Count of group licenses

changeType
changeType string

Indicates what kind of changes have been made to the smap compared to the last published version.

userLicenseCount
userLicenseCount integer

Count of user licenses

lastChanged
lastChanged date-time

Date when that last change has been made to the smap

isUpToDate
isUpToDate boolean

Indicates that the smap has not been changed since it was last published

installationsCount
installationsCount integer

Number of installations of the smap

lastPublishedVersion
lastPublishedVersion SmapVersionModel

Info to a Smap-Version

totalDataCount
totalDataCount integer

Count of all data records for all versions of a smap

totalOpenTasksCount
totalOpenTasksCount integer

Number of open tasks for this smap

tasksActivated
tasksActivated boolean

Indicates that the option to create tasks from data records is activated for this smap.

isCompanyTemplate
isCompanyTemplate boolean

Indicates if this smap was made available as company template

name
name string

Name of a smap

smapId
smapId string

Id of a smap

logoId
logoId string

Id for the logo of a smap

SmapVersionModel

Info to a Smap-Version

Name Path Type Description
lastChanged
lastChanged date-time

Date when this version was published. For version 0.0 (edit version) it shows when the last change was made to the smap.

lastRecordReceived
lastRecordReceived date-time

Date when last data record has been received for this version of a smap

dataCount
dataCount integer

Number of data records for this smap version

smapVersionId
smapVersionId string

The id of this version of a smap

version
version string

The version number of this version of a smap

DataRecordApi

REST API model for data records

Name Path Type Description
schemaVersion
schemaVersion integer

Data format version

id
id string

Identifier of the data record

recordType
recordType string

Describes the type of the data record. It is either a task or a self-created data record.

subscriptionId
subscriptionId string

Identifier of the subscription which the data record and the according smap belongs to.

smapId
smapId string

Identifier of a smap the data record belongs to.

smapVersionId
smapVersionId string

Identifier of a smap version the data record belongs to.

version
version string

Human-readable smap version the data record belongs to.

tokenId
tokenId string

Identifier of a smap token with which the data record was created.

userId
userId string

Identifier of the user who created the data record

userEmail
userEmail string

Email address of the user who created the data record

userName
userName string

Name of the user who created the data record. Attention: When the data record was created via an anonymous license, this field has an unreadable unique identifier in it.

sendDate
sendDate date-time

Time stamp when the data record was completed by the user and queued for sending to the server in the smapOne App.

clientCreatedDate
clientCreatedDate date-time

Time stamp of when a data record was forwarded by the user and thus became a task.

receivedDate
receivedDate date-time

Time stamp at which the data record was received by the server. This will be set when the record itself has been transferred to the server, but the associated files might not have yet. This time stamp will be later than sendDate but before completedDate.

completedDate
completedDate date-time

Time stamp at which the completed data record itself and all referenced files were completely transferred to and received by the server.

deletedDate
deletedDate date-time

Time stamp at which the data record was deleted

lastExportDate
lastExportDate date-time

Time stamp when the data record was exported the last time

toCompleteOn
toCompleteOn date-time

The date on which the data record is to be published

title
title string

Name of the task or data record.

comment
comment string

Single comment to a task

data
data

The collected data from the smap. A list of key value pairs where the key is the id of each module of a smap and the value is the actual data from that module.

SingleFileValue

Name Path Type Description
fileId
fileId string
fileName
fileName string
timestamp
timestamp date-time
checkSum
checkSum string
contentType
contentType string
size
size integer
meta
meta FileMetaData
url
url string

FileMetaData

Name Path Type Description
audioDuration
audioDuration string

object

This is the type 'object'.

binary

This is the basic data type 'binary'.