REST API: Campaigns

Methods


TypeVer.Command parameterParameters
Getters
GET3.3+ getCampaignsTree
Example of success:

GET? getCampaignRootStatistics
Example of success:

GET? getCampaignFolderStatistics
Example of success:

GET3.3+ getCampaignForm
Example of success:

GET3.3+ getCampaignDetails campaignId=<id>
(opt.) frozen=<true|false>
Example of success:

GET3.3+ getCampaignLinkedSuts campaignId=<id>
Example of success:

GET3.3+ getCampaignLinkedRequirements campaignId=<id>
Example of success:

GET3.3+ getCampaignLinkedSpecifications campaignId=<id>
Example of success:

GET3.3+ getCampaignLinkedSutsFullyCovered campaignId=<id>
Example of success:

GET3.3+ getCampaignLinkedSutsPartiallyCovered campaignId=<id>
Example of success:

GET3.3+ getCampaignLinkedSutsNotCovered campaignId=<id>
Example of success:

GET3.3+ getCampaignLinkedRequirementsFullyCovered campaignId=<id>
(opt.) connectorIndex=<index>
Example of success:

GET3.3+ getCampaignLinkedRequirementsPartiallyCovered campaignId=<id>
(opt.) connectorIndex=<index>
Example of success:

GET3.3+ getCampaignLinkedRequirementsNotCovered campaignId=<id>
(opt.) connectorIndex=<index>
Example of success:

GET3.3+ getCampaignLinkedSpecificationsFullyCovered campaignId=<id>
Example of success:

GET3.3+ getCampaignLinkedSpecificationsPartiallyCovered campaignId=<id>
Example of success:

GET3.3+ getCampaignLinkedSpecificationsNotCovered campaignId=<id>
Example of success:

GET5+ getCampaignResultsTestProgress campaignId=<id>
startDate=<date>
stopDate=<date>
Example of success:

GET5+ getCampaignResultsTestcaseProgress campaignId=<id>
startDate=<date>
stopDate=<date>
Example of success:

GET5+ getCampaignResultsTests campaignId=<id>
Example of success:

GET5+ getCampaignResultsTestcases campaignId=<id>
Example of success:

GET5+ getCampaignResultsSteps campaignId=<id>
Example of success:

GET5+ getCampaignResultsHistory campaignId=<id>
Example of success:

GET6+ getCampaignResultsRequirementsSummary campaignId=<id>
(opt.) connectorIndex=<index>
Example of success:

GET5+ getCampaignResultsRequirements campaignId=<id>
(opt.) connectorIndex=<index>
Example of success:

GET5+ getCampaignResultsTreeview campaignId=<id>
Example of success:

GET4.1+ getCampaignCategories campaignId=<id>
Example of success:

GET3.3+ getCampaignSessions campaignId=<id>
Example of success:

GET3.3+ getCampaignTests campaignId=<id>
Example of success:

GET3.0+ getCampaignAttachments campaignId=<id>
Example of success:

GET3.0+ getCampaignInheritedAttachments campaignId=<id>
Example of success:

GET6+ getCampaignFreezeStatus campaignId=<id>
Example of success:

Setters
POST3.3+createCampaign parentFolderId=<id>
Content of the form with values
(see getCampaignForm)
must be passed in the request's body
as multi-part.
Example of success:

POST4.0+createResidualCampaign destParentFolderId=<id>
srcSessionIds=<id, id, ...>
rulesMask=<rulesMask>
Content of the form with values
(see getCampaignForm)
must be passed in the request's body
as multi-part.
Example of success:

POST3.3+updateCampaignDetails Content of the form with values
(see getCampaignDetails)
must be passed in the request's body
as multi-part.
Example of success:

Example of failure:
POST3.3+updateCampaignTests campaignId=<id>
testIds=<id, id, ...>
Example of success:

Example of failure:
POST4.0+updateCampaignTestsOrder campaignId=<id>
testIds=<id, id, ...>
Example of success:

POST5+copyCampaigns campaignIds=<id, id, ...>
campaignNames=<id, id, ...>
destParentFolderId=<id>
Example of success:

POST3.3+moveCampaigns campaignIds=<id, id, ...>
campaignNames=<name, name, ...>
destParentFolderId=<id>
Example of success:

POST3.3+freezeCampaign campaignId=<id>
Example of success:

POST3.3+unfreezeCampaign campaignId=<id>
Example of success:

GET? signCampaign
Example of success:

POST3.0+deleteCampaigns campaignIds=<id, id, ...>
Example of success: