Campaigns

This chapter focuses on services for the campaigns.

Get all campaigns

A GET to /campaigns returns all the campaigns that the client is allowed to read.

HTTP request

Snippet http-request not found for operation::RestCampaignControllerIT/browse-campaign

Request parameters

Snippet request-parameters not found for operation::RestCampaignControllerIT/browse-campaign

HTTP response

Snippet http-response not found for operation::RestCampaignControllerIT/browse-campaign

Response fields

Snippet response-fields not found for operation::RestCampaignControllerIT/browse-campaign

Snippet links not found for operation::RestCampaignControllerIT/browse-campaign

Create campaign

A POST to /campaigns creates a new campaign.

HTTP request

Snippet http-request not found for operation::RestCampaignControllerIT/post-campaign

HTTP response

Snippet http-response not found for operation::RestCampaignControllerIT/post-campaign

Get campaign

A GET to /campaigns/{id} returns the campaign with the given id.

Path parameters

Snippet path-parameters not found for operation::RestCampaignControllerIT/get-campaign

HTTP request

Snippet http-request not found for operation::RestCampaignControllerIT/get-campaign

Request parameters

Snippet request-parameters not found for operation::RestCampaignControllerIT/get-campaign

HTTP response

Snippet http-response not found for operation::RestCampaignControllerIT/get-campaign

Response fields

Snippet response-fields not found for operation::RestCampaignControllerIT/get-campaign

Snippet links not found for operation::RestCampaignControllerIT/get-campaign

Get campaigns by name

A GET to /campaignsByName with a given campaignName returns the campaigns with the given name. Be careful, both the name of the parameter campaignName and the value of the campaign name are case-sensitive.

HTTP request

Snippet http-request not found for operation::RestCampaignControllerIT/get-campaign-by-name

Request parameters

Snippet request-parameters not found for operation::RestCampaignControllerIT/get-campaign-by-name

HTTP response

Snippet http-response not found for operation::RestCampaignControllerIT/get-campaign-by-name

Response fields

Snippet response-fields not found for operation::RestCampaignControllerIT/get-campaign-by-name

Snippet links not found for operation::RestCampaignControllerIT/get-campaign-by-name

Modify campaign

A Patch to /campaigns/{id} modifies the campaign with the given id.

HTTP request

Snippet http-request not found for operation::RestCampaignControllerIT/patch-campaign

HTTP response

Snippet http-response not found for operation::RestCampaignControllerIT/patch-campaign

Delete campaign

A DELETE to /campaigns/{ids} deletes one or several campaign(s) with the given id(s).

Path parameters

Snippet path-parameters not found for operation::RestCampaignControllerIT/delete-campaign

HTTP request

Snippet http-request not found for operation::RestCampaignControllerIT/delete-campaign

Get iterations of campaign

A GET to /campaigns/{id}/iterations returns all the iterations of the campaign with the given id.

Path parameters

Snippet path-parameters not found for operation::RestCampaignControllerIT/get-campaign-iterations

HTTP request

Snippet http-request not found for operation::RestCampaignControllerIT/get-campaign-iterations

Request parameters

Snippet request-parameters not found for operation::RestCampaignControllerIT/get-campaign-iterations

HTTP response

Snippet http-response not found for operation::RestCampaignControllerIT/get-campaign-iterations

Response fields

Snippet response-fields not found for operation::RestCampaignControllerIT/get-campaign-iterations

Snippet links not found for operation::RestCampaignControllerIT/get-campaign-iterations

Get test plans of campaign

A GET to /campaigns/{id}/test-plan returns all the test-plans of the campaign with the given id.

Path parameters

Snippet path-parameters not found for operation::RestCampaignControllerIT/get-campaign-test-plan

HTTP request

Snippet http-request not found for operation::RestCampaignControllerIT/get-campaign-test-plan

Request parameters

Snippet request-parameters not found for operation::RestCampaignControllerIT/get-campaign-test-plan

HTTP response

Snippet http-response not found for operation::RestCampaignControllerIT/get-campaign-test-plan

Response fields

Snippet response-fields not found for operation::RestCampaignControllerIT/get-campaign-test-plan

Snippet links not found for operation::RestCampaignControllerIT/get-campaign-test-plan