REST API: Sessions

Methods

getSessionForm
getSessionDetails
getSessionOperator
getSessionFollowers
getSessionBugs
getSessionSut
getSessionAgents
getSessionTestResults
getSessionTestcaseResults
getSessionTestcaseMessages
getSessionTestcaseAttachments
getSessionTestsAndTestcasesResults
getSessionResultsTests
getSessionResultsTestcases
getSessionResultsSteps
getSessionResultsStatistics
getSessionTestDataForExternalBug
getSessionTestcaseDataForExternalBug
getSessionTestDataForBug
getSessionTestcaseDataForBug
getSessionConfigurations
getConfigurationsForCategory
getConfigurationsForJarName
getConfigurationForms
getConfigurationContent
createConfiguration
getSessionInstanceId
getSessionWebClientInstanceId
getSessionTestsAndTestcasesForExecution
getSessionTestsForExecution
getSessionTestcaseForExecution
getTestExecutionsBugs
getSessionMonitoring
getSessionSutDetails
getSessionMonitoredServers

getSessionStatus
getSessionName
getSessionExecutionOptions
getSessionOperatorName
getSessionOperatorEmail
getSessionFollowerEmails
getSessionAssets
getSessionTestPrerequisitesAndDescriptions
getSessionTestcaseDescriptionsAndStepsAndEditorTypes
getSessionTestCanonicalPathsAndAdditionalInfos
getSessionTestcaseAdditionalInfos
getSessionTestAttachments
getSessionTestAssets
getSessionTestBugsInOtherSessions
getSessionTestBugsInOtherSessions
getSessionTestAttributeValues
getSessionTestcaseParamValues
getSessionTestcasesWithStatus
getSessionTestcaseSteps
getSessionAgentStatus
getSessionInstances
getSessionTestcaseExecutionId
getSessionTestcasesResults
getInstanceTestcasesStats
getSessionTestConsolidationStatus
getSessionTestcaseExecutionAttachments
getSessionAttachments
getSessionFreezeStatus
createSession
updateSessionDetails
updateSessionAgents
updateSessionConfigurations
updateSessionOperator

updateSessionSut
updateSessionFollowers
updateSessionsFollowers
addSessionsFollower
removeSessionsFollower
updateSessionStatus
updateSessionsStatus
updateSessionStartDateTime
updateSessionStopDateTime
updateSessionTestResult
updateSessionTestcaseResult
updateSessionMonitoredServers
insertSessionAttributes
insertSessionParams
insertSessionAgent
insertSessionTestcaseResult
updateSessionTestcasesResult
insertSessionTestResult
updateSessionAgentStatus
insertInstanceCategorySyncId
deleteInstanceSyncId
deleteSelfService
initializeSessionResults
uploadTestcaseExecutionAttachment
deleteTestcaseExecutionAttachment
linkTestExecutionsToBugs
mergeSessions
copySessions
freezeSession
unfreezeSession
signSession
deleteSessions
deleteConfigurations
startSession
importResults

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 0 Example 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:
GET	9+	getConfigurationContent	confId=<>
		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	6+	getSessionMonitoring	sessionId=<id> agentId=<id>
		Example of success:
GET	6+	getSessionSutDetails	sessionId=<id>
		Example of success:
GET	6+	getSessionMonitoredServers	sessionId=<id>
		Example of success:
GET	6+	getSessionStatus	sessionId=<id>
		Example of success:
GET	6+	getSessionName	sessionId=<id>
		Example of success:
GET	6+	getSessionExecutionOptions	sessionId=<id>
		Example of success:
GET	6+	getSessionOperatorName	sessionId=<id>
		Example of success:
GET	6+	getSessionOperatorEmail	sessionId=<id>
		Example of success:
GET	6+	getSessionFollowerEmails	sessionId=<id>
		Example of success:
GET	6+	getSessionAssets	sessionId=<id>
		Example of success:
GET	6+	getSessionTestPrerequisitesAndDescriptions	sessionId=<id>
		Example of success:
GET	6+	getSessionTestcaseDescriptionsAndStepsAndEditorTypes	sessionId=<id>
		Example of success:
GET	6+	getSessionTestCanonicalPathsAndAdditionalInfos	sessionId=<id>
		Example of success:
GET	6+	getSessionTestcaseAdditionalInfos	sessionId=<id>
		Example of success:
GET	6+	getSessionTestAttachments	sessionId=<id>
		Example of success:
GET	6+	getSessionTestAssets	sessionId=<id>
		Example of success:
GET	6+	getSessionTestBugsInOtherSessions	sessionId=<id> (opt.) connectorIndex=<index>
		Example of success:
GET	6+	getSessionTestBugsInOtherSessions	sessionId=<id> (opt.) connectorIndex=<index>
		Example of success:
GET	6+	getSessionTestAttributeValues	sessionId=<id>
		Example of success:
GET	6+	getSessionTestcaseParamValues	sessionId=<id>
		Example of success:
GET	6+	getSessionTestcasesWithStatus	sessionId=<id>
		Example of success:
GET	6+	getSessionTestcaseSteps	sessionId=<id>
		Example of success:
GET	6+	getSessionAgentStatus	sessionId=<id> agentId=<id>
		Example of success:
GET	6+	getSessionInstances	sessionId=<id> agentId=<id>
		Example of success:
GET	6+	getSessionTestcaseExecutionId	sessionId=<id> testcaseId=<id> instanceId=<id> agentId=<id> instanceIndex=<index> either provide: sessionId, testcaseId and instanceId OR sessionId, testcaseId, agentId and instanceIndex
		Example of success:
GET	6+	getSessionTestcasesResults	sessionId=<id>
		Example of success:
GET	6+	getInstanceTestcasesStats	sessionId=<id> categoryIds=<id, id...> agentId=<id> instanceIndex=<index>
		Example of success:
GET	6+	getSessionTestConsolidationStatus	sessionId=<id> instanceId=<id> testId=<id>
		Example of success:
GET	6+	getSessionTestcaseExecutionAttachments	sessionId=<id> testcaseIds=<id, id...>
		Example of success:
GET	3.0+	getSessionAttachments	sessionId=<id>
		Example of success:
GET	6+	getSessionFreezeStatus	sessionId=<id>
		Example of success:
Setters
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	11+	updateSessionsFollowers	sessionIds=<id, id, ...> followerIds=<id, id, ...>
		Example of success: Example of failure:
POST	11+	addSessionsFollower	sessionIds=<id, id, ...> followerId=<id>
		Example of success: Example of failure:
POST	11+	removeSessionsFollower	sessionIds=<id, id, ...> followerId=<id>
		Example of success: Example of failure:
POST	4.0+	updateSessionStatus	sessionId=<id> status=<sessionStatus>
		Example of success: Example of failure:
POST	11+	updateSessionsStatus	sessionIds=<id, 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	6+	updateSessionMonitoredServers	sessionId=<id> monitoredServerIds=<id, id...>
		Example of success: Example of failure:
POST	6+	insertSessionAttributes	sessionId=<id> A json string containing all attribute values (see getSessionTestAttributeValues for the exact format) must be passed in the request's body as multi-part.
		Example of success: Example of failure:
POST	6+	insertSessionParams	sessionId=<id> A json string containing all params values (see getSessionTestcaseParamValues for the exact format) must be passed in the request's body as multi-part.
		Example of success: Example of failure:
POST	6+	insertSessionAgent	sessionId=<id> agentId=<id>
		Example of success: Example of failure:
POST	6+	insertSessionTestcaseResult	sessionId=<id> testcaseId=<id> instanceId=<id> result=<result> timestamp=<timestamp>
		Example of success: Example of failure:
POST	6+	updateSessionTestcasesResult	sessionId=<id> testcaseIds=<id, id...> instanceId=<id> result=<result> timestamp=<timestamp> clearComments=<true\|false>
		Example of success: Example of failure:
POST	6+	insertSessionTestResult	sessionId=<id> testId=<id> instanceId=<id> result=<result> timestamp=<timestamp>
		Example of success: Example of failure:
POST	6+	updateSessionAgentStatus	sessionId=<id> agentId=<id> status=<agentStatus>
		Example of success: Example of failure:
POST	6+	insertInstanceCategorySyncId	instanceId=<id> categoryId=<id> syncId=<id>
		Example of success: Example of failure:
POST	6+	deleteInstanceSyncId	instanceId=<id> categoryId=<id>
		Example of success: Example of failure:
POST	6+	deleteSelfService	sessionId=<id> agentId=<id> userId=<id>
		Example of success: Example of failure:
POST	6+	initializeSessionResults	sessionId=<id>
		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+	deleteTestcaseExecutionAttachment	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, ...> (opt.) connectorIndex=<index> The list of the bug Ids must be passed in the request's body in the object list format
		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	6beta4+	mergeSessions	sessionIds=<id, id, ...> mergeType=<mergeType>
		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:
GET	?	signSession
		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	sessionId=<id>
		Example of success:
POST	7+	importResults	sessionId=<id> filename=<filename> importFormat=<importFormat>
		Content of the attachment must be passed in the request's body as multi-part. Example of success: