Projects

This chapter focuses on project administration.

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::RestProjectAdminControllerIT/browse-project

Request parameters

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

HTTP response

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

Response fields

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

Snippet links not found for operation::RestProjectAdminControllerIT/browse-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::RestProjectAdminControllerIT/get-project

HTTP request

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

Request parameters

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

HTTP response

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

Response fields

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

Snippet links not found for operation::RestProjectAdminControllerIT/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::RestProjectAdminControllerIT/get-project-by-name

Request parameters

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

HTTP response

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

Response fields

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

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

Create project

A POST to /projects creates a new project.

  • Create new project

HTTP request

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

Request fields

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

Request parameters

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

HTTP response

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

Response fields

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

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

  • Create new project using template

HTTP request

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

Request fields

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

Request parameters

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

HTTP response

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

Response fields

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

Snippet links not found for operation::RestProjectAdminControllerIT/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::RestProjectAdminControllerIT/post-project-template

Request fields

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

Request parameters

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

HTTP response

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

Response fields

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

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

  • Create new template from existing project

HTTP request

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

Request fields

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

Request parameters

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

HTTP response

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

Response fields

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

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

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::RestProjectAdminControllerIT/get-project-permissions

HTTP request

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

Request parameters

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

HTTP response

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

Snippet links not found for operation::RestProjectAdminControllerIT/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::RestProjectAdminControllerIT/add-new-permission-to-project

HTTP request

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

Request parameters

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

HTTP response

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

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

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::RestProjectAdminControllerIT/delete-project-party

HTTP request

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

Bind custom field to project

A POST to /projects/{id}/custom-fields/{entity-type} bind custom field with the given id to given entity for given project.

HTTP request

Snippet http-request not found for operation::RestProjectAdminControllerIT/bind-custom-field-to-project

Path parameters

Snippet path-parameters not found for operation::RestProjectAdminControllerIT/bind-custom-field-to-project

Request parameters

Snippet request-parameters not found for operation::RestProjectAdminControllerIT/bind-custom-field-to-project

HTTP response

Snippet http-response not found for operation::RestProjectAdminControllerIT/bind-custom-field-to-project

Unbind custom field to project

A DELETE to /projects/{id}/custom-fields/{entity-type} unbind custom field with the given id to given entity for given project.

HTTP request

Snippet http-request not found for operation::RestProjectAdminControllerIT/unbind-custom-field-to-project

Path parameters

Snippet path-parameters not found for operation::RestProjectAdminControllerIT/unbind-custom-field-to-project

Request parameters

Snippet request-parameters not found for operation::RestProjectAdminControllerIT/unbind-custom-field-to-project

HTTP response

Snippet http-response not found for operation::RestProjectAdminControllerIT/unbind-custom-field-to-project

Bind info list to project

A POST to projects/{id}/info-lists/{list-type} bind the info list with the given id to the given project.

HTTP request

Snippet http-request not found for operation::RestProjectAdminControllerIT/bind-info-list-to-project

Path parameters

Snippet path-parameters not found for operation::RestProjectAdminControllerIT/bind-info-list-to-project

Request parameters

Snippet request-parameters not found for operation::RestProjectAdminControllerIT/bind-info-list-to-project

HTTP response

Snippet http-response not found for operation::RestProjectAdminControllerIT/bind-info-list-to-project

Bind milestones to a project

A POST to /projects/{id}/milestones associate a project with one or more milestones with the list of element IDs given in the request parameters. To consult the milestones just follow the link "milestones".

HTTP request

Snippet http-request not found for operation::RestProjectAdminControllerIT/bind-milestones-to-project

Path parameters

Snippet path-parameters not found for operation::RestProjectAdminControllerIT/bind-milestones-to-project

Request parameters

Snippet request-parameters not found for operation::RestProjectAdminControllerIT/bind-milestones-to-project

HTTP response

Snippet http-response not found for operation::RestProjectAdminControllerIT/bind-milestones-to-project

Response fields

Snippet response-fields not found for operation::RestProjectAdminControllerIT/bind-milestones-to-project

Snippet links not found for operation::RestProjectAdminControllerIT/bind-milestones-to-project

Get all milestones bound to a project

A GET to /projects/{id}/milestones to find all the milestones that are linked to a project

Path parameters

Snippet path-parameters not found for operation::RestProjectAdminControllerIT/get-all-milestones-for-project

HTTP request

Snippet http-request not found for operation::RestProjectAdminControllerIT/get-all-milestones-for-project

HTTP response

Snippet http-response not found for operation::RestProjectAdminControllerIT/get-all-milestones-for-project

Bind a bug tracker to a project

A POST to /projects/{id}/bug-trackers associate a project with the bug-tracker with the given id.

HTTP request

Snippet http-request not found for operation::RestProjectAdminControllerIT/bind-bugtracker-to-project

Path parameters

Snippet path-parameters not found for operation::RestProjectAdminControllerIT/bind-bugtracker-to-project

Request parameters

Snippet request-parameters not found for operation::RestProjectAdminControllerIT/bind-bugtracker-to-project

HTTP response

Snippet http-response not found for operation::RestProjectAdminControllerIT/bind-bugtracker-to-project

Response fields

Snippet response-fields not found for operation::RestProjectAdminControllerIT/bind-bugtracker-to-project

Snippet links not found for operation::RestProjectAdminControllerIT/bind-bugtracker-to-project

Unbind a bug tracker from a project

A DELETE to /projects/{id}/bug-tracker dissociate the project with given id from its bug tracker.

HTTP request

Snippet http-request not found for operation::RestProjectAdminControllerIT/unbind-bugtracker-from-project

HTTP response

Snippet http-response not found for operation::RestProjectAdminControllerIT/unbind-bugtracker-from-project

Snippet links not found for operation::RestProjectAdminControllerIT/unbind-bugtracker-from-project

Get the bug tracker bound to a project

A GET to projects/{id}/bug-trackers to find the bug-tracker linked to a project.

Path parameters

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

HTTP request

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

HTTP response

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

Bind a scm repository to a project

A POST to /projects/{id}/scm-repository associate the project with given id to the scm repository given as parameter.

HTTP request

Snippet http-request not found for operation::RestProjectAdminControllerIT/bind-scm-repository-to-project

Path parameters

Snippet path-parameters not found for operation::RestProjectAdminControllerIT/bind-scm-repository-to-project

Request parameters

Snippet request-parameters not found for operation::RestProjectAdminControllerIT/bind-scm-repository-to-project

HTTP response

Snippet http-response not found for operation::RestProjectAdminControllerIT/bind-scm-repository-to-project

Snippet links not found for operation::RestProjectAdminControllerIT/bind-scm-repository-to-project

Unbind a scm repository from a project

A DELETE to /projects/{id}/scm-repository dissociate the project with given id from its scm repository.

HTTP request

Snippet http-request not found for operation::RestProjectAdminControllerIT/unbind-scm-repository-from-project

Path parameters

Snippet path-parameters not found for operation::RestProjectAdminControllerIT/unbind-scm-repository-from-project

HTTP response

Snippet http-response not found for operation::RestProjectAdminControllerIT/unbind-scm-repository-from-project

Snippet links not found for operation::RestProjectAdminControllerIT/unbind-scm-repository-from-project

Get project automation configuration

A GET to projects/{id}/automation-conf to find a project automation configuration.

Path parameters

Snippet path-parameters not found for operation::RestProjectAdminControllerIT/get-project-automation-configuration

HTTP request

Snippet http-request not found for operation::RestProjectAdminControllerIT/get-project-automation-configuration

HTTP response

Snippet http-response not found for operation::RestProjectAdminControllerIT/get-project-automation-configuration

Response fields

Snippet response-fields not found for operation::RestProjectAdminControllerIT/get-project-automation-configuration

Snippet links not found for operation::RestProjectAdminControllerIT/get-project-automation-configuration

Modify project automation configuration

A PATCH to projects/{id}/automation-conf modifies the automation configuration of the projet with the given id.

Path parameters

Snippet path-parameters not found for operation::RestProjectAdminControllerIT/patch-project-automation-configuration

HTTP request

Snippet http-request not found for operation::RestProjectAdminControllerIT/patch-project-automation-configuration

Request fields

Snippet request-fields not found for operation::RestProjectAdminControllerIT/patch-project-automation-configuration

HTTP response

Snippet http-response not found for operation::RestProjectAdminControllerIT/patch-project-automation-configuration

Response fields

Snippet response-fields not found for operation::RestProjectAdminControllerIT/patch-project-automation-configuration

Snippet links not found for operation::RestProjectAdminControllerIT/patch-project-automation-configuration

Enable or disable plugin of project

A POST to projects/{id}/plugin/{pluginId}/activate activates or deactivates the plugin with the given id.

HTTP request

Snippet http-request not found for operation::RestProjectAdminControllerIT/activate-deactivate-plugin-to-project

Path parameters

Snippet path-parameters not found for operation::RestProjectAdminControllerIT/activate-deactivate-plugin-to-project

Request parameters

Snippet request-parameters not found for operation::RestProjectAdminControllerIT/activate-deactivate-plugin-to-project

HTTP response

Snippet http-response not found for operation::RestProjectAdminControllerIT/activate-deactivate-plugin-to-project