This plugin provides Squash TM with REST-like services (but not exactly like rest), that is, a set of services implemented with a resource-first approach, that allows you to interact with the business without a GUI, by exchanging json representations of those resources via HTTP requests.

Overview

In few words, here is what you will be able/unable to do with this version (4.0.0) of the API:

What you can do with it

  • read operations on most of the business domains

  • create, update and delete services on some of the business domains

  • setup projects

  • have support for attachments and automated tests

  • benefit from this present documentation

What you cannot do with it

  • explore links or use a self-discovery function

  • have support for issues

The basics

In the following documentation, the words Resource and Entity have the same meaning unless the context uses both. When a distinction is made, we generally mean that:

  • an Entity repesents an actual element of the business model (test case, project, etc)

  • a Resource represents any data exchanged with the server. This includes the entities and other kinds of data (paged collections and other things)

Base URL

The API publishes its services under the root URL {squash root url}/api/rest/latest/.
So in a common case, it could be http://localhost:8080/squash/api/rest/latest/.

API versioning

For now, and in a foreseeable future, no versioning of the API is planned. As it stands, the plugin is not ready for multiple concurrent deployment. The placeholder /latest/ that stands for the version number in the API base URL does not make much sense for now; but it makes it future-proof if such a feature is implemented down the road.

Supported HTTP methods

The API supports the following methods (verbs):

Table 1. HTTP methods
Method Usage

GET

Requests resource(s) from the server

POST

Submits new resources to the server

PATCH

Submits modifications of an existing resource

DELETE

Requests suppression of one or several resources

HTTP status codes

The system replies with conventional HTTP statuses, here is a short reminder:

Table 2. HTTP status
Status Meaning

200 OK

The operation completed successfully.

201 Created

A new resource has been created. The response body returns a representation of that resource.

204 No Content

The operation completed successfully and the server returned no response body.

400 Bad Request

The request is malformed.

401 Unauthorized

The user is not authenticated, or supplied wrong credentials.

403 Forbidden

The user’s request is denied.

404 Not Found

The resource doesn’t exist.

412 Preconditions Failed

The submitted resource creation/modification request is rejected because it would leave the resource in an invalid state.

500 Internal Server Error

An error occured while the request was processed.

Response format

The only format supported by the API is JSON. This implies that HTTP requests to and from the API may forgo the headers Accept: application/json and Content-Type: application/json (even if they are accepted and formally correct). The naming convention for the attribute is snake_case.

Rel Names

What we call the rel name (relation name) of an entity is the type of the entity as represented in an URI or in its json representation. They come in two forms: singular and plural. Both are expressed in lowercase, hyphenated names based on the entity type. The root path of the URI uses the plural form (e.g. /test-cases), and the json representation of an entity uses the singular form (e.g. "type" : "test-case").

Conceptually the singular name characterizes a single, actual instance of that entity (this is why it is one of the identifier properties), while the plural name represents the whole family of entities. Unless stated otherwise, the plural form is just composed of the singular form suffixed with an 's'. In some cases, the singular and plural forms are different, and it is often a sign of a polymorphic entity. For instance the script of a test case is composed of several steps that may either describe an action and expected behavior (action-step), or describe a reference to another test case (call-step), yet both are unified under the family of test-steps.

See chapter Entity Reference for a list of known rel names.

Identifying and locating an Entity

Business entities, in particular, share three common properties, that tell you or the system how to identify and locate the entity. Those properties are called identifier properties.

Example : minimal representation of a test case folder
 {
     "_type" : "test-case-folder",   1
     "id" : 10,                      2
     "_links" : {                    3
         "self" : {
             "href" : "http://localhost:8080/squash/api/rest/latest/test-case-folders/10"
         }
     }
 }
1 The _type here is the hyphenated lowercase name of the entity type.
2 This is the id of that instance of the entity.
3 These are the related links, which always contain a self-reference. Note that the _links attribute may look like the HAL format, but it is really not similar: the API serves no cURI nor templated URIs.

The server will always include those attributes when rendering an entity - either as a single response or as part of a deep cluster of entities -, and can never be disabled (see Parameter 'fields').

However, a client posting/ patching a json entity to the server is not required to specify them all. Only the _type is always required even when it is implied by the URI (actually the request will fail if the _type contradicts the target endpoint URI). On the other hand the id and _links are ignored without consequences : the _links can never change, and id is either irrelevant when POSTing a new entity or redundant in other cases (it’s already part of the URI).

Note for REST formalists: the Content-Type is always application/json, there are no dedicated MIME type per resource. Those three attributes are the only one that exist.

Unauthorized resources

When a client requests a resource it is not allowed to read, the server replies with HTTP 403 and a json representation of the error.

Sometimes the client requests a resource it is allowed to read, but not some related resources. This may happen for instance when two related resources (e.g. a test case and a requirement) belong to different projects yet the client is allowed to read the content for only one of them. In that case, those relations will be rendered as unauthorized resources instead of being omitted or leaked. That way, the user is aware that a relation indeed exists without knowing all the details.

Example of unauthorized resources:
{
    "_type" : "test-case",                                  1
    "id" : 4567,
    ...,
    "verified_requirements": [
        {
            "_type": "unauthorized-resource",               2
            "resource_type": "requirement-version",         3
            "resource_id": 256,                             4
            "_links": {                                     5
                "self": {
                    "href": "http://localhost:8080/squash/api/rest/latest/requirement-versions/256"
                }
            }
        }
    ],
    ...
}
1 The client can access the content of the test case as usual.
2 The _type here is the special type unauthorized-resource.
3 This is the real type of the unauthorized resource.
4 This is the id of the unauthorized resource.
5 By following this link, you will result in a proper 403.

Entity extensions

Some business entities can be attached with a module that provides support for additional features. Those features are optional and those modules will appear in the json representation only if your projects actually use them. For instance the executions, in a context of test automation, will be attached with a module named AutomatedExecutionExtender that hosts on Squash-TM the test results produced by a remote test server.

Such extenders are commonly named with a -extender suffix. From the REST API perspective, these extension are managed like any other entities.

Example of an automated execution:
{
  "_type" : "execution",                                        1
  "id" : 56,
  "name" : "sample test case 56",
  "execution_order" : 4,
  "execution_status" : "BLOCKED",
  "execution_mode" : "AUTOMATED",
  "automated_execution_extender" : {                            2
    "_type" : "automated-execution-extender",
    "id" : 778,
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/automated-execution-extenders/778"
      }
    }
  },
  ...
}
1 The type here is still execution : although it supports automated testing, the type has not fundamentally changed (i.e. there is no such thing as an AutomatedExecution).
2 The property automated_execution_extender is defined here but would not appear in a regular, manual execution.

Authentication

REST client should use the Basic Authentication. Remember that this protocol is considered as insecure if it is used without encryption.

Note If you prefer to explore the API using your browser, the session cookie obtained via the login page will also be valid.

Common query parameters

Throughout this documentation you will often find several recurrent query parameters. Rather than detailing them over and over at each documentation site, we prefer to explain them all here.

Pagination parameters

When the requested resource is a collection of other resources/entities, the underlying service often comes with a pagination feature. We call them the paginated resources. Pagination allows you to define pages of entities and browse from one page to another, instead of simply retrieving all the data in one row. It is actually enabled by default, because neither the server nor you would like to swallow possibly several thousands elements at once!

Pagination is driven by a couple of parameters appended to the resource URI:

  • size: it is an integer that defines how many elements should be returned by page. Of course it should be of at least 1 and may have arbitrary large value. The default value is 20.

  • page: it shows you the page you are requesting. Pages are numbered from 0 onward. Negative value will be treated as 0. Default value is 0 (which corresponds to the first page).

Paginated resources are often served with extra attributes _links and page to guide you through your navigation.

Example of a paginated query:
curl 'http://localhost:8080/squash/api/rest/latest/test-cases?page=2&size=1' -i -H 'Accept: application/json'


{
    "_embedded": {
        "test-cases": [
            {
                "_type": "test-case",
                "id": 239,
                "name": "Defensive opening",
                "reference": "",
                "_links": {
                    "self": {
                        "href": "http://localhost:8080/squash/api/rest/latest/test-cases/239"
                    }
                }
            }
        ]
    },
    "_links": {     1
        "first": {
            "href": "http://localhost:8080/squash/api/rest/latest/test-cases?page=0&size=1"
        },
        "prev": {
            "href": "http://localhost:8080/squash/api/rest/latest/test-cases?page=1&size=1"
        },
        "self": {
            "href": "http://localhost:8080/squash/api/rest/latest/test-cases?page=2&size=1"
        },
        "next": {
            "href": "http://localhost:8080/squash/api/rest/latest/test-cases?page=3&size=1"
        },
        "last": {
            "href": "http://localhost:8080/squash/api/rest/latest/test-cases?page=5&size=1"
        }
    },
    "page": {       2
        "size": 1,
        "totalElements": 6,
        "totalPages": 6,
        "number": 2
    }
}
1 It represents the links to the first, previous, current, next and last page. Other query parameters (such as the size) are left untouched.
2 It represents the attributes of the current page. It also states how many elements you can read this way, and therefore how many pages can be viewed in total.

The content of _links is contextual, and only links with sense will be proposed. Consider, for instance, a page large enough to gather all the available entities; this page would be the one and only page available. In that case the only link would be a self-reference, because it would be the first and the last page, and there are no existing pages before nor after.

Sorting paginated resources

Warning That feature is so unsupported that it should be considered as a side effect.

The query parameter sort allows you to specify one or several attributes of the entity under consideration, followed by the (optional) sorting direction. Eg, &sort=attr1[,attr2…​][,asc|desc]. It may work for certain attributes and not for others.

Also note that sorting is disabled for certain paginated resources because the order of the content is important and must be kept. This is the case for a test script for example: it makes no sense to sort it by, id or action, for example.

Parameter 'include'

That parameter, when possible, lets you choose how to deal with hierarchies of entities. Squash TM primarily organizes its business domain in several file tree (one per project) of arbitrary depth. When requesting the content of a container, you may choose one of the following value:

  • root: only the direct children nodes are considered by your request. This is the default.

  • nested: the request should also consider any node that belongs to the subtree of the entity under consideration.

You can combine this with other pagination parameters to limit the returned content.

Example: find everything contained in a folder
curl 'http://localhost:8080/squash/api/rest/latest/test-case-folders/15/content?page=0&size=10&include=nested' -i -H 'Accept: application/json'

Parameter 'fields'

That query parameter lets you define with a filter expression which attributes of an entity you want to have in the response.

A filter expression is a comma-separated list of property names. A star '*' is a wild card that stands for all the properties. If a property name is prefixed with a minus '-', that property will be excluded from the rendering, overriding the wild card if present.

Filter expressions can be nested using brackets '[' and ']''. If a nested filter is defined for a property, it will apply to the value(s) of that property. It is primarily used when the said value is a complex object, a relation of the current entity, or a collection of such. Primary types will remain unaffected. You can nest filters within nested filters and so on.

If a filter expression remains empty, every property will be rendered if the current entity is the root of the cluster targeted by the request, or none for other entities. This rule prevents the engine to crawl forever through an entity cluster, especially if it holds circular references. However, because of this you must explicitly specify a nested expression for each property that requires it, otherwise they will appear empty (except for the identifier properties, see above). To that end, you may redeclare a nested expression for a property even when a '*' was specified if you wish to see more of the relation accessed to by that property.

In all cases, the identifier properties id, _type and _links of an entity will always be included: a filter expression never needs to include them explicitly, and they can never be disabled with the '-' operator.

Table 3. Example: valid filter expressions (applied to a test-case):
Expression Effect

id,label,reference

Renders the properties label, reference and the identifier properties (including id).

id,label,steps[action, called_test_case[name,reference]]

Renders the id, label and test steps. The steps will include the identifier properties, the action to be accomplished and the called_test_case in case the step is a call step. The called test cases will be rendered with their properties name and reference (and identifier properties).

*

Will render all the properties of the test case. However, relations such as the test steps will be rendered with bare bones properties.

*,steps[action]

Will render all the properties of the test case. Its relations will be rendered with bare bones properties, except for the test steps that will also include their actions.

*,-reference

Will render all the properties as stated above, minus the reference.

Table 4. Example: invalid filter expressions
Expression Problem

label,steps[action

A closing bracket is missing, the expression is unbalanced.

label,steps[action]],reference

The root filter expression exited early, the expression is unbalanced.

Example: usage of the parameter filter
curl 'http://localhost:8080/squash/api/rest/latest/test-cases?page=0&size=10&fields=label,last_modified_by' -i -H 'Accept: application/json'

Entity Reference

Most resource URIs are built around the pattern /<plural-rel-name>[/<id>[/component]] (see Rel Names). The following table is a list of the resources known to help you find the URLs you need.

Table 5. Entity and rel names
Entity Singular name Plural name Description

ActionStep

action-step

test-steps

A unit of test script, that describes a user action and expected response from the app

Attachment

attachment

attachments

An attachment

AutomatedExecutionExtender

automated-execution-extender

automated-execution-extenders

An extension of executions for support of automated testing

AutomatedSuite

automated-suite

automated-suites

A set of automated execution extenders that were executed together

AutomatedTest

automated-test

automated-tests

The local representation of a remote test script

CallStep

call-step

test-steps

A unit of test script that inlines a test case into another one

Campaign

campaign

campaigns

A campaign

CampaignFolder

campaign-folder

campaign-folders

A entity that helps to organize the content of the campaign workspace

CampaignTestPlanItem

campaign-test-plan-item

campaign-test-plan-items

An entry in the test plan of a campaign

Dataset

dataset

datasets

A set of parameter values to use when a test-case is executed

Execution

execution

executions

A test run of a test case, with reports and remarks

ExecutionStep

execution-step

execution-steps

A unit of an execution script

Iteration

iteration

iterations

A round of executing a campaign test plan

IterationTestPlanItem

iteration-test-plan-item

iteration-test-plan-items

An entry in the test plan of an iteration, that summarizes all the execution results of a test case

KeywordTestCase

keyword-test-case

test-cases

A Scenario based on action words to run on the system under test in order to qualify one or several requirements

KeywordTestStep

keyword-step

test-steps

A unit of keyword test case script. It represents the call of an action word in a context given by a keyword (given, when, then, but, and)

Parameter

parameter

parameters

A variable piece of a test script

Project

project

projects

A project

ProjectTemplate

project-template

projects

A template that preconfigures new projects with its settings

Requirement

requirement

requirements

A unit of test specification, that may come in one or several versions

RequirementFolder

requirement-folder

requirement-folders

An entity that helps to organize the content of the requirement workspace

RequirementVersion

requirement-version

requirement-versions

A version of a requirement

ScriptedTestCase

scripted-test-case

test-cases

A Gherkin feature to run on the system under test in order to qualify one or several requirements

Team

team

teams

A group of users

TestAutomationServer

test-automation-server

test-automation-servers

A test automation server

TestCase

test-case

test-cases

A scenario to run on the system under test in order to qualify one or several requirements

TestCaseFolder

test-case-folder

test-case-folders

An entity that helps to organize the content of the test case workspace

TestSuite

test-suite

test-suites

A partition of the test plan of an iteration

User

user

users

A user

Attachments

This chapter focuses on services for the attachments.

Get attachment

A GET to /attachments/{id} returns the attachment with the given id.

Path parameters

Snippet path-parameters not found for operation::RestAttachmentControllerIT/get-attachment

HTTP request

Snippet http-request not found for operation::RestAttachmentControllerIT/get-attachment

Request parameters

Snippet request-parameters not found for operation::RestAttachmentControllerIT/get-attachment

Example response

Snippet http-response not found for operation::RestAttachmentControllerIT/get-attachment

Response fields

Snippet response-fields not found for operation::RestAttachmentControllerIT/get-attachment

Snippet links not found for operation::RestAttachmentControllerIT/get-attachment

Rename attachment

A PATCH to /attachments/{id} with new name in request parameters renames the attachment with the given id.

Path parameters

Snippet path-parameters not found for operation::RestAttachmentControllerIT/rename-attachment

HTTP request

Snippet http-request not found for operation::RestAttachmentControllerIT/rename-attachment

Request parameters

Snippet request-parameters not found for operation::RestAttachmentControllerIT/rename-attachment

Example response

Snippet http-response not found for operation::RestAttachmentControllerIT/rename-attachment

Response fields

Snippet response-fields not found for operation::RestAttachmentControllerIT/rename-attachment

Snippet links not found for operation::RestAttachmentControllerIT/rename-attachment

Download attachment

A GET to /attachments/{id}/content downloads the attachment with the given id.

Path parameters

Snippet path-parameters not found for operation::RestAttachmentControllerIT/download-attachment

HTTP request

Snippet http-request not found for operation::RestAttachmentControllerIT/download-attachment

Upload attachment

A POST to /api/rest/latest/{owner}/{ownerId}/attachments/ uploads attachments in request body to the owner with the given id. The key of these attachments should always named as "files".

The possible {owners} are campaigns, campaign-folders, executions, execution-steps, iterations, projects, requirement-folders, requirement-versions, test-cases, test-case-folders, test-steps, test-suites

Path parameters

Snippet path-parameters not found for operation::RestAttachmentControllerIT/upload-attachment

HTTP request

Snippet http-request not found for operation::RestAttachmentControllerIT/upload-attachment

Example response

Snippet http-response not found for operation::RestAttachmentControllerIT/upload-attachment

Response fields

Snippet response-fields not found for operation::RestAttachmentControllerIT/upload-attachment

Delete attachment

A DELETE to /api/rest/latest/{owner}/{ownerId}/attachments/ with attachmentIds in request parameters removes these attachments from their owner with the given id.

The possible {owners} are campaigns, campaign-folders, executions, execution-steps, iterations, projects, requirement-folders, requirement-versions, test-cases, test-case-folders, test-steps, test-suites

Path parameters

Snippet path-parameters not found for operation::RestAttachmentControllerIT/delete-attachment

HTTP request

Snippet http-request not found for operation::RestAttachmentControllerIT/delete-attachment

Request parameters

Snippet request-parameters not found for operation::RestAttachmentControllerIT/delete-attachment

Automated Execution Extenders

This chapter focuses on services for the automated execution extenders.

Get automated execution extender

A GET to /automated-execution-extenders/{id} returns the automated execution extender with the given id.

Path parameters

Snippet path-parameters not found for operation::RestAutomatedExecutionExtenderControllerIT/get-automated-execution-extender

HTTP request

Snippet http-request not found for operation::RestAutomatedExecutionExtenderControllerIT/get-automated-execution-extender

Request parameters

Snippet request-parameters not found for operation::RestAutomatedExecutionExtenderControllerIT/get-automated-execution-extender

Example response

Snippet http-response not found for operation::RestAutomatedExecutionExtenderControllerIT/get-automated-execution-extender

Response fields

Snippet response-fields not found for operation::RestAutomatedExecutionExtenderControllerIT/get-automated-execution-extender

Snippet links not found for operation::RestAutomatedExecutionExtenderControllerIT/get-automated-execution-extender

Automated Suites

This chapter focuses on services for the automated suites.

Get all automated suites

A GET to /automated-suites returns all the automated suites that the client is allowed to read.

HTTP request

Snippet http-request not found for operation::RestAutomatedSuiteControllerIT/browse-automated-suite

Request parameters

Snippet request-parameters not found for operation::RestAutomatedSuiteControllerIT/browse-automated-suite

Example response

Snippet http-response not found for operation::RestAutomatedSuiteControllerIT/browse-automated-suite

Response fields

Snippet response-fields not found for operation::RestAutomatedSuiteControllerIT/browse-automated-suite

Snippet links not found for operation::RestAutomatedSuiteControllerIT/browse-automated-suite

Get automated suite

A GET to /automated-suites/{id} returns the automated suite with the given id.

Path parameters

Snippet path-parameters not found for operation::RestAutomatedSuiteControllerIT/get-automated-suite

HTTP request

Snippet http-request not found for operation::RestAutomatedSuiteControllerIT/get-automated-suite

Request parameters

Snippet request-parameters not found for operation::RestAutomatedSuiteControllerIT/get-automated-suite

Example response

Snippet http-response not found for operation::RestAutomatedSuiteControllerIT/get-automated-suite

Response fields

Snippet response-fields not found for operation::RestAutomatedSuiteControllerIT/get-automated-suite

Snippet links not found for operation::RestAutomatedSuiteControllerIT/get-automated-suite

Get automated execution extenders of automated suite

A GET to /automated-suites/{id}/executions returns all the automated execution extenders related to the automated suite with the given id.

Path parameters

Snippet path-parameters not found for operation::RestAutomatedSuiteControllerIT/get-automated-suite-executions

HTTP request

Snippet http-request not found for operation::RestAutomatedSuiteControllerIT/get-automated-suite-executions

Request parameters

Snippet request-parameters not found for operation::RestAutomatedSuiteControllerIT/get-automated-suite-executions

Example response

Snippet http-response not found for operation::RestAutomatedSuiteControllerIT/get-automated-suite-executions

Response fields

Snippet response-fields not found for operation::RestAutomatedSuiteControllerIT/get-automated-suite-executions

Snippet links not found for operation::RestAutomatedSuiteControllerIT/get-automated-suite-executions

Create automated suite from iteration

A POST to /automated-suite-utils/from-iteration creates a new automated suite with the given iteration id in request parameters.

HTTP request

Snippet http-request not found for operation::RestAutomatedSuiteControllerIT/create-automated-suite-from-iteration

Request parameters

Snippet request-parameters not found for operation::RestAutomatedSuiteControllerIT/create-automated-suite-from-iteration

Example response

Snippet http-response not found for operation::RestAutomatedSuiteControllerIT/create-automated-suite-from-iteration

Response fields

Snippet response-fields not found for operation::RestAutomatedSuiteControllerIT/create-automated-suite-from-iteration

Snippet links not found for operation::RestAutomatedSuiteControllerIT/create-automated-suite-from-iteration

Create automated suite from iteration test plan items

A POST to /automated-suite-utils/from-iteration-test-plan-items creates a new automated suite with the given the list of item id in request parameters.

HTTP request

Snippet http-request not found for operation::RestAutomatedSuiteControllerIT/create-automated-suite-from-iteration-test-plan-items

Request parameters

Snippet request-parameters not found for operation::RestAutomatedSuiteControllerIT/create-automated-suite-from-iteration-test-plan-items

Example response

Snippet http-response not found for operation::RestAutomatedSuiteControllerIT/create-automated-suite-from-iteration-test-plan-items

Response fields

Snippet response-fields not found for operation::RestAutomatedSuiteControllerIT/create-automated-suite-from-iteration-test-plan-items

Snippet links not found for operation::RestAutomatedSuiteControllerIT/create-automated-suite-from-iteration-test-plan-items

Create automated suite from test suite

A POST to /automated-suite-utils/from-test-suite creates a new automated suite with the given test suite id in request parameters.

HTTP request

Snippet http-request not found for operation::RestAutomatedSuiteControllerIT/create-automated-suite-from-test-suite

Request parameters

Snippet request-parameters not found for operation::RestAutomatedSuiteControllerIT/create-automated-suite-from-test-suite

Example response

Snippet http-response not found for operation::RestAutomatedSuiteControllerIT/create-automated-suite-from-test-suite

Response fields

Snippet response-fields not found for operation::RestAutomatedSuiteControllerIT/create-automated-suite-from-test-suite

Snippet links not found for operation::RestAutomatedSuiteControllerIT/create-automated-suite-from-test-suite

Execute automated suite

A POST to /automated-suite-utils/{suiteId}/executor executes the automated suite with the given id.

Path parameters

Snippet path-parameters not found for operation::RestAutomatedSuiteControllerIT/execute-automated-suite

HTTP request

Snippet http-request not found for operation::RestAutomatedSuiteControllerIT/execute-automated-suite

Request parameters

Snippet request-parameters not found for operation::RestAutomatedSuiteControllerIT/execute-automated-suite

Example response

Snippet http-response not found for operation::RestAutomatedSuiteControllerIT/execute-automated-suite

Response fields

Snippet response-fields not found for operation::RestAutomatedSuiteControllerIT/execute-automated-suite

Snippet links not found for operation::RestAutomatedSuiteControllerIT/execute-automated-suite

Automated Tests

This chapter focuses on services for the automated tests.

Get automated test

A GET to /automated-tests/{id} returns the automated test with the given id.

Path parameters

Snippet path-parameters not found for operation::RestAutomatedTestControllerIT/get-automated-test

HTTP request

Snippet http-request not found for operation::RestAutomatedTestControllerIT/get-automated-test

Request parameters

Snippet request-parameters not found for operation::RestAutomatedTestControllerIT/get-automated-test

Example response

Snippet http-response not found for operation::RestAutomatedTestControllerIT/get-automated-test

Response fields

Snippet response-fields not found for operation::RestAutomatedTestControllerIT/get-automated-test

Snippet links not found for operation::RestAutomatedTestControllerIT/get-automated-test

Campaigns

This chapter focuses on services for the campaigns.

Get all campaigns

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

HTTP request

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

Request parameters

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

Example response

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

Response fields

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

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

Create campaign

A POST to /campaigns creates a new campaign.

HTTP request

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

Example response

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

Get campaign

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

Path parameters

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

HTTP request

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

Request parameters

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

Example response

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

Response fields

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

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

Get campaigns by name

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

HTTP request

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

Request parameters

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

Example response

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

Response fields

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

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

Modify campaign

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

HTTP request

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

Example response

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

Delete campaign

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

Path parameters

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

HTTP request

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

Get iterations of campaign

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

Path parameters

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

HTTP request

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

Request parameters

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

Example response

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

Response fields

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

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

Get test plans of campaign

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

Path parameters

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

HTTP request

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

Request parameters

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

Example response

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

Response fields

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

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

Campaign Folders

This chapter focuses on services for the campaign folders.

Get all campaign folders

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

HTTP request

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

Request parameters

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

Example response

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

Response fields

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

Snippet links not found for operation::RestCampaignFolderControllerIT/browse-campaign-folders

Create campaign folder

A POST to /campaign-folders creates a new campaign folder. The parent object and the name are required; refer to the complete reference of Get campaign folder for the other attributes.

HTTP request

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

Example response

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

Get campaign folder

A GET to /campaign-folders/{id} returns the campaign folder with the given id.

Path parameters

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

HTTP request

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

Request parameters

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

Example response

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

Response fields

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

Snippet links not found for operation::RestCampaignFolderControllerIT/get-campaign-folder

Modify campaign folder

A Patch to /campaign-folders/{id} modifies the campaign folder with the given id.

HTTP request

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

Example response

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

Delete campaign folder

A DELETE to /campaign-folders/{ids} deletes one or several campaign folder with the given id(s). Remember that deleting a folder entails that its content is deleted as well !

Path parameters

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

HTTP request

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

Get campaign folder contents

A GET to /campaign-folders/{id}/content returns the contents of the campaign folder with the given id.

Path parameters

Snippet path-parameters not found for operation::RestCampaignFolderControllerIT/get-campaign-folder-content

HTTP request

Snippet http-request not found for operation::RestCampaignFolderControllerIT/get-campaign-folder-content

Request parameters

Snippet request-parameters not found for operation::RestCampaignFolderControllerIT/get-campaign-folder-content

Example response

Snippet http-response not found for operation::RestCampaignFolderControllerIT/get-campaign-folder-content

Response fields

Snippet response-fields not found for operation::RestCampaignFolderControllerIT/get-campaign-folder-content

Snippet links not found for operation::RestCampaignFolderControllerIT/get-campaign-folder-content

Campaign Test Plan Items

This chapter focuses on services for the campaign test plan items. A campaign test plan item represents a test case that has been planned in a campaign test plan. It belongs to a campaign and binds together the test case to execute with a dataset (optional) and an assigned user (optional).

Get campaign test plan item

A GET to /campaign-test-plan-items/{id} returns the campaign test plan item with the given id.

Path parameters

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

HTTP request

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

Request parameters

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

Example response

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

Response fields

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

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

Create campaign test plan item

A POST to /campaign/{id}/test-plan creates a new entry in the test plan of the campaign with the given id. The entry must reference a test case, and optionally for which dataset and which assignee. If specified, the dataset must belong to the referenced Test Case. The dataset and/or assignee may be undefined or null if you don’t want to set them yet.

Path parameters

Snippet path-parameters not found for operation::RestCampaignTestPlanItemControllerIT/post-add-campaign-test-plan-item

HTTP request

Snippet http-request not found for operation::RestCampaignTestPlanItemControllerIT/post-add-campaign-test-plan-item

Request fields

Snippet request-fields not found for operation::RestCampaignTestPlanItemControllerIT/post-add-campaign-test-plan-item

Example response

Snippet http-response not found for operation::RestCampaignTestPlanItemControllerIT/post-add-campaign-test-plan-item

Modify campaign test plan item

A Patch to /campaign-test-plan-items/{id} modifies the campaign test plan item with the given id. You can modify dataset or assigned_to or both. A property left absent from the json payload will not be altered, if present with a null value they will be reset. You cannot change the planned test case.

Path parameters

Snippet path-parameters not found for operation::RestCampaignTestPlanItemControllerIT/patch-modify-campaign-test-plan-item

HTTP request

Snippet http-request not found for operation::RestCampaignTestPlanItemControllerIT/patch-modify-campaign-test-plan-item

Request fields

Snippet request-fields not found for operation::RestCampaignTestPlanItemControllerIT/patch-modify-campaign-test-plan-item

Example response

Snippet http-response not found for operation::RestCampaignTestPlanItemControllerIT/patch-modify-campaign-test-plan-item

Delete campaign test plan item

A DELETE to /campaign-test-plan-items/{testPlanItemsIds} deletes one or several campaign test plan items with the given id(s).

Path parameters

Snippet path-parameters not found for operation::RestCampaignTestPlanItemControllerIT/delete-campaign-test-plan-item

HTTP request

Snippet http-request not found for operation::RestCampaignTestPlanItemControllerIT/delete-campaign-test-plan-item

Datasets

This chapter focuses on services for the datasets.

Get dataset

A GET to /datasets/{id} returns the dataset with the given id.

Path parameters

Snippet path-parameters not found for operation::RestDatasetControllerIT/get-dataset

HTTP request

Snippet http-request not found for operation::RestDatasetControllerIT/get-dataset

Request parameters

Snippet request-parameters not found for operation::RestDatasetControllerIT/get-dataset

Example response

Snippet http-response not found for operation::RestDatasetControllerIT/get-dataset

Response fields

Snippet response-fields not found for operation::RestDatasetControllerIT/get-dataset

Snippet links not found for operation::RestDatasetControllerIT/get-dataset

Create dataset

A POST to /datasets creates a new dataset.

HTTP request

Snippet http-request not found for operation::RestDatasetControllerIT/post-dataset

Example response

Snippet http-response not found for operation::RestDatasetControllerIT/post-dataset

Modify dataset

A Patch to /datasets/{id} modifies the dataset with the given id. You can modify name or parameter values or the both.

Path parameters

Snippet path-parameters not found for operation::RestDatasetControllerIT/patch-dataset

HTTP request

Snippet http-request not found for operation::RestDatasetControllerIT/patch-dataset

Example response

Snippet http-response not found for operation::RestDatasetControllerIT/patch-dataset

Delete dataset

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

Path parameters

Snippet path-parameters not found for operation::RestDatasetControllerIT/delete-dataset

HTTP request

Snippet http-request not found for operation::RestDatasetControllerIT/delete-dataset

Executions

This chapter focuses on services for the executions.

Updates from version 1.2.0:

  • There are 3 types of execution: standard, scripted and keyword.

  • The "script" property is from now available only for scripted execution.

  • There is no longer "language" property in execution. The language for scripted execution is always GHERKIN while there is no defined language for standard and keyword executions.

Get execution

A GET to /executions/{id} returns the execution with the given id.

Path parameters

Snippet path-parameters not found for operation::RestExecutionControllerIT/get-execution-of-standard-test-case

HTTP request

Snippet http-request not found for operation::RestExecutionControllerIT/get-execution-of-standard-test-case

Request parameters

Snippet request-parameters not found for operation::RestExecutionControllerIT/get-execution-of-standard-test-case

Example response

Snippet http-response not found for operation::RestExecutionControllerIT/get-execution-of-standard-test-case

Response fields

Snippet response-fields not found for operation::RestExecutionControllerIT/get-execution-of-standard-test-case

Snippet links not found for operation::RestExecutionControllerIT/get-execution-of-standard-test-case

Create execution for iteration test plan item

A POST to /iteration-test-plan-items/{id}/executions creates a new execution for the iteration test plan item with the given id.

Path parameters

Snippet path-parameters not found for operation::RestIterationTestPlanItemControllerIT/create-execution

HTTP request

Snippet http-request not found for operation::RestIterationTestPlanItemControllerIT/create-execution

Request parameters

Snippet request-parameters not found for operation::RestIterationTestPlanItemControllerIT/create-execution

Example response

Snippet http-response not found for operation::RestIterationTestPlanItemControllerIT/create-execution

Response fields

Snippet response-fields not found for operation::RestIterationTestPlanItemControllerIT/create-execution

Snippet links not found for operation::RestIterationTestPlanItemControllerIT/create-execution

Modify an execution

A PATCH to /executions/{id} modifies the execution with the given id.

Path parameters

Snippet path-parameters not found for operation::RestExecutionPostControllerIT/patch-execution

HTTP request

Snippet http-request not found for operation::RestExecutionPostControllerIT/patch-execution

Request fields

Snippet request-fields not found for operation::RestExecutionPostControllerIT/patch-execution

Request parameters

Snippet request-parameters not found for operation::RestExecutionPostControllerIT/patch-execution

Example response

Snippet http-response not found for operation::RestExecutionPostControllerIT/patch-execution

Response fields

Snippet response-fields not found for operation::RestExecutionPostControllerIT/patch-execution

Snippet links not found for operation::RestExecutionPostControllerIT/patch-execution

Delete an execution

A DELETE to /executions/{id} delete one execution with the given id.

Path parameters

Snippet path-parameters not found for operation::RestExecutionControllerIT/delete-execution

HTTP request

Snippet http-request not found for operation::RestExecutionControllerIT/delete-execution

Get steps of execution

A GET to /executions/{id}/execution-steps returns all the execution steps of the execution with the given id.

Path parameters

Snippet path-parameters not found for operation::RestExecutionControllerIT/get-execution-execution-steps

HTTP request

Snippet http-request not found for operation::RestExecutionControllerIT/get-execution-execution-steps

Request parameters

Snippet request-parameters not found for operation::RestExecutionControllerIT/get-execution-execution-steps

Example response

Snippet http-response not found for operation::RestExecutionControllerIT/get-execution-execution-steps

Response fields

Snippet response-fields not found for operation::RestExecutionControllerIT/get-execution-execution-steps

Snippet links not found for operation::RestExecutionControllerIT/get-execution-execution-steps

Attach issue to an execution

A POST to /executions/{id}/issues attach an issue to an execution with given id. The identifier of the remote issue must be specified; however the bugtracker on which it is hosted is implied by the configuration of the Squash-TM project of the execution.

The actual format of the remote identifier depends on the type of bugtracker you are referencing. For example for issues hosted on Mantis the remote identifier is the ID, while for JIRA the remote identifier is the issue key. You can verify which format is expected in Squash-TM by testing first with the UI, eg in the table of known issues of an iteration.

Note that you cannot declare a new issue this way - post it straight to the bugtracker instead !

Path parameters

Snippet path-parameters not found for operation::RestIssueControllerIT/attache-issue-to-execution

HTTP request

Snippet http-request not found for operation::RestIssueControllerIT/attache-issue-to-execution

Request fields

Snippet request-fields not found for operation::RestIssueControllerIT/attache-issue-to-execution

Example response

Snippet http-response not found for operation::RestIssueControllerIT/attache-issue-to-execution

Execution Steps

This chapter focuses on services for the execution steps.

Get execution step

A GET to /execution-steps/{id} returns the execution step with the given id.

Path parameters

Snippet path-parameters not found for operation::RestExecutionStepControllerIT/get-execution-step

HTTP request

Snippet http-request not found for operation::RestExecutionStepControllerIT/get-execution-step

Request parameters

Snippet request-parameters not found for operation::RestExecutionStepControllerIT/get-execution-step

Example response

Snippet http-response not found for operation::RestExecutionStepControllerIT/get-execution-step

Response fields

Snippet response-fields not found for operation::RestExecutionStepControllerIT/get-execution-step

Snippet links not found for operation::RestExecutionStepControllerIT/get-execution-step

Modify status of execution step

A PATCH to /execution-steps/{id}/execution-status/{status} modifies the execution status of the execution step with the given id to the given status.

Path parameters

Snippet path-parameters not found for operation::RestExecutionStepControllerIT/change-execution-status

HTTP request

Snippet http-request not found for operation::RestExecutionStepControllerIT/change-execution-status

Example response

Snippet http-response not found for operation::RestExecutionStepControllerIT/change-execution-status

Response fields

Snippet response-fields not found for operation::RestExecutionStepControllerIT/change-execution-status

Snippet links not found for operation::RestExecutionStepControllerIT/change-execution-status

Modify comment of execution step

A PATCH to /execution-steps/{id} modifies the comment of the execution step with the given id.

Path parameters

Snippet path-parameters not found for operation::RestExecutionStepControllerIT/change-comment-execution-step

HTTP request

Snippet http-request not found for operation::RestExecutionStepControllerIT/change-comment-execution-step

Example response

Snippet http-response not found for operation::RestExecutionStepControllerIT/change-comment-execution-step

Iterations

This chapter focuses on services for iterations.

Create iteration

A POST to /campaigns/{campaignId}/iterations creates a new iteration.

HTTP request

Snippet http-request not found for operation::RestIterationControllerIT/post-iteration

Request fields

Snippet request-fields not found for operation::RestIterationControllerIT/post-iteration

Request parameters

Snippet request-parameters not found for operation::RestIterationControllerIT/post-iteration

Example response

Snippet http-response not found for operation::RestIterationControllerIT/post-iteration

Response fields

Snippet response-fields not found for operation::RestIterationControllerIT/post-iteration

Snippet links not found for operation::RestIterationControllerIT/post-iteration

Get iteration

A GET to /iterations/{id} returns the iteration with the given id.

Path parameters

Snippet path-parameters not found for operation::RestIterationControllerIT/get-iteration

HTTP request

Snippet http-request not found for operation::RestIterationControllerIT/get-iteration

Request parameters

Snippet request-parameters not found for operation::RestIterationControllerIT/get-iteration

Example response

Snippet http-response not found for operation::RestIterationControllerIT/get-iteration

Response fields

Snippet response-fields not found for operation::RestIterationControllerIT/get-iteration

Snippet links not found for operation::RestIterationControllerIT/get-iteration

Get iteration by name

A GET to /iterations with a request parameter iterationName returns the iteration with the given name. Be careful, both the name of the parameter iterationName and the value of the iteration name are case-sensitive.

HTTP request

Snippet http-request not found for operation::RestIterationControllerIT/get-iteration-by-name

Request parameters

Snippet request-parameters not found for operation::RestIterationControllerIT/get-iteration-by-name

Example response

Snippet http-response not found for operation::RestIterationControllerIT/get-iteration-by-name

Response fields

Snippet response-fields not found for operation::RestIterationControllerIT/get-iteration-by-name

Snippet links not found for operation::RestIterationControllerIT/get-iteration-by-name

Modify iteration

A PATCH to /iterations/{id} modifies the iteration with de given id.

Path parameters

Snippet path-parameters not found for operation::RestIterationControllerIT/patch-iteration

HTTP request

Snippet http-request not found for operation::RestIterationControllerIT/patch-iteration

Request fields

Snippet request-fields not found for operation::RestIterationControllerIT/patch-iteration

Request parameters

Snippet request-parameters not found for operation::RestIterationControllerIT/patch-iteration

Example response

Snippet http-response not found for operation::RestIterationControllerIT/patch-iteration

Response fields

Snippet response-fields not found for operation::RestIterationControllerIT/patch-iteration

Snippet links not found for operation::RestIterationControllerIT/patch-iteration

Get test plans of an iteration

A GET to /iterations/{id}/test-plan returns the test plans of the iteration with the given id.

Path parameters

Snippet path-parameters not found for operation::RestIterationControllerIT/get-iteration-test-plan

HTTP request

Snippet http-request not found for operation::RestIterationControllerIT/get-iteration-test-plan

Request parameters

Snippet request-parameters not found for operation::RestIterationControllerIT/get-iteration-test-plan

Example response

Snippet http-response not found for operation::RestIterationControllerIT/get-iteration-test-plan

Response fields

Snippet response-fields not found for operation::RestIterationControllerIT/get-iteration-test-plan

Snippet links not found for operation::RestIterationControllerIT/get-iteration-test-plan

Get test suites of an iteration

A GET /iterations/{id}/test-suites returns all the test-suites of the iteration with the given id.

Path parameters

Snippet path-parameters not found for operation::RestIterationControllerIT/get-iteration-test-suites

HTTP request

Snippet http-request not found for operation::RestIterationControllerIT/get-iteration-test-suites

Request parameters

Snippet request-parameters not found for operation::RestIterationControllerIT/get-iteration-test-suites

Example response

Snippet http-response not found for operation::RestIterationControllerIT/get-iteration-test-suites

Response fields

Snippet response-fields not found for operation::RestIterationControllerIT/get-iteration-test-suites

Snippet links not found for operation::RestIterationControllerIT/get-iteration-test-suites

Iteration Test Plan Items

This chapter focuses on services for iteration test plan items. An iteration test plan item represents a test case that has been planned in an iteration test plan. It belongs to an iteration, and binds together the test case to execute with a dataset (optional) and an assigned user (optional).

Get iteration test plan item

A GET to /iteration-test-plan-items/{id} returns the iteration test plan item with the given id.

Path parameters

Snippet path-parameters not found for operation::RestIterationTestPlanItemControllerIT/get-iteration-test-plan-item

HTTP request

Snippet http-request not found for operation::RestIterationTestPlanItemControllerIT/get-iteration-test-plan-item

Request parameters

Snippet request-parameters not found for operation::RestIterationTestPlanItemControllerIT/get-iteration-test-plan-item

Example response

Snippet http-response not found for operation::RestIterationTestPlanItemControllerIT/get-iteration-test-plan-item

Response fields

Snippet response-fields not found for operation::RestIterationTestPlanItemControllerIT/get-iteration-test-plan-item

Snippet links not found for operation::RestIterationTestPlanItemControllerIT/get-iteration-test-plan-item

Create iteration test plan item

A POST to /iterations/{iterationId}/test-plan creates a new entry in the test plan of the iteration with the given id. The entry must reference a test case, and optionally for which dataset and which assignee. If specified, the dataset must belong to the referenced Test Case. The dataset and/or assignee may be undefined or null if you don’t want to set them yet.

Path parameters

Snippet path-parameters not found for operation::RestIterationTestPlanItemControllerIT/post-iteration-test-plan-item

HTTP request

Snippet http-request not found for operation::RestIterationTestPlanItemControllerIT/post-iteration-test-plan-item

Request fields

Snippet request-fields not found for operation::RestIterationTestPlanItemControllerIT/post-iteration-test-plan-item

Example response

Snippet http-response not found for operation::RestIterationTestPlanItemControllerIT/post-iteration-test-plan-item

Modify iteration test plan item

A Patch to /iteration-test-plan-items/{id} modifies the iteration test plan item with the given id. You can modify the planned dataset, the assignee, or both. A property left absent from the json payload will not be altered, if present with a null value they will be reset. You cannot change the planned test case.

Path parameters

Snippet path-parameters not found for operation::RestIterationTestPlanItemControllerIT/patch-modify-iteration-test-plan-item

HTTP request

Snippet http-request not found for operation::RestIterationTestPlanItemControllerIT/patch-modify-iteration-test-plan-item

Request fields

Snippet request-fields not found for operation::RestIterationTestPlanItemControllerIT/patch-modify-iteration-test-plan-item

Example response

Snippet http-response not found for operation::RestIterationTestPlanItemControllerIT/patch-modify-iteration-test-plan-item

Delete iteration test plan item

A DELETE to /iteration-test-plan-items/{testPlanItemsIds} deletes one or several iteration test plan items with the given id(s).

Path parameters

Snippet path-parameters not found for operation::RestIterationTestPlanItemControllerIT/delete-iteration-test-plan-item

HTTP request

Snippet http-request not found for operation::RestIterationTestPlanItemControllerIT/delete-iteration-test-plan-item

Get executions of iteration test plan item

A GET to /iteration-test-plan-items/{id}/executions returns all the executions of the iteration test plan item with the given id.

Path parameters

Snippet path-parameters not found for operation::RestIterationTestPlanItemControllerIT/get-iteration-test-plan-item-executions

HTTP request

Snippet http-request not found for operation::RestIterationTestPlanItemControllerIT/get-iteration-test-plan-item-executions

Request parameters

Snippet request-parameters not found for operation::RestIterationTestPlanItemControllerIT/get-iteration-test-plan-item-executions

Example response

Snippet http-response not found for operation::RestIterationTestPlanItemControllerIT/get-iteration-test-plan-item-executions

Response fields

Snippet response-fields not found for operation::RestIterationTestPlanItemControllerIT/get-iteration-test-plan-item-executions

Snippet links not found for operation::RestIterationTestPlanItemControllerIT/get-iteration-test-plan-item-executions

Parameters

This chapter focuses on services for the parameters.

Get parameter

A GET to /parameters/{id} returns the parameter with the given id.

Path parameters

Snippet path-parameters not found for operation::RestParameterControllerIT/get-parameter

HTTP request

Snippet http-request not found for operation::RestParameterControllerIT/get-parameter

Request parameters

Snippet request-parameters not found for operation::RestParameterControllerIT/get-parameter

Example response

Snippet http-response not found for operation::RestParameterControllerIT/get-parameter

Response fields

Snippet response-fields not found for operation::RestParameterControllerIT/get-parameter

Snippet links not found for operation::RestParameterControllerIT/get-parameter

Create parameter

A POST to /parameters creates a new parameter.

HTTP request

Snippet http-request not found for operation::RestParameterControllerIT/post-parameter

Example response

Snippet http-response not found for operation::RestParameterControllerIT/post-parameter

Modify parameter

A Patch to /parameters/{id} modifies the parameter with the given id. You can modify name and/or description.

Path parameters

Snippet path-parameters not found for operation::RestParameterControllerIT/patch-parameter

HTTP request

Snippet http-request not found for operation::RestParameterControllerIT/patch-parameter

Example response

Snippet http-response not found for operation::RestParameterControllerIT/patch-parameter

Delete parameter

A DELETE to /parameters/{id} deletes one parameter with the given id.

Path parameters

Snippet path-parameters not found for operation::RestParameterControllerIT/delete-parameter

HTTP request

Snippet http-request not found for operation::RestParameterControllerIT/delete-parameter

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

Example 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

Example 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

Example 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

Example 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

Example 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

Example 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

Example 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

Example 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

Example 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

Example 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

Example 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

Example 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

Example 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

Example 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

Example 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

Requirements

This chapter focuses on services for the requirements.

Get all requirements

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

HTTP request

Snippet http-request not found for operation::RestRequirementControllerIT/browse-requirements

Request parameters

Snippet request-parameters not found for operation::RestRequirementControllerIT/browse-requirements

Example response

Snippet http-response not found for operation::RestRequirementControllerIT/browse-requirements

Response fields

Snippet response-fields not found for operation::RestRequirementControllerIT/browse-requirements

Snippet links not found for operation::RestRequirementControllerIT/browse-requirements

Create requirement

A POST to /requirements creates a new requirement.

HTTP request

Snippet http-request not found for operation::RestRequirementControllerIT/post-requirement

Request fields

Snippet request-fields not found for operation::RestRequirementControllerIT/post-requirement

Request parameters

Snippet request-parameters not found for operation::RestRequirementControllerIT/post-requirement

Example response

Snippet http-response not found for operation::RestRequirementControllerIT/post-requirement

Response fields

Snippet response-fields not found for operation::RestRequirementControllerIT/post-requirement

Snippet links not found for operation::RestRequirementControllerIT/post-requirement

Modify requirement

A Patch to /requirements/{id} modifies the requirement with the given id. The properties that you can modify are the name, reference, description, category, criticality and status.

Note that modifying a requirement means modifying its current version : this is why those attributes must be enclosed in a section "current_version" (see the example).

Path parameters

Snippet path-parameters not found for operation::RestRequirementControllerIT/patch-requirement

HTTP request

Snippet http-request not found for operation::RestRequirementControllerIT/patch-requirement

Example response

Snippet http-response not found for operation::RestRequirementControllerIT/patch-requirement

Get requirement

A GET to /requirements/{id} returns the requirement with the given id.

Path parameters

Snippet path-parameters not found for operation::RestRequirementControllerIT/get-requirement

HTTP request

Snippet http-request not found for operation::RestRequirementControllerIT/get-requirement

Request parameters

Snippet request-parameters not found for operation::RestRequirementControllerIT/get-requirement

Example response

Snippet http-response not found for operation::RestRequirementControllerIT/get-requirement

Response fields

Snippet response-fields not found for operation::RestRequirementControllerIT/get-requirement

Snippet links not found for operation::RestRequirementControllerIT/get-requirement

Delete requirement

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

Path parameters

Snippet path-parameters not found for operation::RestRequirementControllerIT/delete-requirement

HTTP request

Snippet http-request not found for operation::RestRequirementControllerIT/delete-requirement

Get requirement children

A GET to /requirements/{id}/children returns the children of the requirement with the given id.

Path parameters

Snippet path-parameters not found for operation::RestRequirementControllerIT/get-requirement-children

HTTP request

Snippet http-request not found for operation::RestRequirementControllerIT/get-requirement-children

Request parameters

Snippet request-parameters not found for operation::RestRequirementControllerIT/get-requirement-children

Example response

Snippet http-response not found for operation::RestRequirementControllerIT/get-requirement-children

Response fields

Snippet response-fields not found for operation::RestRequirementControllerIT/get-requirement-children

Snippet links not found for operation::RestRequirementControllerIT/get-requirement-children

Associate test cases to a requirement

A POST to /requirements/{id}/coverages associates the requirement to the test cases which ids are given in parameters.

Path parameters

Snippet path-parameters not found for operation::RestRequirementControllerIT/associate-test-cases

HTTP request

Snippet http-request not found for operation::RestRequirementControllerIT/associate-test-cases

Request parameters

Snippet request-parameters not found for operation::RestRequirementControllerIT/associate-test-cases

Example response

Snippet http-response not found for operation::RestRequirementControllerIT/associate-test-cases

Response fields

Snippet response-fields not found for operation::RestRequirementControllerIT/associate-test-cases

Snippet links not found for operation::RestRequirementControllerIT/associate-test-cases

Disassociate test cases to a requirement

A DELETE to /requirements/{id}/coverages/{testCaseIds} disassociates the requirement to the test cases which ids are given in parameters.

Path parameters

Snippet path-parameters not found for operation::RestRequirementControllerIT/disassociate-test-cases

HTTP request

Snippet http-request not found for operation::RestRequirementControllerIT/disassociate-test-cases

Requirement Folders

This chapter focuses on services for the requirement folders.

Get all requirement folders

A GET to /requirement-folders returns all the requirement folders that the client is allowed to read.

HTTP request

Snippet http-request not found for operation::RestRequirementFolderControllerIT/browse-requirement-folders

Request parameters

Snippet request-parameters not found for operation::RestRequirementFolderControllerIT/browse-requirement-folders

Example response

Snippet http-response not found for operation::RestRequirementFolderControllerIT/browse-requirement-folders

Response fields

Snippet response-fields not found for operation::RestRequirementFolderControllerIT/browse-requirement-folders

Snippet links not found for operation::RestRequirementFolderControllerIT/browse-requirement-folders

Create requirement folder

A POST to /requirement-folders creates a new requirement folder. The parent object and the name are required; refer to the complete reference of Get requirement folder for the other attributes.

HTTP request

Snippet http-request not found for operation::RestRequirementFolderControllerIT/post-requirement-folder

Example response

Snippet http-response not found for operation::RestRequirementFolderControllerIT/post-requirement-folder

Get requirement folder

A GET to /requirement-folders/{id} returns the requirement folder with the given id.

Path parameters

Snippet path-parameters not found for operation::RestRequirementFolderControllerIT/get-requirement-folder

HTTP request

Snippet http-request not found for operation::RestRequirementFolderControllerIT/get-requirement-folder

Request parameters

Snippet request-parameters not found for operation::RestRequirementFolderControllerIT/get-requirement-folder

Example response

Snippet http-response not found for operation::RestRequirementFolderControllerIT/get-requirement-folder

Response fields

Snippet response-fields not found for operation::RestRequirementFolderControllerIT/get-requirement-folder

Snippet links not found for operation::RestRequirementFolderControllerIT/get-requirement-folder

Modify requirement folder

A Patch to /requirement-folders/{id} modifies the requirement folder with the given id.

HTTP request

Snippet http-request not found for operation::RestRequirementFolderControllerIT/patch-requirement-folder

Example response

Snippet http-response not found for operation::RestRequirementFolderControllerIT/patch-requirement-folder

Delete requirement folder

A DELETE to /requirement-folders/{ids} deletes one or several requirement folder with the given id(s). Remember that deleting a folder entails that its content is deleted as well !

Path parameters

Snippet path-parameters not found for operation::RestRequirementFolderControllerIT/delete-requirement-folder

HTTP request

Snippet http-request not found for operation::RestRequirementFolderControllerIT/delete-requirement-folder

Get requirement folder contents

A GET to /requirement-folders/{id}/content returns the content of the requirement folder with the given id.

Path parameters

Snippet path-parameters not found for operation::RestRequirementFolderControllerIT/get-requirement-folder-content

HTTP request

Snippet http-request not found for operation::RestRequirementFolderControllerIT/get-requirement-folder-content

Request parameters

Snippet request-parameters not found for operation::RestRequirementFolderControllerIT/get-requirement-folder-content

Example response

Snippet http-response not found for operation::RestRequirementFolderControllerIT/get-requirement-folder-content

Response fields

Snippet response-fields not found for operation::RestRequirementFolderControllerIT/get-requirement-folder-content

Snippet links not found for operation::RestRequirementFolderControllerIT/get-requirement-folder-content

Requirement Versions

This chapter focuses on services for the requirement versions.

Get requirement version

A GET to /requirement-versions/{id} returns the requirement version with the given id.

Path parameters

Snippet path-parameters not found for operation::RestRequirementVersionControllerIT/get-requirement-version

HTTP request

Snippet http-request not found for operation::RestRequirementVersionControllerIT/get-requirement-version

Request parameters

Snippet request-parameters not found for operation::RestRequirementVersionControllerIT/get-requirement-version

Example response

Snippet http-response not found for operation::RestRequirementVersionControllerIT/get-requirement-version

Response fields

Snippet response-fields not found for operation::RestRequirementVersionControllerIT/get-requirement-version

Snippet links not found for operation::RestRequirementVersionControllerIT/get-requirement-version

Teams

This chapter focuses on services for the teams.

Get all teams

A GET to /teams returns all the teams.

HTTP request

Snippet http-request not found for operation::RestTeamControllerIT/browse-teams

Request parameters

Snippet request-parameters not found for operation::RestTeamControllerIT/browse-teams

Example response

Snippet http-response not found for operation::RestTeamControllerIT/browse-teams

Response fields

Snippet response-fields not found for operation::RestTeamControllerIT/browse-teams

Snippet links not found for operation::RestTeamControllerIT/browse-teams

Create team

A POST to /teams creates a new team.

HTTP request

Snippet http-request not found for operation::RestTeamControllerIT/post-team

Request fields

Snippet request-fields not found for operation::RestTeamControllerIT/post-team

Request parameters

Snippet request-parameters not found for operation::RestTeamControllerIT/post-team

Example response

Snippet http-response not found for operation::RestTeamControllerIT/post-team

Response fields

Snippet response-fields not found for operation::RestTeamControllerIT/post-team

Snippet links not found for operation::RestTeamControllerIT/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::RestTeamControllerIT/get-team

HTTP request

Snippet http-request not found for operation::RestTeamControllerIT/get-team

Request parameters

Snippet request-parameters not found for operation::RestTeamControllerIT/get-team

Example response

Snippet http-response not found for operation::RestTeamControllerIT/get-team

Response fields

Snippet response-fields not found for operation::RestTeamControllerIT/get-team

Snippet links not found for operation::RestTeamControllerIT/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::RestTeamControllerIT/patch-team

HTTP request

Snippet http-request not found for operation::RestTeamControllerIT/patch-team

Request fields

Snippet request-fields not found for operation::RestTeamControllerIT/patch-team

Request parameters

Snippet request-parameters not found for operation::RestTeamControllerIT/patch-team

Example response

Snippet http-response not found for operation::RestTeamControllerIT/patch-team

Response fields

Snippet response-fields not found for operation::RestTeamControllerIT/patch-team

Snippet links not found for operation::RestTeamControllerIT/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::RestTeamControllerIT/delete-team

HTTP request

Snippet http-request not found for operation::RestTeamControllerIT/delete-team

Get team members

A GET to /teams/{id}/members returns all the members of the team with the given id.

Path parameters

Snippet path-parameters not found for operation::RestTeamControllerIT/get-team-members

HTTP request

Snippet http-request not found for operation::RestTeamControllerIT/get-team-members

Request parameters

Snippet request-parameters not found for operation::RestTeamControllerIT/get-team-members

Example response

Snippet http-response not found for operation::RestTeamControllerIT/get-team-members

Response fields

Snippet response-fields not found for operation::RestTeamControllerIT/get-team-members

Snippet links not found for operation::RestTeamControllerIT/get-team-members

Add members

A POST to /teams/{teamId}/members with userIds in request parameters adds these users to the team with the given id.

Path parameters

Snippet path-parameters not found for operation::RestTeamControllerIT/add-new-members-to-team

HTTP request

Snippet http-request not found for operation::RestTeamControllerIT/add-new-members-to-team

Request parameters

Snippet request-parameters not found for operation::RestTeamControllerIT/add-new-members-to-team

Remove members

A DELETE to /teams/{teamId}/members with userIds in request parameters removes these users from the team with the given id.

Path parameters

Snippet path-parameters not found for operation::RestTeamControllerIT/remove-team-members

HTTP request

Snippet http-request not found for operation::RestTeamControllerIT/remove-team-members

Request parameters

Snippet request-parameters not found for operation::RestTeamControllerIT/remove-team-members

Test Automation Servers

This chapter focuses on services for the 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::RestTestAutomationServerControllerIT/browse-test-automation-servers

Request parameters

Snippet request-parameters not found for operation::RestTestAutomationServerControllerIT/browse-test-automation-servers

Example response

Snippet http-response not found for operation::RestTestAutomationServerControllerIT/browse-test-automation-servers

Response fields

Snippet response-fields not found for operation::RestTestAutomationServerControllerIT/browse-test-automation-servers

Snippet links not found for operation::RestTestAutomationServerControllerIT/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::RestTestAutomationServerControllerIT/get-test-automation-server

HTTP request

Snippet http-request not found for operation::RestTestAutomationServerControllerIT/get-test-automation-server

Request parameters

Snippet request-parameters not found for operation::RestTestAutomationServerControllerIT/get-test-automation-server

Example response

Snippet http-response not found for operation::RestTestAutomationServerControllerIT/get-test-automation-server

Response fields

Snippet response-fields not found for operation::RestTestAutomationServerControllerIT/get-test-automation-server

Snippet links not found for operation::RestTestAutomationServerControllerIT/get-test-automation-server

Test Cases

This chapter focuses on services for the test cases.

Updates from version 1.2.0:

  • There are 3 types of test case: standard, scripted and keyword.

  • The "kind" property is no longer available in test case. The test case type is, instead, specified/defined by "_type" property.

  • The "script" property is from now available only for scripted test case.

  • There is no longer "language" property in test case. The language for scripted test case is always GHERKIN while there is no defined language for standard and keyword test cases.

Get all test cases

A GET to /test-cases returns all the test-cases that the client is allowed to read.

Type ('all', 'standard', 'scripted' or 'keyword') can be added as filter parameter to return the test cases with specific type.

HTTP request

Snippet http-request not found for operation::RestTestCaseGetControllerIT/browse-test-cases

Request parameters

Snippet request-parameters not found for operation::RestTestCaseGetControllerIT/browse-test-cases

Example response

Snippet http-response not found for operation::RestTestCaseGetControllerIT/browse-test-cases

Response fields

Snippet response-fields not found for operation::RestTestCaseGetControllerIT/browse-test-cases

Snippet links not found for operation::RestTestCaseGetControllerIT/browse-test-cases

Get test case

A GET to /test-cases/{id} returns the test case with the given id.

Path parameters

Snippet path-parameters not found for operation::RestTestCaseGetControllerIT/get-test-case

HTTP request

Snippet http-request not found for operation::RestTestCaseGetControllerIT/get-test-case

Request parameters

Snippet request-parameters not found for operation::RestTestCaseGetControllerIT/get-test-case

Example response

Snippet http-response not found for operation::RestTestCaseGetControllerIT/get-test-case

Response fields

Snippet response-fields not found for operation::RestTestCaseGetControllerIT/get-test-case

Snippet links not found for operation::RestTestCaseGetControllerIT/get-test-case

Create test case

A POST to /test-cases creates a new test case. By default the created test case will be of "standard" type, to create a "scripted" or a "keyword" test case, you need to specify additional property in your payload : "_type": "scripted-test-case" or "keyword-test-case".

  • Create a standard test case

HTTP request

Snippet http-request not found for operation::RestTestCasePostControllerIT/post-test-case

Example response

Snippet http-response not found for operation::RestTestCasePostControllerIT/post-test-case

  • Create a scripted test case

HTTP request

Snippet http-request not found for operation::RestTestCasePostControllerIT/post-scripted-test-case

Example response

Snippet http-response not found for operation::RestTestCasePostControllerIT/post-scripted-test-case

  • Create a keyword test case

HTTP request

Snippet http-request not found for operation::RestTestCasePostControllerIT/post-keyword-test-case

Example response

Snippet http-response not found for operation::RestTestCasePostControllerIT/post-keyword-test-case

Modify test case

A PATCH to /test-cases/{id} modifies the test case with the given id.

  • Modify a standard test case

HTTP request

Snippet http-request not found for operation::RestTestCasePostControllerIT/patch-test-case

Example response

Snippet http-response not found for operation::RestTestCasePostControllerIT/patch-test-case

  • Modify a scripted test case

HTTP request

Snippet http-request not found for operation::RestTestCasePostControllerIT/patch-scripted-test-case

Example response

Snippet http-response not found for operation::RestTestCasePostControllerIT/patch-scripted-test-case

  • Modify a keyword test case

HTTP request

Snippet http-request not found for operation::RestTestCasePostControllerIT/patch-keyword-test-case

Example response

Snippet http-response not found for operation::RestTestCasePostControllerIT/patch-keyword-test-case

Get datasets of test case

A GET to /test-cases/{id}/datasets returns all the datasets of the test case with the given id.

Path parameters

Snippet path-parameters not found for operation::RestTestCaseGetControllerIT/get-test-case-datasets

HTTP request

Snippet http-request not found for operation::RestTestCaseGetControllerIT/get-test-case-datasets

Request parameters

Snippet request-parameters not found for operation::RestTestCaseGetControllerIT/get-test-case-datasets

Example response

Snippet http-response not found for operation::RestTestCaseGetControllerIT/get-test-case-datasets

Response fields

Snippet response-fields not found for operation::RestTestCaseGetControllerIT/get-test-case-datasets

Snippet links not found for operation::RestTestCaseGetControllerIT/get-test-case-datasets

Get parameters of test case

A GET to /test-cases/{id}/parameters returns all the parameters of the test case with the given id.

Path parameters

Snippet path-parameters not found for operation::RestTestCaseGetControllerIT/get-test-case-parameters

HTTP request

Snippet http-request not found for operation::RestTestCaseGetControllerIT/get-test-case-parameters

Request parameters

Snippet request-parameters not found for operation::RestTestCaseGetControllerIT/get-test-case-parameters

Example response

Snippet http-response not found for operation::RestTestCaseGetControllerIT/get-test-case-parameters

Response fields

Snippet response-fields not found for operation::RestTestCaseGetControllerIT/get-test-case-parameters

Snippet links not found for operation::RestTestCaseGetControllerIT/get-test-case-parameters

Get steps of test case

A GET to /test-cases/{id}/steps returns all the steps of the test case with the given id.

  • In case of a standard test case :

Path parameters

Snippet path-parameters not found for operation::RestTestCaseGetControllerIT/get-test-case-steps

HTTP request

Snippet http-request not found for operation::RestTestCaseGetControllerIT/get-test-case-steps

Request parameters

Snippet request-parameters not found for operation::RestTestCaseGetControllerIT/get-test-case-steps

Example response

Snippet http-response not found for operation::RestTestCaseGetControllerIT/get-test-case-steps

Response fields

Snippet response-fields not found for operation::RestTestCaseGetControllerIT/get-test-case-steps

Snippet links not found for operation::RestTestCaseGetControllerIT/get-test-case-steps

  • In case of a keyword test case :

Path parameters

Snippet path-parameters not found for operation::RestTestCaseGetControllerIT/get-keyword-test-case-steps

HTTP request

Snippet http-request not found for operation::RestTestCaseGetControllerIT/get-keyword-test-case-steps

Request parameters

Snippet request-parameters not found for operation::RestTestCaseGetControllerIT/get-keyword-test-case-steps

Example response

Snippet http-response not found for operation::RestTestCaseGetControllerIT/get-keyword-test-case-steps

Response fields

Snippet response-fields not found for operation::RestTestCaseGetControllerIT/get-keyword-test-case-steps

Snippet links not found for operation::RestTestCaseGetControllerIT/get-keyword-test-case-steps

Delete test case

A DELETE to /test-cases/{ids} deletes one or several test cases/folders with the given id(s).

When a lot of test case should be deleted, the system will determine which of them are really deletable according to the business rules. Once this sorting is done only the deletable items will actually be deleted.

The service returns a list of messages that indicates the result of the operation. If everything goes as expected, this list will be empty. In the case where certain elements could not be deleted (for business rules), the service will return one or more messages which will indicate it to you. Note that these messages are the same as those displayed in the user interface.

Optionally we can pass in parameter 'dry-run = true'. In this case only the diagnostics and messages are returned, but no test case will be deleted.

Path parameters

Snippet path-parameters not found for operation::RestTestCasePostControllerIT/delete-test-case

HTTP request

Snippet http-request not found for operation::RestTestCasePostControllerIT/delete-test-case

Request parameters

Snippet request-parameters not found for operation::RestTestCasePostControllerIT/delete-test-case

Example response

Snippet http-response not found for operation::RestTestCasePostControllerIT/delete-test-case

Test Case Folders

This chapter focuses on services for the test case folders.

Get all test case folders

A GET to /test-case-folders returns all the test case folders that the client is allowed to read.

HTTP request

Snippet http-request not found for operation::RestTestCaseFolderControllerIT/browse-test-case-folders

Request parameters

Snippet request-parameters not found for operation::RestTestCaseFolderControllerIT/browse-test-case-folders

Example response

Snippet http-response not found for operation::RestTestCaseFolderControllerIT/browse-test-case-folders

Response fields

Snippet response-fields not found for operation::RestTestCaseFolderControllerIT/browse-test-case-folders

Snippet links not found for operation::RestTestCaseFolderControllerIT/browse-test-case-folders

Create test case folder

A POST to /test-case-folders creates a new test case folder. The parent object and the name are required; refer to the complete reference of Get test case folder for the other attributes.

HTTP request

Snippet http-request not found for operation::RestTestCaseFolderControllerIT/post-test-case-folder

Example response

Snippet http-response not found for operation::RestTestCaseFolderControllerIT/post-test-case-folder

Get test case folder

A GET to /test-case-folders/{id} returns the test case folder with the given id.

Path parameters

Snippet path-parameters not found for operation::RestTestCaseFolderControllerIT/get-test-case-folder

HTTP request

Snippet http-request not found for operation::RestTestCaseFolderControllerIT/get-test-case-folder

Request parameters

Snippet request-parameters not found for operation::RestTestCaseFolderControllerIT/get-test-case-folder

Example response

Snippet http-response not found for operation::RestTestCaseFolderControllerIT/get-test-case-folder

Response fields

Snippet response-fields not found for operation::RestTestCaseFolderControllerIT/get-test-case-folder

Snippet links not found for operation::RestTestCaseFolderControllerIT/get-test-case-folder

Modify test case folder

A Patch to /test-case-folders/{id} modifies the test case folder with the given id.

HTTP request

Snippet http-request not found for operation::RestTestCaseFolderControllerIT/patch-test-case-folder

Example response

Snippet http-response not found for operation::RestTestCaseFolderControllerIT/patch-test-case-folder

Delete test case folder

A DELETE to /test-case-folders/{ids} deletes one or several test case folder with the given id(s). Remember that deleting a folder entails that its content is deleted as well. Also note that test cases that are called by other test cases will not be deleted, unless those test cases are deleted in the same batch.

Path parameters

Snippet path-parameters not found for operation::RestTestCaseFolderControllerIT/delete-test-case-folder

HTTP request

Snippet http-request not found for operation::RestTestCaseFolderControllerIT/delete-test-case-folder

Get test case folder contents

A GET to /test-case-folders/{id}/content returns the content of the test case folder with the given id.

Path parameters

Snippet path-parameters not found for operation::RestTestCaseFolderControllerIT/get-test-case-folder-content

HTTP request

Snippet http-request not found for operation::RestTestCaseFolderControllerIT/get-test-case-folder-content

Request parameters

Snippet request-parameters not found for operation::RestTestCaseFolderControllerIT/get-test-case-folder-content

Example response

Snippet http-response not found for operation::RestTestCaseFolderControllerIT/get-test-case-folder-content

Response fields

Snippet response-fields not found for operation::RestTestCaseFolderControllerIT/get-test-case-folder-content

Snippet links not found for operation::RestTestCaseFolderControllerIT/get-test-case-folder-content

Test Steps

This chapter focuses on services for the test steps.

Get test step

A GET to /test-steps/{id} returns the test step with the given id, this step can be either an action step, a call step, or a keyword step.

Path parameters

Snippet path-parameters not found for operation::RestTestStepControllerIT/get-action-step

HTTP request

Snippet http-request not found for operation::RestTestStepControllerIT/get-action-step

Request parameters

Snippet request-parameters not found for operation::RestTestStepControllerIT/get-action-step

  • In case of an action step :

Example response

Snippet http-response not found for operation::RestTestStepControllerIT/get-action-step

Response fields

Snippet response-fields not found for operation::RestTestStepControllerIT/get-action-step

Snippet links not found for operation::RestTestStepControllerIT/get-action-step

  • In case of a call step :

Example response

Snippet http-response not found for operation::RestTestStepControllerIT/get-call-step

Response fields

Snippet response-fields not found for operation::RestTestStepControllerIT/get-call-step

Snippet links not found for operation::RestTestStepControllerIT/get-call-step

  • In case of a keyword step :

Example response

Snippet http-response not found for operation::RestTestStepControllerIT/get-keyword-step

Response fields

Snippet response-fields not found for operation::RestTestStepControllerIT/get-keyword-step

Snippet links not found for operation::RestTestStepControllerIT/get-keyword-step

Modify test step

A PATCH to /test-steps/{id} modifies the test step with the given id.

Path parameters

Snippet path-parameters not found for operation::RestTestStepControllerIT/patch-action-test-step

Request parameters

Snippet request-parameters not found for operation::RestTestStepControllerIT/patch-action-test-step

  • In case of an action step :

HTTP request

Snippet http-request not found for operation::RestTestStepControllerIT/patch-action-test-step

Request fields

Snippet request-fields not found for operation::RestTestStepControllerIT/patch-action-test-step

Example response

Snippet http-response not found for operation::RestTestStepControllerIT/patch-action-test-step

Response fields

Snippet response-fields not found for operation::RestTestStepControllerIT/patch-action-test-step

Snippet links not found for operation::RestTestStepControllerIT/patch-action-test-step

  • In case of a call step :

HTTP request

Snippet http-request not found for operation::RestTestStepControllerIT/patch-call-test-step

Request fields

Snippet request-fields not found for operation::RestTestStepControllerIT/patch-call-test-step

Example response

Snippet http-response not found for operation::RestTestStepControllerIT/patch-call-test-step

Response fields

Snippet response-fields not found for operation::RestTestStepControllerIT/patch-call-test-step

Snippet links not found for operation::RestTestStepControllerIT/patch-call-test-step

  • In case of a keyword step :

HTTP request

Snippet http-request not found for operation::RestTestStepControllerIT/patch-keyword-test-step

Request fields

Snippet request-fields not found for operation::RestTestStepControllerIT/patch-keyword-test-step

Example response

Snippet http-response not found for operation::RestTestStepControllerIT/patch-keyword-test-step

Response fields

Snippet response-fields not found for operation::RestTestStepControllerIT/patch-keyword-test-step

Snippet links not found for operation::RestTestStepControllerIT/patch-keyword-test-step

Delete test step

A DELETE to /test-steps/{ids} deletes the test steps with the given ids.

Path parameters

Snippet path-parameters not found for operation::RestTestStepControllerIT/delete-test-step

HTTP request

Snippet http-request not found for operation::RestTestStepControllerIT/delete-test-step

Create test step

A POST to /test-cases/{testCaseId}/steps creates a new test step (action step or call step).

Path parameters

Snippet path-parameters not found for operation::RestTestStepControllerIT/post-action-test-step

Request parameters

Snippet request-parameters not found for operation::RestTestStepControllerIT/post-action-test-step

  • In case of an action step :

HTTP request

Snippet http-request not found for operation::RestTestStepControllerIT/post-action-test-step

Request fields

Snippet request-fields not found for operation::RestTestStepControllerIT/post-action-test-step

Example response

Snippet http-response not found for operation::RestTestStepControllerIT/post-action-test-step

Response fields

Snippet response-fields not found for operation::RestTestStepControllerIT/post-action-test-step

Snippet links not found for operation::RestTestStepControllerIT/post-action-test-step

  • In case of a call step :

HTTP request

Snippet http-request not found for operation::RestTestStepControllerIT/post-call-test-step

Request fields

Snippet request-fields not found for operation::RestTestStepControllerIT/post-call-test-step

Example response

Snippet http-response not found for operation::RestTestStepControllerIT/post-call-test-step

Response fields

Snippet response-fields not found for operation::RestTestStepControllerIT/post-call-test-step

Snippet links not found for operation::RestTestStepControllerIT/post-call-test-step

  • In case of a keyword step :

HTTP request

Snippet http-request not found for operation::RestTestStepControllerIT/post-keyword-test-step

Request fields

Snippet request-fields not found for operation::RestTestStepControllerIT/post-keyword-test-step

Example response

Snippet http-response not found for operation::RestTestStepControllerIT/post-keyword-test-step

Response fields

Snippet response-fields not found for operation::RestTestStepControllerIT/post-keyword-test-step

Snippet links not found for operation::RestTestStepControllerIT/post-keyword-test-step

Test Suites

This chapter focuses on services for the test suites.

Note : A Test Suite is a partition of an Iteration, more specifically its test plan is a partition of that of the Iteration it belongs to. Technically they share the same instances of IterationTestPlanItem; however the lifecycle of those items is managed by the Iteration only. Therefore, in the context of a Test Suite the semantic of PUTing or DELETEing an item changes slightly : those operations becomes 'attach' or 'detach' items. An item is available to a Test Suite only if it has been created first within the Iteration.

Get test suite

A GET to /test-suites/{id} returns the test suite with the given id.

Path parameters

Snippet path-parameters not found for operation::RestTestSuiteControllerIT/get-test-suite

HTTP request

Snippet http-request not found for operation::RestTestSuiteControllerIT/get-test-suite

Request parameters

Snippet request-parameters not found for operation::RestTestSuiteControllerIT/get-test-suite

Example response

Snippet http-response not found for operation::RestTestSuiteControllerIT/get-test-suite

Response fields

Snippet response-fields not found for operation::RestTestSuiteControllerIT/get-test-suite

Snippet links not found for operation::RestTestSuiteControllerIT/get-test-suite

Create test suite

A POST to /test-suites creates a new test suite with or without test plan .

HTTP request

Snippet http-request not found for operation::RestTestSuiteControllerIT/post-test-suite

Request fields

Snippet request-fields not found for operation::RestTestSuiteControllerIT/post-test-suite

Example response

Snippet http-response not found for operation::RestTestSuiteControllerIT/post-test-suite

Modify test suite

A PATCH to /test-suites/{id} modifies the test suite with de given id. You can modify description, status, and/or custom fields.

Path parameters

Snippet path-parameters not found for operation::RestTestSuiteControllerIT/patch-test-suite

HTTP request

Snippet http-request not found for operation::RestTestSuiteControllerIT/patch-test-suite

Example response

Snippet http-response not found for operation::RestTestSuiteControllerIT/patch-test-suite

Attach item to test suite

A POST to /test-suites/{idTestSuite}/test-plan/{ids} attach one or several test plan item to a test suite with the given id(s), and return the content of the test suite.

If among the targeted items some cannot be attached due to validation errors (see below) they won’t be processed; only those that pass the validation will be attached. The operation will return no error message : the client will receive the modified test suite instead, and can then check that the final state is consistent with its expectations.

The possible validation errors are : * the item does not exist, * the item and the test suite belong to different iterations, * the user does not have the required permissions.

Path parameters

Snippet path-parameters not found for operation::RestTestSuiteControllerIT/attach-item-from-test-suite

Example response

Snippet http-response not found for operation::RestTestSuiteControllerIT/attach-item-from-test-suite

Detach item of test suite

A DELETE to /test-suites/{idTestSuite}/test-plan/{ids} Detached one or several test plan item of test suite with the given id(s).

Path parameters

Snippet path-parameters not found for operation::RestTestSuiteControllerIT/detach-item-from-test-suite

Example response

Snippet http-response not found for operation::RestTestSuiteControllerIT/detach-item-from-test-suite

Delete test suite

A DELETE to /test-suites/{ids} deletes one or several test suites with the given id(s).

Path parameters

Snippet path-parameters not found for operation::RestTestSuiteControllerIT/delete-test-suite

HTTP request

Snippet http-request not found for operation::RestTestSuiteControllerIT/delete-test-suite

Get plans of test suite

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

HTTP request

Snippet http-request not found for operation::RestTestSuiteControllerIT/get-test-suite-test-plan

Request parameters

Snippet request-parameters not found for operation::RestTestSuiteControllerIT/get-test-suite-test-plan

Example response

Snippet http-response not found for operation::RestTestSuiteControllerIT/get-test-suite-test-plan

Users

This chapter focuses on services for the users.

Get all users

A GET to /users returns all the users.

HTTP request

Snippet http-request not found for operation::RestUserControllerIT/browse-users

Request parameters

Snippet request-parameters not found for operation::RestUserControllerIT/browse-users

Example response

Snippet http-response not found for operation::RestUserControllerIT/browse-users

Response fields

Snippet response-fields not found for operation::RestUserControllerIT/browse-users

Snippet links not found for operation::RestUserControllerIT/browse-users

Create user

A POST to /users creates a new user.

HTTP request

Snippet http-request not found for operation::RestUserControllerIT/post-user

Request fields

Snippet request-fields not found for operation::RestUserControllerIT/post-user

Request parameters

Snippet request-parameters not found for operation::RestUserControllerIT/post-user

Example response

Snippet http-response not found for operation::RestUserControllerIT/post-user

Response fields

Snippet response-fields not found for operation::RestUserControllerIT/post-user

Snippet links not found for operation::RestUserControllerIT/post-user

Get user

A GET to /users/{id} returns the user with the given id.

Path parameters

Snippet path-parameters not found for operation::RestUserControllerIT/get-user

HTTP request

Snippet http-request not found for operation::RestUserControllerIT/get-user

Request parameters

Snippet request-parameters not found for operation::RestUserControllerIT/get-user

Example response

Snippet http-response not found for operation::RestUserControllerIT/get-user

Response fields

Snippet response-fields not found for operation::RestUserControllerIT/get-user

Snippet links not found for operation::RestUserControllerIT/get-user

Modify user

A PATCH to /users/{id} modifies the user with the given id.

Path parameters

Snippet path-parameters not found for operation::RestUserControllerIT/patch-user

HTTP request

Snippet http-request not found for operation::RestUserControllerIT/patch-user

Request fields

Snippet request-fields not found for operation::RestUserControllerIT/patch-user

Request parameters

Snippet request-parameters not found for operation::RestUserControllerIT/patch-user

Example response

Snippet http-response not found for operation::RestUserControllerIT/patch-user

Response fields

Snippet response-fields not found for operation::RestUserControllerIT/patch-user

Snippet links not found for operation::RestUserControllerIT/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::RestUserControllerIT/delete-user

HTTP request

Snippet http-request not found for operation::RestUserControllerIT/delete-user

Get user subscribed teams

A GET to /users/{id}/teams returns all the subscribed teams of the user with the given id.

Path parameters

Snippet path-parameters not found for operation::RestUserControllerIT/get-teams

HTTP request

Snippet http-request not found for operation::RestUserControllerIT/get-teams

Request parameters

Snippet request-parameters not found for operation::RestUserControllerIT/get-teams

Example response

Snippet http-response not found for operation::RestUserControllerIT/get-teams

Response fields

Snippet response-fields not found for operation::RestUserControllerIT/get-teams

Snippet links not found for operation::RestUserControllerIT/get-teams

Subscribe to teams

A POST to /users/{userId}/teams with teamIds in request parameters subscribes the user with the given id to these teams.

Path parameters

Snippet path-parameters not found for operation::RestUserControllerIT/add-teams

HTTP request

Snippet http-request not found for operation::RestUserControllerIT/add-teams

Request parameters

Snippet request-parameters not found for operation::RestUserControllerIT/add-teams

Unsubscribe from teams

A DELETE to /users/{userId}/teams with teamIds in request parameters unsubscribes the user with the given id from these teams.

Path parameters

Snippet path-parameters not found for operation::RestUserControllerIT/disassociate-teams

HTTP request

Snippet http-request not found for operation::RestUserControllerIT/disassociate-teams

Request parameters

Snippet request-parameters not found for operation::RestUserControllerIT/disassociate-teams