Qalyptus Server API Documentation (v2)
Download OpenAPI specification:
Welcome to the Qalyptus API documentation. This comprehensive guide provides developers with all the necessary information to integrate Qalyptus's reporting capabilities into their applications seamlessly.
Create API key
Create a new API key.
Authorizations:
Request Body schema:
The API key name, description and expiration date.
| name required | string non-empty |
| description | string or null |
| expiryDate required | string <date-time> |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "expiryDate": "2019-08-24T14:15:22Z"
}Response samples
- 200
- 400
- 403
- 404
- 409
Get user API keys
Get a list of all API keys with pagination and filtering support.
Authorizations:
query Parameters
| name | string Api key name used for filtering.
|
| description | string Api key description used for filtering.
|
| sort_by | string Sort by field name (optional). Supported fields:
|
| expired | boolean Expired Api key filter. |
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 400
- 403
Update API key
Update an existing API key.
Authorizations:
path Parameters
| id required | string <uuid> The ID of the API key to update. |
Request Body schema:
The updated API key details; name and description.
| name required | string non-empty |
| description | string or null |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string"
}Response samples
- 200
- 400
- 403
- 404
- 409
Delete API keys (Admin)
Delete multiple API keys (Admin).
Authorizations:
Request Body schema:
A list of unique identifiers for the API keys to delete.
Responses
Request samples
- Payload
[- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]Response samples
- 404
Get all API keys (Admin)
Get a list of all API keys with pagination and filtering support (Admin).
Authorizations:
query Parameters
| user_id | string <uuid> Filter by user (optional). |
| name | string Api key name used for filtering.
|
| description | string Api key description used for filtering.
|
| sort_by | string Sort by field name (optional). Supported fields:
|
| expired | boolean Expired Api key filter. |
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 400
Add condition
Add a new condition to the system.
Authorizations:
Request Body schema:
The data for the condition to add.
| projectId required | string <uuid> |
| name required | string non-empty |
| description | string or null |
| isActive required | boolean |
Responses
Request samples
- Payload
{- "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
- "name": "string",
- "description": "string",
- "isActive": true
}Response samples
- 200
- 400
- 403
- 404
- 409
- 500
Get all conditions
Get all conditions by project with pagination and filtering support.
Authorizations:
query Parameters
| project_id | string <uuid> Filter by project ID (optional). |
| is_active | boolean Filter by active status (optional). |
| sort_by | string Sort by field name (optional). supported fields: "name", "description", "project.name" "createdDate", "modifiedDate", "isActive" |
| name | string Condition name used for filtering.
|
| description | string Condition description used for filtering.
|
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 400
- 500
Delete conditions
Delete one or more conditions by their IDs.
Authorizations:
Request Body schema:
A list of unique identifiers for the conditions to delete.
Responses
Request samples
- Payload
[- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]Response samples
- 200
- 403
- 404
- 500
Update condition
Update an existing condition by its ID.
Authorizations:
path Parameters
| Conditionid required | string <uuid> The unique identifier of the condition to update. |
Request Body schema:
The updated condition data.
| projectId required | string <uuid> |
| name required | string non-empty |
| description | string or null |
| isActive required | boolean |
Responses
Request samples
- Payload
{- "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
- "name": "string",
- "description": "string",
- "isActive": true
}Response samples
- 200
- 400
- 403
- 404
- 409
- 500
Get condition rules by condition id
Get all rules for a specific condition by its unique identifier with pagination support.
Authorizations:
path Parameters
| conditionId required | string <uuid> The unique identifier of the condition whose rules to retrieve. |
query Parameters
| sort_by | string Sort by field name (optional). supported fields: "Name", "connection.name", "CreatedDate", "ModifiedDate" |
| name | string Condition rule name used for filtering.
|
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 400
- 403
- 404
- 500
Add or update condition rules
Add or update rules for a specific condition.
Authorizations:
path Parameters
| conditionId required | string <uuid> The unique identifier of the condition to update rules for. |
Request Body schema:
The rules to add or update for the condition.
required | Array of objects (ConditionRuleResponseDto) |
Responses
Request samples
- Payload
{- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "conditionId": "1e06e0eb-07f6-4fcd-8750-870cbafd1693",
- "name": "string",
- "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",
- "connection": "string",
- "numberOfValues": 0,
- "conditionRuleValues": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "conditionRuleId": "c1500357-2ca4-46d9-9ef2-7dc5a211829b",
- "type": "string",
- "variable": "string",
- "comparisonValue": "string",
- "chart": "string",
- "chartHasValue": true,
- "operator": "string",
- "lastReloadSuccessful": true,
- "order": 0
}
]
}
]
}Response samples
- 200
- 400
- 403
- 404
- 500
Add or update condition rules
Add or update rules for a specific condition.
Authorizations:
path Parameters
| conditionId required | string <uuid> The unique identifier of the condition to update rules for. |
Request Body schema:
The rules to add or update for the condition.
| id | string <uuid> |
| conditionId required | string <uuid> |
| name required | string non-empty |
| connectionId required | string <uuid> |
| connection | string or null |
| numberOfValues | integer or null <int32> |
Array of objects or null (ConditionRuleValueDto) |
Responses
Request samples
- Payload
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "conditionId": "1e06e0eb-07f6-4fcd-8750-870cbafd1693",
- "name": "string",
- "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",
- "connection": "string",
- "numberOfValues": 0,
- "conditionRuleValues": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "conditionRuleId": "c1500357-2ca4-46d9-9ef2-7dc5a211829b",
- "type": "string",
- "variable": "string",
- "comparisonValue": "string",
- "chart": "string",
- "chartHasValue": true,
- "operator": "string",
- "lastReloadSuccessful": true,
- "order": 0
}
]
}Response samples
- 200
- 400
- 403
- 404
- 500
Get condition rule by condition id and rule id
Get a specific condition rule for a specific condition by its unique identifier.
Authorizations:
path Parameters
| conditionId required | string <uuid> The unique identifier of the condition whose rule to retrieve. |
| ruleId required | string <uuid> The unique identifier of the condition rule to retrieve. |
Responses
Response samples
- 200
- 403
- 404
- 500
Add or update condition rules
Add or update rules for a specific condition.
Authorizations:
path Parameters
| conditionRuleId required | string <uuid> The unique identifier of the condition rule to update. |
Request Body schema:
The rule to update for the condition.
| id | string <uuid> |
| conditionId required | string <uuid> |
| name required | string non-empty |
| connectionId required | string <uuid> |
| connection | string or null |
| numberOfValues | integer or null <int32> |
Array of objects or null (ConditionRuleValueDto) |
Responses
Request samples
- Payload
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "conditionId": "1e06e0eb-07f6-4fcd-8750-870cbafd1693",
- "name": "string",
- "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",
- "connection": "string",
- "numberOfValues": 0,
- "conditionRuleValues": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "conditionRuleId": "c1500357-2ca4-46d9-9ef2-7dc5a211829b",
- "type": "string",
- "variable": "string",
- "comparisonValue": "string",
- "chart": "string",
- "chartHasValue": true,
- "operator": "string",
- "lastReloadSuccessful": true,
- "order": 0
}
]
}Response samples
- 200
- 400
- 403
- 404
- 500
Delete conditions
Delete one or more conditions by their IDs.
Authorizations:
path Parameters
| conditionId required | string <uuid> The unique identifier of the condition whose rules should be deleted. |
Request Body schema:
A list of unique identifiers for the condition rules to delete.
Responses
Request samples
- Payload
[- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]Response samples
- 200
- 400
- 403
- 404
- 500
Add group
Add a new group to the system.
Authorizations:
Request Body schema:
The request object containing group details.
| name required | string non-empty |
| description | string or null |
| organizationId | string or null <uuid> |
| isActive | boolean |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
- "isActive": true
}Response samples
- 200
- 400
- 403
- 409
- 500
Get groups
Get a list of groups.
Authorizations:
query Parameters
| sort_by | string Sort by field name (optional). Available fields: "Name", "Type", "Organization.Name", "Users" "CreatedDate", "ModifiedDate" |
| name | string Group name used for filtering. Optional filter operators can be applied to refine the search:
|
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 403
- 500
Delete multiple groups
Delete multiple groups by their unique identifiers.
Authorizations:
Request Body schema:
The list of group IDs to delete.
Responses
Request samples
- Payload
[- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]Response samples
- 200
- 400
- 403
- 500
Update group
Update an existing group by its unique identifier.
Authorizations:
path Parameters
| id required | string <uuid> The ID of the group to update. |
Request Body schema:
The request object containing updated group details.
| name required | string non-empty |
| description | string or null |
| organizationId | string or null <uuid> |
| isActive | boolean |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
- "isActive": true
}Response samples
- 200
- 400
- 403
- 404
- 409
- 500
Update group members
Update the members of a group.
Authorizations:
Request Body schema:
The request object containing group and user details.
| groupId required | string <uuid> |
| name required | string non-empty |
| description | string or null |
| userIds | Array of strings or null <uuid> [ items <uuid > ] |
Responses
Request samples
- Payload
{- "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
- "name": "string",
- "description": "string",
- "userIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}Response samples
- 200
- 400
- 403
- 404
- 409
- 500
Get files
Get all files in the system (single, iteration and dedicated) with pagination and filtering.
Authorizations:
query Parameters
| sort_by | string Sort by field name (optional). Available fields: "starred", "Type", "Name", "CreatedDate" |
| name | string File name used for filtering (optional). Optional filter operators can be applied to refine the search:
|
| extension | string File extension used for filtering (optional). Optional filter operators can be applied to refine the search:
|
| report.name | string Report name used for filtering (optional). Optional filter operators can be applied to refine the search:
|
| is_iteration | boolean Is iteration file filter (optional). |
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 403
- 500
Get file occurrences
Get all occurrences of a specific file by its unique identifier.
Authorizations:
path Parameters
| id required | string <uuid> The unique identifier of the file. |
query Parameters
| sort_by | string Sort by field name (optional). Available fields: "Type", "Name", "Size", "CreatedDate" |
| name | string File name used for filtering. Optional filter operators can be applied to refine the search:
|
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 404
- 500
Get iteration report files
Get iteration report files for a specific report ID and file extension.
Authorizations:
path Parameters
| id required | string <uuid> The unique identifier of the report. |
| extension required | string The file extension. |
query Parameters
| sort_by | string Sort by field name (optional). Available fields: "starred", "Type", "Name", "Size", "CreatedDate" |
| name | string File name used for filtering. Optional filter operators can be applied to refine the search:
|
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 500
Get favorite files
Get favorite files for the authenticated user with pagination and filtering.
Authorizations:
query Parameters
| sort_by | string Sort by field name (optional). Available fields: "Type", "Name", "CreatedDate" |
| name | string File name used for filtering. Optional filter operators can be applied to refine the search:
|
| extension | string File extension used for filtering (exact match). Optional filter operators can be applied to refine the search:
|
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 403
- 500
Get recent files
Get recent files viewed or added within the last 7 days.
Authorizations:
query Parameters
| sort_by | string Sort by field name (optional). Available fields: "Type", "Name", "CreatedDate" |
| name | string File name used for filtering. Optional filter operators can be applied to refine the search:
|
| extension | string File extension used for filtering (exact match). |
| event_type | string Event type filter: "viewed" or "added" (exact match). |
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 403
- 500
Delete files
Delete multiple files and all their occurrences.
Authorizations:
Request Body schema:
List of files to delete.
| id | string <uuid> |
| reportId | string <uuid> |
| reportName | string or null |
| reportAvailableFormats | Array of strings or null |
| reportDelete | boolean or null |
| isIteration | boolean or null |
| occurrenceId | string or null <uuid> |
| name | string or null |
| fullName | string or null |
| type | string or null |
| extension | string or null |
| thumbnailPath | string or null |
| size | integer or null <int32> |
| starred | boolean or null |
| typeMime | string or null |
| lastStarDate | string or null <date-time> |
| createdDate | string or null <date-time> |
Array of objects or null (FileOccurrencerResponseDto) |
Responses
Request samples
- Payload
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "reportId": "836df459-dc40-4aa1-972a-6eb0a864dff9",
- "reportName": "string",
- "reportAvailableFormats": [
- "string"
], - "reportDelete": true,
- "isIteration": true,
- "occurrenceId": "740a3903-0839-47b4-bce7-bee5e46cbf4a",
- "name": "string",
- "fullName": "string",
- "type": "string",
- "extension": "string",
- "thumbnailPath": "string",
- "size": 0,
- "starred": true,
- "typeMime": "string",
- "lastStarDate": "2019-08-24T14:15:22Z",
- "createdDate": "2019-08-24T14:15:22Z",
- "fileOccurrences": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
- "name": "string",
- "fullName": "string",
- "extension": "string",
- "path": "string",
- "size": 0,
- "typeMime": "string",
- "createdDate": "2019-08-24T14:15:22Z"
}
]
}
]Response samples
- 200
- 400
- 404
- 500
Download file
Download a file or zipped report file.
Authorizations:
query Parameters
| id | string <uuid> The unique identifier of the file to download. |
| isIteration | boolean Default: false Flag indicating whether the file is an iteration report. |
Responses
Response samples
- 200
- 404
- 500
Update hub configuration
Update an existing hub configuration by its unique identifier.
Authorizations:
path Parameters
| id required | string <uuid> The unique identifier of the hub configuration to update. |
Request Body schema:
The updated hub configuration data.
| fromEmail required | string non-empty |
| fromName required | string non-empty |
| customEmailFooter | string or null |
| hideSubsciptionLink | boolean |
Responses
Request samples
- Payload
{- "fromEmail": "string",
- "fromName": "string",
- "customEmailFooter": "string",
- "hideSubsciptionLink": true
}Response samples
- 200
- 400
- 404
- 500
Add folder
Add a new folder to the hub.
Authorizations:
Request Body schema:
The data for the folder to add.
| parentId | string or null <uuid> |
| name required | string non-empty |
| parentUrl required | string non-empty |
| location required | string non-empty |
Responses
Request samples
- Payload
{- "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
- "name": "string",
- "parentUrl": "string",
- "location": "string"
}Response samples
- 200
- 400
- 409
Get folders
Get all folders, optionally excluding a specific folder or the root folder.
Authorizations:
query Parameters
| exceptFolderId | string <uuid> Optional folder ID to exclude from the results. |
| exceptRoot | boolean Default: false If true, excludes the root folder from the results. |
Responses
Response samples
- 200
- 500
Update folder
Update an existing folder by its unique identifier.
Authorizations:
path Parameters
| HubFolderId required | string <uuid> The unique identifier of the folder to update. |
Request Body schema:
The updated folder data.
| parentId | string or null <uuid> |
| name required | string non-empty |
| parentUrl required | string non-empty |
| location required | string non-empty |
Responses
Request samples
- Payload
{- "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
- "name": "string",
- "parentUrl": "string",
- "location": "string"
}Response samples
- 200
- 400
- 404
- 409
Get folders except root.
Authorizations:
query Parameters
| sort_by | string Sort by field name (optional). Available fields: "Name", "ParentUrl" |
| name | string Folder name used for filtering. Optional filter operators can be applied to refine the search:
|
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 500
Delete folders
Delete one or more folders by their unique identifiers.
Authorizations:
Request Body schema:
A list of unique identifiers for the folders to delete.
Responses
Request samples
- Payload
[- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]Response samples
- 200
- 400
- 403
- 404
- 500
Get all identity providers
Get a list of all identity providers in the system.
Authorizations:
query Parameters
| sort_by | string Sort by field name (optional). Available fields: "Name", "Description", "Type" |
| name | string Identity provider name used for filtering. Optional filter operators can be applied to refine the search:
|
| description | string Identity provider description used for filtering. Optional filter operators can be applied to refine the search:
|
| type | string Identity provider type used for filtering (e.g., "SAML", "JWT"). Optional filter operators can be applied to refine the search:
|
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 500
Delete identity providers
Delete multiple identity providers by their unique identifiers.
Authorizations:
Request Body schema:
List of identity provider identifiers to delete.
Responses
Request samples
- Payload
[- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]Response samples
- 200
- 400
- 403
- 404
- 500
Add identity provider
Add a new identity provider to the system.
Authorizations:
Request Body schema:
The identity provider details to create.
| name required | string non-empty |
| description | string or null |
| signAuthnRequest | boolean |
| entityID | string or null |
| singleSignOnUrl | string or null |
| type required | string non-empty |
| certificatePublicKey | string or null |
| singleLogoutUrl | string or null |
| certificateFile | string or null |
| buttonLabel | string or null |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "signAuthnRequest": true,
- "entityID": "string",
- "singleSignOnUrl": "string",
- "type": "string",
- "certificatePublicKey": "string",
- "singleLogoutUrl": "string",
- "certificateFile": "string",
- "buttonLabel": "string"
}Response samples
- 200
- 400
- 403
- 409
- 500
Update identity provider
Update an existing identity provider by its unique identifier.
Authorizations:
path Parameters
| id required | string <uuid> The ID of the identity provider to update. |
Request Body schema:
The updated identity provider details.
| name required | string non-empty |
| description | string or null |
| signAuthnRequest | boolean |
| entityID | string or null |
| singleSignOnUrl | string or null |
| type required | string non-empty |
| certificatePublicKey | string or null |
| singleLogoutUrl | string or null |
| certificateFile | string or null |
| buttonLabel | string or null |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "signAuthnRequest": true,
- "entityID": "string",
- "singleSignOnUrl": "string",
- "type": "string",
- "certificatePublicKey": "string",
- "singleLogoutUrl": "string",
- "certificateFile": "string",
- "buttonLabel": "string"
}Response samples
- 200
- 400
- 403
- 404
- 409
- 500
Add organization
Add a new organization to the system.
Authorizations:
Request Body schema:
The data for the organization to add.
| name | string or null |
| displayName required | string non-empty |
| description | string or null |
| themeId required | string <uuid> |
Responses
Request samples
- Payload
{- "name": "string",
- "displayName": "string",
- "description": "string",
- "themeId": "53fe7fb9-b3ba-4541-bf79-a49c12f44b76"
}Response samples
- 201
- 400
- 403
- 404
- 409
- 500
Get all organizations
Get a list of all organizations.
Authorizations:
query Parameters
| sort_by | string Sort by field name (optional). Available fields: "Name", "DisplayName", "Description" |
| name | string Organization name used for filtering. Optional filter operators can be applied to refine the search:
|
| description | string Organization description used for filtering. Optional filter operators can be applied to refine the search:
|
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 500
Update organization
Update an existing organization by its unique identifier.
Authorizations:
path Parameters
| id required | string <uuid> The ID of the organization to update. |
Request Body schema:
The updated organization data.
| name | string or null |
| displayName required | string non-empty |
| description | string or null |
| themeId required | string <uuid> |
Responses
Request samples
- Payload
{- "name": "string",
- "displayName": "string",
- "description": "string",
- "themeId": "53fe7fb9-b3ba-4541-bf79-a49c12f44b76"
}Response samples
- 200
- 400
- 404
- 409
- 500
Get organization projects
Get all projects for a specific organization with optional filtering, sorting, and pagination.
Authorizations:
path Parameters
| id required | string <uuid> The ID of the organization. |
query Parameters
| sort_by | string Sort by field name (optional). Available fields: "Name", "Description" |
| name | string Project name used for filtering. Optional filter operators can be applied to refine the search:
|
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 404
- 500
Get organization members
Get all members of a specific organization with optional filtering, sorting, and pagination.
Authorizations:
path Parameters
| id required | string <uuid> The ID of the organization. |
query Parameters
| sort_by | string Sort by field name (optional). Available fields: "Type", "Name", "Email" |
| name | string Member name used for filtering. Optional filter operators can be applied to refine the search:
|
| type | string Member type used for filtering. Available types : "user", "group". |
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 404
- 500
Get organization resources
Get all resources of a specific organization with optional filtering, sorting, and pagination.
Authorizations:
path Parameters
| id required | string <uuid> The ID of the organization. |
query Parameters
| sort_by | string Sort by field name (optional). Available fields: "Name", "Description", "Url" |
| name | string Resource name used for filtering. Optional filter operators can be applied to refine the search:
|
| description | string Resource description used for filtering. Optional filter operators can be applied to refine the search:
|
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 404
- 500
Get organization Qlik apps
Get all Qlik apps of a specific organization with optional filtering, sorting, and pagination.
Authorizations:
path Parameters
| id required | string <uuid> The ID of the organization. |
query Parameters
| sort_by | string Sort by field name (optional). Available fields: "Name", "Stream" |
| name | string QlikApp name used for filtering. Optional filter operators can be applied to refine the search:
|
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 404
- 500
Update organization Qlik apps
Update Qlik apps of a specific organization.
Authorizations:
path Parameters
| id required | string <uuid> The ID of the organization. |
Request Body schema:
The updated list of Qlik apps.
| id | string <uuid> |
| appId | string or null |
| name | string or null |
| description | string or null |
| stream | string or null |
| folder | string or null |
Responses
Request samples
- Payload
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "appId": "string",
- "name": "string",
- "description": "string",
- "stream": "string",
- "folder": "string"
}
]Response samples
- 200
- 400
- 404
- 500
Get Qlik apps without organization
Get all Qlik apps that are not associated with any organization with optional filtering, sorting, and pagination.
Authorizations:
query Parameters
| sort_by | string Sort by field name (optional). Available fields: "Name", "Stream" |
| name | string QlikApp name used for filtering. Optional filter operators can be applied to refine the search:
|
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 500
Update organization authentications
Update authentication details of a specific organization.
Authorizations:
path Parameters
| id required | string <uuid> The ID of the organization. |
Request Body schema:
The updated authentication details.
| allowNtlm | boolean |
| allowJwt | boolean |
Array of objects or null (IdentityProviderResponseInfoDto) |
Responses
Request samples
- Payload
{- "allowNtlm": true,
- "allowJwt": true,
- "identityProviders": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "isAactive": true,
- "createdDate": "2019-08-24T14:15:22Z"
}
]
}Response samples
- 200
- 400
- 404
- 500
Delete organizations
Delete organizations by their unique identifiers.
Authorizations:
Request Body schema:
A list of organization IDs to delete.
Responses
Request samples
- Payload
[- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]Response samples
- 200
- 400
- 403
- 404
- 500
Get projects
Get a list of all projects with pagination and filtering.
Authorizations:
query Parameters
| organization_id | string <uuid> Filter by organization name (optional) |
| modified_by | string Filter by modified by user (optional) : exact match. |
| is_active | boolean Filter by active status (optional) |
| sort_by | string Sort by field name (optional). Available fields: "Name", "Description", "Organization.name", "IsActive", "Tasks", "CreatedDate", "ModifiedDate" |
| name | string Project name used for filtering.
|
| description | string Project description used for filtering. Optional filter operators can be applied to refine the search:
|
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 500
Delete projects
Delete one or more projects.
Authorizations:
query Parameters
| deleteFiles | boolean Whether to delete associated files. |
Request Body schema:
A list of project IDs to delete.
| id required | string <uuid> |
| name required | string non-empty |
Responses
Request samples
- Payload
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
]Response samples
- 200
- 400
- 403
- 500
Add Qlik app
Create a new Qlik app.
Authorizations:
Request Body schema:
The data for the Qlik app to add.
| appId required | string non-empty |
| name required | string non-empty |
| description | string or null |
| folderId required | string <uuid> |
| folderPath required | string non-empty |
| stream | string or null |
| mashupTemplate | string or null |
| allowQlikSenseApp required | boolean |
| allowMashup required | boolean |
| defaultOpen required | string non-empty |
| templateTitle | string or null |
| templateDescription | string or null |
| themeId | string or null |
| organizationId | string or null <uuid> |
Array of objects or null (QlikFieldRequestDto) | |
Array of objects or null (QlikAppSheetsRequestDto) |
Responses
Request samples
- Payload
{- "appId": "string",
- "name": "string",
- "description": "string",
- "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
- "folderPath": "string",
- "stream": "string",
- "mashupTemplate": "string",
- "allowQlikSenseApp": true,
- "allowMashup": true,
- "defaultOpen": "string",
- "templateTitle": "string",
- "templateDescription": "string",
- "themeId": "string",
- "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
- "usedFields": [
- {
- "name": "string",
- "order": 0,
- "appId": "string"
}
], - "usedSheets": [
- {
- "sheetId": "string",
- "sheetName": "string",
- "showSelection": true,
- "groupName": "string",
- "order": 0
}
]
}Response samples
- 200
- 400
- 404
- 500
Get all Qlik apps
Get a list of all Qlik apps with pagination and filtering.
Authorizations:
query Parameters
| sort_by | string Sort by field name (optional). Available fields: "Name", "Stream", "FolderPath", "MashupTemplate" |
| name | string QlikApp name used for filtering. Optional filter operators can be applied to refine the search:
|
| stream | string QlikApp stream used for filtering. Optional filter operators can be applied to refine the search:
|
| folder_id | string <uuid> QlikApp folderId used for filtering (exact match). |
| mashup_template | string QlikApp mashupTemplate used for filtering. Optional filter operators can be applied to refine the search:
|
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 500
Update Qlik app
Update an existing Qlik app by its unique identifier.
Authorizations:
path Parameters
| id required | string <uuid> The unique identifier of the Qlik app to update. |
Request Body schema:
The updated Qlik app data.
| appId required | string non-empty |
| name required | string non-empty |
| description | string or null |
| folderId required | string <uuid> |
| folderPath required | string non-empty |
| stream | string or null |
| mashupTemplate | string or null |
| allowQlikSenseApp required | boolean |
| allowMashup required | boolean |
| defaultOpen required | string non-empty |
| templateTitle | string or null |
| templateDescription | string or null |
| themeId | string or null |
| organizationId | string or null <uuid> |
Array of objects or null (QlikFieldRequestDto) | |
Array of objects or null (QlikAppSheetsRequestDto) |
Responses
Request samples
- Payload
{- "appId": "string",
- "name": "string",
- "description": "string",
- "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
- "folderPath": "string",
- "stream": "string",
- "mashupTemplate": "string",
- "allowQlikSenseApp": true,
- "allowMashup": true,
- "defaultOpen": "string",
- "templateTitle": "string",
- "templateDescription": "string",
- "themeId": "string",
- "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
- "usedFields": [
- {
- "name": "string",
- "order": 0,
- "appId": "string"
}
], - "usedSheets": [
- {
- "sheetId": "string",
- "sheetName": "string",
- "showSelection": true,
- "groupName": "string",
- "order": 0
}
]
}Response samples
- 200
- 400
- 404
- 500
Get Qlik apps of folder
Get Qlik apps of a specific folder or the root folder.
Authorizations:
path Parameters
| folderId required | string <uuid> The unique identifier of the folder (optional). |
query Parameters
| name | string Filter by recipient name (optional). Optional filter operators can be applied to refine the search:
|
| ofRoot | boolean Default: false If true, retrieves Qlik apps of the root folder. |
Responses
Response samples
- 200
- 403
- 404
- 500
Update Qlik app synchronization
Update the synchronization information of a Qlik app.
Authorizations:
path Parameters
| id required | string <uuid> The unique identifier of the Qlik app. |
Request Body schema:
The updated synchronization information.
| defaultFolderUrl | string or null |
| defaultFolderId | string or null <uuid> |
| qlikSenseServer | string or null |
| qlikSenseAdminUser | string or null |
object (ScheduleRequestDto) |
Responses
Request samples
- Payload
{- "defaultFolderUrl": "string",
- "defaultFolderId": "1f1371df-c978-4137-ba84-9ead709b283b",
- "qlikSenseServer": "string",
- "qlikSenseAdminUser": "string",
- "schedule": {
- "name": "string",
- "isActive": true,
- "frequency": "string",
- "execution": "string",
- "priority": 0,
- "timeZone": "string",
- "day": 0,
- "month": 0,
- "atHour": 0,
- "atMinut": 0,
- "everyHours": 0,
- "fromHour": 0,
- "fromMinut": 0,
- "toHour": 0,
- "weeklyDays": "string",
- "timeZoneOfset": "string",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}
}Response samples
- 200
- 400
- 404
- 500
Get reports
Get a list of reports associated with the authenticated user with pagination and filtering.
Authorizations:
query Parameters
| project_id | string <uuid> Filter by project ID (optional) |
| sort_by | string Sort by field name (optional). Available fields: "Name", "Description", "Type", "Project.Name", "IsIteration" |
| name | string Report name used for filtering.
|
| description | string Report description used for filtering.
|
| type | string Filter by report type (optional) |
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 500
Get all resources
Get a list of all resources.
Authorizations:
query Parameters
| sort_by | string Sort by field name (optional). Example: "name", "description", "type", "url", "createdDate", "modifiedDate" |
| name | string Resource name used for filtering.
|
| description | string Resource description used for filtering.
|
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 500
Add resource
Add a new resource to the system.
Authorizations:
Request Body schema:
The resource details to add.
| name required | string non-empty |
| description | string or null |
| type required | string non-empty |
| organizationId required | string <uuid> |
| url required | string non-empty |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "type": "string",
- "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
- "url": "string"
}Response samples
- 200
- 400
- 404
- 409
- 500
Get user resources
Get resources specific to the authenticated user.
Authorizations:
query Parameters
| sort_by | string Sort by field name (optional). Example: "name", "description", "type", "url", "createdDate", "modifiedDate" |
| name | string Resource name used for filtering.
|
| description | string Resource description used for filtering.
|
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 403
- 500
Delete resources
Delete resources by their unique identifiers.
Authorizations:
path Parameters
| resourceIds required | string |
Request Body schema:
List of resource IDs to delete.
Responses
Request samples
- Payload
[- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]Response samples
- 200
- 400
- 404
- 500
Update resource
Update an existing resource by its unique identifier.
Authorizations:
path Parameters
| id required | string <uuid> The ID of the resource to update. |
Request Body schema:
The updated resource details.
| name required | string non-empty |
| description | string or null |
| type required | string non-empty |
| organizationId required | string <uuid> |
| url required | string non-empty |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "type": "string",
- "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
- "url": "string"
}Response samples
- 200
- 400
- 404
- 409
- 500
Get roles
Get a list of roles
Authorizations:
query Parameters
| sort_by | string Sort by field name (optional). Available fields: "Name", "Type", "CreatedDate", "ModifiedDate" |
| name | string Group name used for filtering. Optional filter operators can be applied to refine the search:
|
| is_active | boolean Role IsActive field used for filtering. |
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 500
Add role
Add a new role to the system.
Authorizations:
Request Body schema:
The data for the role to add.
| name required | string non-empty |
| description | string or null |
| allProjects | boolean |
Array of objects or null (BaseEntityInfo) | |
required | object (PermissionDto) |
| isActive required | boolean |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "allProjects": true,
- "projects": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
], - "permissions": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "viewProject": true,
- "importProject": true,
- "updateProject": true,
- "deleteProject": true,
- "viewTask": true,
- "createTask": true,
- "editTask": true,
- "deleteTask": true,
- "runTask": true,
- "viewTaskStatus": true,
- "viewUser": true,
- "createUser": true,
- "editUser": true,
- "deleteUser": true,
- "viewGroup": true,
- "createGroup": true,
- "editGroup": true,
- "deleteGroup": true,
- "viewUserDirectory": true,
- "createUserDirectory": true,
- "editUserDirectory": true,
- "deleteUserDirectory": true,
- "viewSystem": true,
- "createSystem": true,
- "editSystem": true,
- "deleteSystem": true,
- "viewSettings": true,
- "editSettings": true,
- "useApiKeys": true,
- "previewPublishedReport": true,
- "downloadPublishedReport": true,
- "subscribePublishedReport": true,
- "deletePublishedReport": true,
- "viewCondition": true,
- "createCondition": true,
- "editCondition": true,
- "deleteCondition": true,
- "enterprise": true,
- "createdDate": "2019-08-24T14:15:22Z",
- "modifiedDate": "2019-08-24T14:15:22Z"
}, - "isActive": true
}Response samples
- 200
- 400
- 403
- 409
- 500
Get roles info
Get simplified roles info (ID + Name).
Authorizations:
query Parameters
| sort_by | string Sort by field name (optional). Available fields: "Name", "Type", "CreatedDate", "ModifiedDate" |
| name | string Group name used for filtering. Optional filter operators can be applied to refine the search:
|
| is_active | boolean Role IsActive field used for filtering. |
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 500
Update role
Update an existing role by its unique identifier.
Authorizations:
path Parameters
| id required | string <uuid> The unique identifier of the role to update. |
Request Body schema:
The updated role data.
| name required | string non-empty |
| description | string or null |
| allProjects | boolean |
Array of objects or null (BaseEntityInfo) | |
required | object (PermissionDto) |
| isActive required | boolean |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "allProjects": true,
- "projects": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
], - "permissions": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "viewProject": true,
- "importProject": true,
- "updateProject": true,
- "deleteProject": true,
- "viewTask": true,
- "createTask": true,
- "editTask": true,
- "deleteTask": true,
- "runTask": true,
- "viewTaskStatus": true,
- "viewUser": true,
- "createUser": true,
- "editUser": true,
- "deleteUser": true,
- "viewGroup": true,
- "createGroup": true,
- "editGroup": true,
- "deleteGroup": true,
- "viewUserDirectory": true,
- "createUserDirectory": true,
- "editUserDirectory": true,
- "deleteUserDirectory": true,
- "viewSystem": true,
- "createSystem": true,
- "editSystem": true,
- "deleteSystem": true,
- "viewSettings": true,
- "editSettings": true,
- "useApiKeys": true,
- "previewPublishedReport": true,
- "downloadPublishedReport": true,
- "subscribePublishedReport": true,
- "deletePublishedReport": true,
- "viewCondition": true,
- "createCondition": true,
- "editCondition": true,
- "deleteCondition": true,
- "enterprise": true,
- "createdDate": "2019-08-24T14:15:22Z",
- "modifiedDate": "2019-08-24T14:15:22Z"
}, - "isActive": true
}Response samples
- 200
- 400
- 403
- 404
- 409
- 500
Update authentication configuration
Update the authentication methods (JWT / NTLM).
Authorizations:
Request Body schema:
The updated authentication configuration.
| jwtAuth required | boolean |
| ntlmAuth required | boolean |
Responses
Request samples
- Payload
{- "jwtAuth": true,
- "ntlmAuth": true
}Response samples
- 200
- 400
- 404
- 500
Add SMTP server
Add a new SMTP server.
Authorizations:
Request Body schema:
| name required | string non-empty |
| description | string or null |
| fromAddress | string or null |
| fromName required | string non-empty |
| emailPrefix | string or null |
| hostName required | string non-empty |
| smtpPort required | integer <int32> |
| ssl | boolean |
| userName | string or null |
| password | string or null |
| testEmail | string or null |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "fromAddress": "string",
- "fromName": "string",
- "emailPrefix": "string",
- "hostName": "string",
- "smtpPort": 0,
- "ssl": true,
- "userName": "string",
- "password": "string",
- "testEmail": "string"
}Response samples
- 200
- 400
- 409
- 500
Update SMTP server
Update an existing SMTP server by its unique identifier.
Authorizations:
path Parameters
| id required | string <uuid> |
Request Body schema:
| name required | string non-empty |
| description | string or null |
| fromAddress | string or null |
| fromName required | string non-empty |
| emailPrefix | string or null |
| hostName required | string non-empty |
| smtpPort required | integer <int32> |
| ssl | boolean |
| userName | string or null |
| password | string or null |
| testEmail | string or null |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "fromAddress": "string",
- "fromName": "string",
- "emailPrefix": "string",
- "hostName": "string",
- "smtpPort": 0,
- "ssl": true,
- "userName": "string",
- "password": "string",
- "testEmail": "string"
}Response samples
- 200
- 400
- 404
- 500
Tests the connection to an SMTP server using the provided configuration.
Authorizations:
Request Body schema:
The SMTP server configuration to test.
| name required | string non-empty |
| description | string or null |
| fromAddress | string or null |
| fromName required | string non-empty |
| emailPrefix | string or null |
| hostName required | string non-empty |
| smtpPort required | integer <int32> |
| ssl | boolean |
| userName | string or null |
| password | string or null |
| testEmail | string or null |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "fromAddress": "string",
- "fromName": "string",
- "emailPrefix": "string",
- "hostName": "string",
- "smtpPort": 0,
- "ssl": true,
- "userName": "string",
- "password": "string",
- "testEmail": "string"
}Response samples
- 200
- 400
- 500
Get task statuses
Get a list of available task statuses.
Authorizations:
query Parameters
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 500
Get requests statuses
Get a list of available request statuses.
Authorizations:
query Parameters
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 500
Generate report on-demand
Generates and executes an on-demand report request with selections and filters.
Authorizations:
Request Body schema:
The on-demand request containing report configuration, selections, and options.
| id | string <uuid> |
| type | string or null |
object (OnDemandRequestConfig) | |
Array of objects or null (FieldSelection) | |
| appId | string or null |
| ignoreExistingFilters | boolean |
| overrideReportApp | boolean |
Responses
Request samples
- Payload
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "string",
- "config": {
- "reportId": "836df459-dc40-4aa1-972a-6eb0a864dff9",
- "outputFormat": "string"
}, - "selections": [
- {
- "fieldName": "string",
- "selectedCount": 0,
- "selectedValues": [
- "string"
], - "isNumeric": true
}
], - "appId": "string",
- "ignoreExistingFilters": true,
- "overrideReportApp": true
}Response samples
- 200
- 400
- 404
- 500
Get all file storage services
Get all file storage services, optionally filtered by type.
Authorizations:
query Parameters
| sort_by | string Sort by field name (optional). Available fields: "Name", "Description", "Type", "IsDefault" |
| name | string File storage service name used for filtering. Optional filter operators can be applied to refine the search:
|
| description | string File storage service description used for filtering. Optional filter operators can be applied to refine the search:
|
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 500
Delete multiple file storage services by their IDs
Delete multiple file storage services by their unique identifiers.
Authorizations:
Request Body schema:
The list of IDs of the file storage services to delete.
Responses
Request samples
- Payload
[- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]Response samples
- 200
- 400
- 403
- 404
- 500
Add subscription
Create a new subscription (destination).
Authorizations:
Request Body schema:
The destination data.
| name | string or null |
| description | string or null |
| triggerType required | string non-empty |
| type required | string non-empty |
Array of objects or null (SubscriptionReportDto) | |
object (SubscriptionQlikEntityDto) | |
| format | string or null |
object (ScheduleRequestDto) | |
object (ExternalEventRequestDto) | |
Array of objects or null (SubscriptionRecipientDto) | |
| subscribeTo | string or null |
object (SubscriptionFilterDto) | |
required | object (SubscriptionEmailDto) |
| isActive | boolean |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "triggerType": "string",
- "type": "string",
- "reports": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "formats": [
- "string"
], - "zipEmailFiles": true,
- "emailAttachment": true,
- "emailEmbedment": true,
- "filter": {
- "selections": [
- {
- "fieldName": "string",
- "selectedCount": 0,
- "selectedValues": [
- "string"
], - "isNumeric": true
}
], - "selectionsPreview": "string",
- "bookmarkId": "string",
- "bookmarkName": "string",
- "appId": "string",
- "serverAddress": "string"
}
}
], - "qlikEntity": {
- "id": "string",
- "appId": "string",
- "serverAddress": "string",
- "type": "string",
- "format": "string",
- "width": 0.1,
- "height": 0.1
}, - "format": "string",
- "schedule": {
- "name": "string",
- "isActive": true,
- "frequency": "string",
- "execution": "string",
- "priority": 0,
- "timeZone": "string",
- "day": 0,
- "month": 0,
- "atHour": 0,
- "atMinut": 0,
- "everyHours": 0,
- "fromHour": 0,
- "fromMinut": 0,
- "toHour": 0,
- "weeklyDays": "string",
- "timeZoneOfset": "string",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}, - "externalEvent": {
- "name": "string",
- "description": "string",
- "appId": "string",
- "isActive": true,
- "execution": "string",
- "priority": 0,
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}, - "recipients": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "fullName": "string",
- "email": "string",
- "type": "string"
}
], - "subscribeTo": "string",
- "filter": {
- "selections": [
- {
- "fieldName": "string",
- "selectedCount": 0,
- "selectedValues": [
- "string"
], - "isNumeric": true
}
], - "selectionsPreview": "string",
- "bookmarkId": "string",
- "bookmarkName": "string",
- "appId": "string",
- "serverAddress": "string"
}, - "email": {
- "bc": "string",
- "bcc": "string",
- "ccQlikVariableId": "009367f7-7731-4b42-80ba-c925ab8a19ec",
- "bccQlikVariableId": "5b8685b6-bf7c-447b-9ff3-8f7f5a2e0bf8",
- "subject": "string",
- "message": "string"
}, - "isActive": true
}Response samples
- 200
- 400
- 404
- 409
- 500
Get subscriptions
Get all subscriptions for the current user with support for pagination, filtering by name and type, and sorting.
Authorizations:
query Parameters
| sort_by | string Sort by field name (optional). Available fields: "subscribeTo", "Type", "Subject", "triggerType", "lastExecutionDate", "nextExecutionDate" |
| subscribe_to | string Subscribe_to used for filtering by title of the subscription.
|
| type | string Filter by subscription type (Report, MultipleReports, QlikEntity) Optional filter operators can be applied to refine the search:
|
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 403
- 500
Delete subscriptions
Delete one or more subscriptions by their unique identifiers.
Authorizations:
Request Body schema:
A list of subscription IDs to delete.
Responses
Request samples
- Payload
[- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]Response samples
- 200
- 400
- 403
- 404
- 500
Update subscription
Update an existing subscription (destination).
Authorizations:
path Parameters
| SubcriptionId required | string <uuid> The unique identifier of the subscription to update. |
Request Body schema:
The destination data.
| name | string or null |
| description | string or null |
| triggerType required | string non-empty |
| type required | string non-empty |
Array of objects or null (SubscriptionReportDto) | |
object (SubscriptionQlikEntityDto) | |
| format | string or null |
object (ScheduleRequestDto) | |
object (ExternalEventRequestDto) | |
Array of objects or null (SubscriptionRecipientDto) | |
| subscribeTo | string or null |
object (SubscriptionFilterDto) | |
required | object (SubscriptionEmailDto) |
| isActive | boolean |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "triggerType": "string",
- "type": "string",
- "reports": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "formats": [
- "string"
], - "zipEmailFiles": true,
- "emailAttachment": true,
- "emailEmbedment": true,
- "filter": {
- "selections": [
- {
- "fieldName": "string",
- "selectedCount": 0,
- "selectedValues": [
- "string"
], - "isNumeric": true
}
], - "selectionsPreview": "string",
- "bookmarkId": "string",
- "bookmarkName": "string",
- "appId": "string",
- "serverAddress": "string"
}
}
], - "qlikEntity": {
- "id": "string",
- "appId": "string",
- "serverAddress": "string",
- "type": "string",
- "format": "string",
- "width": 0.1,
- "height": 0.1
}, - "format": "string",
- "schedule": {
- "name": "string",
- "isActive": true,
- "frequency": "string",
- "execution": "string",
- "priority": 0,
- "timeZone": "string",
- "day": 0,
- "month": 0,
- "atHour": 0,
- "atMinut": 0,
- "everyHours": 0,
- "fromHour": 0,
- "fromMinut": 0,
- "toHour": 0,
- "weeklyDays": "string",
- "timeZoneOfset": "string",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}, - "externalEvent": {
- "name": "string",
- "description": "string",
- "appId": "string",
- "isActive": true,
- "execution": "string",
- "priority": 0,
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}, - "recipients": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "fullName": "string",
- "email": "string",
- "type": "string"
}
], - "subscribeTo": "string",
- "filter": {
- "selections": [
- {
- "fieldName": "string",
- "selectedCount": 0,
- "selectedValues": [
- "string"
], - "isNumeric": true
}
], - "selectionsPreview": "string",
- "bookmarkId": "string",
- "bookmarkName": "string",
- "appId": "string",
- "serverAddress": "string"
}, - "email": {
- "bc": "string",
- "bcc": "string",
- "ccQlikVariableId": "009367f7-7731-4b42-80ba-c925ab8a19ec",
- "bccQlikVariableId": "5b8685b6-bf7c-447b-9ff3-8f7f5a2e0bf8",
- "subject": "string",
- "message": "string"
}, - "isActive": true
}Response samples
- 200
- 400
- 403
- 404
- 409
- 500
Get user subscriptions
Get all subscriptions for the current user.
Authorizations:
query Parameters
| name | string Filter by subscription site name (supports search operators via query string) Example: ?name[contains]=site or ?name[equals]=MySite |
| sort_by | string Sort field: "name", "createddate", "modifieddate". Default is "name" |
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 403
- 500
Add task
Add a new task.
Authorizations:
Request Body schema:
The task data to add.
| name required | string non-empty |
| projectId required | string <uuid> |
| description | string or null |
Responses
Request samples
- Payload
{- "name": "string",
- "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
- "description": "string"
}Response samples
- 201
- 400
- 404
- 409
- 500
Get tasks
Authorizations:
query Parameters
| project_id | string <uuid> Filter by project ID (optional). |
| is_active | boolean Filter by active status (optional). |
| is_scheduled | boolean Filter by scheduled status (optional). |
| name | string Task name used for filtering.
|
| description | string Task description used for filtering.
|
| sort_by | string Sort by field name (optional). Supported fields:
|
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 500
Update task
Update an existing task.
Authorizations:
path Parameters
| id required | string <uuid> The unique identifier of the task. |
Request Body schema:
The updated task data.
| name required | string non-empty |
| description | string or null |
| isActive required | boolean |
| sendNotifications | boolean |
| notifyIfError | boolean |
| notifyIfWarning | boolean |
| notifyIfSuccess | boolean |
| notificationRecipients | string or null |
| notificationCc | string or null |
| notificationBcc | string or null |
| testMode | boolean |
| testModeRecipients | string or null |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "isActive": true,
- "sendNotifications": true,
- "notifyIfError": true,
- "notifyIfWarning": true,
- "notifyIfSuccess": true,
- "notificationRecipients": "string",
- "notificationCc": "string",
- "notificationBcc": "string",
- "testMode": true,
- "testModeRecipients": "string"
}Response samples
- 200
- 400
- 404
- 500
Duplicate task
Duplicate an existing task by its unique identifier.
Authorizations:
path Parameters
| id required | string <uuid> The unique identifier of the task to duplicate. |
Request Body schema:
The request data for duplicating the task (To Overwrite report apps).
| newName | string or null |
Array of objects or null (OverwriteReportAppsDto) |
Responses
Request samples
- Payload
{- "newName": "string",
- "overwriteReportApps": [
- {
- "reportId": "836df459-dc40-4aa1-972a-6eb0a864dff9",
- "qlikApps": [
- {
- "qlikAppId": "c8e142ed-5c22-4064-87da-aac893bd9e5b",
- "newQlikAppId": "b99f706c-8be1-4727-98ff-d7031402bcd1"
}
]
}
]
}Response samples
- 200
- 400
- 404
- 409
- 500
Enable or disable tasks
Enable or disable tasks.
Authorizations:
Request Body schema:
A list of tasks to enable or disable.
| id required | string <uuid> |
| isActive required | boolean |
Responses
Request samples
- Payload
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "isActive": true
}
]Response samples
- 200
- 400
- 403
- 404
- 500
Get task reports
Authorizations:
path Parameters
| id required | string <uuid> The unique identifier of the task. |
query Parameters
| selected_format_id | string Filter by selected format ID (optional). |
| sort_by | string Sort by field name (optional). Supported fields: "format", "createdDate", etc. |
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 403
- 404
- 500
/api/v2/tasks/{taskId}/reports
Authorizations:
path Parameters
| taskId required | string <uuid> |
Request Body schema:
| reportId required | string <uuid> |
| format required | string non-empty |
| zipFolderFiles | boolean |
| zipEmailFiles | boolean |
| evaluateConditionForEachIteration | boolean |
| folderVariable | string or null |
| recipientsVariable | string or null |
| ftpVariable | string or null |
| hubAuthorizedUserVariable | string or null |
| dropboxVariable | string or null |
| onedriveVariable | string or null |
| googledriveVariable | string or null |
| emailAttachment | boolean |
| emailEmbedment | boolean |
| publishToQalyptusHub | boolean |
| maxFileOccurrences | integer <int32> |
| secureOutputFiles | boolean |
| fileOpenPassword | string or null |
| fileWritePassword | string or null |
| isOpenFilePasswordProtected | boolean |
| isWriteFilePasswordProtected | boolean |
Array of objects or null (ReportConditionDto) | |
Array of objects or null (ReportFilterDto) | |
Array of objects or null (ReportStorageServiceDto) | |
Array of objects or null (TaskReportFolderDto) | |
Array of objects or null (OverwriteReportAppsDto) |
Responses
Request samples
- Payload
{- "reportId": "836df459-dc40-4aa1-972a-6eb0a864dff9",
- "format": "string",
- "zipFolderFiles": true,
- "zipEmailFiles": true,
- "evaluateConditionForEachIteration": true,
- "folderVariable": "string",
- "recipientsVariable": "string",
- "ftpVariable": "string",
- "hubAuthorizedUserVariable": "string",
- "dropboxVariable": "string",
- "onedriveVariable": "string",
- "googledriveVariable": "string",
- "emailAttachment": true,
- "emailEmbedment": true,
- "publishToQalyptusHub": true,
- "maxFileOccurrences": 0,
- "secureOutputFiles": true,
- "fileOpenPassword": "string",
- "fileWritePassword": "string",
- "isOpenFilePasswordProtected": true,
- "isWriteFilePasswordProtected": true,
- "reportConditions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "taskReportId": "ad6383c6-c2fc-41b1-a0db-20eb065c3d31",
- "conditionId": "1e06e0eb-07f6-4fcd-8750-870cbafd1693"
}
], - "reportFilters": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "taskReportId": "ad6383c6-c2fc-41b1-a0db-20eb065c3d31",
- "filterId": "aff0ee0f-f371-4b82-82c6-dc3b96f05c91",
- "order": 0
}
], - "reportStorageServices": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "fileStorageServiceId": "ec26fc06-bcc1-4aad-941e-cddbc71126f5",
- "path": "string",
- "sharePointSiteUrl": "string",
- "order": 0
}
], - "reportFolders": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "taskReportId": "ad6383c6-c2fc-41b1-a0db-20eb065c3d31",
- "path": "string"
}
], - "overwriteReportApps": [
- {
- "reportId": "836df459-dc40-4aa1-972a-6eb0a864dff9",
- "qlikApps": [
- {
- "qlikAppId": "c8e142ed-5c22-4064-87da-aac893bd9e5b",
- "newQlikAppId": "b99f706c-8be1-4727-98ff-d7031402bcd1"
}
]
}
]
}Response samples
- 200
- 400
- 404
- 409
- 500
Update task report
Update task reports for a specific task.
Authorizations:
path Parameters
| taskId required | string <uuid> The unique identifier of the task. |
| taskReportId required | string <uuid> The unique identifier of task report. |
Request Body schema:
Task report data to update.
| reportId required | string <uuid> |
| format required | string non-empty |
| zipFolderFiles | boolean |
| zipEmailFiles | boolean |
| evaluateConditionForEachIteration | boolean |
| folderVariable | string or null |
| recipientsVariable | string or null |
| ftpVariable | string or null |
| hubAuthorizedUserVariable | string or null |
| dropboxVariable | string or null |
| onedriveVariable | string or null |
| googledriveVariable | string or null |
| emailAttachment | boolean |
| emailEmbedment | boolean |
| publishToQalyptusHub | boolean |
| maxFileOccurrences | integer <int32> |
| secureOutputFiles | boolean |
| fileOpenPassword | string or null |
| fileWritePassword | string or null |
| isOpenFilePasswordProtected | boolean |
| isWriteFilePasswordProtected | boolean |
Array of objects or null (ReportConditionDto) | |
Array of objects or null (ReportFilterDto) | |
Array of objects or null (ReportStorageServiceDto) | |
Array of objects or null (TaskReportFolderDto) | |
Array of objects or null (OverwriteReportAppsDto) |
Responses
Request samples
- Payload
{- "reportId": "836df459-dc40-4aa1-972a-6eb0a864dff9",
- "format": "string",
- "zipFolderFiles": true,
- "zipEmailFiles": true,
- "evaluateConditionForEachIteration": true,
- "folderVariable": "string",
- "recipientsVariable": "string",
- "ftpVariable": "string",
- "hubAuthorizedUserVariable": "string",
- "dropboxVariable": "string",
- "onedriveVariable": "string",
- "googledriveVariable": "string",
- "emailAttachment": true,
- "emailEmbedment": true,
- "publishToQalyptusHub": true,
- "maxFileOccurrences": 0,
- "secureOutputFiles": true,
- "fileOpenPassword": "string",
- "fileWritePassword": "string",
- "isOpenFilePasswordProtected": true,
- "isWriteFilePasswordProtected": true,
- "reportConditions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "taskReportId": "ad6383c6-c2fc-41b1-a0db-20eb065c3d31",
- "conditionId": "1e06e0eb-07f6-4fcd-8750-870cbafd1693"
}
], - "reportFilters": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "taskReportId": "ad6383c6-c2fc-41b1-a0db-20eb065c3d31",
- "filterId": "aff0ee0f-f371-4b82-82c6-dc3b96f05c91",
- "order": 0
}
], - "reportStorageServices": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "fileStorageServiceId": "ec26fc06-bcc1-4aad-941e-cddbc71126f5",
- "path": "string",
- "sharePointSiteUrl": "string",
- "order": 0
}
], - "reportFolders": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "taskReportId": "ad6383c6-c2fc-41b1-a0db-20eb065c3d31",
- "path": "string"
}
], - "overwriteReportApps": [
- {
- "reportId": "836df459-dc40-4aa1-972a-6eb0a864dff9",
- "qlikApps": [
- {
- "qlikAppId": "c8e142ed-5c22-4064-87da-aac893bd9e5b",
- "newQlikAppId": "b99f706c-8be1-4727-98ff-d7031402bcd1"
}
]
}
]
}Response samples
- 200
- 400
- 404
- 409
- 500
Delete task report
Delete a task report by its unique identifier .
Authorizations:
path Parameters
| taskReportId required | string <uuid> The task report unique identifier to delete. |
| taskId required | string <uuid> The unique identifier of the task. |
Responses
Response samples
- 200
- 404
- 500
Delete task reports
Delete a task reports by its unique identifiers .
Authorizations:
path Parameters
| taskId required | string <uuid> The unique identifier of the task reports to delete. |
Request Body schema:
List of task reports unique identifiers to delete.
Responses
Request samples
- Payload
[- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]Response samples
- 200
- 404
- 500
Get task recipients
Authorizations:
path Parameters
| id required | string <uuid> The unique identifier of the task. |
query Parameters
| name | string Filter by recipient name (optional). Optional filter operators can be applied to refine the search:
|
| email_address | string Filter by recipient name (optional). Optional filter operators can be applied to refine the search:
|
| type | string Filter by recipient type (optional). Available types : "user", "group". |
| sort_by | string Sort by field name (optional). Supported fields: "type", "name", etc. |
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 403
- 404
- 500
Add task recepients
Add recepients to a task.
Authorizations:
path Parameters
| taskId required | string <uuid> The unique identifier of the task |
Request Body schema:
The task recepients details.
| id required | string <uuid> |
| type required | string non-empty |
| sendEmail required | boolean |
| seeInHub required | boolean |
Responses
Request samples
- Payload
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "string",
- "sendEmail": true,
- "seeInHub": true
}
]Response samples
- 200
- 400
- 404
- 500
Delete task recepients
Delete a task recepients by its unique identifier and type.
Authorizations:
path Parameters
| taskId required | string <uuid> The unique identifier of the task recepients to delete. |
Request Body schema:
The task recepients to delete.
| id required | string <uuid> |
| type required | string non-empty |
| sendEmail required | boolean |
| seeInHub required | boolean |
Responses
Request samples
- Payload
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "string",
- "sendEmail": true,
- "seeInHub": true
}
]Response samples
- 200
- 404
- 500
Update task users
Update users associated with a task.
Authorizations:
path Parameters
| taskId required | string <uuid> The unique identifier of the task to update. |
Request Body schema:
The updated task user details.
| id required | string <uuid> |
| type required | string non-empty |
| sendEmail required | boolean |
| seeInHub required | boolean |
Responses
Request samples
- Payload
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "string",
- "sendEmail": true,
- "seeInHub": true
}Response samples
- 400
- 404
Get task triggers
Authorizations:
path Parameters
| taskId required | string <uuid> |
query Parameters
| type | string Filter by trigger type (optional). |
| sort_by | string Sort by field name (optional). Supported fields: "type", "name", etc. |
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 403
- 404
- 500
Add task schedule
Add a new task schedule.
Authorizations:
path Parameters
| taskId required | string <uuid> The unique identifier of the task |
Request Body schema:
The task schedule data.
| name required | string non-empty |
| isActive | boolean |
| frequency | string or null |
| execution | string or null |
| priority | integer or null <int32> |
| timeZone required | string non-empty |
| day | integer <int32> |
| month | integer <int32> |
| atHour | integer <int32> |
| atMinut | integer <int32> |
| everyHours | integer <int32> |
| fromHour | integer <int32> |
| fromMinut | integer <int32> |
| toHour | integer <int32> |
| weeklyDays | string or null |
| timeZoneOfset | string or null |
| startDate required | string <date-time> |
| endDate required | string <date-time> |
Responses
Request samples
- Payload
{- "name": "string",
- "isActive": true,
- "frequency": "string",
- "execution": "string",
- "priority": 0,
- "timeZone": "string",
- "day": 0,
- "month": 0,
- "atHour": 0,
- "atMinut": 0,
- "everyHours": 0,
- "fromHour": 0,
- "fromMinut": 0,
- "toHour": 0,
- "weeklyDays": "string",
- "timeZoneOfset": "string",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}Response samples
- 200
- 400
- 404
- 409
- 500
Update task schedule.
Update an existing task schedule.
Authorizations:
path Parameters
| taskId required | string <uuid> The unique identifier of the task |
| taskScheduleId required | string <uuid> The unique identifier of the task schedule to update |
Request Body schema:
The task schedule data.
| name required | string non-empty |
| isActive | boolean |
| frequency | string or null |
| execution | string or null |
| priority | integer or null <int32> |
| timeZone required | string non-empty |
| day | integer <int32> |
| month | integer <int32> |
| atHour | integer <int32> |
| atMinut | integer <int32> |
| everyHours | integer <int32> |
| fromHour | integer <int32> |
| fromMinut | integer <int32> |
| toHour | integer <int32> |
| weeklyDays | string or null |
| timeZoneOfset | string or null |
| startDate required | string <date-time> |
| endDate required | string <date-time> |
Responses
Request samples
- Payload
{- "name": "string",
- "isActive": true,
- "frequency": "string",
- "execution": "string",
- "priority": 0,
- "timeZone": "string",
- "day": 0,
- "month": 0,
- "atHour": 0,
- "atMinut": 0,
- "everyHours": 0,
- "fromHour": 0,
- "fromMinut": 0,
- "toHour": 0,
- "weeklyDays": "string",
- "timeZoneOfset": "string",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}Response samples
- 200
- 400
- 404
- 409
- 500
Get task schedule.
Get a task schedule by its unique identifier and the task's unique identifier.
Authorizations:
path Parameters
| taskId required | string <uuid> The unique identifier of the task. |
| taskScheduleId required | string <uuid> The unique identifier of the task Schedule. |
Responses
Response samples
- 200
- 403
- 404
- 500
Delete task schedule
Delete a task schedule by its unique identifier.
Authorizations:
path Parameters
| taskId required | string <uuid> The unique identifier of the task. |
| taskScheduleId required | string <uuid> The unique identifier of the task schedule to delete. |
Responses
Response samples
- 200
- 404
- 500
Delete task triggers
Delete one or more task triggers by their unique identifiers.
Authorizations:
path Parameters
| taskId required | string <uuid> The unique identifier of the task. |
Request Body schema:
List of task triggers unique identifiers to delete.
Responses
Request samples
- Payload
[- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]Response samples
- 200
- 404
- 500
Add task external event
Add an external event to a task.
Authorizations:
path Parameters
| taskId required | string <uuid> The unique identifier of the task. |
Request Body schema:
The external event details.
| name required | string non-empty |
| description | string or null |
| appId required | string non-empty |
| isActive | boolean |
| execution | string or null |
| priority | integer or null <int32> |
| startDate required | string <date-time> |
| endDate required | string <date-time> |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "appId": "string",
- "isActive": true,
- "execution": "string",
- "priority": 0,
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}Response samples
- 200
- 400
- 404
- 409
- 500
Update task external event
Update an external event associated with a task.
Authorizations:
path Parameters
| taskId required | string <uuid> The unique identifier of the task. |
| externalEventId required | string <uuid> The unique identifier of the external event to update. |
Request Body schema:
The updated external event details.
| name required | string non-empty |
| description | string or null |
| appId required | string non-empty |
| isActive | boolean |
| execution | string or null |
| priority | integer or null <int32> |
| startDate required | string <date-time> |
| endDate required | string <date-time> |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "appId": "string",
- "isActive": true,
- "execution": "string",
- "priority": 0,
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}Response samples
- 200
- 400
- 404
- 409
- 500
Delete task external event
Delete a task external event by its unique identifier.
Authorizations:
path Parameters
| externalEventId required | string <uuid> The unique identifier of the task external event to delete. |
| taskId required | string <uuid> The unique identifier of the task. |
Responses
Response samples
- 200
- 404
- 500
Get task external event
Get detailed information about a specific external event associated with a task.
Authorizations:
path Parameters
| taskId required | string <uuid> The unique identifier of the task. |
| taskExternalEventId required | string <uuid> The unique identifier of the task external event. |
Responses
Response samples
- 200
- 404
- 500
Update task email
Update a TaskEmail of a task.
Authorizations:
path Parameters
| taskId required | string <uuid> The ID of the task to update the TaskEmail for. |
Request Body schema:
The updated TaskEmail data.
| taskId required | string <uuid> |
| from | string or null |
| bcBcc | boolean |
| bc | string or null |
| bcc | string or null |
| ccQlikVariableId | string or null <uuid> |
| bccQlikVariableId | string or null <uuid> |
| subject required | string non-empty |
| message required | string non-empty |
| isActive | boolean |
| oneToAll | boolean |
Responses
Request samples
- Payload
{- "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
- "from": "string",
- "bcBcc": true,
- "bc": "string",
- "bcc": "string",
- "ccQlikVariableId": "009367f7-7731-4b42-80ba-c925ab8a19ec",
- "bccQlikVariableId": "5b8685b6-bf7c-447b-9ff3-8f7f5a2e0bf8",
- "subject": "string",
- "message": "string",
- "isActive": true,
- "oneToAll": true
}Response samples
- 200
- 400
- 404
- 500
Get all trusted origins
Get a list of all trusted origins.
Authorizations:
query Parameters
| sort_by | string Sort by field name (optional). Available fields: "Name", "Description", "Address" |
| name | string Trusted origin name used for filtering. Optional filter operators can be applied to refine the search:
|
| description | string Trusted origin description used for filtering. Optional filter operators can be applied to refine the search:
|
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 500
Delete trusted origins
Delete Delete trusted origins by their unique identifiers.
Authorizations:
Request Body schema:
The IDs of the trusted origins to delete.
Responses
Request samples
- Payload
[- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]Response samples
- 200
- 400
- 404
- 500
Add trusted origin
Create a new trusted origin.
Authorizations:
Request Body schema:
The trusted origin details.
| name required | string non-empty |
| description | string or null |
| address required | string non-empty |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "address": "string"
}Response samples
- 200
- 400
- 409
- 500
Update trusted origin
Update an existing trusted origin by its unique identifier.
Authorizations:
path Parameters
| id required | string <uuid> The ID of the trusted origin to update. |
Request Body schema:
The updated trusted origin details.
| name required | string non-empty |
| description | string or null |
| address required | string non-empty |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "address": "string"
}Response samples
- 200
- 400
- 404
- 409
- 500
Add user
Add a new user.
Authorizations:
Request Body schema:
The user details.
| domainAccount | string or null |
| firstName required | string non-empty |
| lastName required | string non-empty |
string or null | |
| password | string or null |
| isActive required | boolean |
| sendNotification | boolean |
| isoLanguage | string or null |
Array of objects or null (BaseEntityInfo) | |
required | Array of objects (BaseEntityInfo) |
Array of objects or null (BaseEntityInfo) |
Responses
Request samples
- Payload
{- "domainAccount": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "password": "string",
- "isActive": true,
- "sendNotification": true,
- "isoLanguage": "string",
- "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
], - "organizations": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
], - "groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
]
}Response samples
- 200
- 400
- 403
- 404
- 409
- 500
Get all users
Get a list of all users with pagination and filtering.
Authorizations:
query Parameters
| sort_by | string Sort by field name (optional). Available fields: "FullName", "Email", "UserName", "IsActive", "Groups", "Type", "CreatedDate", "ModifiedDate" |
| full_name | string User full name used for filtering. Optional filter operators can be applied to refine the search:
|
string User email used for filtering. Optional filter operators can be applied to refine the search:
| |
| is_active | boolean User isActive field used for filtering (optional). values : true or false. |
| group_id | string <uuid> Group ID used for filtering users by group membership. Only supports exact match (equals operator). Example: ?group_id=4ae9735a-d165-4671-bd00-4119204f00d8 |
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 500
Add recipient
Create a new recipient with default 'Hub users' role. Roles are automatically assigned and should not be provided in the request.
Authorizations:
Request Body schema:
The recipient details (fullName, userName, email, isoLanguage, organizations).
| firstName required | string non-empty |
| lastName required | string non-empty |
string or null | |
| password | string or null |
| isActive required | boolean |
| isoLanguage | string or null |
required | Array of objects (BaseEntityInfo) |
Array of objects or null (BaseEntityInfo) |
Responses
Request samples
- Payload
{- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "password": "string",
- "isActive": true,
- "isoLanguage": "string",
- "organizations": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
], - "groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
]
}Response samples
- 200
- 201
- 400
- 404
- 409
- 500
Update user
Update an existing user by its unique identifier.
Authorizations:
path Parameters
| id required | string <uuid> The ID of the user to update. |
Request Body schema:
The updated user details.
| domainAccount | string or null |
| firstName required | string non-empty |
| lastName required | string non-empty |
string or null | |
| password | string or null |
| isActive required | boolean |
| sendNotification | boolean |
| isoLanguage | string or null |
Array of objects or null (BaseEntityInfo) | |
required | Array of objects (BaseEntityInfo) |
Array of objects or null (BaseEntityInfo) |
Responses
Request samples
- Payload
{- "domainAccount": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "password": "string",
- "isActive": true,
- "sendNotification": true,
- "isoLanguage": "string",
- "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
], - "organizations": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
], - "groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
]
}Response samples
- 200
- 400
- 403
- 404
- 409
- 500
Update recipient
Update an existing recipient by its unique identifier.
Authorizations:
path Parameters
| id required | string <uuid> The ID of the recipient to update. |
Request Body schema:
The updated recipient details.
| firstName required | string non-empty |
| lastName required | string non-empty |
string or null | |
| password | string or null |
| isActive required | boolean |
| isoLanguage | string or null |
required | Array of objects (BaseEntityInfo) |
Array of objects or null (BaseEntityInfo) |
Responses
Request samples
- Payload
{- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "password": "string",
- "isActive": true,
- "isoLanguage": "string",
- "organizations": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
], - "groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
]
}Response samples
- 200
- 400
- 403
- 404
- 409
- 500
Convert recipient to user
Convert a recipient to a user by adding roles.
Authorizations:
path Parameters
| id required | string <uuid> The ID of the recipient to convert. |
Request Body schema:
The conversion details (roles, isActive, sendNotification).
required | Array of objects (BaseEntityInfo) |
| isActive required | boolean |
| sendNotification | boolean |
| language required | string non-empty |
| domain | string or null |
Responses
Request samples
- Payload
{- "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
], - "isActive": true,
- "sendNotification": true,
- "language": "string",
- "domain": "string"
}Response samples
- 200
- 400
- 404
- 500
Get user directories
Retrieve all user directories with pagination and filtering.
Authorizations:
query Parameters
| sort_by | string Sort by field name (optional). Available fields: "Name", "Type", "LastStartedSync", "SyncStatus" |
| name | string User directory name used for filtering. Optional filter operators can be applied to refine the search:
|
| page | integer <int32> [ 1 .. 2147483647 ] Page number (1-based). Default is 1. Ignored when get_all = true. |
| page_size | integer <int32> [ 1 .. 50 ] Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true. |
| get_all | boolean When true, pagination is disabled and all items are returned. |
| sort_direction | string Sort direction: "asc" or "desc". Default is "asc" (optional) |
Responses
Response samples
- 200
- 500
Add user directory
Add a new user directory.
Authorizations:
Request Body schema:
The request object containing user directory details.
| type required | string non-empty |
| name required | string non-empty |
| prefix | string or null |
| userDirectoryName | string or null |
| azureClientId | string or null |
| azureTenantId | string or null |
| azureClientSecret | string or null |
| hostName | string or null |
| port | integer <int32> |
| userName | string or null |
| password | string or null |
| sendNotification required | boolean |
| defaultUserRole | string or null <uuid> |
| filter | string or null |
| synchronization required | string non-empty |
| frequency | string or null |
| frequencyTime | string or null |
| timeZone | string or null |
| isActive | boolean |
| organizationId required | string <uuid> |
Responses
Request samples
- Payload
{- "type": "string",
- "name": "string",
- "prefix": "string",
- "userDirectoryName": "string",
- "azureClientId": "string",
- "azureTenantId": "string",
- "azureClientSecret": "string",
- "hostName": "string",
- "port": 0,
- "userName": "string",
- "password": "string",
- "sendNotification": true,
- "defaultUserRole": "12c86826-3b6a-4b8e-a933-763c01234cdc",
- "filter": "string",
- "synchronization": "string",
- "frequency": "string",
- "frequencyTime": "string",
- "timeZone": "string",
- "isActive": true,
- "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9"
}Response samples
- 200
- 400
- 403
- 404
- 408
- 409
- 500
Delete user directories
Delete user directories by their unique identifiers.
Authorizations:
Request Body schema:
The list of unique identifiers of the user directories.
Responses
Request samples
- Payload
[- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]Response samples
- 200
- 400
- 403
- 500
Update user directory
Update an existing user directory by its unique identifier.
Authorizations:
path Parameters
| id required | string <uuid> The unique identifier of the user directory. |
Request Body schema:
The updated user directory data.
| type required | string non-empty |
| name required | string non-empty |
| prefix | string or null |
| userDirectoryName | string or null |
| azureClientId | string or null |
| azureTenantId | string or null |
| azureClientSecret | string or null |
| hostName | string or null |
| port | integer <int32> |
| userName | string or null |
| password | string or null |
| sendNotification required | boolean |
| defaultUserRole | string or null <uuid> |
| filter | string or null |
| synchronization required | string non-empty |
| frequency | string or null |
| frequencyTime | string or null |
| timeZone | string or null |
| isActive | boolean |
| organizationId required | string <uuid> |
Responses
Request samples
- Payload
{- "type": "string",
- "name": "string",
- "prefix": "string",
- "userDirectoryName": "string",
- "azureClientId": "string",
- "azureTenantId": "string",
- "azureClientSecret": "string",
- "hostName": "string",
- "port": 0,
- "userName": "string",
- "password": "string",
- "sendNotification": true,
- "defaultUserRole": "12c86826-3b6a-4b8e-a933-763c01234cdc",
- "filter": "string",
- "synchronization": "string",
- "frequency": "string",
- "frequencyTime": "string",
- "timeZone": "string",
- "isActive": true,
- "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9"
}Response samples
- 200
- 400
- 403
- 404
- 408
- 409
- 500