Qalyptus Cloud API Documentation (beta) (v1)

Download OpenAPI specification:Download

Qalyptus support: [email protected] Terms of Service

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.

API keys

Create API key

Create a new API key.

Request Body schema:
application/json-patch+json

The API key name, description and expiration date.

name required	string
description	string or null
expiryDate required	string <date-time>
organizationID required	string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

{"name": "string",
"description": "string",
"expiryDate": "2019-08-24T14:15:22Z",
"organizationID": "7bbda8d5-3d76-4b0c-b85a-4ae115424874"
}

Response samples

200

Content type

text/plain

No sample

Get user API keys

Get a list of all API keys.

Responses

Response samples

200

Content type

text/plain

No sample

Update API key

Update an existing API key.

path Parameters

id

required

string <uuid>

The ID of the API key to update.

Request Body schema:
application/json-patch+json

The updated API key details; name and description.

name required	string
description	string or null

Responses

Request samples

Payload

Content type

application/json-patch+json

{"name": "string",
"description": "string"
}

Response samples

200

Content type

text/plain

No sample

Get user API key

Get the details of a user's API key by its unique identifier.

path Parameters

id

required

string <uuid>

The ID of the API key to retrieve.

Responses

Response samples

200

Content type

text/plain

No sample

Delete API key

Delete a user's API key by its unique identifier.

path Parameters

id

required

string <uuid>

The ID of the API key to delete.

Responses

Delete API keys

Delete multiple user API keys.

Request Body schema:
application/json-patch+json

A list of unique identifiers for the API keys to delete.

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Conditions

Create condition

Create a new condition

Request Body schema:
application/json-patch+json

The condition creation request containing project ID, name, and description.

name required	string
description	string or null
projectID required	string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

{"name": "string",
"description": "string",
"projectID": "4a3bdc18-db9e-4363-964a-de75946969f0"
}

Response samples

200
400
403
500

Content type

text/plain

No sample

Get conditions

Get a list of all conditions.

Responses

Response samples

200
500

Content type

text/plain

No sample

Duplicate condition

Duplicate a condition.

path Parameters

id

required

string <uuid>

The ID of the condition to duplicate.

Request Body schema:
application/json-patch+json

Project ID and organization ID.

projectID required	string <uuid>
organizationID required	string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

{"projectID": "4a3bdc18-db9e-4363-964a-de75946969f0",
"organizationID": "7bbda8d5-3d76-4b0c-b85a-4ae115424874"
}

Response samples

200
400
403
404
500

Content type

text/plain

No sample

Update condition

Update a condition.

path Parameters

id

required

string <uuid>

The ID of the condition to update.

Request Body schema:
application/json-patch+json

The updated information for the condition.

name required	string
description	string or null

Responses

Request samples

Payload

Content type

application/json-patch+json

{"name": "string",
"description": "string"
}

Response samples

Content type

text/plain

No sample

Get condition

Get the details of a specific condition.

path Parameters

id

required

string <uuid>

The ID of the condition.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Delete condition

Delete a specific condition by its ID.

path Parameters

id

required

string <uuid>

The ID of the condition to delete.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Create or update rule

Create or update a rule for a condition.

path Parameters

id

required

string <uuid>

The ID of the condition.

Request Body schema:
application/json-patch+json

The rule information to add or update.

id	string or null <uuid>
name required	string
qlikAppID required	string <uuid>
required	Array of objects (ConditionRuleValueRequestDto)

Responses

Request samples

Payload

Content type

application/json-patch+json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"qlikAppID": "c8dee41f-8f7c-4943-af38-1fded965fd1b",
"values": [{"type": "string",
"variable": "string",
"comparisonValue": "string",
"chart": "string",
"chartHasValue": true,
"operator": "string",
"order": 0
}
]
}

Response samples

400
403
404
409
500

Content type

text/plain

No sample

Get project conditions

Get the conditions associated with a specific project.

path Parameters

id

required

string <uuid>

The ID of the project.

Responses

Response samples

200
500

Content type

text/plain

No sample

Get rules

Get the rules associated with a specific condition.

path Parameters

id

required

string <uuid>

The ID of the condition.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Get rule

Get a specific condition rule by its ID.

path Parameters

id

required

string <uuid>

The ID of the condition rule.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Delete conditions

Delete multiple conditions.

Request Body schema:
application/json-patch+json

A list of IDs of the conditions to delete.

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

200
400
403
500

Content type

text/plain

No sample

Delete condition rules

Delete multiple rules from a condition.

path Parameters

id

required

string <uuid>

The ID of the condition.

Request Body schema:
application/json-patch+json

A list of IDs of the rules to delete.

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

400
403
500

Content type

text/plain

No sample

Get condition permissions

Get the permissions associated with a specific condition.

path Parameters

id

required

string <uuid>

The ID of the condition.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Set permissions

Set permissions for a condition.

path Parameters

id

required

string <uuid>

The ID of the condition.

Request Body schema:
application/json-patch+json

The permissions request DTO containing the permissions to be set.

required	Array of objects (MemberRequestDto)
required	object (PermissionDto)

Responses

Request samples

Payload

Content type

application/json-patch+json

{"members": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "string"
}
],
"permissions": {"viewProject": true,
"viewReport": true,
"createReport": true,
"useReport": true,
"editReport": true,
"subscribeReport": true,
"runReport": true,
"deleteReport": true,
"setPermissionsReport": true,
"duplicateReport": true,
"moveReport": true,
"viewFilter": true,
"createFilter": true,
"useFilter": true,
"editFilter": true,
"deleteFilter": true,
"duplicateFilter": true,
"moveFilter": true,
"setPermissionsFilter": true,
"viewCondition": true,
"createCondition": true,
"useCondition": true,
"editCondition": true,
"deleteCondition": true,
"setPermissionsCondition": true,
"duplicateCondition": true,
"moveCondition": true,
"viewTask": true,
"createTask": true,
"editTask": true,
"runTask": true,
"deleteTask": true,
"setPermissionsTask": true,
"duplicateTask": true,
"moveTask": true,
"viewFolderContent": true,
"createFolderContent": true,
"editFolderContent": true,
"downloadFolderContent": true,
"deleteFolderContent": true,
"duplicateFolderContent": true,
"moveFolderContent": true
}
}

Response samples

200
400
403
404
500

Content type

text/plain

No sample

Get member permissions

Get the permissions associated with a specific member permission of a condition.

path Parameters

id required	string <uuid> The ID of the condition.
memberPermissionId required	string <uuid> The ID of the member permission.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Set member permissions

Set permissions for a specific member in a condition.

path Parameters

id required	string <uuid> The ID of the condition.
memberPermissionId required	string <uuid> The ID of the member permission to set.

Request Body schema:
application/json-patch+json

The permission DTO containing the permission details to be set.

viewProject	boolean
viewReport	boolean
createReport	boolean
useReport	boolean
editReport	boolean
subscribeReport	boolean
runReport	boolean
deleteReport	boolean
setPermissionsReport	boolean
duplicateReport	boolean
moveReport	boolean
viewFilter	boolean
createFilter	boolean
useFilter	boolean
editFilter	boolean
deleteFilter	boolean
duplicateFilter	boolean
moveFilter	boolean
setPermissionsFilter	boolean
viewCondition	boolean
createCondition	boolean
useCondition	boolean
editCondition	boolean
deleteCondition	boolean
setPermissionsCondition	boolean
duplicateCondition	boolean
moveCondition	boolean
viewTask	boolean
createTask	boolean
editTask	boolean
runTask	boolean
deleteTask	boolean
setPermissionsTask	boolean
duplicateTask	boolean
moveTask	boolean
viewFolderContent	boolean
createFolderContent	boolean
editFolderContent	boolean
downloadFolderContent	boolean
deleteFolderContent	boolean
duplicateFolderContent	boolean
moveFolderContent	boolean

Responses

Request samples

Payload

Content type

application/json-patch+json

{"viewProject": true,
"viewReport": true,
"createReport": true,
"useReport": true,
"editReport": true,
"subscribeReport": true,
"runReport": true,
"deleteReport": true,
"setPermissionsReport": true,
"duplicateReport": true,
"moveReport": true,
"viewFilter": true,
"createFilter": true,
"useFilter": true,
"editFilter": true,
"deleteFilter": true,
"duplicateFilter": true,
"moveFilter": true,
"setPermissionsFilter": true,
"viewCondition": true,
"createCondition": true,
"useCondition": true,
"editCondition": true,
"deleteCondition": true,
"setPermissionsCondition": true,
"duplicateCondition": true,
"moveCondition": true,
"viewTask": true,
"createTask": true,
"editTask": true,
"runTask": true,
"deleteTask": true,
"setPermissionsTask": true,
"duplicateTask": true,
"moveTask": true,
"viewFolderContent": true,
"createFolderContent": true,
"editFolderContent": true,
"downloadFolderContent": true,
"deleteFolderContent": true,
"duplicateFolderContent": true,
"moveFolderContent": true
}

Response samples

200
400
403
404
500

Content type

text/plain

No sample

Delete member permissions

Delete permissions of a specific member in a condition.

path Parameters

id required	string <uuid> The ID of the condition.
memberPermissionId required	string <uuid> The ID of the member permission to delete.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Delete members permissions

Delete members permissions in a condition.

path Parameters

id

required

string <uuid>

The ID of the condition.

Request Body schema:
application/json-patch+json

The IDs of the member permissions to delete.

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

200
403
404
500

Content type

text/plain

No sample

Change owner

Change the owner of a condition.

path Parameters

id required	string <uuid> The ID of the condition.
ownerId required	string <uuid> The ID of the new owner.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Filters

Create filter

Create a new filter in a project.

Request Body schema:
application/json-patch+json

Filter creation request containing name, description, and project ID.

name required	string
description	string or null
projectID required	string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

{"name": "string",
"description": "string",
"projectID": "4a3bdc18-db9e-4363-964a-de75946969f0"
}

Response samples

200
400
403
409
500

Content type

text/plain

No sample

Get filters

Get a list of all filters.

Responses

Response samples

200
500

Content type

text/plain

No sample

Duplicate filter.

Create a duplicate of the specified filter.

path Parameters

id

required

string <uuid>

The ID of the filter to duplicate.

Request Body schema:
application/json-patch+json

Project ID and organization ID.

projectID required	string <uuid>
organizationID required	string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

{"projectID": "4a3bdc18-db9e-4363-964a-de75946969f0",
"organizationID": "7bbda8d5-3d76-4b0c-b85a-4ae115424874"
}

Response samples

200
400
403
404
500

Content type

text/plain

No sample

Update filter

Update the details of an existing filter.

path Parameters

id

required

string <uuid>

The ID of the filter to update.

Request Body schema:
application/json-patch+json

The details to update for the filter.

name required	string
description	string or null
projectID required	string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

{"name": "string",
"description": "string",
"projectID": "4a3bdc18-db9e-4363-964a-de75946969f0"
}

Response samples

Content type

text/plain

No sample

Get filter by ID

Get the filter with the specified ID.

path Parameters

id

required

string <uuid>

The ID of the filter.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Delete filter

Delete the filter with the specified ID.

path Parameters

id

required

string <uuid>

The ID of the filter to delete.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Update filter variable values

Update the variable values of a specified filter.

path Parameters

id

required

string <uuid>

The ID of the filter to update variable values for.

Request Body schema:
application/json-patch+json

The details of the filter variable values to update.

id	string or null <uuid>
qlikVariableID required	string <uuid>
variableValue required	string

Responses

Request samples

Payload

Content type

application/json-patch+json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"qlikVariableID": "2425c056-e32d-4c1c-a223-962a5b8862ee",
"variableValue": "string"
}

Response samples

400
403
404
500

Content type

text/plain

No sample

Update filter bookmark values

Update the bookmark values of a specified filter.

path Parameters

id

required

string <uuid>

The ID of the filter to update bookmark values for.

Request Body schema:
application/json-patch+json

The details of the filter bookmark values to update.

id	string or null <uuid>
qlikBookmarkID required	string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"qlikBookmarkID": "c52e0274-209c-44ff-83ae-4344247a4621"
}

Response samples

400
403
404
500

Content type

text/plain

No sample

Update filter field values

Update the field values of a specified filter.

path Parameters

id

required

string <uuid>

The ID of the filter to update field values for.

Request Body schema:
application/json-patch+json

The details of the filter field values to update.

id	string or null <uuid>
qlikFieldID required	string <uuid>
filterItemFieldValues required	Array of strings

Responses

Request samples

Payload

Content type

application/json-patch+json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"qlikFieldID": "0332e57c-79d4-40cf-8033-f627c768cda6",
"filterItemFieldValues": ["string"
]
}

Delete filter values

Delete specified filter values associated with a filter.

path Parameters

id

required

string <uuid>

The ID of the filter whose values are to be deleted.

Request Body schema:
application/json-patch+json

The list of IDs of filter values to be deleted.

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

400
403
404
500

Content type

text/plain

No sample

Order filter values.

Updates the order of filter values associated with a filter item.

path Parameters

id

required

string <uuid>

The ID of the filter whose values order is to be updated.

Request Body schema:
application/json-patch+json

The request object containing the ID of the filter item and the direction of the order change (Up/Down).

id required	string <uuid>
direction required	string

Responses

Request samples

Payload

Content type

application/json-patch+json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"direction": "string"
}

Response samples

400
403
404
500

Content type

text/plain

No sample

Get filter items.

Get filter items associated with a specific filter.

path Parameters

id

required

string <uuid>

The ID of the filter whose items are to be retrieved.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Get filter items field.

Get details of a specific filter item.

path Parameters

id

required

string <uuid>

The ID of the filter item to retrieve.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Get filters by project

Get a list of filters associated with the specified project.

path Parameters

id

required

string <uuid>

The ID of the project.

Responses

Response samples

200
500

Content type

text/plain

No sample

Get report filters

Get the filters applicable to the specified report.

path Parameters

id

required

string <uuid>

The ID of the report.

Responses

Response samples

200
500

Content type

text/plain

No sample

Delete filters.

Delete the filters with the specified IDs.

Request Body schema:
application/json-patch+json

The IDs of the filters to delete.

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

200
400
403
500

Content type

text/plain

No sample

Get filter permissions

Get the permissions associated with the specified filter.

path Parameters

id

required

string <uuid>

The ID of the filter.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Set permissions

Set permissions for the specified filter.

path Parameters

id

required

string <uuid>

The ID of the filter.

Request Body schema:
application/json-patch+json

The permissions request data.

required	Array of objects (MemberRequestDto)
required	object (PermissionDto)

Responses

Request samples

Payload

Content type

application/json-patch+json

{"members": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "string"
}
],
"permissions": {"viewProject": true,
"viewReport": true,
"createReport": true,
"useReport": true,
"editReport": true,
"subscribeReport": true,
"runReport": true,
"deleteReport": true,
"setPermissionsReport": true,
"duplicateReport": true,
"moveReport": true,
"viewFilter": true,
"createFilter": true,
"useFilter": true,
"editFilter": true,
"deleteFilter": true,
"duplicateFilter": true,
"moveFilter": true,
"setPermissionsFilter": true,
"viewCondition": true,
"createCondition": true,
"useCondition": true,
"editCondition": true,
"deleteCondition": true,
"setPermissionsCondition": true,
"duplicateCondition": true,
"moveCondition": true,
"viewTask": true,
"createTask": true,
"editTask": true,
"runTask": true,
"deleteTask": true,
"setPermissionsTask": true,
"duplicateTask": true,
"moveTask": true,
"viewFolderContent": true,
"createFolderContent": true,
"editFolderContent": true,
"downloadFolderContent": true,
"deleteFolderContent": true,
"duplicateFolderContent": true,
"moveFolderContent": true
}
}

Response samples

400
403
404
500

Content type

text/plain

No sample

Get member permissions

Get the permissions associated with the specified member in the filter.

path Parameters

id required	string <uuid> The ID of the filter.
memberPermissionId required	string <uuid> The ID of the member permission.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Set member permissions

Set permissions for the specified member of the filter.

path Parameters

id required	string <uuid> The ID of the filter.
memberPermissionId required	string <uuid> The ID of the member permission.

Request Body schema:
application/json-patch+json

The permission data.

viewProject	boolean
viewReport	boolean
createReport	boolean
useReport	boolean
editReport	boolean
subscribeReport	boolean
runReport	boolean
deleteReport	boolean
setPermissionsReport	boolean
duplicateReport	boolean
moveReport	boolean
viewFilter	boolean
createFilter	boolean
useFilter	boolean
editFilter	boolean
deleteFilter	boolean
duplicateFilter	boolean
moveFilter	boolean
setPermissionsFilter	boolean
viewCondition	boolean
createCondition	boolean
useCondition	boolean
editCondition	boolean
deleteCondition	boolean
setPermissionsCondition	boolean
duplicateCondition	boolean
moveCondition	boolean
viewTask	boolean
createTask	boolean
editTask	boolean
runTask	boolean
deleteTask	boolean
setPermissionsTask	boolean
duplicateTask	boolean
moveTask	boolean
viewFolderContent	boolean
createFolderContent	boolean
editFolderContent	boolean
downloadFolderContent	boolean
deleteFolderContent	boolean
duplicateFolderContent	boolean
moveFolderContent	boolean

Responses

Request samples

Payload

Content type

application/json-patch+json

{"viewProject": true,
"viewReport": true,
"createReport": true,
"useReport": true,
"editReport": true,
"subscribeReport": true,
"runReport": true,
"deleteReport": true,
"setPermissionsReport": true,
"duplicateReport": true,
"moveReport": true,
"viewFilter": true,
"createFilter": true,
"useFilter": true,
"editFilter": true,
"deleteFilter": true,
"duplicateFilter": true,
"moveFilter": true,
"setPermissionsFilter": true,
"viewCondition": true,
"createCondition": true,
"useCondition": true,
"editCondition": true,
"deleteCondition": true,
"setPermissionsCondition": true,
"duplicateCondition": true,
"moveCondition": true,
"viewTask": true,
"createTask": true,
"editTask": true,
"runTask": true,
"deleteTask": true,
"setPermissionsTask": true,
"duplicateTask": true,
"moveTask": true,
"viewFolderContent": true,
"createFolderContent": true,
"editFolderContent": true,
"downloadFolderContent": true,
"deleteFolderContent": true,
"duplicateFolderContent": true,
"moveFolderContent": true
}

Response samples

400
403
404
500

Content type

text/plain

No sample

Delete member permission

Delete member permission from the filter.

path Parameters

id required	string <uuid> The ID of the filter.
memberPermissionId required	string <uuid> The ID of the member permission.

Responses

Response samples

403
404
500

Content type

text/plain

No sample

Delete member permissions

Delete member permissions from the filter.

path Parameters

id

required

string <uuid>

The ID of the filter.

Request Body schema:
application/json-patch+json

The IDs of the member permissions to delete.

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

403
404
500

Content type

text/plain

No sample

Change owner

Change the owner of the specified filter to the user with the provided ID.

path Parameters

id required	string <uuid> The ID of the filter.
ownerId required	string <uuid> The ID of the new owner.

Responses

Response samples

403
404
500

Content type

text/plain

No sample

Groups

Create group

Create a new group with the provided details.

Request Body schema:
application/json-patch+json

The details of the group to be added.

name required	string
description	string or null
organizationID required	string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

{"name": "string",
"description": "string",
"organizationID": "7bbda8d5-3d76-4b0c-b85a-4ae115424874"
}

Response samples

400
409
500

Content type

text/plain

No sample

Get all groups

Get a list of all groups.

Responses

Response samples

200
500

Content type

text/plain

No sample

Update group

Update an existing group with the provided details.

path Parameters

id

required

string <uuid>

The ID of the group to be updated.

Request Body schema:
application/json-patch+json

The updated details of the group.

name required	string
description	string or null

Responses

Request samples

Payload

Content type

application/json-patch+json

{"name": "string",
"description": "string"
}

Response samples

400
403
404
409
500

Content type

text/plain

No sample

Get group

Get a group by its unique identifier.

path Parameters

id

required

string <uuid>

The ID of the group.

Responses

Response samples

200

Content type

text/plain

No sample

Delete group

Delete a group by its ID.

path Parameters

id

required

string <uuid>

The ID of the group to delete.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Delete groups

Delete multiple groups based on the provided list of group IDs.

Request Body schema:
application/json-patch+json

The list of group IDs to delete.

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

200
400
500

Content type

text/plain

No sample

Update group members

Update the members of a group based on the provided list of user IDs.

path Parameters

id

required

string <uuid>

The ID of the group to update.

Request Body schema:
application/json-patch+json

The list of user IDs to set as group members.

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

200
400
404
500

Content type

text/plain

No sample

Get group members

Get the members of a group specified by the provided group ID.

path Parameters

id

required

string <uuid>

The ID of the group whose members are to be retrieved.

Responses

Response samples

200
404
500

Content type

text/plain

No sample

Identity provider

Create an identity provider

Create a new identity provider based on the provided request data.

Request Body schema:
application/json-patch+json

The request data for adding the identity provider.

name required	string
description	string or null
type required	string
clientID required	string
clientSecret required	string
authorizationEndpoint required	string
accessTokenEndpoint required	string
userinfoEndpoint required	string
logoutEndpoint	string or null
postLogoutRedirectUrl	string or null

Responses

Request samples

Payload

Content type

application/json-patch+json

{"name": "string",
"description": "string",
"type": "string",
"clientID": "string",
"clientSecret": "string",
"authorizationEndpoint": "string",
"accessTokenEndpoint": "string",
"userinfoEndpoint": "string",
"logoutEndpoint": "string",
"postLogoutRedirectUrl": "string"
}

Response samples

201
400
403
409
500

Content type

text/plain

No sample

Get all identity providers

Get a list of all identity providers available in the system.

Responses

Response samples

200
500

Content type

text/plain

No sample

Update identity provider

Update an existing identity provider based on the provided ID and request data.

path Parameters

id

required

string <uuid>

The ID of the identity provider to be updated.

Request Body schema:
application/json-patch+json

The request data for updating the identity provider.

name required	string
description	string or null
clientID required	string
clientSecret	string or null
authorizationEndpoint required	string
accessTokenEndpoint required	string
userinfoEndpoint required	string
logoutEndpoint	string or null
postLogoutRedirectUrl	string or null

Responses

Request samples

Payload

Content type

application/json-patch+json

{"name": "string",
"description": "string",
"clientID": "string",
"clientSecret": "string",
"authorizationEndpoint": "string",
"accessTokenEndpoint": "string",
"userinfoEndpoint": "string",
"logoutEndpoint": "string",
"postLogoutRedirectUrl": "string"
}

Response samples

200
400
404
409
500

Content type

text/plain

No sample

Get identity provider

Get details of a specific identity provider based on its unique ID.

path Parameters

id

required

string <uuid>

The unique identifier of the identity provider.

Responses

Response samples

200
404
500

Content type

text/plain

No sample

Delete identity provider

Delete a specific identity provider based on its unique ID.

path Parameters

id

required

string <uuid>

The unique identifier of the identity provider to delete.

Responses

Response samples

200
404
409
500

Content type

text/plain

No sample

Licenses

Get licenses

Get information about licenses.

Responses

Response samples

200
404
500

Content type

text/plain

No sample

Organizations

Create organization

Create a new organization with the provided details.

Request Body schema:
application/json-patch+json

The details of the organization to be added.

name	string or null
displayName required	string
description	string or null
themeID required	string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

{"name": "string",
"displayName": "string",
"description": "string",
"themeID": "53ee002d-07b8-4788-8458-9266e3c0b778"
}

Response samples

200
400
404
409
500

Content type

text/plain

No sample

Get all organizations

Get information about all organizations.

Responses

Response samples

200
500

Content type

text/plain

No sample

Update organization

Update the details of an existing organization with the provided information.

path Parameters

id

required

string <uuid>

The ID of the organization to update.

Request Body schema:
application/json-patch+json

The updated details of the organization.

displayName required	string
description	string or null
themeID required	string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

{"displayName": "string",
"description": "string",
"themeID": "53ee002d-07b8-4788-8458-9266e3c0b778"
}

Response samples

200
400
404
409
500

Content type

text/plain

No sample

Get organization by ID

Get organization details by ID.

path Parameters

id

required

string <uuid>

The ID of the organization.

Responses

Response samples

200
404
500

Content type

text/plain

No sample

Delete organization

Delete a specific organization.

path Parameters

id

required

string <uuid>

The ID of the organization to be deleted.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Get user organizations

Get organizations.

Responses

Response samples

200
500

Content type

text/plain

No sample

Get organization projects

Get projects belonging to the organization with the provided ID.

path Parameters

id

required

string <uuid>

The ID of the organization.

Responses

Response samples

200
404
500

Content type

text/plain

No sample

Get organization members

Get members belonging to the organization with the provided ID.

path Parameters

id

required

string <uuid>

The ID of the organization.

Responses

Response samples

200
404
500

Content type

text/plain

No sample

Get organization resources

Get resources belonging to the organization with the provided ID.

path Parameters

id

required

string <uuid>

The ID of the organization.

Responses

Response samples

200
404
500

Content type

text/plain

No sample

Get organization qlik apps

Get Qlik apps associated with a specific organization.

path Parameters

id

required

string <uuid>

The ID of the organization.

Responses

Response samples

200
404
500

Content type

text/plain

No sample

Get organization authentications

Get authentication details for a specific organization.

path Parameters

id

required

string <uuid>

The ID of the organization.

Responses

Response samples

200
404
500

Content type

text/plain

No sample

Update organization authentications

Update authentication settings for a specific organization.

path Parameters

id

required

string <uuid>

The ID of the organization.

Request Body schema:
application/json-patch+json

The request containing updated authentication details.

qalyptusAuth required	boolean
identityProvider	string or null <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

{"qalyptusAuth": true,
"identityProvider": "0bc609d0-0c91-4207-bc6d-b5f2e59d7b31"
}

Response samples

200
400
404
500

Content type

text/plain

No sample

Delete organizations

Delete multiple organizations.

Request Body schema:
application/json-patch+json

The list of IDs of the organizations to be deleted.

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

200
400
403
404
500

Content type

text/plain

No sample

Projects

Create project

Create a new project.

Request Body schema:
application/json-patch+json

The details of the project to be created.

name required	string
description	string or null

Responses

Request samples

Payload

Content type

application/json-patch+json

{"name": "string",
"description": "string"
}

Response samples

200
400
403
409
500

Content type

text/plain

No sample

Get projects

Get a list of all projects

Responses

Response samples

200
500

Content type

text/plain

No sample

Update project

Update an existing project.

path Parameters

id

required

string <uuid>

The ID of the project to update.

Request Body schema:
application/json-patch+json

The details of the project to be updated.

name required	string
description	string or null

Responses

Request samples

Payload

Content type

application/json-patch+json

{"name": "string",
"description": "string"
}

Response samples

Content type

text/plain

No sample

Get project

Get details of a specific project.

path Parameters

id

required

string <uuid>

The ID of the project.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Delete project

Delete a specific project.

path Parameters

id

required

string <uuid>

The ID of the project to delete.

Responses

Response samples

200
403
404
409
500

Content type

text/plain

No sample

Update permission mode

Update permissions mode for a specific project.

path Parameters

id required	string <uuid> The ID of the project to update.
value required	boolean The new value for the global permission mode (true for enabled, false for disabled).

Responses

Response samples

200
400
403
404
500

Content type

text/plain

No sample

Get organization projects

Get a list of all projects associated with a specific organization.

path Parameters

id

required

string <uuid>

The ID of the organization to get projects for.

Responses

Response samples

200
500

Content type

text/plain

No sample

Delete multiple projects

Delete multiple projects by providing a list of project IDs.

Request Body schema:
application/json-patch+json

A list of project IDs to delete.

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

200
400
403
409
500

Content type

text/plain

No sample

Get permissions

Get permissions of a specific project.

path Parameters

id

required

string <uuid>

The ID of the project to get permissions for.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Set permissions

Set permissions for users or groups.

path Parameters

id

required

string <uuid>

The ID of the project to set permissions for.

Request Body schema:
application/json-patch+json

The permissions request data containing members and permissions.

required	Array of objects (MemberRequestDto)
required	object (PermissionDto)

Responses

Request samples

Payload

Content type

application/json-patch+json

{"members": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "string"
}
],
"permissions": {"viewProject": true,
"viewReport": true,
"createReport": true,
"useReport": true,
"editReport": true,
"subscribeReport": true,
"runReport": true,
"deleteReport": true,
"setPermissionsReport": true,
"duplicateReport": true,
"moveReport": true,
"viewFilter": true,
"createFilter": true,
"useFilter": true,
"editFilter": true,
"deleteFilter": true,
"duplicateFilter": true,
"moveFilter": true,
"setPermissionsFilter": true,
"viewCondition": true,
"createCondition": true,
"useCondition": true,
"editCondition": true,
"deleteCondition": true,
"setPermissionsCondition": true,
"duplicateCondition": true,
"moveCondition": true,
"viewTask": true,
"createTask": true,
"editTask": true,
"runTask": true,
"deleteTask": true,
"setPermissionsTask": true,
"duplicateTask": true,
"moveTask": true,
"viewFolderContent": true,
"createFolderContent": true,
"editFolderContent": true,
"downloadFolderContent": true,
"deleteFolderContent": true,
"duplicateFolderContent": true,
"moveFolderContent": true
}
}

Response samples

200
400
403
404
500

Content type

text/plain

No sample

Get member permissions

Get permissions of a specific member in a project.

path Parameters

id required	string <uuid> The ID of the project.
memberPermissionId required	string <uuid> The ID of the member's permission.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Set member permissions

Set permissions for a specific member.

path Parameters

id required	string <uuid> The ID of the project where permissions will be set.
memberPermissionId required	string <uuid> The ID of the member's permission to be updated.

Request Body schema:
application/json-patch+json

The permission data to be set for the member.

viewProject	boolean
viewReport	boolean
createReport	boolean
useReport	boolean
editReport	boolean
subscribeReport	boolean
runReport	boolean
deleteReport	boolean
setPermissionsReport	boolean
duplicateReport	boolean
moveReport	boolean
viewFilter	boolean
createFilter	boolean
useFilter	boolean
editFilter	boolean
deleteFilter	boolean
duplicateFilter	boolean
moveFilter	boolean
setPermissionsFilter	boolean
viewCondition	boolean
createCondition	boolean
useCondition	boolean
editCondition	boolean
deleteCondition	boolean
setPermissionsCondition	boolean
duplicateCondition	boolean
moveCondition	boolean
viewTask	boolean
createTask	boolean
editTask	boolean
runTask	boolean
deleteTask	boolean
setPermissionsTask	boolean
duplicateTask	boolean
moveTask	boolean
viewFolderContent	boolean
createFolderContent	boolean
editFolderContent	boolean
downloadFolderContent	boolean
deleteFolderContent	boolean
duplicateFolderContent	boolean
moveFolderContent	boolean

Responses

Request samples

Payload

Content type

application/json-patch+json

{"viewProject": true,
"viewReport": true,
"createReport": true,
"useReport": true,
"editReport": true,
"subscribeReport": true,
"runReport": true,
"deleteReport": true,
"setPermissionsReport": true,
"duplicateReport": true,
"moveReport": true,
"viewFilter": true,
"createFilter": true,
"useFilter": true,
"editFilter": true,
"deleteFilter": true,
"duplicateFilter": true,
"moveFilter": true,
"setPermissionsFilter": true,
"viewCondition": true,
"createCondition": true,
"useCondition": true,
"editCondition": true,
"deleteCondition": true,
"setPermissionsCondition": true,
"duplicateCondition": true,
"moveCondition": true,
"viewTask": true,
"createTask": true,
"editTask": true,
"runTask": true,
"deleteTask": true,
"setPermissionsTask": true,
"duplicateTask": true,
"moveTask": true,
"viewFolderContent": true,
"createFolderContent": true,
"editFolderContent": true,
"downloadFolderContent": true,
"deleteFolderContent": true,
"duplicateFolderContent": true,
"moveFolderContent": true
}

Response samples

200
400
403
404
500

Content type

text/plain

No sample

Delete member permission

Delete permission for a specific member

path Parameters

id required	string <uuid> The ID of the project from which permission will be deleted.
memberPermissionId required	string <uuid> The ID of the member's permission to be deleted.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Delete member's permissions

Delete member's permissions.

path Parameters

id

required

string <uuid>

The ID of the project from which permissions will be deleted.

Request Body schema:
application/json-patch+json

The IDs of the member permissions to be deleted.

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

200
403
404
500

Content type

text/plain

No sample

Change owner

Change the owner of a project.

path Parameters

id required	string <uuid> The ID of the project for which the owner will be changed.
ownerId required	string <uuid> The ID of the new owner.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Reports

Create report

Create a new report.

Request Body schema:
application/json-patch+json

The details of the report to be created.

name required	string
description	string or null
projectID required	string <uuid>
type	string or null

Responses

Request samples

Payload

Content type

application/json-patch+json

{"name": "string",
"description": "string",
"projectID": "4a3bdc18-db9e-4363-964a-de75946969f0",
"type": "string"
}

Response samples

200
400
403
409
500

Content type

text/plain

No sample

Get reports

Get the list of all reports.

Responses

Response samples

200
500

Content type

text/plain

No sample

Duplicate report

Create a duplicate of the specified report.

path Parameters

id

required

string <uuid>

The ID of the report to duplicate.

Request Body schema:
application/json-patch+json

The details of the duplicate report to be created.

projectID required	string <uuid>
organizationID required	string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

{"projectID": "4a3bdc18-db9e-4363-964a-de75946969f0",
"organizationID": "7bbda8d5-3d76-4b0c-b85a-4ae115424874"
}

Response samples

200
400
403
404

Content type

text/plain

No sample

Update a report

Update the details of the specified report.

path Parameters

id

required

string <uuid>

The ID of the report to update.

Request Body schema:
application/json-patch+json

The updated details of the report.

name required	string
description	string or null
isIteration required	boolean
	Array of objects or null (IterationFieldRequestDto)
dynamicNameSeparator	string or null
	Array of objects or null (DynamicNameRequestDto)

Responses

Request samples

Payload

Content type

application/json-patch+json

{"name": "string",
"description": "string",
"isIteration": true,
"iterationFields": [{"fieldID": "848f532e-13d0-4721-877d-5c0d75f12f02",
"order": 0
}
],
"dynamicNameSeparator": "string",
"dynamicNames": [{"itemType": "string",
"value": "string",
"order": 0,
"variableQlikAppID": "79587313-a553-4e27-9db3-3109d08bcfc8"
}
]
}

200
403
404
500

Content type

text/plain

No sample

Delete reports

Delete multiple reports with the specified IDs.

Request Body schema:
application/json-patch+json

A list of IDs of the reports to delete.

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

200
400
403
500

Content type

text/plain

No sample

Get permissions

Get the permissions associated with a report

path Parameters

id

required

string <uuid>

The unique ID of the report.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Set permissions

Set permissions for a report

path Parameters

id

required

string <uuid>

The unique ID of the report.

Request Body schema:
application/json-patch+json

The permissions request data.

required	Array of objects (MemberRequestDto)
required	object (PermissionDto)

Responses

Request samples

Payload

Content type

application/json-patch+json

{"members": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "string"
}
],
"permissions": {"viewProject": true,
"viewReport": true,
"createReport": true,
"useReport": true,
"editReport": true,
"subscribeReport": true,
"runReport": true,
"deleteReport": true,
"setPermissionsReport": true,
"duplicateReport": true,
"moveReport": true,
"viewFilter": true,
"createFilter": true,
"useFilter": true,
"editFilter": true,
"deleteFilter": true,
"duplicateFilter": true,
"moveFilter": true,
"setPermissionsFilter": true,
"viewCondition": true,
"createCondition": true,
"useCondition": true,
"editCondition": true,
"deleteCondition": true,
"setPermissionsCondition": true,
"duplicateCondition": true,
"moveCondition": true,
"viewTask": true,
"createTask": true,
"editTask": true,
"runTask": true,
"deleteTask": true,
"setPermissionsTask": true,
"duplicateTask": true,
"moveTask": true,
"viewFolderContent": true,
"createFolderContent": true,
"editFolderContent": true,
"downloadFolderContent": true,
"deleteFolderContent": true,
"duplicateFolderContent": true,
"moveFolderContent": true
}
}

Response samples

400
403
404
500

Content type

text/plain

No sample

Get member permissions

Get the permissions associated with the specified member in the report.

path Parameters

id required	string <uuid> The unique ID of the report.
memberPermissionId required	string <uuid> The unique ID of the member's permission.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Sets member permissions

Set permissions for the specified member of the report.

path Parameters

id required	string <uuid> The unique ID of the report.
memberPermissionId required	string <uuid> The ID of the member permission.

Request Body schema:
application/json-patch+json

The permission data.

viewProject	boolean
viewReport	boolean
createReport	boolean
useReport	boolean
editReport	boolean
subscribeReport	boolean
runReport	boolean
deleteReport	boolean
setPermissionsReport	boolean
duplicateReport	boolean
moveReport	boolean
viewFilter	boolean
createFilter	boolean
useFilter	boolean
editFilter	boolean
deleteFilter	boolean
duplicateFilter	boolean
moveFilter	boolean
setPermissionsFilter	boolean
viewCondition	boolean
createCondition	boolean
useCondition	boolean
editCondition	boolean
deleteCondition	boolean
setPermissionsCondition	boolean
duplicateCondition	boolean
moveCondition	boolean
viewTask	boolean
createTask	boolean
editTask	boolean
runTask	boolean
deleteTask	boolean
setPermissionsTask	boolean
duplicateTask	boolean
moveTask	boolean
viewFolderContent	boolean
createFolderContent	boolean
editFolderContent	boolean
downloadFolderContent	boolean
deleteFolderContent	boolean
duplicateFolderContent	boolean
moveFolderContent	boolean

Responses

Request samples

Payload

Content type

application/json-patch+json

{"viewProject": true,
"viewReport": true,
"createReport": true,
"useReport": true,
"editReport": true,
"subscribeReport": true,
"runReport": true,
"deleteReport": true,
"setPermissionsReport": true,
"duplicateReport": true,
"moveReport": true,
"viewFilter": true,
"createFilter": true,
"useFilter": true,
"editFilter": true,
"deleteFilter": true,
"duplicateFilter": true,
"moveFilter": true,
"setPermissionsFilter": true,
"viewCondition": true,
"createCondition": true,
"useCondition": true,
"editCondition": true,
"deleteCondition": true,
"setPermissionsCondition": true,
"duplicateCondition": true,
"moveCondition": true,
"viewTask": true,
"createTask": true,
"editTask": true,
"runTask": true,
"deleteTask": true,
"setPermissionsTask": true,
"duplicateTask": true,
"moveTask": true,
"viewFolderContent": true,
"createFolderContent": true,
"editFolderContent": true,
"downloadFolderContent": true,
"deleteFolderContent": true,
"duplicateFolderContent": true,
"moveFolderContent": true
}

Response samples

400
403
404
500

Content type

text/plain

No sample

Delete member permissions

Delete member permission from the report.

path Parameters

id required	string <uuid> The unique ID of the report.
memberPermissionId required	string <uuid> The unique ID of the member's permission to be deleted.

Responses

Response samples

403
404
500

Content type

text/plain

No sample

Delete member permissions

Delete member permissions from the report.

path Parameters

id

required

string <uuid>

The unique ID of the report.

Request Body schema:
application/json-patch+json

The IDs of the member permissions to delete.

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

400
403
404
500

Content type

text/plain

No sample

Change owner

Change the owner of the specified report to the user with the provided ID.

path Parameters

id required	string <uuid> The ID of the report.
ownerId required	string <uuid> The ID of the new owner.

Responses

Response samples

403
404
500

Content type

text/plain

No sample

Get report variables

Get a list of Qlik variables.

path Parameters

id

required

string <uuid>

The unique ID of the report.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Get report Qlik apps

Get the list of Qlik apps from the report template items.

path Parameters

id

required

string <uuid>

The unique ID of the report.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Get Qlik objects by report

Get the list of Qlik objects from the report template items.

path Parameters

id

required

string <uuid>

The unique ID of the report.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Get report objects

Get a list of template items

path Parameters

id

required

string <uuid>

The unique ID of the report.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Generate an on-demand report

Generate a report in the specified output format based on the provided selections.

path Parameters

id required	string <uuid> The unique ID of the report.
outputFormat required	string The desired output format for the generated report.

Request Body schema:
application/json-patch+json

The selections for generating the report.

	Array of objects or null (FieldSelectionDto)
appId	string or null
bookmarkId	string or null

Responses

Request samples

Payload

Content type

application/json-patch+json

{"selections": [{"fieldName": "string",
"values": ["string"
]
}
],
"appId": "string",
"bookmarkId": "string"
}

Response samples

200

Content type

text/plain

No sample

Status

Get scheduled task status list

Get the status of scheduled tasks.

Responses

Response samples

200
500

Content type

text/plain

No sample

Get scheduled task status

Get the status of a scheduled task based on the provided ID.

path Parameters

id

required

string <uuid>

The ID of the scheduled task.

Responses

Response samples

200
404
500

Content type

text/plain

No sample

Get on-demand requests status

Get the status of on-demand requests.

Responses

Response samples

200
500

Content type

text/plain

No sample

Get on-demand request status

Get the status of the specified on-demand request.

path Parameters

id

required

string <uuid>

The ID of the on-demand request.

Responses

Response samples

200
404
500

Content type

text/plain

No sample

Runs a specified task or report

Initiates the execution of the specified task or report request. The request can be a scheduled task, on-demand report, or on-demand task.

path Parameters

id

required

string <uuid>

The ID of the task or report request to run.

Responses

Response samples

400
403
404
500

Content type

text/plain

No sample

Stop the execution of a specified task or request

Stops the execution of the specified task or request. The request can be a scheduled task or an on-demand request.

path Parameters

id

required

string <uuid>

The ID of the task or request to stop.

Responses

Response samples

400
404
500

Content type

text/plain

No sample

Download the scheduled task log file

Download the log file of the specified scheduled task if available. The log file contains information about the execution of the task.

path Parameters

id

required

string <uuid>

The ID of the scheduled task.

Responses

Response samples

200
404
500

Content type

text/plain

No sample

Download the scheduled task SMTP log file

Download the SMTP log file of the specified scheduled task if available.

path Parameters

id

required

string <uuid>

The ID of the scheduled task.

Responses

Response samples

200
404
500

Content type

text/plain

No sample

Download the on-demand request log

Download the log file of the specified on-demand request if available. The log file contains information about the execution of the on-demand request.

path Parameters

id

required

string <uuid>

The ID of the on-demand request.

Responses

Response samples

200
404
500

Content type

text/plain

No sample

Download on-demand request SMTP log file

Download the SMTP log file of the specified on-demand request if available.

path Parameters

id

required

string <uuid>

The ID of the on-demand request.

Responses

Response samples

200
404
500

Content type

text/plain

No sample

Delete request

Deletes the specified request. If the request is currently in the running or queued state, it will first be stopped before deletion. Additionally, associated log files and report files, if any, will be deleted from the storage.

path Parameters

id

required

string <uuid>

The ID of the request to delete.

Responses

Response samples

404
500

Content type

text/plain

No sample

Download report

Download the report file generated by the specified request. The method gets the file from the storage and returns its URI for download.

path Parameters

id

required

string <uuid>

The ID of the request for which to download the report.

query Parameters

version

string

Responses

Response samples

200

Content type

text/plain

No sample

Download report as a stream

Download the report file as a stream. The method gets the file from the storage and returns it as a stream.

path Parameters

id

required

string <uuid>

The ID of the request for which to download the report.

Responses

Response samples

200
404
500

Content type

text/plain

No sample

Storage services

Update a storage service

Update the storage service with the specified ID.

path Parameters

id

required

string <uuid>

The ID of the storage service to update.

Request Body schema:
application/json-patch+json

name required	string
description	string or null
type	string or null
host	string or null
username	string or null
password	string or null
passiveMode	boolean or null
ftpTestDirectoryPath	string or null
sftpPort	integer or null <int32>

Responses

Request samples

Payload

Content type

application/json-patch+json

{"name": "string",
"description": "string",
"type": "string",
"host": "string",
"username": "string",
"password": "string",
"passiveMode": true,
"ftpTestDirectoryPath": "string",
"sftpPort": 0
}

Get the storage service with the specified ID.

Get the details of a specific storage service associated with the authenticated user.

path Parameters

id

required

string <uuid>

The ID of the storage service.

Responses

Response samples

200
404
500

Content type

text/plain

No sample

Delete the storage service with the specified ID.

Delete a specific storage service with the specified ID.

path Parameters

id

required

string <uuid>

The ID of the storage service to delete.

Responses

Response samples

200
404
500

Content type

text/plain

No sample

Get a list of all storage services.

Get the storage services associated with the authenticated user.

Responses

Response samples

200
404
500

Content type

text/plain

No sample

Delete multiple storage services.

Delete multiple storage services with the specified IDs.

Request Body schema:
application/json-patch+json

The list of storage service IDs to delete.

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

200
500

Content type

text/plain

No sample

Tasks

Create task

Create a new task.

Request Body schema:
application/json-patch+json

The request body containing task details.

name required	string
description	string or null
projectID required	string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

{"name": "string",
"description": "string",
"projectID": "4a3bdc18-db9e-4363-964a-de75946969f0"
}

Response samples

200
400
403
409
500

Content type

text/plain

No sample

Get tasks

Get a list of all tasks.

Responses

Response samples

200
500

Content type

text/plain

No sample

Duplicate task

Duplicate an existing task.

path Parameters

id

required

string <uuid>

The ID of the task to duplicate.

Responses

Response samples

200
400
403
404
500

Content type

text/plain

No sample

Update task

Update an existing task.

path Parameters

id

required

string <uuid>

The ID of the task to update.

Request Body schema:
application/json-patch+json

The request containing updated task information.

name required	string
description	string or null
isActive required	boolean
sendNotifications required	boolean
notifyIfError	boolean or null
notifyIfWarning	boolean or null
notifyIfSuccess	boolean or null
notificationRecipients	string or null
notificationCc	string or null
notificationBcc	string or null
testMode	boolean
testModeRecipients	string or null

Responses

Request samples

Payload

Content type

application/json-patch+json

{"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
403
404
500

Content type

text/plain

No sample

Get task

Get details of a specific task by its ID.

path Parameters

id

required

string <uuid>

The ID of the task.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Delete task

Delete a task by its ID.

path Parameters

id

required

string <uuid>

The ID of the task to delete.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Delete tasks.

Delete multiple tasks.

Request Body schema:
application/json-patch+json

A list of IDs of tasks to delete.

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

200
400
403
500

Content type

text/plain

No sample

Get permissions

Get permissions associated with a specific task.

path Parameters

id

required

string <uuid>

The ID of the task.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Set permissions

Set permission for a task.

path Parameters

id

required

string <uuid>

The ID of the task.

Request Body schema:
application/json-patch+json

The permission request DTO containing the permission to set.

required	Array of objects (MemberRequestDto)
required	object (PermissionDto)

Responses

Request samples

Payload

Content type

application/json-patch+json

{"members": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "string"
}
],
"permissions": {"viewProject": true,
"viewReport": true,
"createReport": true,
"useReport": true,
"editReport": true,
"subscribeReport": true,
"runReport": true,
"deleteReport": true,
"setPermissionsReport": true,
"duplicateReport": true,
"moveReport": true,
"viewFilter": true,
"createFilter": true,
"useFilter": true,
"editFilter": true,
"deleteFilter": true,
"duplicateFilter": true,
"moveFilter": true,
"setPermissionsFilter": true,
"viewCondition": true,
"createCondition": true,
"useCondition": true,
"editCondition": true,
"deleteCondition": true,
"setPermissionsCondition": true,
"duplicateCondition": true,
"moveCondition": true,
"viewTask": true,
"createTask": true,
"editTask": true,
"runTask": true,
"deleteTask": true,
"setPermissionsTask": true,
"duplicateTask": true,
"moveTask": true,
"viewFolderContent": true,
"createFolderContent": true,
"editFolderContent": true,
"downloadFolderContent": true,
"deleteFolderContent": true,
"duplicateFolderContent": true,
"moveFolderContent": true
}
}

Response samples

400
403
404
500

Content type

text/plain

No sample

Get member permissions

Get permissions associated with a specific member of a task.

path Parameters

id required	string <uuid> The ID of the task.
memberPermissionId required	string <uuid> The ID of the member permissions.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Set member permissions

Set permissions for a member of a task.

path Parameters

id required	string <uuid> The ID of the task.
memberPermissionId required	string <uuid> The ID of the member's permissions.

Request Body schema:
application/json-patch+json

The permission DTO containing the permissions to set.

viewProject	boolean
viewReport	boolean
createReport	boolean
useReport	boolean
editReport	boolean
subscribeReport	boolean
runReport	boolean
deleteReport	boolean
setPermissionsReport	boolean
duplicateReport	boolean
moveReport	boolean
viewFilter	boolean
createFilter	boolean
useFilter	boolean
editFilter	boolean
deleteFilter	boolean
duplicateFilter	boolean
moveFilter	boolean
setPermissionsFilter	boolean
viewCondition	boolean
createCondition	boolean
useCondition	boolean
editCondition	boolean
deleteCondition	boolean
setPermissionsCondition	boolean
duplicateCondition	boolean
moveCondition	boolean
viewTask	boolean
createTask	boolean
editTask	boolean
runTask	boolean
deleteTask	boolean
setPermissionsTask	boolean
duplicateTask	boolean
moveTask	boolean
viewFolderContent	boolean
createFolderContent	boolean
editFolderContent	boolean
downloadFolderContent	boolean
deleteFolderContent	boolean
duplicateFolderContent	boolean
moveFolderContent	boolean

Responses

Request samples

Payload

Content type

application/json-patch+json

{"viewProject": true,
"viewReport": true,
"createReport": true,
"useReport": true,
"editReport": true,
"subscribeReport": true,
"runReport": true,
"deleteReport": true,
"setPermissionsReport": true,
"duplicateReport": true,
"moveReport": true,
"viewFilter": true,
"createFilter": true,
"useFilter": true,
"editFilter": true,
"deleteFilter": true,
"duplicateFilter": true,
"moveFilter": true,
"setPermissionsFilter": true,
"viewCondition": true,
"createCondition": true,
"useCondition": true,
"editCondition": true,
"deleteCondition": true,
"setPermissionsCondition": true,
"duplicateCondition": true,
"moveCondition": true,
"viewTask": true,
"createTask": true,
"editTask": true,
"runTask": true,
"deleteTask": true,
"setPermissionsTask": true,
"duplicateTask": true,
"moveTask": true,
"viewFolderContent": true,
"createFolderContent": true,
"editFolderContent": true,
"downloadFolderContent": true,
"deleteFolderContent": true,
"duplicateFolderContent": true,
"moveFolderContent": true
}

Response samples

400
403
404
500

Content type

text/plain

No sample

Delete member permissions

Delete permissions for a member.

path Parameters

id required	string <uuid> The ID of the task.
memberPermissionId required	string <uuid> The ID of the member's permissions to delete.

Responses

Response samples

400
403
404
500

Content type

text/plain

No sample

Delete members permissions

Delete members permissions.

path Parameters

id

required

string <uuid>

The ID of the task.

Request Body schema:
application/json-patch+json

The IDs of the members permissions to delete.

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

400
403
404
500

Content type

text/plain

No sample

Change owner

Change the owner of a task.

path Parameters

id required	string <uuid> The ID of the task.
ownerId required	string <uuid> The ID of the new owner.

Responses

Response samples

400
403
404
500

Content type

text/plain

No sample

Get task email

Get the email details associated with a task.

path Parameters

id

required

string <uuid>

The ID of the task.

Responses

Response samples

200
400
403
404
500

Content type

text/plain

No sample

Update task email

Update the email details associated with a task.

path Parameters

id

required

string <uuid>

The ID of the task.

Request Body schema:
application/json-patch+json

The request containing the updated email settings.

from required	string
ccBcc	boolean
cc	string or null
bcc	string or null
ccQlikVariable	string or null <uuid>
bccQlikVariable	string or null <uuid>
subject required	string
message	string or null
isActive required	boolean
oneToAll	boolean

Responses

Request samples

Payload

Content type

application/json-patch+json

{"from": "string",
"ccBcc": true,
"cc": "string",
"bcc": "string",
"ccQlikVariable": "b6a9a39e-9f60-4061-a5c7-d76c97c0d292",
"bccQlikVariable": "15f165ef-b08e-4517-9856-7a12e51bb5d3",
"subject": "string",
"message": "string",
"isActive": true,
"oneToAll": true
}

Response samples

200
400
403
404
500

Content type

text/plain

No sample

Get task recipients

Get the recipients associated with a task.

path Parameters

id

required

string <uuid>

The ID of the task.

Responses

Response samples

200
400
403
404
500

Content type

text/plain

No sample

Update task recipients

Update the recipients associated with a task.

path Parameters

id

required

string <uuid>

The ID of the task.

Request Body schema:
application/json-patch+json

The list of recipient request DTOs.

Array

id required	string <uuid>
type required	string

Responses

Request samples

Payload

Content type

application/json-patch+json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "string"
}
]

Response samples

400
403
404
500

Content type

text/plain

No sample

Delete task recipients

Delete the specified recipients from the task.

path Parameters

id

required

string <uuid>

The ID of the task.

Request Body schema:
application/json-patch+json

The list of recipient IDs to be deleted.

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

400
403
404
500

Content type

text/plain

No sample

Add or update a schedule

Add or update a schedule for the specified task.

path Parameters

id

required

string <uuid>

The ID of the task.

query Parameters

taskScheduleID

string <uuid>

The ID of the task schedule, if updating an existing schedule.

Request Body schema:
application/json-patch+json

The request object containing schedule details.

name required	string
frequency	string or null
execution	string or null
priority	integer <int32>
timeZone required	string
day	integer <int32>
month	integer <int32>
atHour	integer or null <int32>
atMinut	integer or null <int32>
everyHours	integer <int32>
fromHour	integer or null <int32>
fromMinut	integer or null <int32>
toHour	integer or null <int32>
toMinut	integer or null <int32>
weeklyDays	string or null
startDate	string <date-time>
endDate	string <date-time>

Responses

Request samples

Payload

Content type

application/json-patch+json

{"name": "string",
"frequency": "string",
"execution": "string",
"priority": 0,
"timeZone": "string",
"day": 0,
"month": 0,
"atHour": 0,
"atMinut": 0,
"everyHours": 0,
"fromHour": 0,
"fromMinut": 0,
"toHour": 0,
"toMinut": 0,
"weeklyDays": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
}

Response samples

400
403
404
409
500

Content type

text/plain

No sample

Get task schedule

Get the schedule details for the specified task schedule ID.

path Parameters

id required	string <uuid> The ID of the task.
taskScheduleID required	string <uuid> The ID of the task schedule.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Get task schedules

Get the schedules associated with the specified task.

path Parameters

id

required

string <uuid>

The ID of the task.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Delete task schedules

Delete multiple task schedules based on their unique identifiers.

path Parameters

id

required

string <uuid>

The ID of the task whose schedules are to be deleted.

Request Body schema:
application/json-patch+json

A list of IDs of the schedules to delete.

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

200
403
404
500

Content type

text/plain

No sample

Add or update external event

Add or update an external event associated with a task. If a taskExternalEventID is provided, it updates the existing external event; otherwise, it adds a new external event.

path Parameters

id

required

string <uuid>

The ID of the task.

query Parameters

taskExternalEventID

string <uuid>

The ID of the external event (optional).

Request Body schema:
application/json-patch+json

The request containing information about the external event.

name required	string
execution required	string
priority required	integer <int32>
description	string or null
appID	string or null
qlikEvent required	string
startDate	string <date-time>
endDate	string <date-time>
timeZone	string or null

Responses

Request samples

Payload

Content type

application/json-patch+json

{"name": "string",
"execution": "string",
"priority": 0,
"description": "string",
"appID": "string",
"qlikEvent": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"timeZone": "string"
}

Response samples

Content type

text/plain

No sample

Get external event

Get a specific external event associated with a task identified by its ID and the external event ID.

path Parameters

id required	string <uuid> The ID of the task.
taskExternalEventID required	string <uuid> The ID of the external event.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Get task external event

Get a list of external events associated with a specific task identified by its ID.

path Parameters

id

required

string <uuid>

The ID of the task.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Get triggers

Get triggers associated with a specific task identified by its ID.

path Parameters

id

required

string <uuid>

The ID of the task.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Delete external events

Delete multiple external events associated with a specific task identified by its ID.

path Parameters

id

required

string <uuid>

The ID of the task.

Request Body schema:
application/json-patch+json

The IDs of the external events to delete.

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

200
400
403
404
500

Content type

text/plain

No sample

Delete external event

Delete a specific external event associated with a task identified by its ID and the ID of the external event.

path Parameters

id required	string <uuid> The ID of the task.
externalEventId required	string <uuid> The ID of the external event to delete.

Responses

Response samples

200
400
403
404
500

Content type

text/plain

No sample

Delete triggers

Delete multiple triggers associated with a task.

path Parameters

id

required

string <uuid>

The ID of the task.

Request Body schema:
application/json-patch+json

A list of trigger IDs to delete.

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

200
400
403
404
500

Content type

text/plain

No sample

Get task reports

Get reports associated with a specific task.

path Parameters

id

required

string <uuid>

The ID of the task.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Get task report

Get a specific task report.

path Parameters

id required	string <uuid> The ID of the task.
taskReportID required	string <uuid> The ID of the task report.

Responses

Response samples

200
403
404
500

Content type

text/plain

No sample

Add or update report

Add or update a report associated with a task.

path Parameters

id

required

string <uuid>

The ID of the task.

query Parameters

taskReportID

string <uuid>

The ID of the task report.

Request Body schema:
application/json-patch+json

The request containing the report details.

reportID required	string <uuid>
format required	string
emailEmbedment required	boolean
emailAttachment required	boolean
fileOpenPassword	string or null
fileWritePassword	string or null
isOpenFilePasswordProtected	boolean
isWriteFilePasswordProtected	boolean
	object (IterationReportDto)
	Array of objects or null (ReportFilterDto)
	Array of objects or null (ReportConditionDto)
	Array of objects or null (ReportStorageServiceDto)
	object (ReportHubDto)
	object (ReportFileStorageDto)
	object (SeparatorOptionsDto)

Responses

Request samples

Payload

Content type

application/json-patch+json

{"reportID": "8359868a-424a-4ab7-af4e-2c301663b76a",
"format": "string",
"emailEmbedment": true,
"emailAttachment": true,
"fileOpenPassword": "string",
"fileWritePassword": "string",
"isOpenFilePasswordProtected": true,
"isWriteFilePasswordProtected": true,
"iterationOptions": {"zipEmailFiles": true,
"evaluateConditionForEachIteration": true,
"recipientsVariable": "string"
},
"filters": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0
}
],
"conditions": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
],
"storageServices": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"fileStorageServiceID": "db6b02f1-07ca-4496-a2e2-141758930e83",
"type": "string",
"name": "string",
"path": "string",
"zipeFiles": true,
"siteUrl": "string",
"order": 0
}
],
"hub": {"folderID": "5b50a50a-0479-45f3-91f4-930134815ca7",
"hubMaxFileOccurrences": 0
},
"fileStorage": {"fileStorageServiceID": "db6b02f1-07ca-4496-a2e2-141758930e83",
"path": "string"
},
"separatorOptions": {"numberDecimalSeparator": "string",
"numberGroupSeparator": "string"
}
}

Response samples

Content type

text/plain

No sample

Delete task reports

Delete task reports associated with a task.

path Parameters

id

required

string <uuid>

The ID of the task.

Request Body schema:
application/json-patch+json

The IDs of the reports to delete.

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

200
403
404
500

Content type

text/plain

No sample

Run

Run a task

path Parameters

id

required

string <uuid>

The ID of the task to run.

Responses

Users

Add user

Add a new recipient. The recipient is added to the specified organizations and the default group 'All users'.

Request Body schema:
application/json-patch+json

The request containing details of the recipient to be added.

firstName required	string
lastName required	string
email	string or null
organizations required	Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Payload

Content type

application/json-patch+json

{"firstName": "string",
"lastName": "string",
"email": "string",
"organizations": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

200
400
409
500

Content type

text/plain

No sample

Get users

Get a list of users.

Responses

Response samples

200
500

Content type

text/plain

No sample

Update user

Update an existing user with the provided details. Supports updating user status, organizations, groups, organization roles, license, and tenant admin role.

path Parameters

id

required

string <uuid>

The ID of the user to be updated.

Request Body schema:
application/json-patch+json

The request containing details of the update action.

type required	string
value required	any

Responses

Request samples

Payload

Content type

application/json-patch+json

{"type": "string",
"value": null
}

Response samples

400
403
404
409
500

Content type

text/plain

No sample

Get user

Get information about a user.

path Parameters

id

required

string <uuid>

The ID of the user.

Responses

Response samples

200
404
500

Content type

text/plain

No sample

Delete user

Delete a user based on the provided user ID. Users cannot delete themselves. If the user is a tenant owner, deletion is forbidden. If the user has associated content, deletion is also forbidden.

path Parameters

id

required

string <uuid>

The ID of the user to delete.

Responses

Response samples

200
400
403
404
500

Content type

text/plain

No sample

Add users from Excel

Add users to the system by importing their details from an Excel file. Supported file formats include .xlsx, .xls, and .xlsm.

Responses

Response samples

400
415
500

Content type

text/plain

No sample

Transfer user content and authorizations

Transfer content and authorizations from one user to another based on the provided user ID and transfer request.

path Parameters

id

required

string <uuid>

The ID of the user whose content and authorizations will be transferred.

Request Body schema:
application/json-patch+json

The transfer request containing information about the new user and transfer options.

newUserID required	string <uuid>
transferContent required	boolean
transferPermissions required	boolean

Responses

Request samples

Payload

Content type

application/json-patch+json

{"newUserID": "7b14406f-6e5e-4539-9241-498262c20b44",
"transferContent": true,
"transferPermissions": true
}

Response samples

Content type

text/plain

No sample

Download import users template

Download an Excel file template for importing users.

Responses

Response samples

200
500

Content type

text/plain

No sample

Delete users

Delete multiple users based on their IDs.

Request Body schema:
application/json-patch+json

The list of user IDs to be deleted.

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json-patch+json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

200
400
403
500

Content type

text/plain

No sample

Invite users

Invite multiple users by email.

Request Body schema:
application/json-patch+json

The request containing the details of users to be invited.

emails required	Array of strings
tenantAdminRole	string or null
	Array of objects or null (OrganizationRoleDto)

Responses

Request samples

Payload

Content type

application/json-patch+json

{"emails": ["string"
],
"tenantAdminRole": "string",
"organizations": [{"organizationID": "7bbda8d5-3d76-4b0c-b85a-4ae115424874",
"roleName": "string"
}
]
}

Response samples

200
400
403
409
500

Content type

text/plain

No sample

Qalyptus Cloud API Documentation (beta) (v1)

API keys

Create API key

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Responses

Request samples

Response samples

Get user API keys

Responses

Response samples

Update API key

path Parameters

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Responses

Request samples

Response samples

Get user API key

path Parameters

Responses

Response samples

Delete API key

path Parameters

Responses

Delete API keys

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Responses

Request samples

Conditions

Create condition

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Responses

Request samples

Response samples

Get conditions

Responses

Response samples

Duplicate condition

path Parameters

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Responses

Request samples

Response samples

Update condition

path Parameters

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Responses

Request samples

Response samples

Get condition

path Parameters

Responses

Response samples

Delete condition

path Parameters

Responses

Response samples

Create or update rule

path Parameters

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Responses

Request samples

Response samples

Get project conditions

path Parameters

Responses

Response samples

Get rules

path Parameters

Responses

Response samples

Get rule

path Parameters

Responses

Response samples

Delete conditions

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Responses

Request samples

Response samples

Delete condition rules

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json