Softools (Preview)

  • Reference

Softools is a web-based application platform where off-the-shelf and custom apps can be designed, built and deployed in hours.

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 Softools Support
URL https://support.softools.net
Email support@softools.net
Connector Metadata
Publisher Softools Limited
Website https://www.softools.net
Privacy policy https://www.softools.net/privacy-policy
Categories Business Intelligence;Data

Softools is a leading NoCode platform for building business process applications. Softools is a web-based application platform where off-the-shelf and custom apps can be designed, built and deployed in hours.

Prerequisites

Users require an Enterprise License or have a Softools site to use our apis.

An API Key is required to call the API, this can be found under My Profile on your Softools Site.

An App Identifier is required from most API calls.

How to get credentials

Users require an Enterprise License or have a Softools site to use our apis. An API Key can be found under My Profile on your Softools Site.

Get started with your connector

Please use these instructions to deploy this connector as a custom connector within Microsoft Power Automate and Power Apps.

Known issues and limitations

Rate limits can be found here

Common errors and remedies

N/A

FAQ

More support documentation can be found here

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
KEY securestring The KEY for this API True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Archive a record

Archive a record. Call this before delete.
Create a record

Send all field values including defaults when adding a new record to an App
Delete a record

Delete a record. To delete a record you need to archive first.
Get a Record

Gets a record
Get all records

Gets a list of all records from app. Can iterate using $top and $skip
Get basic field info

Get basic field data for an app
Get report records

Gets a list of records from report, limited to 250 records per request. Only returns report field data. Can iterate using $top and $skip
Patch a Record

The Softools Api caters for Delta updates, meaning you can send only the changes which are relevant and not the entire document per PATCH request.
Unarchive a record

Unarchive a record.

Archive a record

Operation ID:
Archive-record

Archive a record. Call this before delete.

Parameters

Name Key Required Type Description
App Identifier
 AppIdentifier True string

Identifier for the App, can be found in the app Url /App/{AppIdentifier} or /{AppIdentifier}
Identifier of the record
 RecordID True string

Identifier of the record
Tenant Identifier
 tenant True string

The tenant can be obtained from your system administrator

Returns

Body
Message

Create a record

Operation ID:
Post-a-record

Send all field values including defaults when adding a new record to an App

Parameters

Name Key Required Type Description
App Identifier
 AppIdentifier True string

Identifier for the App, can be found in the app Url /App/{AppIdentifier} or /{AppIdentifier}
Tenant Identifier
 tenant True string

The tenant can be obtained from your system administrator
object

Returns

Body
Message

Delete a record

Operation ID:
Delete-record

Delete a record. To delete a record you need to archive first.

Parameters

Name Key Required Type Description
App Identifier
 AppIdentifier True string

Identifier for the App, can be found in the app Url /App/{AppIdentifier} or /{AppIdentifier}
Identifier of the record
 RecordID True string

Identifier of the record
Tenant Identifier
 tenant True string

The tenant can be obtained from your system administrator

Returns

Body
Message

Get a Record

Operation ID:
Get-record

Gets a record

Parameters

Name Key Required Type Description
App Identifier
 AppIdentifier True string

Identifier for the App, can be found in the app Url /App/{AppIdentifier} or /{AppIdentifier}
Identifier of the record
 RecordID True string

Identifier of the record
Tenant Identifier
 tenant True string

The tenant can be obtained from your system administrator

Returns

Body
Record-Response

Get all records

Operation ID:
Get-all-records

Gets a list of all records from app. Can iterate using $top and $skip

Parameters

Name Key Required Type Description
App Identifier
 AppIdentifier True string

Identifier for the App, can be found in the app Url /App/{AppIdentifier} or /{AppIdentifier}
Number or records to skip
 $skip True number

Skips records, setting to 1 will return the second record
Number or records to take
 $top True number

The number of records to return, max = 250
The field indentifier to order by in braces [FieldIdentifier]
 $orderby string

Field to order by [fieldIdentifier] asc/desc
Odata filter example [TextField1] eq 'My record'
 $filter string

Provide an oData filter string to filter records by. In the form [fieldIdentifier] operation filterValue Example [textField] eq 'Text'

Operators allowed Eq Equal /Suppliers?$filter=[City] eq 'Redmond' Ne Not equal /Suppliers?$filter=[City] ne 'London' Gt Greater than /Products?$filter=[Price] gt 20 Ge Greater than or equal /Products?$filter=[Price] ge 10 Lt Less than /Products?$filter=[Price] lt 20 Le Less than or equal /Products?$filter=[Price] le 100 And Logical and /Products?$filter=[Price] le 200 and Price gt 3.5
Tenant Identifier
 tenant True string

The tenant can be obtained from your system administrator

Returns

Items
List-record-response

Get basic field info

Operation ID:
Get-basic-field-info

Get basic field data for an app

Parameters

Name Key Required Type Description
App Identifier
 AppIdentifier True string

Identifier for the App, can be found in the app Url /App/{AppIdentifier} or /{AppIdentifier}
Tenant Identifier
 tenant True string

Tenant is usually in the site url {tenant}.off.softools.net, however sometimes this is an alias. Contact systems administrator to confirm it.

Returns

Items
basic-fields-response

Get report records

Operation ID:
Get-report-records

Gets a list of records from report, limited to 250 records per request. Only returns report field data. Can iterate using $top and $skip

Parameters

Name Key Required Type Description
App Identifier
 AppIdentifier True string

Identifier for the App, can be found in the app Url /App/{AppIdentifier} or /{AppIdentifier}
Identifier of the record
 ReportID True number

Id of report
Number or records to skip
 $skip True number

Skips records, setting to 1 will return the second record
Number or records to take
 $top True number

The number of records to return, max = 250
The field indentifier to order by in braces [FieldIdentifier]
 $orderby string

Field to order by [fieldIdentifier] asc/desc
Odata filter example [TextField1] eq 'My record'
 $filter string

Provide an oData filter string to filter records by. In the form [fieldIdentifier] operation filterValue Example [textField] eq 'Text'

Operators allowed Eq Equal /Suppliers?$filter=[City] eq 'Redmond' Ne Not equal /Suppliers?$filter=[City] ne 'London' Gt Greater than /Products?$filter=[Price] gt 20 Ge Greater than or equal /Products?$filter=[Price] ge 10 Lt Less than /Products?$filter=[Price] lt 20 Le Less than or equal /Products?$filter=[Price] le 100 And Logical and /Products?$filter=[Price] le 200 and Price gt 3.5
Tenant Identifier
 tenant True string

The tenant can be obtained from your system administrator

Returns

Items
List-record-response

Patch a Record

Operation ID:
Patch-a-record

The Softools Api caters for Delta updates, meaning you can send only the changes which are relevant and not the entire document per PATCH request.

Parameters

Name Key Required Type Description
App Identifier
 AppIdentifier True string

Identifier for the App. Can be found in the app Url /App/{AppIdentifier} or /{AppIdentifier}
Identifier of the record
 RecordID True string

Id of the record
Tenant Identifier
 tenant True string

The tenant can be obtained from your system administrator
object

Returns

Body
Message

Unarchive a record

Operation ID:
Unarchived-record

Unarchive a record.

Parameters

Name Key Required Type Description
App Identifier
 AppIdentifier True string

Identifier for the App, can be found in the app Url /App/{AppIdentifier} or /{AppIdentifier}
Identifier of the record
 RecordID True string

Identifier of the record
Tenant Identifier
 tenant True string

The tenant can be obtained from your system administrator

Returns

Body
Message

Definitions

Message

Name Path Type Description
Message
 Message string

basic-fields-response

Name Path Type Description
Identifier
 Identifier string
Type
 Type integer

List-record-response

Name Path Type Description
Items

Record-Response

Name Path Type Description
_id
 _id string
AppIdentifier
 AppIdentifier string
CreatedByUserId
 CreatedByUserId string
CreatedByUser
 CreatedByUser string
$date
 CreatedDate.$date integer
UpdatedByUserId
 UpdatedByUserId string
UpdatedByUser
 UpdatedByUser string
$date
 UpdatedDate.$date integer
Identifier
 Identifier string
QuickFilterSearchText
 QuickFilterSearchText string
Id
 Id string
EditableAccessForUser
 EditableAccessForUser boolean