AlisQI (Preview)
Integrate your QMS with your ERP, MES, PLM, instruments, sensors or website using AlisQI's connectivity tools.
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 | AlisQI Support |
| URL | https://help.alisqi.com/ |
| support@alisqi.com |
| Connector Metadata | |
|---|---|
| Publisher | AlisQI BV |
| Website | https://www.alisqi.com |
| Privacy policy | https://www.alisqi.com/en/privacy-statement |
| Categories | Business Management |
AlisQI
Integrate your QMS with your ERP, MES, PLM, instruments, sensors or website using AlisQI's connectivity tools.
Publisher: AlisQI B.V.
Prerequisites
In order to use this connector, you will need the following:
- An account with AlisQI.
- Once you've signed up and you have an application, get the API Key from the online portal; you will use this key to authenticate your requests from our AlisQI connector.
Supported Operations
The connector supports the following operations:
Get results or master data
/getResults: Get (quality) results from analysis sets or master data from selection lists.Get all analysis sets or selection lists
/getAllSets: Get a list of (all) analysis sets or selection lists.Create or update results or master data
/storeResults: Create or update quality results in analysis sets or master data in selection lists.Get descriptive statistics for analysis set fields
/getStatistics: Get descriptive statistics for numeric analysis set fields of your choice.Get capability statistics for analysis set fields
/getSpecificationEvaluation: Get in-depth statistics of specification evaluation and product and process capability for an analysis set's numeric fields.Get specification versions
/getSpecificationVersion: Get (a) specification version(s) for an analysis set.Create a new specification version
/storeSpecificationVersion: Create (a) new specification version(s) for an analysis sets.Get the structure of an analysis sets or selection list
/getSetDefinition: Get the structural definition of an analysis sets or selection lists.
Obtaining Credentials
All API calls are subject to authentication. In order to invoke the AlisQI API endpoints, developers need to create an authentication token.
The API supports the Bearer authentication specification.
Each token is connected to a single user. The Read, Insert and Update permission this user has for analysis sets (via its user group), also apply to API invocations. More information on the user and permission management in AlisQI.
API authentication tokens can be created in the in-app integration hub. We recommend using dedicated tokens per integration scenario.
Alternatively, if the Bearer authentication method is unavailable, requests can be authenticated using the accessToken URL parameter
&accessToken=abc...123.
Known Issues and Limitations
Filters: Operations with a filter parameter expect a JSON string that represents the filter. Use the in-app integration hub to build a filter and copy the JSON string.
Dates: All dates and times are in UTC (formatted as
yyyy-mm-dd hh:mm:ss), and all strings are encoded using UTF-8.Caching: The getResults operation supports cache validation using ETag and Last-Modified headers. We recommend enabling caching on clients and making conditional requests to reduce latency, server load and energy usage.
Usage limits: Previously we have seen performance degradation due to overloading the API. To safeguard stability of our platform usage limits apply to the API. These limits are designed to prevent undesired loads on our systems from misconfigured API integrations or abuse. The rate limit defaults 30 calls per minute. This applies to both read and write operations. Requests that hit the rate limit will have a status code of
429 Too many requests.
All responses include the following headers with explicit numbers on the limits and remaining calls:
- X-RateLimit-Limit
- X-RateLimit-Remaining
- X-RateLimit-Retry-After
To debug problems in your integration scenarios that are or can be caused by rate limits, please go through this checklist:
- Consult your integration specialist to inspect the API calls and return headers.
- Open your AlisQI integration hub to learn about the concrete rate limit applied to your installation.
- Inspect the API log in the AlisQI integration hub, to determine the number of requests per minute.
- Inspect the API request return headers, to see if they contain the
429 Too many requestsstatus code. - Inspect individual API request return headers to assess the
X-RateLimit-* headers. - Assess whether you can improve the integration by reducing duplicate requests, or by combining multiple results in a single storeResults call. Feel free to reach out to AlisQI support to discuss the capabilities of our API regarding caching and processing multiple results.
- If your integration scenario is optimized but legitimately requires more calls per minutes, please reach out to AlisQI support to discuss possibilities to raise the limit.
Deployment instructions
Please use these instructions to deploy this connector as custom connector in Microsoft Flow and PowerApps.
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 |
|---|---|---|---|
| API Key | securestring | The API Key for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Create a new specification version |
Create (a) new specification version(s) for an analysis sets. |
| Create or update results or master data |
Create or update quality results in analysis sets or master data in selection lists. |
| Get all analysis sets or selection lists |
Get a list of (all) analysis sets or selection lists. |
| Get capability statistics for analysis set fields |
Get in-depth statistics of specification evaluation and product and process capability for an analysis set's numeric fields. |
| Get descriptive statistics for analysis set fields |
Get descriptive statistics for numeric analysis set fields of your choice. |
| Get results or master data |
Get (quality) results from analysis sets or master data from selection lists. |
| Get specification versions |
Get (a) specification version(s) for an analysis set. |
| Get the structure of an analysis sets or selection list |
Get the structural definition of an analysis sets or selection lists. |
Create a new specification version
Create (a) new specification version(s) for an analysis sets.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Subdomain
|
subdomain | True | string |
The subdomain to be used for the request. |
|
Set ID
|
setId | True | string |
Enter the unique ID of the analysis set you're interested in (historically known as maskid in URLs). |
|
Specs
|
specs | True | string |
JSON object as a string. |
|
Index Value
|
indexValue | string |
The index field value. |
|
|
Start Date Time
|
startDateTime | string |
Formatted as yyyy-mm-dd hh:mm:ss or unix stimestamp. |
|
|
Reason
|
reason | string |
The reason for changing the spec. |
Returns
- response
- boolean
Create or update results or master data
Create or update quality results in analysis sets or master data in selection lists.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Subdomain
|
subdomain | True | string |
The subdomain to be used for the request. |
|
Set ID
|
setId | True | string |
Enter the unique ID of the analysis set you're interested in (historically known as maskid in URLs). |
|
Results
|
results | True | string |
JSON object as a string. |
|
Key Field
|
keyField | string |
Find and modify existing results based on this field's value. |
|
|
Edit Only
|
editOnly | string |
Use (only) in conjunction with keyField. |
|
|
Add List Options
|
addListOptions | string |
Flag to add new options to lists. |
Get all analysis sets or selection lists
Get a list of (all) analysis sets or selection lists.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Subdomain
|
subdomain | True | string |
The subdomain to be used for the request. |
|
Groups
|
groups | string |
Enter group IDs or names to find specific groups, use 'Selection lists' to get all. |
|
|
Names
|
names | string |
Input the names of analysis sets or selection lists you want to retrieve. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | integer |
id |
|
name
|
name | string |
name |
|
groupId
|
groupId | integer |
groupId |
|
groupName
|
groupName | string |
groupName |
|
topLevelMenu
|
topLevelMenu | string |
topLevelMenu |
Get capability statistics for analysis set fields
Get in-depth statistics of specification evaluation and product and process capability for an analysis set's numeric fields.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Subdomain
|
subdomain | True | string |
The subdomain to be used for the request. |
|
Set ID
|
setId | True | integer |
Enter the unique ID of the analysis set you're interested in (historically known as maskid in URLs). |
|
Fields
|
fields | True | string |
Comma separated list with the specific data points you want to be returned. |
|
Limit
|
limit | integer |
The maximum number of results to consider. |
|
|
Filter
|
filter | string |
Use a JSON-formatted string to narrow down the data you're requesting, based on specific conditions. |
Get descriptive statistics for analysis set fields
Get descriptive statistics for numeric analysis set fields of your choice.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Subdomain
|
subdomain | True | string |
The subdomain to be used for the request. |
|
Set ID
|
setId | True | integer |
Enter the unique ID of the analysis set you're interested in (historically known as maskid in URLs). |
|
Fields
|
fields | True | string |
Comma separated list with the specific data points you want to be returned. |
|
Limit
|
limit | integer |
The maximum number of results to consider. |
|
|
Filter
|
filter | string |
Use a JSON-formatted string to narrow down the data you're requesting, based on specific conditions. |
Get results or master data
Get (quality) results from analysis sets or master data from selection lists.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Subdomain
|
subdomain | True | string |
The subdomain to be used for the request. |
|
Set ID
|
setId | True | integer |
Enter the unique ID of the analysis set you're interested in (historically known as maskid in URLs). |
|
Limit
|
limit | integer |
Specify the maximum number of records you want to receive, up to a cap of 10,000. |
|
|
Offset
|
offset | integer |
Choose a starting position for the results, useful for paging through data (defaults to 0). |
|
|
Sort
|
sort | string |
Determine the order of your data by a field and direction, like date:desc for the most recent first. |
|
|
Filter
|
filter | string |
Use a JSON-formatted string to narrow down the data you're requesting, based on specific conditions. |
|
|
Fields
|
fields | string |
Comma separated list with the specific data points you want to be returned. |
|
|
Include Attachments
|
includeAttachments | boolean |
Mark true if you want to include any file attachments with your data, otherwise leave as false. |
|
|
Include ID
|
includeId | boolean |
Set to true if you want to get the system's unique record numbers for your data, making it easier to manage or reference. |
|
|
Include Last Modification Date
|
includeLastModificationDate | boolean |
Turn on to get the last change date for each piece of data, which is great for tracking the most recent updates. |
Get specification versions
Get (a) specification version(s) for an analysis set.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Subdomain
|
subdomain | True | string |
The subdomain to be used for the request. |
|
Set ID
|
setId | True | integer |
Enter the unique ID of the analysis set you're interested in (historically known as maskid in URLs). |
|
Index Value
|
indexValue | string |
Get the current specification version for this index value. |
Get the structure of an analysis sets or selection list
Get the structural definition of an analysis sets or selection lists.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Subdomain
|
subdomain | True | string |
The subdomain to be used for the request. |
|
Set ID
|
setId | True | integer |
Enter the unique ID of the analysis set you're interested in (historically known as maskid in URLs). |
|
Only Active Fields
|
onlyActiveFields | boolean |
Whether to only show currently active fields. |
|
|
Accept
|
Accept | True | string |
Accept |
Definitions
boolean
This is the basic data type 'boolean'.