ancoreMate Automations (Preview)
Run and manage the automations of Qlik Cloud®: run, stop and retry automations, follow their runs, copy, enable or move automations and maintain their connections. Triggers when an automation changes or a run starts, ends or fails. Qlik®, Qlik Cloud® and Qlik Sense® are trademarks of QlikTech International AB. ancoreMate is not affiliated with or endorsed by Qlik.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | 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) |
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - 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) |
| 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) |
| Contact | |
|---|---|
| Name | ancoreSoft |
| URL | https://ancorecloud.com/ |
| support@ancoresoft.com |
| Connector Metadata | |
|---|---|
| Publisher | ancoreSoft |
| Website | https://ancorecloud.com/ |
| Privacy policy | https://ancoresoft.com/legal/ancoremate/privacy/ |
| Categories | IT Operations;Productivity |
ancoreMate Automations
Run and manage the automations of Qlik Cloud®: run, stop and retry automations, follow their runs, copy, enable or move automations and maintain their connections. Triggers when an automation changes or a run starts, ends or fails.
Qlik®, Qlik Cloud® and Qlik Sense® are trademarks of QlikTech International AB. ancoreMate is not affiliated with or endorsed by Qlik.
Publisher
ancoreSoft
Prerequisites
- An ancoreCloud account with an ancoreMate subscription. See https://ancorecloud.com/ for details and https://docs.ancoresoft.com/ for the documentation.
- A Qlik Cloud user with access to the content you want to automate. No OAuth client, client ID or API key needs to be created in Qlik Cloud.
Supported operations
Copy automation
Creates a copy of an automation.
Create automation
Creates an automation in Qlik Automate.
Create automation connection
Creates a connection for automations.
Delete automation
Deletes an automation.
Delete automation connection
Deletes an automation connection.
Disable automation
Disables an automation so that it no longer runs.
Enable automation
Enables an automation so that it runs on its triggers again.
Export automation run
Returns a link to the detailed log of a run.
Get Qlik connection
Returns whether ancoreMate is connected to a Qlik Cloud tenant, and to which tenant and Qlik user.
Get automation
Returns an automation of Qlik Automate.
Get automation connection
Returns an automation connection.
Get automation run
Returns a run of an automation with its status.
List automation connections
Lists the connections that automations use to reach other services.
List automation runs
Lists the runs of an automation, newest first.
List automations
Lists the automations of Qlik Automate the connected user can see.
Move automation connection to space
Moves an automation connection to another space.
Move automation to space
Moves an automation to another space.
Retry automation run
Runs a failed run of an automation again.
Run automation
Starts a run of an automation.
Send Qlik Cloud request
Calls any REST API of your Qlik Cloud tenant below /api/v1/ with the connected user's rights, for operations that have no action of their own.
Stop automation run
Stops a running run of an automation.
Update automation
Replaces the definition of an automation.
Update automation connection
Changes the name or parameters of an automation connection.
Supported triggers
When an automation is created
Starts when an automation is created.
When an automation is deleted
Starts when an automation is deleted.
When an automation is updated
Starts when an automation is changed.
When an automation run ends
Starts when a run of an automation ends.
When an automation run fails
Starts when a run of an automation fails.
When an automation run starts
Starts when a run of an automation starts.
Obtaining credentials
- Create a connection and select Sign in.
- Sign in with your ancoreCloud account.
- The first time, enter your Qlik Cloud tenant, for example
company.eu.qlikcloud.com, sign in at Qlik Cloud and approve the access for ancoreMate. Later sign-ins list the Qlik Cloud connections of your ancoreCloud account: continue with one of them, or add another tenant or Qlik user. Each connection works with the Qlik Cloud connection chosen in its sign-in; the others stay as they are. - If your Qlik Cloud administrators require it, an administrator approves ancoreMate once in the Qlik Cloud administration (Integrations > OAuth).
Getting started
Use List automations and List automation runs to find failed runs of Qlik Automate, or Run automation to start an existing automation from a flow, for example while moving automations step by step.
Known issues and limitations
- Automations can only be run and changed by users with the corresponding rights in Qlik Cloud.
- Only Qlik Cloud tenants are supported; Qlik Sense client-managed (on-premises) deployments are not supported.
- Qlik Cloud rate limits apply. When Qlik Cloud limits requests, the action fails with status 429; the flow's retry policy retries it automatically.
- Each connection works with one Qlik Cloud tenant and Qlik user, chosen in its sign-in. To work with several tenants or Qlik users, for example development and production, create one connection per tenant or user; a flow can use several of them.
Deployment instructions
Use the instructions to deploy a custom connector with the files apiDefinition.swagger.json and apiProperties.json of this folder.
Actions
| Copy automation |
Creates a copy of an automation. |
| Create automation |
Creates an automation in Qlik Automate. |
| Create automation connection |
Creates a connection for automations. |
| Delete automation |
Deletes an automation. |
| Delete automation connection |
Deletes an automation connection. |
| Disable automation |
Disables an automation so that it no longer runs. |
| Enable automation |
Enables an automation so that it runs on its triggers again. |
| Export automation run |
Returns a link to the detailed log of a run. |
| Get automation |
Returns an automation of Qlik Automate. |
| Get automation connection |
Returns an automation connection. |
| Get automation run |
Returns a run of an automation with its status. |
| Get Qlik connection |
Returns whether ancoreMate is connected to a Qlik Cloud tenant, and to which tenant and Qlik user. |
| List automation connections |
Lists the connections that automations use to reach other services. |
| List automation runs |
Lists the runs of an automation, newest first. |
| List automations |
Lists the automations of Qlik Automate the connected user can see. |
| Move automation connection to space |
Moves an automation connection to another space. |
| Move automation to space |
Moves an automation to another space. |
| Retry automation run |
Runs a failed run of an automation again. |
| Run automation |
Starts a run of an automation. |
| Send Qlik Cloud request |
Calls any REST API of your Qlik Cloud tenant below /api/v1/ with the connected user's rights, for operations that have no action of their own. |
| Stop automation run |
Stops a running run of an automation. |
| Update automation |
Replaces the definition of an automation. |
| Update automation connection |
Changes the name or parameters of an automation connection. |
Copy automation
Creates a copy of an automation.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Automation ID
|
automationId | True | string |
The unique identifier for the automation. |
|
Name
|
name | True | string |
Name of the new automation. |
Returns
The result of copy automation.
Create automation
Creates an automation in Qlik Automate.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Name
|
name | string |
The name. |
|
|
Space ID
|
spaceId | string |
The space id. |
|
|
Stop At
|
stopAt | string |
The stop at. |
|
|
Start At
|
startAt | string |
The start at. |
|
|
Interval
|
interval | integer |
Interval in seconds; must be a multiple of 60. |
|
|
Timezone
|
timezone | string |
The timezone. |
|
|
Recurrence
|
recurrence | string |
The RRULE that defines when the automation runs. |
|
|
Workspace
|
workspace | object |
The workspace generated by the Qlik Automate editor. |
|
|
Description
|
description | string |
The description. |
|
|
Max Concurrent Runs
|
maxConcurrentRuns | integer |
Maximum number of concurrent runs allowed for this automation. |
Returns
An automation.
- Body
- AutomationDetails
Create automation connection
Creates a connection for automations.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Name
|
name | string |
The name of the created automation connection. |
|
|
Name
|
name | string |
The name of the automation connection parameter. |
|
|
Value
|
value | string |
The value of the automation connection parameter option. |
|
|
Space ID
|
spaceId | string |
The unique identifier of the space in which the automation connection is created. |
|
|
Connector ID
|
connectorId | True | string |
The unique identifier of the connector from which the automation connection is created. |
Returns
An automation connection.
Delete automation
Deletes an automation.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Automation ID
|
automationId | True | string |
The unique identifier for the automation. |
Delete automation connection
Deletes an automation connection.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Automation Connection ID
|
automationConnectionId | True | string |
The unique identifier for the automation connection. |
|
Forced
|
forced | boolean |
When true, the automation connection will be deleted regardless of its usage by any automations. |
Disable automation
Disables an automation so that it no longer runs.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Automation ID
|
automationId | True | string |
The unique identifier for the automation. |
Enable automation
Enables an automation so that it runs on its triggers again.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Automation ID
|
automationId | True | string |
The unique identifier for the automation. |
Export automation run
Returns a link to the detailed log of a run.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Automation ID
|
automationId | True | string |
The unique identifier for the automation. |
|
Run ID
|
runId | True | string |
The unique identifier for the run. |
Returns
The result of export automation run.
Get automation
Returns an automation of Qlik Automate.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Automation ID
|
automationId | True | string |
The unique identifier for the automation. |
Returns
An automation.
- Body
- AutomationDetails
Get automation connection
Returns an automation connection.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Automation Connection ID
|
automationConnectionId | True | string |
The unique identifier for the automation connection. |
Returns
An automation connection.
Get automation run
Returns a run of an automation with its status.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Automation ID
|
automationId | True | string |
The unique identifier for the automation. |
|
Run ID
|
runId | True | string |
The unique identifier for the run. |
Returns
An automation run.
- Body
- AutomationRun
Get Qlik connection
Returns whether ancoreMate is connected to a Qlik Cloud tenant, and to which tenant and Qlik user.
Returns
The connection between ancoreMate and Qlik Cloud.
- Body
- Connection
List automation connections
Lists the connections that automations use to reach other services.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filter
|
filter | string |
Filters the result based on the specified criteria: name, connectorId, ownerId, or spaceId. |
|
|
List All
|
listAll | boolean |
When true, list all connections. |
|
|
Sort
|
sort | string |
The field to sort by, with +- prefix indicating sort order. |
|
|
Limit
|
limit | integer |
The maximum number of items to return, between 1 and 5000. |
Returns
A list of automation connection items.
List automation runs
Lists the runs of an automation, newest first.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Automation ID
|
automationId | True | string |
The unique identifier for the automation. |
|
Filter
|
filter | string |
Allowed filters: status, context, startTime, title, spaceId, ownerId, executedById, billable. |
|
|
Sort
|
sort | string |
The field to sort by, with +- prefix indicating sort order. |
|
|
Limit
|
limit | integer |
The maximum number of items to return, between 1 and 5000. |
Returns
A list of automation run items.
- Body
- AutomationRunList
List automations
Lists the automations of Qlik Automate the connected user can see.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filter
|
filter | string |
Allowed filters: name, runMode, lastRunStatus, ownerId, spaceId. |
|
|
List All
|
listAll | boolean |
When true, list all automations. |
|
|
Sort
|
sort | string |
The field to sort by, with +- prefix indicating sort order. |
|
|
Limit
|
limit | integer |
The maximum number of items to return, between 1 and 5000. |
Returns
A list of automation items.
- Body
- AutomationList
Move automation connection to space
Moves an automation connection to another space.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Automation Connection ID
|
automationConnectionId | True | string |
The unique identifier for the automation connection. |
|
Space ID
|
spaceId | string |
The unique identifier of the new space. |
Move automation to space
Moves an automation to another space.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Automation ID
|
automationId | True | string |
The unique identifier for the automation. |
|
Space ID
|
spaceId | True | string |
The unique identifier of the new space. |
Retry automation run
Runs a failed run of an automation again.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Automation ID
|
automationId | True | string |
The unique identifier for the automation. |
|
Run ID
|
runId | True | string |
The unique identifier for the run. |
Run automation
Starts a run of an automation.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Automation ID
|
automationId | True | string |
The unique identifier for the automation. |
|
Context
|
context | True | string |
The source that triggers the automation will set the context. |
Returns
An automation run.
- Body
- AutomationRun
Send Qlik Cloud request
Calls any REST API of your Qlik Cloud tenant below /api/v1/ with the connected user's rights, for operations that have no action of their own.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Method
|
method | True | string |
The HTTP method. |
|
Path
|
path | True | string |
The path below /api/v1/, for example spaces or apps/1234/reloads/logs. |
|
Query
|
query | string |
Query parameters as in a URL, for example limit=10&name=Sales. |
|
|
Body
|
body | object |
The JSON body for POST, PUT, PATCH and DELETE, for example the IDs of the items to delete. |
Returns
The JSON response of Qlik Cloud, unchanged.
- response
- object
Stop automation run
Stops a running run of an automation.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Automation ID
|
automationId | True | string |
The unique identifier for the automation. |
|
Run ID
|
runId | True | string |
The unique identifier for the run. |
Update automation
Replaces the definition of an automation.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Automation ID
|
automationId | True | string |
The unique identifier for the automation. |
|
Name
|
name | string |
The name. |
|
|
Stop At
|
stopAt | string |
The stop at. |
|
|
Start At
|
startAt | string |
The start at. |
|
|
Interval
|
interval | integer |
Interval in seconds; must be a multiple of 60. |
|
|
Timezone
|
timezone | string |
The timezone. |
|
|
Recurrence
|
recurrence | string |
The RRULE that defines when the automation runs. |
|
|
Workspace
|
workspace | object |
The workspace generated by the Qlik Automate editor. |
|
|
Description
|
description | string |
The description. |
|
|
Max Concurrent Runs
|
maxConcurrentRuns | integer |
Maximum number of concurrent runs allowed for this automation. |
Returns
An automation.
- Body
- AutomationDetails
Update automation connection
Changes the name or parameters of an automation connection.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Automation Connection ID
|
automationConnectionId | True | string |
The unique identifier for the automation connection. |
|
Name
|
name | string |
The new name of the automation connection to be renamed to. |
|
|
ID
|
id | string |
The unique identifier of the automation connection parameter option. |
|
|
Value
|
value | string |
The value of the automation connection parameter option. |
Returns
An automation connection.
Triggers
| When an automation is created |
Starts when an automation is created. |
| When an automation is deleted |
Starts when an automation is deleted. |
| When an automation is updated |
Starts when an automation is changed. |
| When an automation run ends |
Starts when a run of an automation ends. |
| When an automation run fails |
Starts when a run of an automation fails. |
| When an automation run starts |
Starts when a run of an automation starts. |
When an automation is created
Starts when an automation is created.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space
|
spaceId | string |
Only events in this space. Leave empty for all spaces. |
Returns
An event of Qlik Cloud.
- Body
- QlikEvent
When an automation is deleted
Starts when an automation is deleted.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Automation
|
automationId | string |
Only events of this automation. Leave empty for all automations. |
|
|
Space
|
spaceId | string |
Only events in this space. Leave empty for all spaces. |
Returns
An event of Qlik Cloud.
- Body
- QlikEvent
When an automation is updated
Starts when an automation is changed.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Automation
|
automationId | string |
Only events of this automation. Leave empty for all automations. |
|
|
Space
|
spaceId | string |
Only events in this space. Leave empty for all spaces. |
Returns
An event of Qlik Cloud.
- Body
- QlikEvent
When an automation run ends
Starts when a run of an automation ends.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Automation
|
automationId | string |
Only events of this automation. Leave empty for all automations. |
|
|
Space
|
spaceId | string |
Only events in this space. Leave empty for all spaces. |
Returns
An event of Qlik Cloud.
- Body
- QlikEvent
When an automation run fails
Starts when a run of an automation fails.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Automation
|
automationId | string |
Only events of this automation. Leave empty for all automations. |
|
|
Space
|
spaceId | string |
Only events in this space. Leave empty for all spaces. |
Returns
An event of Qlik Cloud.
- Body
- QlikEvent
When an automation run starts
Starts when a run of an automation starts.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Automation
|
automationId | string |
Only events of this automation. Leave empty for all automations. |
|
|
Space
|
spaceId | string |
Only events in this space. Leave empty for all spaces. |
Returns
An event of Qlik Cloud.
- Body
- QlikEvent
Definitions
Automation
An automation.
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The unique identifier for the automation. |
|
Name
|
name | string |
The name of the automation. |
|
State
|
state | string |
The state of the automation. |
|
ID
|
lastRun.id | string |
The unique identifier of the run. |
|
Error
|
lastRun.error | array of object |
List of errors that occurred during the automation run. |
|
items
|
lastRun.error | object |
Details of the error. |
|
Title
|
lastRun.title | string |
The title of the automation run. |
|
Status
|
lastRun.status | string |
The current status of the automation run. |
|
Context
|
lastRun.context | string |
The source that triggers the automation will set the context. |
|
Blocks
|
lastRun.metrics.blocks | array of object |
List of blocks used during execution. |
|
items
|
lastRun.metrics.blocks | object |
Information of the ended execution per block. |
|
Rx Bytes
|
lastRun.metrics.network.rxBytes | integer |
The number of received bytes. |
|
Tx Bytes
|
lastRun.metrics.network.txBytes | integer |
The number of sent bytes. |
|
Total API Calls
|
lastRun.metrics.totalApiCalls | integer |
The number of API calls made. |
|
Owner ID
|
lastRun.ownerId | string |
The unique identifier of the owner of the automation run. |
|
Space ID
|
lastRun.spaceId | string |
The unique identifier of the space in which the automation run is created. |
|
Test Run
|
lastRun.testRun | boolean |
Indicates if this automation run is a test run. |
|
Archived
|
lastRun.archived | boolean |
Indicates if this automation run is archived. |
|
Stop Time
|
lastRun.stopTime | date-time |
The date and time at which the automation run stopped. |
|
Created At
|
lastRun.createdAt | date-time |
The created at. |
|
Is Test Run
|
lastRun.isTestRun | boolean |
Indicates if this automation run is a test run. |
|
Start Time
|
lastRun.startTime | date-time |
The date and time at which the automation run started. |
|
Updated At
|
lastRun.updatedAt | date-time |
The updated at. |
|
Is Archived
|
lastRun.isArchived | boolean |
Indicates if this automation run is archived. |
|
Executed By ID
|
lastRun.executedById | string |
The unique identifier of the user who executed the automation run. |
|
Scheduled Start Time
|
lastRun.scheduledStartTime | date-time |
The date and time at which the automation run is scheduled to start. |
|
Owner ID
|
ownerId | string |
The unique identifier of the owner of the automation. |
|
Run Mode
|
runMode | string |
Defines how the automation run is started. |
|
Space ID
|
spaceId | string |
The unique identifier of the space that contains the automation. |
|
Duration
|
duration | integer |
Duration of the last run, indicated in seconds. |
|
Created At
|
createdAt | date-time |
The created at. |
|
Last Run At
|
lastRunAt | date-time |
The date and time when the last automation run was finished. |
|
Updated At
|
updatedAt | date-time |
The updated at. |
|
Workspace
|
workspace | object |
The workspace contains the JSON representation of the used blocks. |
|
Snippet IDs
|
snippetIds | array of string |
A list of snippets that were detected in the workspace. |
|
Description
|
description | string |
The description of the automation. |
|
Endpoint IDs
|
endpointIds | array of string |
A list of endpoints that were detected in the workspace. |
|
Connector IDs
|
connectorIds | array of string |
A list of connectors that were detected in the workspace. |
|
Last Run Status
|
lastRunStatus | string |
The status of the last run of the automation. |
|
Execution Token
|
executionToken | string |
The execution token. |
|
Max Concurrent Runs
|
maxConcurrentRuns | integer |
Maximum number of concurrent runs allowed for automation. |
AutomationConnection
An automation connection.
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The unique identifier of an automation connection. |
|
Name
|
name | string |
The name of an automation connection. |
|
Owner ID
|
ownerId | string |
The unique identifier of the owner of the automation connection. |
|
Space ID
|
spaceId | string |
The space ID of the automation connection. |
|
Created At
|
createdAt | date-time |
The timestamp when the automation connection is created. |
|
Updated At
|
updatedAt | date-time |
The timestamp when the automation connection is updated. |
|
Connector ID
|
connectorId | string |
The unique identifier of the connector the automation connection is created from. |
|
Is Connected
|
isConnected | boolean |
Returns true if the automtion connection is connected. |
AutomationConnectionDetails
An automation connection.
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The unique identifier of the automation connection. |
|
Name
|
name | string |
The name of the automation connection. |
|
Error
|
error | object |
This contains the error message if a connection is being created with an issue. |
|
Params
|
params | array of object |
The params. |
|
ID
|
params.id | string |
The unique identifier of the automation connection parameter. |
|
Meta
|
params.meta | array of string |
The metadata of the automation connection parameter. |
|
Name
|
params.name | string |
The name of the automation connection parameter. |
|
Order
|
params.order | integer |
The order that the automation connection configuration fields should be displayed in. |
|
Value
|
params.value | string |
The value of the automation connection parameter. |
|
Field Type
|
params.fieldType | string |
The field type of the automation connection parameter. |
|
Is Optional
|
params.isOptional | boolean |
When true, the parameter is optional. |
|
Example Value
|
params.exampleValue | string |
The example value of the automation connection parameter. |
|
Param Options
|
params.paramOptions | array of object |
The param options. |
|
items
|
params.paramOptions | object |
An item. |
|
Documentation
|
params.documentation | string |
The documentation of the automation connection parameter. |
|
Owner ID
|
ownerId | string |
The unique identifier of the owner of the automation connection. |
|
Space ID
|
spaceId | string |
The space ID of the automation connection. |
|
Redirect
|
redirect | string |
The redirect of the OAuth account. |
|
Created At
|
createdAt | date-time |
The timestamp when the automation connection was created. |
|
Updated At
|
updatedAt | date-time |
The timestamp when the automation connection was updated. |
|
Connector ID
|
connectorId | string |
The unique identifier of the automation connector. |
|
Is Connected
|
isConnected | boolean |
The connection status of the automation connection. |
|
Oauth Account Name
|
oauthAccountName | string |
The name of the OAuth account associated with the automation connection. |
AutomationConnectionList
A list of automation connection items.
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
value | array of AutomationConnection |
The items. |
AutomationDetails
An automation.
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The id. |
|
Name
|
name | string |
The name of the automation. |
|
State
|
state | string |
The state of the automation. |
|
ID
|
lastRun.id | string |
The unique identifier of the run. |
|
Error
|
lastRun.error | array of object |
List of errors that occurred during the automation run. |
|
items
|
lastRun.error | object |
Details of the error. |
|
Title
|
lastRun.title | string |
The title of the automation run. |
|
Status
|
lastRun.status | string |
The current status of the automation run. |
|
Context
|
lastRun.context | string |
The source that triggers the automation will set the context. |
|
Blocks
|
lastRun.metrics.blocks | array of object |
List of blocks used during execution. |
|
items
|
lastRun.metrics.blocks | object |
Information of the ended execution per block. |
|
Rx Bytes
|
lastRun.metrics.network.rxBytes | integer |
The number of received bytes. |
|
Tx Bytes
|
lastRun.metrics.network.txBytes | integer |
The number of sent bytes. |
|
Total API Calls
|
lastRun.metrics.totalApiCalls | integer |
The number of API calls made. |
|
Owner ID
|
lastRun.ownerId | string |
The unique identifier of the owner of the automation run. |
|
Space ID
|
lastRun.spaceId | string |
The unique identifier of the space in which the automation run is created. |
|
Test Run
|
lastRun.testRun | boolean |
Indicates if this automation run is a test run. |
|
Archived
|
lastRun.archived | boolean |
Indicates if this automation run is archived. |
|
Stop Time
|
lastRun.stopTime | date-time |
The date and time at which the automation run stopped. |
|
Created At
|
lastRun.createdAt | date-time |
The created at. |
|
Is Test Run
|
lastRun.isTestRun | boolean |
Indicates if this automation run is a test run. |
|
Start Time
|
lastRun.startTime | date-time |
The date and time at which the automation run started. |
|
Updated At
|
lastRun.updatedAt | date-time |
The updated at. |
|
Is Archived
|
lastRun.isArchived | boolean |
Indicates if this automation run is archived. |
|
Executed By ID
|
lastRun.executedById | string |
The unique identifier of the user who executed the automation run. |
|
Scheduled Start Time
|
lastRun.scheduledStartTime | date-time |
The date and time at which the automation run is scheduled to start. |
|
Owner ID
|
ownerId | string |
The unique identifier of the owner of the automation. |
|
Run Mode
|
runMode | string |
Defines how the automation run is started. |
|
Space ID
|
spaceId | string |
The unique identifier of the space that contains the automation. |
|
Created At
|
createdAt | date-time |
The created at. |
|
Last Run At
|
lastRunAt | date-time |
The date and time when the last automation run was finished. |
|
Schedules
|
schedules | array of object |
The schedules. |
|
ID
|
schedules.id | string |
The id. |
|
Stop At
|
schedules.stopAt | string |
The stop at. |
|
Start At
|
schedules.startAt | string |
The start at. |
|
Interval
|
schedules.interval | integer |
Interval in seconds. |
|
Timezone
|
schedules.timezone | string |
The timezone. |
|
Next Run At
|
schedules.nextRunAt | string |
The next run at. |
|
Recurrence
|
schedules.recurrence | string |
The RRULE that defines when the automation runs. |
|
Last Started At
|
schedules.lastStartedAt | date-time |
The last started at. |
|
Updated At
|
updatedAt | date-time |
The updated at. |
|
Workspace
|
workspace | object |
The workspace generated by the Qlik Automate editor. |
|
Snippet IDs
|
snippetIds | array of string |
A list of snippets that were detected in the workspace. |
|
Description
|
description | string |
The description of the automation. |
|
Endpoint IDs
|
endpointIds | array of string |
A list of endpoints that were detected in the workspace. |
|
Connector IDs
|
connectorIds | array of string |
A list of connectors that were detected in the workspace. |
|
Last Run Status
|
lastRunStatus | string |
The status of the last run of the automation. |
|
Execution Token
|
executionToken | string |
Execution token required to authorize the execution of the automation. |
|
Max Concurrent Runs
|
maxConcurrentRuns | integer |
Maximum number of concurrent runs allowed for this automation. |
AutomationList
A list of automation items.
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
value | array of Automation |
The items. |
AutomationRun
An automation run.
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The unique identifier of the run. |
|
Error
|
error | array of object |
List of errors that occurred during the automation run. |
|
items
|
error | object |
Details of the error. |
|
Title
|
title | string |
The title of the automation run. |
|
Status
|
status | string |
The current status of the automation run. |
|
Context
|
context | string |
The source that triggers the automation will set the context. |
|
Blocks
|
metrics.blocks | array of object |
List of blocks used during execution. |
|
Type
|
metrics.blocks.type | string |
Type of the block. |
|
Rx Bytes
|
metrics.blocks.rxBytes | integer |
Total amount of received bytes sent by the current block. |
|
Tx Bytes
|
metrics.blocks.txBytes | integer |
Total amount of sent bytes sent by the current block. |
|
API Calls
|
metrics.blocks.apiCalls | integer |
API calls to external resources made by the current block. |
|
Snippet ID
|
metrics.blocks.snippetId | string |
Unique identifier for the snippet block used within the execution. |
|
Endpoint ID
|
metrics.blocks.endpointId | string |
Unique identifier for the endpoint block used within the execution. |
|
Connector ID
|
metrics.blocks.connectorId | string |
Unique identifier for the connector used within the block of the execution. |
|
Rx Bytes
|
metrics.network.rxBytes | integer |
The number of received bytes. |
|
Tx Bytes
|
metrics.network.txBytes | integer |
The number of sent bytes. |
|
Total API Calls
|
metrics.totalApiCalls | integer |
The number of API calls made. |
|
Owner ID
|
ownerId | string |
The unique identifier of the owner of the automation run. |
|
Space ID
|
spaceId | string |
The unique identifier of the space in which the automation run is created. |
|
Test Run
|
testRun | boolean |
Indicates if this automation run is a test run. |
|
Archived
|
archived | boolean |
Indicates if this automation run is archived. |
|
Stop Time
|
stopTime | date-time |
The date and time at which the automation run stopped. |
|
Created At
|
createdAt | date-time |
The created at. |
|
Is Test Run
|
isTestRun | boolean |
Indicates if this automation run is a test run. |
|
Start Time
|
startTime | date-time |
The date and time at which the automation run started. |
|
Updated At
|
updatedAt | date-time |
The updated at. |
|
Is Archived
|
isArchived | boolean |
Indicates if this automation run is archived. |
|
Executed By ID
|
executedById | string |
The unique identifier of the user who executed the automation run. |
|
Scheduled Start Time
|
scheduledStartTime | date-time |
The date and time at which the automation run is scheduled to start. |
AutomationRunList
A list of automation run items.
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
value | array of ListAutomationRunsItem |
The items. |
Connection
The connection between ancoreMate and Qlik Cloud.
| Name | Path | Type | Description |
|---|---|---|---|
|
Connected
|
connected | boolean |
Whether ancoreMate is connected to Qlik Cloud. |
|
Qlik Cloud tenant
|
tenantHost | string |
The host name of the connected Qlik Cloud tenant. |
|
Qlik user
|
qlikUserName | string |
The name of the connected Qlik Cloud user. |
|
Connected at
|
connectedAt | date-time |
The time the connection was established. |
CopyAutomationResponse
The result of copy automation.
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The unique identifier for the automation. |
ExportAutomationRunResponse
The result of export automation run.
| Name | Path | Type | Description |
|---|---|---|---|
|
URL
|
url | string |
The url. |
ListAutomationRunsItem
An automation run.
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The id. |
|
Error
|
error | array of object |
List of errors that occurred during the automation run. |
|
items
|
error | object |
Details of the error. |
|
Title
|
title | string |
The title of the automation run. |
|
Status
|
status | string |
The current status of the automation run. |
|
Context
|
context | string |
The context set by the source that triggers the automation. |
|
Owner ID
|
ownerId | string |
The unique identifier of the owner of the automation run. |
|
Space ID
|
spaceId | string |
The unique identifier of the space in which the automation run is created. |
|
Test Run
|
testRun | boolean |
Indicates if this automation run is a test run. |
|
Archived
|
archived | boolean |
Indicates if this automation run is archived. |
|
Duration
|
duration | integer |
Duration of the run, indicated in seconds. |
|
Stop Time
|
stopTime | date-time |
The date and time at which the automation run stopped. |
|
Created At
|
createdAt | string |
The created at. |
|
Is Test Run
|
isTestRun | boolean |
Indicates if this automation run is a test run. |
|
Start Time
|
startTime | date-time |
The date and time at which the automation run started. |
|
Updated At
|
updatedAt | string |
The updated at. |
|
Is Archived
|
isArchived | boolean |
Indicates if this automation run is archived. |
|
Executed By ID
|
executedById | string |
The unique identifier of the user who executed the automation run. |
|
Scheduled Start Time
|
scheduledStartTime | date-time |
The date and time at which the automation run is scheduled to start. |
QlikEvent
An event of Qlik Cloud.
| Name | Path | Type | Description |
|---|---|---|---|
|
Event ID
|
id | string |
The unique ID of the event. |
|
Event type
|
type | string |
The type of the event, for example com.qlik.v1.app.reload.finished. |
|
Time
|
time | date-time |
The time of the event. |
|
Source
|
source | string |
The Qlik Cloud service that reported the event. |
|
Subject
|
subject | string |
The item the event is about. |
|
Tenant ID
|
tenantid | string |
The ID of the Qlik Cloud tenant. |
|
User ID
|
userid | string |
The ID of the user who caused the event. |
|
Owner ID
|
ownerid | string |
The ID of the user who owns the item. |
|
Space ID
|
spaceid | string |
The ID of the space of the item. |
|
Resource ID
|
toplevelresourceid | string |
The ID of the item, for example the app or automation. |
|
Data
|
data | object |
The details of the event; for apps, data.attributes holds the app with name, ID and space. |
object
This is the type 'object'.