REST API: Miscellaneous

Methods


TypeVer.Command parameterParameters
Getters
GET3.0b1+ getSettings
Example of success:

GET11+ getSsoSettings
Example of success:

GET6b2+ getServerSettingsForm
Example of success:

GET11+ getSsoSettingsForm
Example of success:

GET6b2+ getUserPreferencesForm
Example of success:

Setters
POST6b2+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:
POST6b2+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:
POST6b2+clearUserPreferences
Example of success:

Example of failure:
Getters
GET9+ getExternalBugConnectorForm
Example of success:

Setters
POST9+deleteRequirementConnector connectorIndex=<index>
Example of success:

POST9+deleteBugConnector connectorIndex=<index>
Example of success:

GET6b2+ restartServer
Example of success:

Getters
GET6b2+ isServerRestartRequired
Example of success:

POST11+ checkDatabaseIntegrity
If the Database schema is invalid, an email is automatically sent to XQual support with details about the differences.

Example of success:

GET3.0b1+ getLocalization
Example of success:
GET3.3sp1+ getWebClientAgentId
Example of success:

GET9+ getWebClientAgent
Example of success:

GET6b1+ getDefinitions
Example of success:

GET6b1+ getDefinitionForm
Example of success:

GET3.0sp6+checkDatabaseSchemaCompatibility
Example of success:

Example of failure:
GET11+getLicenseWarning
Example of success:

GET7beta+ getDefaultUniqueName nodeType=<nodeType>
originalName=<originalName>
parentId=<id>
prefix=<prefix>
A unique name (in the current parent)
Setters
POST6+ deleteDeprecatedResultsFromCampaign campaignId=<id>
Example of success:

POST6+ deleteAllDeprecatedResults
Example of success:

POST6b1+createDefinition Content of the form with values
(see getDefinitionForm)
must be passed in the request's body
as multi-part.
Example of success:

POST6b1+ deleteDefinitions definitionIds=<id, id, ...>
Example of success:

POST4.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
GET10+ getTreeFilter treeFilterId=<id>
Example of success:

GET10+ getTreeFilterForm
Example of success:

GET10+ getTreeFilters treeType=<treeType>
Example of success:

Setters
POST10+createTreeFilter treeType=<treeType>
Content of the filter with
must be passed in the request's body.
See <treeFilter> for more details.
Example of success:

POST10+ deleteTreeFilters treeFilterIds=<id, id, ...>
Example of success:

Getters
GET10+ getMarketplaceCatalog
Example of success:

Setters
POST10+importPackage packageId=<packageId>
Example of success:

POST10+buyPackage packageId=<packageId>
licenseKey=<licenseKey>
Example of success: