REST API: Miscellaneous

Methods

getSettings
getSsoSettings
getServerSettingsForm
getSsoSettingsForm
getUserPreferencesForm
updateServerSettings
updateUserPreferences
clearUserPreferences
getExternalBugConnectorForm
deleteBugConnector
deleteRequirementConnector
restartServer
isServerRestartRequired
isNextServerRestartNightly
checkDatabaseIntegrity

getLocalization
getWebClientAgentId
getWebClientAgent
getDefinitions
getDefinitionForm
checkDatabaseSchemaCompatibility
getLicenseWarning
getDefaultUniqueName

deleteDeprecatedResultsFromCampaign
deleteAllDeprecatedResults
createDefinition
deleteDefinitions
importData

getTreeFilter
getTreeFilterForm
getTreeFilters
createTreeFilter
deleteTreeFilters

getMarketplaceCatalog
importPackage
buyPackage

Type	Ver.	Command parameter	Parameters
Getters
GET	3.0b1+	getSettings
		Example of success:
GET	11+	getSsoSettings
		Example of success:
GET	6b2+	getServerSettingsForm
		Example of success:
GET	11+	getSsoSettingsForm
		Example of success:
GET	6b2+	getUserPreferencesForm
		Example of success:
Setters
POST	6b2+	updateServerSettings	Content of the form with values (see getServerSettingsForm) must be passed in the request's body as multi-part.
		Example of success: Example of failure:
POST	6b2+	updateUserPreferences	Content of the form with values (see getUserPreferencesForm) must be passed in the request's body as multi-part.
		Example of success: Example of failure:
POST	6b2+	clearUserPreferences
		Example of success: Example of failure:
Getters
GET	9+	getExternalBugConnectorForm
		Example of success:
Setters
POST	9+	deleteRequirementConnector	connectorIndex=<index>
		Example of success:
POST	9+	deleteBugConnector	connectorIndex=<index>
		Example of success:
GET	6b2+	restartServer
		Example of success:
Getters
GET	6b2+	isServerRestartRequired
		Example of success:
POST	11+	checkDatabaseIntegrity
		If the Database schema is invalid, an email is automatically sent to XQual support with details about the differences. Example of success:
GET	3.0b1+	getLocalization
		Example of success:
GET	3.3sp1+	getWebClientAgentId
		Example of success:
GET	9+	getWebClientAgent
		Example of success:
GET	6b1+	getDefinitions
		Example of success:
GET	6b1+	getDefinitionForm
		Example of success:
GET	3.0sp6+	checkDatabaseSchemaCompatibility
		Example of success: Example of failure:
GET	11+	getLicenseWarning
		Example of success:
GET	7beta+	getDefaultUniqueName	nodeType=<nodeType> originalName=<originalName> parentId=<id> prefix=<prefix>
		A unique name (in the current parent)
Setters
POST	6+	deleteDeprecatedResultsFromCampaign	campaignId=<id>
		Example of success:
POST	6+	deleteAllDeprecatedResults
		Example of success:
POST	6b1+	createDefinition	Content of the form with values (see getDefinitionForm) must be passed in the request's body as multi-part.
		Example of success:
POST	6b1+	deleteDefinitions	definitionIds=<id, id, ...>
		Example of success:
POST	4.0sp1+	importData	filename=<filename> importType=<importType> importFormat=<importFormat> conflictResolution=<conflictResolution>
		Content of the attachment must be passed in the request's body as multi-part. Example of success:
Getters
GET	10+	getTreeFilter	treeFilterId=<id>
		Example of success:
GET	10+	getTreeFilterForm
		Example of success:
GET	10+	getTreeFilters	treeType=<treeType>
		Example of success:
Setters
POST	10+	createTreeFilter	treeType=<treeType> Content of the filter with must be passed in the request's body. See <treeFilter> for more details.
		Example of success:
POST	10+	deleteTreeFilters	treeFilterIds=<id, id, ...>
		Example of success:
Getters
GET	10+	getMarketplaceCatalog
		Example of success:
Setters
POST	10+	importPackage	packageId=<packageId>
		Example of success:
POST	10+	buyPackage	packageId=<packageId> licenseKey=<licenseKey>
		Example of success: