- Introduction
- Authentication
- Miscellaneous
- User_rights
- Versioning
- Attachments
- Embedded Images
- Reports
- Custom Fields
- Search
- Discussion threads
- Folders
- Companies
- Categories
- User Profiles
- Users
- Teams
- SUTs
- Requirements
- Specifications
- Test Attributes
- Tests
- Test case Parameters
- Test cases
- Testcases referencing reusable testcases
- Campaigns
- Sessions
- Bugs
- Assets
- Agents
- SQL Reports
- Dashboard
- New Features
- Summary (Pre-formatted HTML)
- Types
Methods
getSessionForm
getSessionDetails
getSessionOperator
getSessionFollowers
getSessionBugs
getSessionSut
getSessionAgents
getSessionTestResults
getSessionTestcaseResults
getSessionTestcaseMessages
getSessionTestcaseAttachments
getSessionTestsAndTestcasesResults
getSessionResultsTests
getSessionResultsTestcases
getSessionResultsSteps
getSessionResultsStatistics
getSessionTestDataForExternalBug
getSessionTestcaseDataForExternalBug
getSessionDetails
getSessionOperator
getSessionFollowers
getSessionBugs
getSessionSut
getSessionAgents
getSessionTestResults
getSessionTestcaseResults
getSessionTestcaseMessages
getSessionTestcaseAttachments
getSessionTestsAndTestcasesResults
getSessionResultsTests
getSessionResultsTestcases
getSessionResultsSteps
getSessionResultsStatistics
getSessionTestDataForExternalBug
getSessionTestcaseDataForExternalBug
getSessionTestDataForBug
getSessionTestcaseDataForBug
getSessionConfigurations
getConfigurationsForCategory
getConfigurationsForJarName
getConfigurationForms
createConfiguration
getSessionInstanceId
getSessionWebClientInstanceId
getSessionTestsAndTestcasesForExecution
getSessionTestsForExecution
getSessionTestcaseForExecution
getTestExecutionsBugs
getSessionAttachments
createSession
updateSessionDetails
updateSessionAgents
updateSessionConfigurations
getSessionTestcaseDataForBug
getSessionConfigurations
getConfigurationsForCategory
getConfigurationsForJarName
getConfigurationForms
createConfiguration
getSessionInstanceId
getSessionWebClientInstanceId
getSessionTestsAndTestcasesForExecution
getSessionTestsForExecution
getSessionTestcaseForExecution
getTestExecutionsBugs
getSessionAttachments
createSession
updateSessionDetails
updateSessionAgents
updateSessionConfigurations
updateSessionOperator
updateSessionSut
updateSessionFollowers
updateSessionStatus
updateSessionStartDateTime
updateSessionStopDateTime
updateSessionTestResult
updateSessionTestcaseResult
uploadTestcaseExecutionAttachment
deleteTestcaseExecutionAttachment
linkTestExecutionsToBugs
copySessions
freezeSession
unfreezeSession
signSession
deleteSessions
deleteConfigurations
startSession
updateSessionSut
updateSessionFollowers
updateSessionStatus
updateSessionStartDateTime
updateSessionStopDateTime
updateSessionTestResult
updateSessionTestcaseResult
uploadTestcaseExecutionAttachment
deleteTestcaseExecutionAttachment
linkTestExecutionsToBugs
copySessions
freezeSession
unfreezeSession
signSession
deleteSessions
deleteConfigurations
startSession
Type | Ver. | Command parameter | Parameters |
Getters | |||
GET | 3.3+ | getSessionForm | campaignId=<id> |
Example of success: |
|||
GET | 3.3+ | getSessionDetails | sessionId=<id> (opt.) frozen=<true|false> |
Example of success: |
|||
GET | 3.3+ | getSessionOperator | sessionId=<id> |
Example of success: |
|||
GET | 3.3+ | getSessionFollowers | sessionId=<id> |
Example of success: |
|||
GET | 3.3+ | getSessionBugs | sessionId=<id> |
Example of success: |
|||
GET | 3.3+ | getSessionSut | sessionId=<id> |
Example of success: |
|||
GET | 3.3+ | getSessionAgents | sessionId=<id> |
Example of success: |
|||
GET | 3.3+ | getSessionTestResults | sessionId=<id> (opt.) agentId=<id> (opt.) instanceIndex |
If agentId is not provided or is null, the id corresponding to the [Web Client] is used. If instanceIndex is not provided or is null, the index 0 is used. Example of success: |
|||
GET | 3.3+ | getSessionTestcaseResults | sessionId=<id> testId=<id> (opt.) agentId=<id> (opt.) instanceIndex |
If agentId is not provided or is null, the id corresponding to the [Web Client] is used. If instanceIndex is not provided or is null, the index 0 is used. Example of success: |
|||
GET | 5+ | getSessionResultsTests | sessionId=<id> |
Example of success: |
|||
GET | 5+ | getSessionResultsTestcases | sessionId=<id> |
Example of success: |
|||
GET | 5+ | getSessionResultsSteps | sessionId=<id> |
Example of success: |
|||
GET | 5+ | getSessionResultsStatistics | sessionId=<id> |
Example of success: |
|||
GET | 3.3+ | getSessionTestcaseMessages | sessionId=<id> testcaseId=<id> (opt.) agentId=<id> (opt.) instanceIndex |
If agentId is not provided or is null, the id corresponding to the [Web Client] is used. If instanceIndex is not provided or is null, the index 0 is used. Example of success: |
|||
GET | 3.3+ | getSessionTestcaseAttachments | sessionId=<id> testcaseId=<id> (opt.) agentId=<id> (opt.) instanceIndex |
If agentId is not provided or is null, the id corresponding to the [Web Client] is used. If instanceIndex is not provided or is null, the index 0 is used. Example of success: |
|||
GET | 4.1sp4+ | getSessionTestsAndTestcasesResults | sessionId=<id> (opt.) agentId=<id> (opt.) instanceIndex |
If agentId is not provided or is null, the id corresponding to the [Web Client] is used. If instanceIndex is not provided or is null, the index 0 is used. Example of success: |
|||
GET | 4.1sp4+ to 4.1sp9 | getSessionTestDataForExternalBug (DEPRECATED) replaced by getSessionTestDataForBug |
sessionId=<id> testId=<id> |
Note: If the bugs are coming from a third-party system, the formatting is prepared for that specific system so that it can be directly used as-is. Example of success: |
|||
GET | 4.1sp4+ to 4.1sp9 | getSessionTestcaseDataForExternalBug (DEPRECATED) replaced by getSessionTestcaseDataForBug |
sessionId=<id> testcaseId=<id> |
Note: If the bugs are coming from a third-party system, the formatting is prepared for that specific system so that it can be directly used as-is. Example of success: |
|||
GET | 5.0b0+ | getSessionTestDataForBug | sessionId=<id> testId=<id> externalFormat=<true|false> |
Note: If the bugs are coming from a third-party system, the formatting is prepared for that specific system so that it can be directly used as-is. Example of success: |
|||
GET | 5.0b0+ | getSessionTestcaseDataForBug | sessionId=<id> testcaseId=<id> externalFormat=<true|false> |
Note: If the bugs are coming from a third-party system, the formatting is prepared for that specific system so that it can be directly used as-is. Example of success: |
|||
GET | 3.3+ | getSessionConfigurations | sessionId=<id> |
Note: If the session does not have any configuration associated to one of its category: - jarName and name are left empty- id has the value 0Example of success: |
|||
GET | 4.0sp1+ | getConfigurationsForCategory | categoryId=<id> |
Example of success: |
|||
GET | 3.3+ | getConfigurationsForJarName | jarName=<jar name (incl. extension)> |
Example of success: |
|||
GET | 4.0sp2+ | getConfigurationForms | categoryId=<> |
Example of success: |
|||
POST | 4.0sp2+ | createConfiguration | categoryId=<id> configurationName=<configuration name> Content of the forms with values (see getConfigurationForms) must be passed in the request's body as multi-part. |
Example of success: |
|||
GET | 3.3sp1+ | getSessionInstanceId | sessionId=<id> (opt.) agentId=<id> (opt.) instanceIndex=<index> |
If agentId is not provided or is null, the id corresponding to the [Web Client] is used. If instanceIndex is not provided or is null, the index 0 is used. Example of success: |
|||
GET | 3.3sp1+ | getSessionWebClientInstanceId | sessionId=<id> |
Example of success: |
|||
GET | 3.3sp1+ | getSessionTestsAndTestcasesForExecution | sessionId=<id> |
Example of success: |
|||
GET | 3.3sp1+ | getSessionTestsForExecution | sessionId=<id> |
Example of success: |
|||
GET | 3.3sp1+ | getSessionTestcaseForExecution | sessionId=<id> testcaseId=<id> |
Example of success: |
|||
GET | 4.1+ | getTestExecutionsBugs |
sessionId=<id> (opt.) agentId=<id> (opt.) instanceIndex=<index> testIds=<id, id...> |
If agentId is not provided or is null, the id corresponding to the [Web Client] is used. If instanceIndex is not provided or is null, the index 0 is used. Example of success: |
|||
GET | 3.0+ | getSessionAttachments | sessionId=<id> |
Example of success: |
|||
POST | 3.3+ | createSession | parentCampaignId=<id> sutId=<id> Content of the form with values (see getSessionForm) must be passed in the request's body as multi-part. |
Example of success: |
|||
POST | 3.2+ | updateSessionDetails | Content of the form with values (see getSessionDetails) must be passed in the request's body as multi-part. |
Example of success: Example of failure: | |||
POST | 4.0sp1+ | updateSessionAgents | sessionId=<id> agentIds=<id, id...> |
Example of success: Example of failure: | |||
POST | 4.0sp1+ | updateSessionConfigurations | sessionId=<id> categoryIds=<id, id...> configurationIds=<id, id...> |
Example of success: Example of failure: | |||
POST | 3.3+ | updateSessionOperator | sessionId=<id> operatorId=<id> |
Example of success: Example of failure: | |||
POST | 3.3+ | updateSessionSut | sessionId=<id> sutId=<id> |
Example of success: Example of failure: | |||
POST | 3.3+ | updateSessionFollowers | sessionId=<id> followerIds=<id, id, ...> |
Example of success: Example of failure: | |||
POST | 4.0+ | updateSessionStatus | sessionId=<id> status=<sessionStatus> |
Example of success: Example of failure: | |||
POST | 5+ | updateSessionState | sessionId=<id> state=<sessionState> |
Example of success: Example of failure: | |||
POST | 4.0+ | updateSessionStartDateTime | sessionId=<id> |
Example of success: Example of failure: | |||
POST | 4.0+ | updateSessionStopDateTime | sessionId=<id> |
Example of success: Example of failure: | |||
POST | 3.3sp1+ | updateSessionTestResult | sessionId=<id> instanceId=<id> testId=<id> result=<result> |
Note: This method should theoretically never be used as when you set a testcase result (see updateSessionTestcaseResult) the parent test's result is automatically consolidated and updated. Example of success: Example of failure: | |||
POST | 3.3sp1+ | updateSessionTestcaseResult | sessionId=<id> instanceId=<id> testcaseId=<id> Content of the message structure (see getSessionTestcaseForExecution) must be passed in the request's body as multi-part. |
As a reminder: The message structure must be formatted this way: Example of success: Example of failure: | |||
POST | 4.0sp1+ | uploadTestcaseExecutionAttachment | treeType=<treeType> attachmentName=<name> sessionId=<id> testcaseId=<id> (opt.) agentId=<id> (opt.) instanceIndex=<index> |
If agentId is not provided or is null, the id corresponding to the [Web Client] is used. If instanceIndex is not provided or is null, the index 0 is used. Content of the attachments must be passed in the request's body as multi-part. |
|||
POST | 4.0sp1+ | deleteTestcaseExecutionAttachments | treeType=<treeType> attachmentIds=<id, id, ...> attachmentNames=<name, name, ...> sessionId=<id> testcaseId=<id> (opt.) agentId=<id> (opt.) instanceIndex=<index> |
If agentId is not provided or is null, the id corresponding to the [Web Client] is used. If instanceIndex is not provided or is null, the index 0 is used. Example of success: |
|||
POST | 4.1+ | linkTestExecutionsToBugs |
sessionId=<id> (opt.) agentId=<id> (opt.) instanceIndex=<index> testIds=<id, id, ...> bugIds=<id, id, ...> |
If agentId is not provided or is null, the id corresponding to the [Web Client] is used. If instanceIndex is not provided or is null, the index 0 is used. Example of success: Example of failure: | |||
POST | 3.3sp1+ | copySessions | sessionIds=<id, id, ...> sessionNames=<name, name, ...> destCampaignId=<id> |
Example of success: Example of failure: | |||
POST | 3.3+ | freezeSession | sessionId=<id> |
Example of success: |
|||
POST | 3.3+ | unfreezeSession | sessionId=<id> |
Example of success: |
|||
POST | 3.0+ | deleteSessions | sessionIds=<id, id, ...> |
Example of success: |
|||
POST | 4.0sp1+ | deleteConfigurations | configurationIds=<id, id, ...> |
Example of success: |
|||
POST | 4.0+ to 5beta2 | startSession (DEPRECATED) | sessionId=<id> |
Example of success: |