Projects

This chapter focuses on services for the projects.

Get all projects

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

HTTP request

Snippet http-request not found for operation::RestProjectControllerIT/browse-project

Request parameters

Snippet request-parameters not found for operation::RestProjectControllerIT/browse-project

HTTP response

Snippet http-response not found for operation::RestProjectControllerIT/browse-project

Response fields

Snippet response-fields not found for operation::RestProjectControllerIT/browse-project

Snippet links not found for operation::RestProjectControllerIT/browse-project

Create project

A POST to /projects creates a new project.

  • Create new project

HTTP request

Snippet http-request not found for operation::RestProjectControllerIT/post-project

Request fields

Snippet request-fields not found for operation::RestProjectControllerIT/post-project

Request parameters

Snippet request-parameters not found for operation::RestProjectControllerIT/post-project

HTTP response

Snippet http-response not found for operation::RestProjectControllerIT/post-project

Response fields

Snippet response-fields not found for operation::RestProjectControllerIT/post-project

Snippet links not found for operation::RestProjectControllerIT/post-project

  • Create new project using template

HTTP request

Snippet http-request not found for operation::RestProjectControllerIT/post-project-from-template

Request fields

Snippet request-fields not found for operation::RestProjectControllerIT/post-project-from-template

Request parameters

Snippet request-parameters not found for operation::RestProjectControllerIT/post-project-from-template

HTTP response

Snippet http-response not found for operation::RestProjectControllerIT/post-project-from-template

Response fields

Snippet response-fields not found for operation::RestProjectControllerIT/post-project-from-template

Snippet links not found for operation::RestProjectControllerIT/post-project-from-template

Create project template

A POST to /projects creates a new project template.

  • Create new template

HTTP request

Snippet http-request not found for operation::RestProjectControllerIT/post-project-template

Request fields

Snippet request-fields not found for operation::RestProjectControllerIT/post-project-template

Request parameters

Snippet request-parameters not found for operation::RestProjectControllerIT/post-project-template

HTTP response

Snippet http-response not found for operation::RestProjectControllerIT/post-project-template

Response fields

Snippet response-fields not found for operation::RestProjectControllerIT/post-project-template

Snippet links not found for operation::RestProjectControllerIT/post-project-template

  • Create new template from existing project

HTTP request

Snippet http-request not found for operation::RestProjectControllerIT/post-project-template-from-project

Request fields

Snippet request-fields not found for operation::RestProjectControllerIT/post-project-template-from-project

Request parameters

Snippet request-parameters not found for operation::RestProjectControllerIT/post-project-template-from-project

HTTP response

Snippet http-response not found for operation::RestProjectControllerIT/post-project-template-from-project

Response fields

Snippet response-fields not found for operation::RestProjectControllerIT/post-project-template-from-project

Snippet links not found for operation::RestProjectControllerIT/post-project-template-from-project

Get project

A GET to /projects/{id} returns the project with the given id. This retrieves a project administration data and is only authorized to administrators.

Path parameters

Snippet path-parameters not found for operation::RestProjectControllerIT/get-project

HTTP request

Snippet http-request not found for operation::RestProjectControllerIT/get-project

Request parameters

Snippet request-parameters not found for operation::RestProjectControllerIT/get-project

HTTP response

Snippet http-response not found for operation::RestProjectControllerIT/get-project

Response fields

Snippet response-fields not found for operation::RestProjectControllerIT/get-project

Snippet links not found for operation::RestProjectControllerIT/get-project

Get project by name

A GET to /projects with a request parameter projectName returns the project with the given name. This retrieves a project administration data and is only authorized to administrators. Be careful, both the name of the parameter projectName and the value of the project name are case-sensitive.

HTTP request

Snippet http-request not found for operation::RestProjectControllerIT/get-project-by-name

Request parameters

Snippet request-parameters not found for operation::RestProjectControllerIT/get-project-by-name

HTTP response

Snippet http-response not found for operation::RestProjectControllerIT/get-project-by-name

Response fields

Snippet response-fields not found for operation::RestProjectControllerIT/get-project-by-name

Snippet links not found for operation::RestProjectControllerIT/get-project-by-name

Get project permissions

A GET to /projects/{id}/permissions returns the permission groups of the project with the given id.

Path parameters

Snippet path-parameters not found for operation::RestProjectControllerIT/get-project-permissions

HTTP request

Snippet http-request not found for operation::RestProjectControllerIT/get-project-permissions

Request parameters

Snippet request-parameters not found for operation::RestProjectControllerIT/get-project-permissions

HTTP response

Snippet http-response not found for operation::RestProjectControllerIT/get-project-permissions

Snippet links not found for operation::RestProjectControllerIT/get-project-permissions

Add permissions to project

A POST to /projects/{id}/permissions/{permissionGroup} adds certain users or teams to the permission group of the project with the given id.

The possible {permissionGroup} are test_editor, project_viewer, project_manager, test_runner, test_designer, advanced_tester and validator.

Path parameters

Snippet path-parameters not found for operation::RestProjectControllerIT/add-new-permission-to-project

HTTP request

Snippet http-request not found for operation::RestProjectControllerIT/add-new-permission-to-project

Request parameters

Snippet request-parameters not found for operation::RestProjectControllerIT/add-new-permission-to-project

HTTP response

Snippet http-response not found for operation::RestProjectControllerIT/add-new-permission-to-project

Snippet links not found for operation::RestProjectControllerIT/add-new-permission-to-project

Get campaigns of project

A GET to /projects/{id}/campaigns returns the campaigns in the project with the given id.

Path parameters

Snippet path-parameters not found for operation::RestProjectControllerIT/get-project-campaigns

HTTP request

Snippet http-request not found for operation::RestProjectControllerIT/get-project-campaigns

Request parameters

Snippet request-parameters not found for operation::RestProjectControllerIT/get-project-campaigns

HTTP response

Snippet http-response not found for operation::RestProjectControllerIT/get-project-campaigns

Response fields

Snippet response-fields not found for operation::RestProjectControllerIT/get-project-campaigns

Snippet links not found for operation::RestProjectControllerIT/get-project-campaigns

Get requirements of project

A GET to /projects/{id}/requirements returns the requirements in the project with the given id.

Path parameters

Snippet path-parameters not found for operation::RestProjectControllerIT/get-project-requirements

HTTP request

Snippet http-request not found for operation::RestProjectControllerIT/get-project-requirements

Request parameters

Snippet request-parameters not found for operation::RestProjectControllerIT/get-project-requirements

HTTP response

Snippet http-response not found for operation::RestProjectControllerIT/get-project-requirements

Response fields

Snippet response-fields not found for operation::RestProjectControllerIT/get-project-requirements

Snippet links not found for operation::RestProjectControllerIT/get-project-requirements

Get test cases of project

A GET to /projects/{id}/test-cases returns the test cases in the project with the given id.

Path parameters

Snippet path-parameters not found for operation::RestProjectControllerIT/get-project-test-cases

HTTP request

Snippet http-request not found for operation::RestProjectControllerIT/get-project-test-cases

Request parameters

Snippet request-parameters not found for operation::RestProjectControllerIT/get-project-test-cases

HTTP response

Snippet http-response not found for operation::RestProjectControllerIT/get-project-test-cases

Response fields

Snippet response-fields not found for operation::RestProjectControllerIT/get-project-test-cases

Snippet links not found for operation::RestProjectControllerIT/get-project-test-cases

Get campaign library contents

A GET to /projects/{id}/campaigns-library/content returns the contents of the campaign library in the project with the given id.

Path parameters

Snippet path-parameters not found for operation::RestProjectControllerIT/browse-campaign-library-content

HTTP request

Snippet http-request not found for operation::RestProjectControllerIT/browse-campaign-library-content

Request parameters

Snippet request-parameters not found for operation::RestProjectControllerIT/browse-campaign-library-content

HTTP response

Snippet http-response not found for operation::RestProjectControllerIT/browse-campaign-library-content

Response fields

Snippet response-fields not found for operation::RestProjectControllerIT/browse-campaign-library-content

Snippet links not found for operation::RestProjectControllerIT/browse-campaign-library-content

Get requirement library contents

A GET to /projects/{id}/requirements-library/content returns the contents of the requirement library in the project with the given id.

Path parameters

Snippet path-parameters not found for operation::RestProjectControllerIT/browse-requirement-library-content

HTTP request

Snippet http-request not found for operation::RestProjectControllerIT/browse-requirement-library-content

Request parameters

Snippet request-parameters not found for operation::RestProjectControllerIT/browse-requirement-library-content

HTTP response

Snippet http-response not found for operation::RestProjectControllerIT/browse-requirement-library-content

Response fields

Snippet response-fields not found for operation::RestProjectControllerIT/browse-requirement-library-content

Snippet links not found for operation::RestProjectControllerIT/browse-requirement-library-content

Get test case library contents

A GET to /projects/{id}/test-cases-library/content returns the contents of the test case library in the project with the given id.

Path parameters

Snippet path-parameters not found for operation::RestProjectControllerIT/browse-test-case-library-content

HTTP request

Snippet http-request not found for operation::RestProjectControllerIT/browse-test-case-library-content

Request parameters

Snippet request-parameters not found for operation::RestProjectControllerIT/browse-test-case-library-content

HTTP response

Snippet http-response not found for operation::RestProjectControllerIT/browse-test-case-library-content

Response fields

Snippet response-fields not found for operation::RestProjectControllerIT/browse-test-case-library-content

Snippet links not found for operation::RestProjectControllerIT/browse-test-case-library-content

Delete permission(s) in project

A DELETE to /projects/{projectId}/users/{partyIds} deletes one or several user(s) with the given id(s) (separated with comma).

Path parameters

Snippet path-parameters not found for operation::RestProjectControllerIT/delete-project-party

HTTP request

Snippet http-request not found for operation::RestProjectControllerIT/delete-project-party