The Rest Administration API plugin is built on top of the Squash TM Rest API. It provides you with additional services that allows a remote user to perform administration tasks on the platform.
Bug Trackers
This chapter focuses on services for the bug trackers.
Get all bug trackers
A GET
to /bug-trackers
returns all the bug trackers.
HTTP request
Snippet http-request not found for operation::RestBugTrackerControllerIT/find-all-bugtrackers
Request parameters
Snippet request-parameters not found for operation::RestBugTrackerControllerIT/find-all-bugtrackers
Example response
Snippet http-response not found for operation::RestBugTrackerControllerIT/find-all-bugtrackers
Response fields
Snippet response-fields not found for operation::RestBugTrackerControllerIT/find-all-bugtrackers
Links
Snippet links not found for operation::RestBugTrackerControllerIT/find-all-bugtrackers
Get bug tracker
A GET
to /bug-trackers/{id}
returns the bug tracker with the given id.
HTTP request
Snippet http-request not found for operation::RestBugTrackerControllerIT/find-bugtracker-by-id
Path parameters
Snippet path-parameters not found for operation::RestBugTrackerControllerIT/find-bugtracker-by-id
Example response
Snippet http-response not found for operation::RestBugTrackerControllerIT/find-bugtracker-by-id
Response fields
Snippet response-fields not found for operation::RestBugTrackerControllerIT/find-bugtracker-by-id
Links
Snippet links not found for operation::RestBugTrackerControllerIT/find-bugtracker-by-id
Create bug tracker
A POST
to /bug-trackers
creates a new bug tracker.
HTTP request
Snippet http-request not found for operation::RestBugTrackerControllerIT/add-new-bugtracker
Request fields
Snippet request-fields not found for operation::RestBugTrackerControllerIT/add-new-bugtracker
Example response
Snippet http-response not found for operation::RestBugTrackerControllerIT/add-new-bugtracker
Response fields
Snippet response-fields not found for operation::RestBugTrackerControllerIT/add-new-bugtracker
Links
Snippet links not found for operation::RestBugTrackerControllerIT/add-new-bugtracker
Modify bug tracker
A PATCH
to /bug-trackers/{id}
modifies the bug trackers with the given id.
HTTP request
Snippet http-request not found for operation::RestBugTrackerControllerIT/update-bugtracker
Path parameters
Snippet path-parameters not found for operation::RestBugTrackerControllerIT/update-bugtracker
Request fields
Snippet request-fields not found for operation::RestBugTrackerControllerIT/update-bugtracker
Example response
Snippet http-response not found for operation::RestBugTrackerControllerIT/update-bugtracker
Response fields
Snippet response-fields not found for operation::RestBugTrackerControllerIT/update-bugtracker
Links
Snippet links not found for operation::RestBugTrackerControllerIT/update-bugtracker
Delete bug tracker
A DELETE
to /bug-trackers/{ids}
deletes one or several bug tracker(s) with the given id(s).
HTTP request
Snippet http-request not found for operation::RestBugTrackerControllerIT/delete-bugtracker
Path parameters
Snippet path-parameters not found for operation::RestBugTrackerControllerIT/delete-bugtracker
Get bug tracker credentials
A GET
to /bug-trackers/{id}/credentials
get the credentials of the bug tracker with the given id.
-
In case of basic auth credentials:
HTTP request
Snippet http-request not found for operation::RestBugTrackerControllerIT/get-bugtracker-basic-auth-credentials
Path parameters
Snippet path-parameters not found for operation::RestBugTrackerControllerIT/get-bugtracker-basic-auth-credentials
Example response
Snippet http-response not found for operation::RestBugTrackerControllerIT/get-bugtracker-basic-auth-credentials
Response fields
Snippet response-fields not found for operation::RestBugTrackerControllerIT/get-bugtracker-basic-auth-credentials
-
In case of oauth-1a credentials:
HTTP request
Snippet http-request not found for operation::RestBugTrackerControllerIT/get-bugtracker-oauth-1a-credentials
Path parameters
Snippet path-parameters not found for operation::RestBugTrackerControllerIT/get-bugtracker-oauth-1a-credentials
Example response
Snippet http-response not found for operation::RestBugTrackerControllerIT/get-bugtracker-oauth-1a-credentials
Response fields
Snippet response-fields not found for operation::RestBugTrackerControllerIT/get-bugtracker-oauth-1a-credentials
Set bug tracker credentials
A POST
to /bug-trackers/{id}/credentials
set the credentials of the bug tracker with the given id.
-
In case of basic auth credentials:
HTTP request
Snippet http-request not found for operation::RestBugTrackerControllerIT/set-bugtracker-basic-auth-credentials
Path parameters
Snippet path-parameters not found for operation::RestBugTrackerControllerIT/set-bugtracker-basic-auth-credentials
Request fields
Snippet request-fields not found for operation::RestBugTrackerControllerIT/set-bugtracker-basic-auth-credentials
Example response
Snippet http-response not found for operation::RestBugTrackerControllerIT/set-bugtracker-basic-auth-credentials
Response fields
Snippet response-fields not found for operation::RestBugTrackerControllerIT/set-bugtracker-basic-auth-credentials
-
In case of oauth-1a credentials:
HTTP request
Snippet http-request not found for operation::RestBugTrackerControllerIT/set-bugtracker-oauth-1a-credentials
Path parameters
Snippet path-parameters not found for operation::RestBugTrackerControllerIT/set-bugtracker-oauth-1a-credentials
Request fields
Snippet request-fields not found for operation::RestBugTrackerControllerIT/set-bugtracker-oauth-1a-credentials
Example response
Snippet http-response not found for operation::RestBugTrackerControllerIT/set-bugtracker-oauth-1a-credentials
Response fields
Snippet response-fields not found for operation::RestBugTrackerControllerIT/set-bugtracker-oauth-1a-credentials
Get bug tracker authentication configuration
A GET
to /bug-trackers/{id}/auth-configuration
get the authentication configuration of the bug tracker with the given id.
Only a bug tracker using OAuth 1a authentication protocol can have an authentication configuration.
HTTP request
Snippet http-request not found for operation::RestBugTrackerControllerIT/get-bugtracker-auth-configuration
Path parameters
Snippet path-parameters not found for operation::RestBugTrackerControllerIT/get-bugtracker-auth-configuration
Example response
Snippet http-response not found for operation::RestBugTrackerControllerIT/get-bugtracker-auth-configuration
Response fields
Snippet response-fields not found for operation::RestBugTrackerControllerIT/get-bugtracker-auth-configuration
Set bug tracker authentication configuration
A POST
to /bug-trackers/{id}/auth-configuration
sets the authentication configuration of the bug tracker with the given id.
Only a bug tracker using OAuth 1a authentication protocol can have an authentication configuration.
HTTP request
Snippet http-request not found for operation::RestBugTrackerControllerIT/set-bugtracker-auth-configuration
Path parameters
Snippet path-parameters not found for operation::RestBugTrackerControllerIT/set-bugtracker-auth-configuration
Example response
Snippet http-response not found for operation::RestBugTrackerControllerIT/set-bugtracker-auth-configuration
Response fields
Snippet response-fields not found for operation::RestBugTrackerControllerIT/set-bugtracker-auth-configuration
Custom Fields
This chapter focuses on custom fields. Custom fields are extra fields that can be attached to certain entities. The set of such extra fields is defined by per-project configuration, which means for instance that two test cases in two distinct projects may have different custom fields.
Please be careful not to be confused with Custom Field Values : whereas a Custom Field is the abstract definition of a field, a Custom Field Value represents an actual value for that field.
TODO : les différents sous-types etc.
Get all custom fields
A GET
to /custom-fields
returns all the custom fields.
HTTP request
Snippet http-request not found for operation::RestCustomFieldControllerIT/find-all-custom-fields
Request parameters
Snippet request-parameters not found for operation::RestCustomFieldControllerIT/find-all-custom-fields
Example response
Snippet http-response not found for operation::RestCustomFieldControllerIT/find-all-custom-fields
Response fields
Snippet response-fields not found for operation::RestCustomFieldControllerIT/find-all-custom-fields
Links
Snippet links not found for operation::RestCustomFieldControllerIT/find-all-custom-fields
Get custom field
A GET
to /custom-fields/{id}
returns the custom field with the given ID.
Path parameters
Snippet path-parameters not found for operation::RestCustomFieldControllerIT/find-custom-fields-by-id
HTTP request
Snippet http-request not found for operation::RestCustomFieldControllerIT/find-custom-fields-by-id
Request parameters
Snippet request-parameters not found for operation::RestCustomFieldControllerIT/find-custom-fields-by-id
Example response
Snippet http-response not found for operation::RestCustomFieldControllerIT/find-custom-fields-by-id
Response fields
Snippet response-fields not found for operation::RestCustomFieldControllerIT/find-custom-fields-by-id
Links
Snippet links not found for operation::RestCustomFieldControllerIT/find-custom-fields-by-id
Create custom field
A POST
to /custom-fields
creates a new custom field.
HTTP request
Snippet http-request not found for operation::RestCustomFieldControllerIT/add-new-custom-field
Request fields
Snippet request-fields not found for operation::RestCustomFieldControllerIT/add-new-custom-field
Example response
Snippet http-response not found for operation::RestCustomFieldControllerIT/add-new-custom-field
Response fields
Snippet response-fields not found for operation::RestCustomFieldControllerIT/add-new-custom-field
Links
Snippet links not found for operation::RestCustomFieldControllerIT/add-new-custom-field
Modify custom field
A PATCH
to /custom-fields/{id}
modifies the custom field with the given id.
HTTP request
Snippet http-request not found for operation::RestCustomFieldControllerIT/update-custom-field
Path parameters
Snippet path-parameters not found for operation::RestCustomFieldControllerIT/update-custom-field
Request fields
Snippet request-fields not found for operation::RestCustomFieldControllerIT/update-custom-field
Example response
Snippet http-response not found for operation::RestCustomFieldControllerIT/update-custom-field
Response fields
Snippet response-fields not found for operation::RestCustomFieldControllerIT/update-custom-field
Links
Snippet links not found for operation::RestCustomFieldControllerIT/update-custom-field
Delete custom field
A DELETE
to /custom-fields/{ids}
deletes the custom field(s) with the given id(s).
HTTP request
Snippet http-request not found for operation::RestCustomFieldControllerIT/delete-custom-field
Path parameters
Snippet path-parameters not found for operation::RestCustomFieldControllerIT/delete-custom-field
Example response
Snippet http-response not found for operation::RestCustomFieldControllerIT/delete-custom-field
![]() |
Features about custom field options must be modified. |
Add custom field option
A POST
to /custom-fields/{id}/options
adds option to the custom field with the given id .
HTTP request
Snippet http-request not found for operation::RestCustomFieldControllerIT/add-new-custom-field-option
Path parameters
Snippet path-parameters not found for operation::RestCustomFieldControllerIT/add-new-custom-field-option
Request fields
Snippet request-fields not found for operation::RestCustomFieldControllerIT/add-new-custom-field-option
Example response
Snippet http-response not found for operation::RestCustomFieldControllerIT/add-new-custom-field-option
Response fields
Snippet response-fields not found for operation::RestCustomFieldControllerIT/add-new-custom-field-option
Links
Snippet links not found for operation::RestCustomFieldControllerIT/add-new-custom-field-option
Update custom field option label
A PATCH
to /custom-fields/{id}/options/{optionLabel}/label/{newValue}
modifies the label of the option with given original label .
HTTP request
Snippet http-request not found for operation::RestCustomFieldControllerIT/update-custom-field-option
Path parameters
Snippet path-parameters not found for operation::RestCustomFieldControllerIT/update-custom-field-option
Example response
Snippet http-response not found for operation::RestCustomFieldControllerIT/update-custom-field-option
Response fields
Snippet response-fields not found for operation::RestCustomFieldControllerIT/update-custom-field-option
Links
Snippet links not found for operation::RestCustomFieldControllerIT/update-custom-field-option
Info Lists
This chapter focuses on info lists.
Get all info lists
A GET
to /info-lists
returns all the info lists.
HTTP request
Snippet http-request not found for operation::RestInfoListControllerIT/find-all-info-lists
Request parameters
Snippet request-parameters not found for operation::RestInfoListControllerIT/find-all-info-lists
Example response
Snippet http-response not found for operation::RestInfoListControllerIT/find-all-info-lists
Response fields
Snippet response-fields not found for operation::RestInfoListControllerIT/find-all-info-lists
Links
Snippet links not found for operation::RestInfoListControllerIT/find-all-info-lists
Get info list
A GET
to /info-lists/{id}
returns the info list with the given id.
HTTP request
Snippet http-request not found for operation::RestInfoListControllerIT/find-info-list-by-id
Path parameters
Snippet path-parameters not found for operation::RestInfoListControllerIT/find-info-list-by-id
Example response
Snippet http-response not found for operation::RestInfoListControllerIT/find-info-list-by-id
Response fields
Snippet response-fields not found for operation::RestInfoListControllerIT/find-info-list-by-id
Links
Snippet links not found for operation::RestInfoListControllerIT/find-info-list-by-id
Create info list
A POST
to /info-lists
creates a new info list.
HTTP request
Snippet http-request not found for operation::RestInfoListControllerIT/add-new-info-list
Request fields
Snippet request-fields not found for operation::RestInfoListControllerIT/add-new-info-list
Example response
Snippet http-response not found for operation::RestInfoListControllerIT/add-new-info-list
Response fields
Snippet response-fields not found for operation::RestInfoListControllerIT/add-new-info-list
Links
Snippet links not found for operation::RestInfoListControllerIT/add-new-info-list
Modify info list
A PATCH
to /info-lists/{id}
modifies the info list with the given id.
HTTP request
Snippet http-request not found for operation::RestInfoListControllerIT/update-info-list
Path parameters
Snippet path-parameters not found for operation::RestInfoListControllerIT/update-info-list
Request fields
Snippet request-fields not found for operation::RestInfoListControllerIT/update-info-list
Example response
Snippet http-response not found for operation::RestInfoListControllerIT/update-info-list
Response fields
Snippet response-fields not found for operation::RestInfoListControllerIT/update-info-list
Links
Snippet links not found for operation::RestInfoListControllerIT/update-info-list
Delete info list
A DELETE
to /info-lists/{ids}
deletes the info list(s) with the given id(s).
If associated with at least one project, the objects will permanently be disassociated with the info list(s). The default list will be activated and the values associated to the objects will be reset to the default 'Undefined' value.
HTTP request
Snippet http-request not found for operation::RestInfoListControllerIT/delete-info-list
Path parameters
Snippet path-parameters not found for operation::RestInfoListControllerIT/delete-info-list
Example response
Snippet http-response not found for operation::RestInfoListControllerIT/delete-info-list
Info List Items
This chapter focuses on info list items.
Get info list item
A GET
to /info-list-items/{id}
returns the info list item with the given id.
HTTP request
Snippet http-request not found for operation::RestInfoListItemControllerIT/find-info-list-item-by-id
Path parameters
Snippet path-parameters not found for operation::RestInfoListItemControllerIT/find-info-list-item-by-id
Example response
Snippet http-response not found for operation::RestInfoListItemControllerIT/find-info-list-item-by-id
Response fields
Snippet response-fields not found for operation::RestInfoListItemControllerIT/find-info-list-item-by-id
Links
Snippet links not found for operation::RestInfoListItemControllerIT/find-info-list-item-by-id
Create info list item
A POST
to /info-lists/{id}/items
creates a new info list item.
HTTP request
Snippet http-request not found for operation::RestInfoListItemControllerIT/add-new-info-list-item
Path parameters
Snippet path-parameters not found for operation::RestInfoListItemControllerIT/add-new-info-list-item
Request fields
Snippet request-fields not found for operation::RestInfoListItemControllerIT/add-new-info-list-item
Example response
Snippet http-response not found for operation::RestInfoListItemControllerIT/add-new-info-list-item
Response fields
Snippet response-fields not found for operation::RestInfoListItemControllerIT/add-new-info-list-item
Links
Snippet links not found for operation::RestInfoListItemControllerIT/add-new-info-list-item
Modify info list item
A PATCH
to /info-list-items/{id}
modifies the info list item with the given id.
HTTP request
Snippet http-request not found for operation::RestInfoListItemControllerIT/update-info-list-item
Path parameters
Snippet path-parameters not found for operation::RestInfoListItemControllerIT/update-info-list-item
Request fields
Snippet request-fields not found for operation::RestInfoListItemControllerIT/update-info-list-item
Example response
Snippet http-response not found for operation::RestInfoListItemControllerIT/update-info-list-item
Response fields
Snippet response-fields not found for operation::RestInfoListItemControllerIT/update-info-list-item
Links
Snippet links not found for operation::RestInfoListItemControllerIT/update-info-list-item
Delete info list item
A DELETE
to /info-list-items/{id}
deletes the info list item with the given id.
If the info list item to delete is the default one, then it cannot be deleted.
HTTP request
Snippet http-request not found for operation::RestInfoListItemControllerIT/delete-info-list-item
Path parameters
Snippet path-parameters not found for operation::RestInfoListItemControllerIT/delete-info-list-item
Example response
Snippet http-response not found for operation::RestInfoListItemControllerIT/delete-info-list-item
License Information
This chapter focuses on information from the license file.
Get information from the Premium license file
A GET
to /license/info
returns information from the Premium license file.
HTTP request
Snippet http-request not found for operation::RestLicenseInfoControllerIT/find-license-info
Request parameters
Snippet request-parameters not found for operation::RestLicenseInfoControllerIT/find-license-info
Example response
Snippet http-response not found for operation::RestLicenseInfoControllerIT/find-license-info
Response fields
Snippet response-fields not found for operation::RestLicenseInfoControllerIT/find-license-info
Links
Snippet links not found for operation::RestLicenseInfoControllerIT/find-license-info
Login Message
This chapter focuses on the message showing in Squash TM Login Page.
Get login message
A GET
to /login-message
returns the login message.
HTTP request
Snippet http-request not found for operation::RestLoginMessageControllerIT/get-login-message
Example response
Snippet http-response not found for operation::RestLoginMessageControllerIT/get-login-message
Response fields
Snippet response-fields not found for operation::RestLoginMessageControllerIT/get-login-message
Modify login message
A PATCH
to /login-message
modifies the login message.
HTTP request
Snippet http-request not found for operation::RestLoginMessageControllerIT/update-login-message
Request fields
Snippet request-fields not found for operation::RestLoginMessageControllerIT/update-login-message
Example response
Snippet http-response not found for operation::RestLoginMessageControllerIT/update-login-message
Response fields
Snippet response-fields not found for operation::RestLoginMessageControllerIT/update-login-message
Milestones
This chapter focuses on milestones. Milestones allow you to “version” your test repository and to view only the objects (requirements, test cases and campaigns) associated with them. With milestones, you can in particular organize your object libraries by version, create a new version of the repository from an existing version, synchronize two versions …
Activate / deactivate milestones mode
A POST
to /milestones/activate
activate / deactivate milestones mode, according to the value sent in the parameter.
HTTP request
Snippet http-request not found for operation::RestMilestoneControllerIT/activate-mode-milestones
Request parameters
Snippet request-parameters not found for operation::RestMilestoneControllerIT/activate-mode-milestones
Example response
Snippet http-response not found for operation::RestMilestoneControllerIT/activate-mode-milestones
Get all milestones
A GET
to /milestones
returns all the milestones that the user is allowed to read.
HTTP request
Snippet http-request not found for operation::RestMilestoneControllerIT/find-all-milestones
Request parameters
Snippet request-parameters not found for operation::RestMilestoneControllerIT/find-all-milestones
Example response
Snippet http-response not found for operation::RestMilestoneControllerIT/find-all-milestones
Response fields
Snippet response-fields not found for operation::RestMilestoneControllerIT/find-all-milestones
Links
Snippet links not found for operation::RestMilestoneControllerIT/find-all-milestones
Get milestone
A GET
to /milestones/{id}
returns the milestone with the given id.
Path parameters
Snippet path-parameters not found for operation::RestMilestoneControllerIT/find-milestone-by-id
HTTP request
Snippet http-request not found for operation::RestMilestoneControllerIT/find-milestone-by-id
Example response
Snippet http-response not found for operation::RestMilestoneControllerIT/find-milestone-by-id
Response fields
Snippet response-fields not found for operation::RestMilestoneControllerIT/find-milestone-by-id
Links
Snippet links not found for operation::RestMilestoneControllerIT/find-milestone-by-id
Create milestone
A POST
to /milestones
creates a new milestone.
HTTP request
Snippet http-request not found for operation::RestMilestoneControllerIT/add-new-milestone
Request fields
Snippet request-fields not found for operation::RestMilestoneControllerIT/add-new-milestone
Example response
Snippet http-response not found for operation::RestMilestoneControllerIT/add-new-milestone
Response fields
Snippet response-fields not found for operation::RestMilestoneControllerIT/add-new-milestone
Links
Snippet links not found for operation::RestMilestoneControllerIT/add-new-milestone
Modify milestone
A PATCH
to /milestones/{id}
modifies the milestone with the given id.
HTTP request
Snippet http-request not found for operation::RestMilestoneControllerIT/update-milestone
Path parameters
Snippet path-parameters not found for operation::RestMilestoneControllerIT/update-milestone
Request fields
Snippet request-fields not found for operation::RestMilestoneControllerIT/update-milestone
Example response
Snippet http-response not found for operation::RestMilestoneControllerIT/update-milestone
Response fields
Snippet response-fields not found for operation::RestMilestoneControllerIT/update-milestone
Links
Snippet links not found for operation::RestMilestoneControllerIT/update-milestone
Delete milestone
A DELETE
to /milestones/{ids}
deletes one or several milestone(s) with the given id(s).
Path parameters
Snippet path-parameters not found for operation::RestMilestoneControllerIT/delete-milestone
HTTP request
Snippet http-request not found for operation::RestMilestoneControllerIT/delete-milestone
Example response
Snippet http-response not found for operation::RestMilestoneControllerIT/delete-milestone
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
Example response
Snippet http-response not found for operation::RestProjectAdminControllerIT/browse-project
Response fields
Snippet response-fields not found for operation::RestProjectAdminControllerIT/browse-project
Links
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
Example response
Snippet http-response not found for operation::RestProjectAdminControllerIT/get-project
Response fields
Snippet response-fields not found for operation::RestProjectAdminControllerIT/get-project
Links
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
Example 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
Links
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
Example response
Snippet http-response not found for operation::RestProjectAdminControllerIT/post-project
Response fields
Snippet response-fields not found for operation::RestProjectAdminControllerIT/post-project
Links
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
Example 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
Links
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
Example 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
Links
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
Example 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
Links
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
Example response
Snippet http-response not found for operation::RestProjectAdminControllerIT/get-project-permissions
Links
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
Example response
Snippet http-response not found for operation::RestProjectAdminControllerIT/add-new-permission-to-project
Links
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
Example 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
Example 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
Example 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
Example 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
Links
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
Example 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
Example 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
Links
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
Example response
Snippet http-response not found for operation::RestProjectAdminControllerIT/unbind-bugtracker-from-project
Links
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
Example 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
Example response
Snippet http-response not found for operation::RestProjectAdminControllerIT/bind-scm-repository-to-project
Links
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
Example response
Snippet http-response not found for operation::RestProjectAdminControllerIT/unbind-scm-repository-from-project
Links
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
Example 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
Links
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
Example 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
Links
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
Example response
Snippet http-response not found for operation::RestProjectAdminControllerIT/activate-deactivate-plugin-to-project
Requirement Version Link Types
This chapter focuses on types of links between requirements.
Get all link type
A GET
to /requirement-link-types
returns all the link types.
HTTP request
Snippet http-request not found for operation::RestLinkTypeControllerIT/find-all-link-type
Request parameters
Snippet request-parameters not found for operation::RestLinkTypeControllerIT/find-all-link-type
Example response
Snippet http-response not found for operation::RestLinkTypeControllerIT/find-all-link-type
Response fields
Snippet response-fields not found for operation::RestLinkTypeControllerIT/find-all-link-type
Links
Snippet links not found for operation::RestLinkTypeControllerIT/find-all-link-type
Get link type by id
A GET
to /requirement-link-types/{id}
returns the link type with the given id.
Path parameters
Snippet path-parameters not found for operation::RestLinkTypeControllerIT/find-link-type-by-id
HTTP request
Snippet http-request not found for operation::RestLinkTypeControllerIT/find-link-type-by-id
Request parameters
Snippet request-parameters not found for operation::RestLinkTypeControllerIT/find-link-type-by-id
Example response
Snippet http-response not found for operation::RestLinkTypeControllerIT/find-link-type-by-id
Response fields
Snippet response-fields not found for operation::RestLinkTypeControllerIT/find-link-type-by-id
Links
Snippet links not found for operation::RestLinkTypeControllerIT/find-link-type-by-id
Get link type by code role
A GET
to /requirement-link-types
returns the link type with the given code role.
HTTP request
Snippet http-request not found for operation::RestLinkTypeControllerIT/find-link-type-by-code
Request parameters
Snippet request-parameters not found for operation::RestLinkTypeControllerIT/find-link-type-by-code
Example response
Snippet http-response not found for operation::RestLinkTypeControllerIT/find-link-type-by-code
Response fields
Snippet response-fields not found for operation::RestLinkTypeControllerIT/find-link-type-by-code
Links
Snippet links not found for operation::RestLinkTypeControllerIT/find-link-type-by-code
Create link type
A POST
to /requirement-link-types
creates a new link type.
HTTP request
Snippet http-request not found for operation::RestLinkTypeControllerIT/create-link-type
Request fields
Snippet request-fields not found for operation::RestLinkTypeControllerIT/create-link-type
Request parameters
Snippet request-parameters not found for operation::RestLinkTypeControllerIT/create-link-type
Example response
Snippet http-response not found for operation::RestLinkTypeControllerIT/create-link-type
Response fields
Snippet response-fields not found for operation::RestLinkTypeControllerIT/create-link-type
Links
Snippet links not found for operation::RestLinkTypeControllerIT/create-link-type
Modify link type
A PATCH
to /requirement-link-types/{id}
modifies the link type with the given id.
HTTP request
Snippet http-request not found for operation::RestLinkTypeControllerIT/update-link-type
Path parameters
Snippet path-parameters not found for operation::RestLinkTypeControllerIT/update-link-type
Request fields
Snippet request-fields not found for operation::RestLinkTypeControllerIT/update-link-type
Example response
Snippet http-response not found for operation::RestLinkTypeControllerIT/update-link-type
Delete link type
A DELETE
to /requirement-link-types/{ids}
deletes one or several link type(s) with the given id(s).
Path parameters
Snippet path-parameters not found for operation::RestLinkTypeControllerIT/delete-link-type
HTTP request
Snippet http-request not found for operation::RestLinkTypeControllerIT/delete-link-type
Example response
Snippet http-response not found for operation::RestLinkTypeControllerIT/delete-link-type
Source Code Management Repositories
This chapter is managed on source code management repositories.
Get scm repository
A GET
to /scm-repositories/{id}
returns the source code management repository with the given id.
Path parameters
Snippet path-parameters not found for operation::RestScmRepositoryControllerIT/find-scm-repository-by-id
HTTP request
Snippet http-request not found for operation::RestScmRepositoryControllerIT/find-scm-repository-by-id
Request parameters
Snippet request-parameters not found for operation::RestScmRepositoryControllerIT/find-scm-repository-by-id
Example response
Snippet http-response not found for operation::RestScmRepositoryControllerIT/find-scm-repository-by-id
Response fields
Snippet response-fields not found for operation::RestScmRepositoryControllerIT/find-scm-repository-by-id
Links
Snippet links not found for operation::RestScmRepositoryControllerIT/find-scm-repository-by-id
Modify scm repository
A PATCH
to /scm-repositories/{id}
modifies the source code management repository with the given id.
HTTP request
Snippet http-request not found for operation::RestScmRepositoryControllerIT/patch-scm-repository
Path parameters
Snippet path-parameters not found for operation::RestScmRepositoryControllerIT/patch-scm-repository
Request parameters
Snippet request-parameters not found for operation::RestScmRepositoryControllerIT/patch-scm-repository
Example response
Snippet http-response not found for operation::RestScmRepositoryControllerIT/patch-scm-repository
Response fields
Snippet response-fields not found for operation::RestScmRepositoryControllerIT/patch-scm-repository
Delete scm repository
A DELETE
to /scm-repositories/{ids}
deletes one or several source code management repositories with the given id(s).
Path parameters
Snippet path-parameters not found for operation::RestScmRepositoryControllerIT/remove-scm-repository
HTTP request
Snippet http-request not found for operation::RestScmRepositoryControllerIT/remove-scm-repository
Example response
Snippet http-response not found for operation::RestScmRepositoryControllerIT/remove-scm-repository
Source Code Management Servers
This chapter is managed on source code management servers.
Get all scm servers
A GET
to /scm-servers
returns all the source code management servers.
HTTP request
Snippet http-request not found for operation::RestScmServerControllerIT/find-all-scm-server
Request parameters
Snippet request-parameters not found for operation::RestScmServerControllerIT/find-all-scm-server
Example response
Snippet http-response not found for operation::RestScmServerControllerIT/find-all-scm-server
Response fields
Snippet response-fields not found for operation::RestScmServerControllerIT/find-all-scm-server
Links
Snippet links not found for operation::RestScmServerControllerIT/find-all-scm-server
Get scm server
A GET
to /scm-servers/{id}
returns the source code management server with the given id.
Path parameters
Snippet path-parameters not found for operation::RestScmServerControllerIT/find-scm-server-by-id
HTTP request
Snippet http-request not found for operation::RestScmServerControllerIT/find-scm-server-by-id
Request parameters
Snippet request-parameters not found for operation::RestScmServerControllerIT/find-scm-server-by-id
Example response
Snippet http-response not found for operation::RestScmServerControllerIT/find-scm-server-by-id
Response fields
Snippet response-fields not found for operation::RestScmServerControllerIT/find-scm-server-by-id
Links
Snippet links not found for operation::RestScmServerControllerIT/find-scm-server-by-id
Create scm server
A POST
to /scm-servers
creates a new source code management server.
HTTP request
Snippet http-request not found for operation::RestScmServerControllerIT/create-scm-server
Request fields
Snippet request-fields not found for operation::RestScmServerControllerIT/create-scm-server
Request parameters
Snippet request-parameters not found for operation::RestScmServerControllerIT/create-scm-server
Example response
Snippet http-response not found for operation::RestScmServerControllerIT/create-scm-server
Response fields
Snippet response-fields not found for operation::RestScmServerControllerIT/create-scm-server
Links
Snippet links not found for operation::RestScmServerControllerIT/create-scm-server
Modify scm server
A PATCH
to /scm-servers/{id}
modifies the source code management server with the given id.
Path parameters
Snippet path-parameters not found for operation::RestScmServerControllerIT/update-scm-server
HTTP request
Snippet http-request not found for operation::RestScmServerControllerIT/update-scm-server
Request fields
Snippet request-fields not found for operation::RestScmServerControllerIT/update-scm-server
Example response
Snippet http-response not found for operation::RestScmServerControllerIT/update-scm-server
Response fields
Snippet response-fields not found for operation::RestScmServerControllerIT/update-scm-server
Links
Snippet links not found for operation::RestScmServerControllerIT/update-scm-server
Delete scm server
A DELETE
to /scm-servers/{ids}
deletes one or several source code management servers with the given id(s).
Path parameters
Snippet path-parameters not found for operation::RestScmServerControllerIT/delete-scm-server
HTTP request
Snippet http-request not found for operation::RestScmServerControllerIT/delete-scm-server
Example response
Snippet http-response not found for operation::RestScmServerControllerIT/delete-scm-server
Get all scm repositories from the scm server
A GET
to /scm-servers/{id}/scm-repositories
returns all the source code management repository for the scm server.
HTTP request
Snippet http-request not found for operation::RestScmServerControllerIT/find-all-repository-for-scm-server
Request parameters
Snippet request-parameters not found for operation::RestScmServerControllerIT/find-all-repository-for-scm-server
Example response
Snippet http-response not found for operation::RestScmServerControllerIT/find-all-repository-for-scm-server
Response fields
Snippet response-fields not found for operation::RestScmServerControllerIT/find-all-repository-for-scm-server
Links
Snippet links not found for operation::RestScmServerControllerIT/find-all-repository-for-scm-server
Add a scm repository to a scm server
A POST
to /scm-servers/{id}/scm-repositories
creates a new source code management repository for the given scm server id .
HTTP request
Snippet http-request not found for operation::RestScmServerControllerIT/add-scm-repository
Path parameters
Snippet path-parameters not found for operation::RestScmServerControllerIT/add-scm-repository
Request fields
Snippet request-fields not found for operation::RestScmServerControllerIT/add-scm-repository
Request parameters
Snippet request-parameters not found for operation::RestScmServerControllerIT/add-scm-repository
Example response
Snippet http-response not found for operation::RestScmServerControllerIT/add-scm-repository
Response fields
Snippet response-fields not found for operation::RestScmServerControllerIT/add-scm-repository
Links
Snippet links not found for operation::RestScmServerControllerIT/add-scm-repository
Get scm server credentials
A GET
to /scm-servers/{id}/credentials
get the credentials for the given source code management server.
HTTP request
Snippet http-request not found for operation::RestScmServerControllerIT/get-scm-server-credentials
Path parameters
Snippet path-parameters not found for operation::RestScmServerControllerIT/get-scm-server-credentials
Example response
Snippet http-response not found for operation::RestScmServerControllerIT/get-scm-server-credentials
Response fields
Snippet response-fields not found for operation::RestScmServerControllerIT/get-scm-server-credentials
Set scm server credentials
A POST
to /scm-servers/{id}/credentials
set credentials for the given source code management server.
HTTP request
Snippet http-request not found for operation::RestScmServerControllerIT/set-scm-server-credentials
Path parameters
Snippet path-parameters not found for operation::RestScmServerControllerIT/set-scm-server-credentials
Request fields
Snippet request-fields not found for operation::RestScmServerControllerIT/set-scm-server-credentials
Example response
Snippet http-response not found for operation::RestScmServerControllerIT/set-scm-server-credentials
Response fields
Snippet response-fields not found for operation::RestScmServerControllerIT/set-scm-server-credentials
Teams
This chapter focuses on additional services for the teams. These services extend driven-by-id methods implemented in the Rest Services API by allowing search by Team name.
Get all teams
A GET
to /teams
returns all the teams.
HTTP request
Snippet http-request not found for operation::RestAdminTeamControllerIT/browse-teams
Request parameters
Snippet request-parameters not found for operation::RestAdminTeamControllerIT/browse-teams
Example response
Snippet http-response not found for operation::RestAdminTeamControllerIT/browse-teams
Response fields
Snippet response-fields not found for operation::RestAdminTeamControllerIT/browse-teams
Links
Snippet links not found for operation::RestAdminTeamControllerIT/browse-teams
Create team
A POST
to /teams
creates a new team.
HTTP request
Snippet http-request not found for operation::RestAdminTeamControllerIT/post-team
Request fields
Snippet request-fields not found for operation::RestAdminTeamControllerIT/post-team
Request parameters
Snippet request-parameters not found for operation::RestAdminTeamControllerIT/post-team
Example response
Snippet http-response not found for operation::RestAdminTeamControllerIT/post-team
Response fields
Snippet response-fields not found for operation::RestAdminTeamControllerIT/post-team
Links
Snippet links not found for operation::RestAdminTeamControllerIT/post-team
Get team
A GET
to /teams/{id}
returns the team with the given id.
Path parameters
Snippet path-parameters not found for operation::RestAdminTeamControllerIT/get-team
HTTP request
Snippet http-request not found for operation::RestAdminTeamControllerIT/get-team
Request parameters
Snippet request-parameters not found for operation::RestAdminTeamControllerIT/get-team
Example response
Snippet http-response not found for operation::RestAdminTeamControllerIT/get-team
Response fields
Snippet response-fields not found for operation::RestAdminTeamControllerIT/get-team
Links
Snippet links not found for operation::RestAdminTeamControllerIT/get-team
Modify team
A PATCH
to /teams/{id}
modifies the team with the given id.
Path parameters
Snippet path-parameters not found for operation::RestAdminTeamControllerIT/patch-team
HTTP request
Snippet http-request not found for operation::RestAdminTeamControllerIT/patch-team
Request fields
Snippet request-fields not found for operation::RestAdminTeamControllerIT/patch-team
Request parameters
Snippet request-parameters not found for operation::RestAdminTeamControllerIT/patch-team
Example response
Snippet http-response not found for operation::RestAdminTeamControllerIT/patch-team
Response fields
Snippet response-fields not found for operation::RestAdminTeamControllerIT/patch-team
Links
Snippet links not found for operation::RestAdminTeamControllerIT/patch-team
Delete team
A DELETE
to /teams/{ids}
deletes one or several team(s) with the given id(s).
Path parameters
Snippet path-parameters not found for operation::RestAdminTeamControllerIT/delete-team
HTTP request
Snippet http-request not found for operation::RestAdminTeamControllerIT/delete-team
Get team members
A GET
to /teams/team-name/{teamName}/members
returns all the members of the team with the given teamName.
Path parameters
Snippet path-parameters not found for operation::RestAdminTeamControllerIT/get-team-members
HTTP request
Snippet http-request not found for operation::RestAdminTeamControllerIT/get-team-members
Request parameters
Snippet request-parameters not found for operation::RestAdminTeamControllerIT/get-team-members
Example response
Snippet http-response not found for operation::RestAdminTeamControllerIT/get-team-members
Response fields
Snippet response-fields not found for operation::RestAdminTeamControllerIT/get-team-members
Links
Snippet links not found for operation::RestAdminTeamControllerIT/get-team-members
Add members
A POST
to /teams/team-name/{teamName}/members
with userLogins in request parameters adds these users to the team with the given teamName.
Path parameters
Snippet path-parameters not found for operation::RestAdminTeamControllerIT/add-new-members-to-team
HTTP request
Snippet http-request not found for operation::RestAdminTeamControllerIT/add-new-members-to-team
Request parameters
Snippet request-parameters not found for operation::RestAdminTeamControllerIT/add-new-members-to-team
Remove members
A DELETE
to /teams/team-name/{teamName}/members
with userLogins in request parameters removes these users from the team with the given teamName.
Path parameters
Snippet path-parameters not found for operation::RestAdminTeamControllerIT/remove-team-members
HTTP request
Snippet http-request not found for operation::RestAdminTeamControllerIT/remove-team-members
Request parameters
Snippet request-parameters not found for operation::RestAdminTeamControllerIT/remove-team-members
Test Automation Servers
This chapter focuses on test automation servers.
Get all test automation servers
A GET
to /test-automation-servers
returns all the test automation servers that the client is allowed to read.
HTTP request
Snippet http-request not found for operation::RestAutomationServerControllerIT/browse-test-automation-servers
Request parameters
Snippet request-parameters not found for operation::RestAutomationServerControllerIT/browse-test-automation-servers
Example response
Snippet http-response not found for operation::RestAutomationServerControllerIT/browse-test-automation-servers
Response fields
Snippet response-fields not found for operation::RestAutomationServerControllerIT/browse-test-automation-servers
Links
Snippet links not found for operation::RestAutomationServerControllerIT/browse-test-automation-servers
Get test automation server
A GET
to /test-automation-servers/{id}
returns the test automation server with the given id.
Path parameters
Snippet path-parameters not found for operation::RestAutomationServerControllerIT/get-test-automation-server
HTTP request
Snippet http-request not found for operation::RestAutomationServerControllerIT/get-test-automation-server
Request parameters
Snippet request-parameters not found for operation::RestAutomationServerControllerIT/get-test-automation-server
Example response
Snippet http-response not found for operation::RestAutomationServerControllerIT/get-test-automation-server
Response fields
Snippet response-fields not found for operation::RestAutomationServerControllerIT/get-test-automation-server
Links
Snippet links not found for operation::RestAutomationServerControllerIT/get-test-automation-server
Create test automation server
A POST
to /test-automation-servers
creates a new test automation server.
HTTP request
Snippet http-request not found for operation::RestAutomationServerControllerIT/create-new-automation-server
Request fields
Snippet request-fields not found for operation::RestAutomationServerControllerIT/create-new-automation-server
Request parameters
Snippet request-parameters not found for operation::RestAutomationServerControllerIT/create-new-automation-server
Example response
Snippet http-response not found for operation::RestAutomationServerControllerIT/create-new-automation-server
Response fields
Snippet response-fields not found for operation::RestAutomationServerControllerIT/create-new-automation-server
Links
Snippet links not found for operation::RestAutomationServerControllerIT/create-new-automation-server
Modify test automation server
A PATCH
to /test-automation-servers/{id}
modifies the test automation server with the given id.
HTTP request
Snippet http-request not found for operation::RestAutomationServerControllerIT/update-automation-server
Path parameters
Snippet path-parameters not found for operation::RestAutomationServerControllerIT/update-automation-server
Request fields
Snippet request-fields not found for operation::RestAutomationServerControllerIT/update-automation-server
Example response
Snippet http-response not found for operation::RestAutomationServerControllerIT/update-automation-server
Response fields
Snippet response-fields not found for operation::RestAutomationServerControllerIT/update-automation-server
Links
Snippet links not found for operation::RestAutomationServerControllerIT/update-automation-server
Delete test automation server
A DELETE
to /test-automation-servers/{ids}
deletes one or several test automation server(s) with the given id(s).
Path parameters
Snippet path-parameters not found for operation::RestAutomationServerControllerIT/delete-automation-server
HTTP request
Snippet http-request not found for operation::RestAutomationServerControllerIT/delete-automation-server
Example response
Snippet http-response not found for operation::RestAutomationServerControllerIT/delete-automation-server
Get test automation server credentials
A GET
to /test-automation-servers/{id}/credentials
get the credentials for the given test automation server.
HTTP request
Snippet http-request not found for operation::RestAutomationServerControllerIT/get-test-automation-server-credentials
Path parameters
Snippet path-parameters not found for operation::RestAutomationServerControllerIT/get-test-automation-server-credentials
Example response
Snippet http-response not found for operation::RestAutomationServerControllerIT/get-test-automation-server-credentials
Response fields
Snippet response-fields not found for operation::RestAutomationServerControllerIT/get-test-automation-server-credentials
Set test automation server credentials
A POST
to /test-automation-servers/{id}/credentials
set credentials for the given test automation server.
HTTP request
Snippet http-request not found for operation::RestAutomationServerControllerIT/set-test-automation-server-credentials
Path parameters
Snippet path-parameters not found for operation::RestAutomationServerControllerIT/set-test-automation-server-credentials
Request fields
Snippet request-fields not found for operation::RestAutomationServerControllerIT/set-test-automation-server-credentials
Example response
Snippet http-response not found for operation::RestAutomationServerControllerIT/set-test-automation-server-credentials
Response fields
Snippet response-fields not found for operation::RestAutomationServerControllerIT/set-test-automation-server-credentials
Users
This chapter focuses on additional services for the users. These services extend driven-by-id methods implemented in the Rest Services API by allowing search by User login.
Get all users
A GET
to /users
returns all the users.
HTTP request
Snippet http-request not found for operation::RestAdminUserControllerIT/browse-users
Request parameters
Snippet request-parameters not found for operation::RestAdminUserControllerIT/browse-users
Example response
Snippet http-response not found for operation::RestAdminUserControllerIT/browse-users
Response fields
Snippet response-fields not found for operation::RestAdminUserControllerIT/browse-users
Links
Snippet links not found for operation::RestAdminUserControllerIT/browse-users
Get user
A GET
to /users/login/{login}
returns the user with the given login.
Path parameters
Snippet path-parameters not found for operation::RestAdminUserControllerIT/get-user
HTTP request
Snippet http-request not found for operation::RestAdminUserControllerIT/get-user
Request parameters
Snippet request-parameters not found for operation::RestAdminUserControllerIT/get-user
Example response
Snippet http-response not found for operation::RestAdminUserControllerIT/get-user
Response fields
Snippet response-fields not found for operation::RestAdminUserControllerIT/get-user
Links
Snippet links not found for operation::RestAdminUserControllerIT/get-user
Create user
A POST
to /users
creates a new user.
HTTP request
Snippet http-request not found for operation::RestAdminUserControllerIT/post-user
Request fields
Snippet request-fields not found for operation::RestAdminUserControllerIT/post-user
Request parameters
Snippet request-parameters not found for operation::RestAdminUserControllerIT/post-user
Example response
Snippet http-response not found for operation::RestAdminUserControllerIT/post-user
Response fields
Snippet response-fields not found for operation::RestAdminUserControllerIT/post-user
Links
Snippet links not found for operation::RestAdminUserControllerIT/post-user
Modify user
A PATCH
to /users/{id}
modifies the user with the given id.
Path parameters
Snippet path-parameters not found for operation::RestAdminUserControllerIT/patch-user
HTTP request
Snippet http-request not found for operation::RestAdminUserControllerIT/patch-user
Request fields
Snippet request-fields not found for operation::RestAdminUserControllerIT/patch-user
Request parameters
Snippet request-parameters not found for operation::RestAdminUserControllerIT/patch-user
Example response
Snippet http-response not found for operation::RestAdminUserControllerIT/patch-user
Response fields
Snippet response-fields not found for operation::RestAdminUserControllerIT/patch-user
Links
Snippet links not found for operation::RestAdminUserControllerIT/patch-user
Delete user
A DELETE
to /users/{ids}
deletes one or several user(s) with the given id(s).
Path parameters
Snippet path-parameters not found for operation::RestAdminUserControllerIT/delete-user
HTTP request
Snippet http-request not found for operation::RestAdminUserControllerIT/delete-user
Get user subscribed teams
A GET
to /users/login/{login}/teams
returns all the subscribed teams of the user with the given login.
Path parameters
Snippet path-parameters not found for operation::RestAdminUserControllerIT/get-teams
HTTP request
Snippet http-request not found for operation::RestAdminUserControllerIT/get-teams
Request parameters
Snippet request-parameters not found for operation::RestAdminUserControllerIT/get-teams
Example response
Snippet http-response not found for operation::RestAdminUserControllerIT/get-teams
Response fields
Snippet response-fields not found for operation::RestAdminUserControllerIT/get-teams
Links
Snippet links not found for operation::RestAdminUserControllerIT/get-teams
Subscribe to teams
A POST
to /users/login/{login}/teams
with teamNames in request parameters subscribes the user with the given login to these teams.
Path parameters
Snippet path-parameters not found for operation::RestAdminUserControllerIT/add-teams
HTTP request
Snippet http-request not found for operation::RestAdminUserControllerIT/add-teams
Request parameters
Snippet request-parameters not found for operation::RestAdminUserControllerIT/add-teams
Unsubscribe from teams
A DELETE
to /users/login/{loginId}/teams
with teamNames in request parameters unsubscribes the user with the given login from these teams.
Path parameters
Snippet path-parameters not found for operation::RestAdminUserControllerIT/disassociate-teams
HTTP request
Snippet http-request not found for operation::RestAdminUserControllerIT/disassociate-teams
Request parameters
Snippet request-parameters not found for operation::RestAdminUserControllerIT/disassociate-teams
Welcome Message
This chapter focuses on service for the welcome message of Squash TM.
Get welcome message
A GET
to /welcome-message
returns the welcome message.
HTTP request
Snippet http-request not found for operation::RestWelcomeMessageControllerIT/get-welcome-message
Example response
Snippet http-response not found for operation::RestWelcomeMessageControllerIT/get-welcome-message
Response fields
Snippet response-fields not found for operation::RestWelcomeMessageControllerIT/get-welcome-message
Modify welcome message
A PATCH
to /welcome-message
modifies the welcome message.
HTTP request
Snippet http-request not found for operation::RestWelcomeMessageControllerIT/update-welcome-message
Request fields
Snippet request-fields not found for operation::RestWelcomeMessageControllerIT/update-welcome-message
Example response
Snippet http-response not found for operation::RestWelcomeMessageControllerIT/update-welcome-message
Response fields
Snippet response-fields not found for operation::RestWelcomeMessageControllerIT/update-welcome-message