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 Get test suite

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

Path parameters

Table 1. /api/rest/latest/test-suites/{id}
Parameter Description

id

the id of the test suite

HTTP request

GET /api/rest/latest/test-suites/9 HTTP/1.1
Accept: application/json
Host: localhost:8080

Request parameters

Parameter Description

fields

which fields of the elements should be returned (optional)

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 3599

{
  "_type" : "test-suite",
  "id" : 9,
  "name" : "sample test suite",
  "description" : "<p>this is a sample test suite</p>",
  "uuid" : "2f7198zd-eb2e-4379-f82d-ddc207c866bd",
  "status" : "READY",
  "parent" : {
    "_type" : "iteration",
    "id" : 101,
    "name" : "second iteration",
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/iterations/101"
      }
    }
  },
  "created_by" : "admin",
  "created_on" : "2017-07-12T10:00:00.000+00:00",
  "last_modified_by" : "admin",
  "last_modified_on" : "2017-07-12T10:00:00.000+00:00",
  "custom_fields" : [ {
    "code" : "CF_TXT",
    "label" : "cuf text",
    "value" : "the_value"
  }, {
    "code" : "CF_TAG",
    "label" : "cuf tag",
    "value" : [ "tag_1", "tag_2" ]
  } ],
  "test_plan" : [ {
    "_type" : "iteration-test-plan-item",
    "id" : 80,
    "execution_status" : "READY",
    "referenced_test_case" : {
      "_type" : "test-case",
      "id" : 90,
      "name" : "first test case",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/test-cases/90"
        }
      }
    },
    "referenced_dataset" : {
      "_type" : "dataset",
      "id" : 5,
      "name" : "dataset",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/datasets/5"
        }
      }
    },
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/iteration-test-plan-items/80"
      }
    }
  }, {
    "_type" : "iteration-test-plan-item",
    "id" : 41,
    "execution_status" : "SUCCESS",
    "referenced_test_case" : {
      "_type" : "scripted-test-case",
      "id" : 91,
      "name" : "scripted test case 2",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/test-cases/91"
        }
      }
    },
    "referenced_dataset" : {
      "_type" : "dataset",
      "id" : 9,
      "name" : "dataset",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/datasets/9"
        }
      }
    },
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/iteration-test-plan-items/41"
      }
    }
  }, {
    "_type" : "iteration-test-plan-item",
    "id" : 95,
    "execution_status" : "SUCCESS",
    "referenced_test_case" : {
      "_type" : "keyword-test-case",
      "id" : 105,
      "name" : "keyword test case 3",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/test-cases/105"
        }
      }
    },
    "referenced_dataset" : {
      "_type" : "dataset",
      "id" : 18,
      "name" : "dataset",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/datasets/18"
        }
      }
    },
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/iteration-test-plan-items/95"
      }
    }
  } ],
  "attachments" : [ ],
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/rest/latest/test-suites/9"
    },
    "project" : {
      "href" : "http://localhost:8080/api/rest/latest/projects/15"
    },
    "iteration" : {
      "href" : "http://localhost:8080/api/rest/latest/iterations/101"
    },
    "test-plan" : {
      "href" : "http://localhost:8080/api/rest/latest/test-suites/9/test-plan"
    },
    "attachments" : {
      "href" : "http://localhost:8080/api/rest/latest/test-suites/9/attachments"
    },
    "issues" : {
      "href" : "http://localhost:8080/api/rest/latest/test-suites/9/issues"
    }
  }
}

Response fields

Path Type Description

id

Number

the id of the test suite

_type

String

the type of the entity

name

String

the name of the test suite

description

String

the description of the test suite

uuid

String

the uuid of the test suite

status

String

the status of the test suite

parent

Object

the parent entity of the test suite

created_by

String

the user who created the test suite

created_on

String

the date the test suite was created

last_modified_by

String

the user who last modified the test suite

last_modified_on

String

the date the test suite was last modified

custom_fields

Array

the custom fields of the test suite

test_plan

Array

the iteration test plan items of the test suite

attachments

Array

the attachments of the test suite

_links

Object

related links

Relation Description

self

link to this test suite

project

link to the project the test suite belongs to

iteration

link to the iteration the test suite belongs to

test-plan

link the test plan of the test suite

attachments

link the test plan of the test suite

issues

link the issues of the test suite

post Create test suite

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

HTTP request

POST /api/rest/latest/test-suites HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 430
Host: localhost:8080

{
  "_type" : "test-suite",
  "name" : "sample test suite",
  "description" : "<p>this is a sample test suite</p>",
  "parent" : {
    "_type" : "iteration",
    "id" : 101
  },
  "custom_fields" : [ {
    "code" : "CF_TXT",
    "label" : "cuf text",
    "value" : "the_value"
  } ],
  "test_plan" : [ {
    "_type" : "iteration-test-plan-item",
    "id" : 80
  }, {
    "_type" : "iteration-test-plan-item",
    "id" : 41
  } ]
}

Request fields

Path Type Description

_type

String

the type of the entity

name

String

the name of the iteration

description

String

the description of the test suite

parent

Object

the parent iteration of this test suite

test_plan

Array

the iteration test plan items of the test suite (optional)

custom_fields

Array

the custom fields of this iteration

HTTP response

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 3497

{
  "_type" : "test-suite",
  "id" : 9,
  "name" : "sample test suite",
  "description" : "<p>this is a sample test suite</p>",
  "uuid" : "2f7198zd-eb2e-4379-f82d-ddc207c866bd",
  "status" : "READY",
  "parent" : {
    "_type" : "iteration",
    "id" : 101,
    "name" : "second iteration",
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/iterations/101"
      }
    }
  },
  "created_by" : "admin",
  "created_on" : "2017-07-12T10:00:00.000+00:00",
  "last_modified_by" : "admin",
  "last_modified_on" : "2017-07-12T10:00:00.000+00:00",
  "custom_fields" : [ {
    "code" : "CF_TXT",
    "label" : "cuf text",
    "value" : "the_value"
  }, {
    "code" : "CF_TAG",
    "label" : "cuf tag",
    "value" : [ "tag_1", "tag_2" ]
  } ],
  "test_plan" : [ {
    "_type" : "iteration-test-plan-item",
    "id" : 80,
    "execution_status" : "READY",
    "referenced_test_case" : {
      "_type" : "test-case",
      "id" : 90,
      "name" : "first test case",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/test-cases/90"
        }
      }
    },
    "referenced_dataset" : {
      "_type" : "dataset",
      "id" : 5,
      "name" : "dataset",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/datasets/5"
        }
      }
    },
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/iteration-test-plan-items/80"
      }
    }
  }, {
    "_type" : "iteration-test-plan-item",
    "id" : 41,
    "execution_status" : "SUCCESS",
    "referenced_test_case" : {
      "_type" : "scripted-test-case",
      "id" : 91,
      "name" : "scripted test case 2",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/test-cases/91"
        }
      }
    },
    "referenced_dataset" : {
      "_type" : "dataset",
      "id" : 9,
      "name" : "dataset",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/datasets/9"
        }
      }
    },
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/iteration-test-plan-items/41"
      }
    }
  }, {
    "_type" : "iteration-test-plan-item",
    "id" : 81,
    "execution_status" : "SUCCESS",
    "referenced_test_case" : {
      "_type" : "keyword-test-case",
      "id" : 99,
      "name" : "keyword test case 3",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/test-cases/99"
        }
      }
    },
    "referenced_dataset" : {
      "_type" : "dataset",
      "id" : 19,
      "name" : "dataset",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/datasets/19"
        }
      }
    },
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/iteration-test-plan-items/81"
      }
    }
  } ],
  "attachments" : [ ],
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/rest/latest/test-suites/9"
    },
    "project" : {
      "href" : "http://localhost:8080/api/rest/latest/projects/15"
    },
    "iteration" : {
      "href" : "http://localhost:8080/api/rest/latest/iterations/101"
    },
    "test-plan" : {
      "href" : "http://localhost:8080/api/rest/latest/test-suites/9/test-plan"
    },
    "attachments" : {
      "href" : "http://localhost:8080/api/rest/latest/test-suites/9/attachments"
    }
  }
}

patch Modify test suite

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

Path parameters

Table 1. /api/rest/latest/test-suites/{id}
Parameter Description

id

the id of the test suite

HTTP request

PATCH /api/rest/latest/test-suites/9 HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 229
Host: localhost:8080

{
  "_type" : "test-suite",
  "description" : "<p>modified description sample test suite</p>",
  "status" : "SUCCESS",
  "custom_fields" : [ {
    "code" : "CF_TXT",
    "label" : "cuf text",
    "value" : "the_new_value"
  } ]
}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 3516

{
  "_type" : "test-suite",
  "id" : 9,
  "name" : "sample test suite",
  "description" : "<p>modified description sample test suite</p>",
  "uuid" : "2f7198zd-eb2e-4379-f82d-ddc207c866bd",
  "status" : "SUCCESS",
  "parent" : {
    "_type" : "iteration",
    "id" : 101,
    "name" : "second iteration",
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/iterations/101"
      }
    }
  },
  "created_by" : "admin",
  "created_on" : "2017-07-12T10:00:00.000+00:00",
  "last_modified_by" : "admin",
  "last_modified_on" : "2017-07-12T10:00:00.000+00:00",
  "custom_fields" : [ {
    "code" : "CF_TXT",
    "label" : "cuf text",
    "value" : "the_new_value"
  }, {
    "code" : "CF_TAG",
    "label" : "cuf tag",
    "value" : [ "tag_1", "tag_2" ]
  } ],
  "test_plan" : [ {
    "_type" : "iteration-test-plan-item",
    "id" : 80,
    "execution_status" : "READY",
    "referenced_test_case" : {
      "_type" : "test-case",
      "id" : 90,
      "name" : "first test case",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/test-cases/90"
        }
      }
    },
    "referenced_dataset" : {
      "_type" : "dataset",
      "id" : 5,
      "name" : "dataset",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/datasets/5"
        }
      }
    },
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/iteration-test-plan-items/80"
      }
    }
  }, {
    "_type" : "iteration-test-plan-item",
    "id" : 41,
    "execution_status" : "SUCCESS",
    "referenced_test_case" : {
      "_type" : "scripted-test-case",
      "id" : 91,
      "name" : "scripted test case 2",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/test-cases/91"
        }
      }
    },
    "referenced_dataset" : {
      "_type" : "dataset",
      "id" : 9,
      "name" : "dataset",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/datasets/9"
        }
      }
    },
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/iteration-test-plan-items/41"
      }
    }
  }, {
    "_type" : "iteration-test-plan-item",
    "id" : 91,
    "execution_status" : "SUCCESS",
    "referenced_test_case" : {
      "_type" : "keyword-test-case",
      "id" : 191,
      "name" : "keyword test case 3",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/test-cases/191"
        }
      }
    },
    "referenced_dataset" : {
      "_type" : "dataset",
      "id" : 29,
      "name" : "dataset",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/datasets/29"
        }
      }
    },
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/iteration-test-plan-items/91"
      }
    }
  } ],
  "attachments" : [ ],
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/rest/latest/test-suites/9"
    },
    "project" : {
      "href" : "http://localhost:8080/api/rest/latest/projects/15"
    },
    "iteration" : {
      "href" : "http://localhost:8080/api/rest/latest/iterations/101"
    },
    "test-plan" : {
      "href" : "http://localhost:8080/api/rest/latest/test-suites/9/test-plan"
    },
    "attachments" : {
      "href" : "http://localhost:8080/api/rest/latest/test-suites/9/attachments"
    }
  }
}

post Attach item to test suite

A POST to /test-suites/{testSuiteId}/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 user 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

Table 1. /api/rest/latest/test-suites/{testSuiteId}/test-plan/{ids}
Parameter Description

testSuiteId

the id of the test suite

ids

the id(s) of the test plan item

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 3321

{
  "_type" : "test-suite",
  "id" : 9,
  "name" : "sample test suite",
  "description" : "<p>this is a sample test suite</p>",
  "uuid" : "2f7198zd-eb2e-4379-f82d-ddc207c866bd",
  "status" : "SUCCESS",
  "parent" : {
    "_type" : "iteration",
    "id" : 101,
    "name" : "first iteration",
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/iterations/101"
      }
    }
  },
  "created_by" : "admin",
  "created_on" : "2017-07-12T10:00:00.000+00:00",
  "last_modified_by" : "admin",
  "last_modified_on" : "2017-07-12T10:00:00.000+00:00",
  "custom_fields" : [ ],
  "test_plan" : [ {
    "_type" : "iteration-test-plan-item",
    "id" : 80,
    "execution_status" : "READY",
    "referenced_test_case" : {
      "_type" : "test-case",
      "id" : 90,
      "name" : "first test case",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/test-cases/90"
        }
      }
    },
    "referenced_dataset" : {
      "_type" : "dataset",
      "id" : 5,
      "name" : "dataset",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/datasets/5"
        }
      }
    },
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/iteration-test-plan-items/80"
      }
    }
  }, {
    "_type" : "iteration-test-plan-item",
    "id" : 81,
    "execution_status" : "SUCCESS",
    "referenced_test_case" : {
      "_type" : "scripted-test-case",
      "id" : 91,
      "name" : "scripted test case",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/test-cases/91"
        }
      }
    },
    "referenced_dataset" : {
      "_type" : "dataset",
      "id" : 6,
      "name" : "dataset",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/datasets/6"
        }
      }
    },
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/iteration-test-plan-items/81"
      }
    }
  }, {
    "_type" : "iteration-test-plan-item",
    "id" : 82,
    "execution_status" : "SUCCESS",
    "referenced_test_case" : {
      "_type" : "keyword-test-case",
      "id" : 92,
      "name" : "keyword test case",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/test-cases/92"
        }
      }
    },
    "referenced_dataset" : {
      "_type" : "dataset",
      "id" : 7,
      "name" : "dataset",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/datasets/7"
        }
      }
    },
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/iteration-test-plan-items/82"
      }
    }
  } ],
  "attachments" : [ ],
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/rest/latest/test-suites/9"
    },
    "project" : {
      "href" : "http://localhost:8080/api/rest/latest/projects/15"
    },
    "iteration" : {
      "href" : "http://localhost:8080/api/rest/latest/iterations/101"
    },
    "test-plan" : {
      "href" : "http://localhost:8080/api/rest/latest/test-suites/9/test-plan"
    },
    "attachments" : {
      "href" : "http://localhost:8080/api/rest/latest/test-suites/9/attachments"
    }
  }
}

delete Detach item of test suite

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

Path parameters

Table 1. /api/rest/latest/test-suites/{testSuiteId}/test-plan/{ids}
Parameter Description

testSuiteId

the id of the test suite

ids

the id(s) of the test plan item

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 3504

{
  "_type" : "test-suite",
  "id" : 9,
  "name" : "sample test suite",
  "description" : "<p>modified description sample test suite</p>",
  "uuid" : "2f7198zd-eb2e-4379-f82d-ddc207c866bd",
  "status" : "SUCCESS",
  "parent" : {
    "_type" : "iteration",
    "id" : 101,
    "name" : "second iteration",
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/iterations/101"
      }
    }
  },
  "created_by" : "admin",
  "created_on" : "2017-07-12T10:00:00.000+00:00",
  "last_modified_by" : "admin",
  "last_modified_on" : "2017-07-12T10:00:00.000+00:00",
  "custom_fields" : [ {
    "code" : "CF_TXT",
    "label" : "cuf text",
    "value" : "the_new_value"
  }, {
    "code" : "CF_TAG",
    "label" : "cuf tag",
    "value" : [ "tag_1", "tag_2" ]
  } ],
  "test_plan" : [ {
    "_type" : "iteration-test-plan-item",
    "id" : 80,
    "execution_status" : "READY",
    "referenced_test_case" : {
      "_type" : "test-case",
      "id" : 90,
      "name" : "first test case",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/test-cases/90"
        }
      }
    },
    "referenced_dataset" : {
      "_type" : "dataset",
      "id" : 5,
      "name" : "dataset",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/datasets/5"
        }
      }
    },
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/iteration-test-plan-items/80"
      }
    }
  }, {
    "_type" : "iteration-test-plan-item",
    "id" : 81,
    "execution_status" : "READY",
    "referenced_test_case" : {
      "_type" : "scripted-test-case",
      "id" : 91,
      "name" : "scripted test case",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/test-cases/91"
        }
      }
    },
    "referenced_dataset" : {
      "_type" : "dataset",
      "id" : 6,
      "name" : "dataset",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/datasets/6"
        }
      }
    },
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/iteration-test-plan-items/81"
      }
    }
  }, {
    "_type" : "iteration-test-plan-item",
    "id" : 82,
    "execution_status" : "READY",
    "referenced_test_case" : {
      "_type" : "keyword-test-case",
      "id" : 92,
      "name" : "keyword test case",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/test-cases/92"
        }
      }
    },
    "referenced_dataset" : {
      "_type" : "dataset",
      "id" : 7,
      "name" : "dataset",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/datasets/7"
        }
      }
    },
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/iteration-test-plan-items/82"
      }
    }
  } ],
  "attachments" : [ ],
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/rest/latest/test-suites/9"
    },
    "project" : {
      "href" : "http://localhost:8080/api/rest/latest/projects/15"
    },
    "iteration" : {
      "href" : "http://localhost:8080/api/rest/latest/iterations/101"
    },
    "test-plan" : {
      "href" : "http://localhost:8080/api/rest/latest/test-suites/9/test-plan"
    },
    "attachments" : {
      "href" : "http://localhost:8080/api/rest/latest/test-suites/9/attachments"
    }
  }
}

delete Delete test suite

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

Path parameters

Table 1. /api/rest/latest//test-suites/{ids}
Parameter Description

ids

the list of ids of the test suites

HTTP request

DELETE /api/rest/latest/test-suites/169,189 HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: localhost:8080

get 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

GET /api/rest/latest/test-suites/44/test-plan HTTP/1.1
Accept: application/json
Host: localhost:8080

Request parameters

Parameter Description

page

number of the page to retrieve (optional)

size

size of the page to retrieve (optional)

fields

which fields of the elements should be returned (optional)

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 6809

{
  "_embedded" : {
    "test-plan" : [ {
      "_type" : "iteration-test-plan-item",
      "id" : 1,
      "execution_status" : "BLOCKED",
      "referenced_test_case" : {
        "_type" : "test-case",
        "id" : 1,
        "name" : "sample test case 1",
        "reference" : "",
        "_links" : {
          "self" : {
            "href" : "http://localhost:8080/api/rest/latest/test-cases/1"
          }
        }
      },
      "referenced_dataset" : {
        "_type" : "dataset",
        "id" : 1,
        "name" : "sample dataset 1",
        "_links" : {
          "self" : {
            "href" : "http://localhost:8080/api/rest/latest/datasets/1"
          }
        }
      },
      "last_executed_by" : "User-1",
      "last_executed_on" : "2017-07-13T10:00:00.000+00:00",
      "assigned_to" : "User-1",
      "executions" : [ {
        "_type" : "execution",
        "id" : 11,
        "execution_status" : "FAILURE",
        "last_executed_by" : "User-1",
        "last_executed_on" : "2017-07-13T10:00:00.000+00:00",
        "_links" : {
          "self" : {
            "href" : "http://localhost:8080/api/rest/latest/executions/11"
          }
        }
      }, {
        "_type" : "execution",
        "id" : 21,
        "execution_status" : "BLOCKED",
        "last_executed_by" : "User-1",
        "last_executed_on" : "2017-07-13T10:00:00.000+00:00",
        "_links" : {
          "self" : {
            "href" : "http://localhost:8080/api/rest/latest/executions/21"
          }
        }
      } ],
      "iteration" : {
        "_type" : "iteration",
        "id" : 1,
        "name" : "sample iteration 1",
        "reference" : "IT1",
        "_links" : {
          "self" : {
            "href" : "http://localhost:8080/api/rest/latest/iterations/1"
          }
        }
      },
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/iteration-test-plan-items/1"
        }
      }
    }, {
      "_type" : "iteration-test-plan-item",
      "id" : 2,
      "execution_status" : "SUCCESS",
      "referenced_test_case" : {
        "_type" : "scripted-test-case",
        "id" : 2,
        "name" : "sample test case 2",
        "reference" : "",
        "_links" : {
          "self" : {
            "href" : "http://localhost:8080/api/rest/latest/test-cases/2"
          }
        }
      },
      "referenced_dataset" : {
        "_type" : "dataset",
        "id" : 2,
        "name" : "sample dataset 2",
        "_links" : {
          "self" : {
            "href" : "http://localhost:8080/api/rest/latest/datasets/2"
          }
        }
      },
      "last_executed_by" : "User-2",
      "last_executed_on" : "2017-07-15T10:00:00.000+00:00",
      "assigned_to" : "User-2",
      "executions" : [ {
        "_type" : "scripted-execution",
        "id" : 12,
        "execution_status" : "SUCCESS",
        "last_executed_by" : "User-2",
        "last_executed_on" : "2017-07-07T10:00:00.000+00:00",
        "_links" : {
          "self" : {
            "href" : "http://localhost:8080/api/rest/latest/executions/12"
          }
        }
      }, {
        "_type" : "scripted-execution",
        "id" : 22,
        "execution_status" : "BLOCKED",
        "last_executed_by" : "User-2",
        "last_executed_on" : "2017-07-15T10:00:00.000+00:00",
        "_links" : {
          "self" : {
            "href" : "http://localhost:8080/api/rest/latest/executions/22"
          }
        }
      }, {
        "_type" : "scripted-execution",
        "id" : 32,
        "execution_status" : "RUNNING",
        "last_executed_by" : "User-2",
        "last_executed_on" : "2017-07-20T10:00:00.000+00:00",
        "_links" : {
          "self" : {
            "href" : "http://localhost:8080/api/rest/latest/executions/32"
          }
        }
      } ],
      "iteration" : {
        "_type" : "iteration",
        "id" : 2,
        "name" : "sample iteration 2",
        "reference" : "IT2",
        "_links" : {
          "self" : {
            "href" : "http://localhost:8080/api/rest/latest/iterations/2"
          }
        }
      },
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/iteration-test-plan-items/2"
        }
      }
    }, {
      "_type" : "iteration-test-plan-item",
      "id" : 3,
      "execution_status" : "SUCCESS",
      "referenced_test_case" : {
        "_type" : "keyword-test-case",
        "id" : 3,
        "name" : "sample test case 3",
        "reference" : "",
        "_links" : {
          "self" : {
            "href" : "http://localhost:8080/api/rest/latest/test-cases/3"
          }
        }
      },
      "referenced_dataset" : {
        "_type" : "dataset",
        "id" : 3,
        "name" : "sample dataset 3",
        "_links" : {
          "self" : {
            "href" : "http://localhost:8080/api/rest/latest/datasets/3"
          }
        }
      },
      "last_executed_by" : "User-3",
      "last_executed_on" : "2020-04-15T10:00:00.000+00:00",
      "assigned_to" : "User-3",
      "executions" : [ {
        "_type" : "keyword-execution",
        "id" : 13,
        "execution_status" : "SUCCESS",
        "last_executed_by" : "User-3",
        "last_executed_on" : "2020-04-15T10:00:00.000+00:00",
        "_links" : {
          "self" : {
            "href" : "http://localhost:8080/api/rest/latest/executions/13"
          }
        }
      }, {
        "_type" : "keyword-execution",
        "id" : 23,
        "execution_status" : "BLOCKED",
        "last_executed_by" : "User-3",
        "last_executed_on" : "2020-04-15T10:00:00.000+00:00",
        "_links" : {
          "self" : {
            "href" : "http://localhost:8080/api/rest/latest/executions/23"
          }
        }
      }, {
        "_type" : "keyword-execution",
        "id" : 33,
        "execution_status" : "RUNNING",
        "last_executed_by" : "User-3",
        "last_executed_on" : "2020-04-15T10:00:00.000+00:00",
        "_links" : {
          "self" : {
            "href" : "http://localhost:8080/api/rest/latest/executions/33"
          }
        }
      } ],
      "iteration" : {
        "_type" : "iteration",
        "id" : 2,
        "name" : "sample iteration 2",
        "reference" : "IT2",
        "_links" : {
          "self" : {
            "href" : "http://localhost:8080/api/rest/latest/iterations/2"
          }
        }
      },
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/iteration-test-plan-items/3"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/rest/latest/test-suites/44/test-plan?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 3,
    "totalPages" : 1,
    "number" : 0
  }
}

get Get issues of test suite

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

Path parameters

Table 1. /api/rest/latest/test-suites/{id}/issues
Parameter Description

id

the id of the test suite

HTTP request

GET /api/rest/latest/test-suites/1/issues?page=0&size=20 HTTP/1.1
Accept: application/json
Host: localhost:8080

Request parameters

Parameter Description

page

number of the page to retrieve (optional)

size

size of the page to retrieve (optional)

fields

which fields of the elements should be returned (optional)

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 602

{
  "_embedded" : {
    "issues" : [ {
      "remoteIssueId" : "165",
      "url" : "http://192.175.1.51/bugzilla/show_bug.cgi?id=165",
      "executions" : [ {
        "_type" : "execution",
        "id" : 2,
        "_links" : {
          "self" : {
            "href" : "http://localhost:8080/api/rest/latest/executions/2"
          }
        }
      } ]
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/rest/latest/test-suites/1/issues?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Response fields

Path Type Description

_embedded.issues

Array

the issues of this test suite

_embedded.issues[].remoteIssueId

String

the remote issue id of the issue linked to the entity.

_embedded.issues[].url

String

the url of the issue linked to the entity.

_embedded.issues[].executions

Array

the executions linked to the entity.

page.size

Number

the page size for that query

page.totalElements

Number

total number of elements the user is allowed to read

page.totalPages

Number

how many pages can be browsed

page.number

Number

the page number

_links

Object

related links

Relation Description

first

link to the first page (optional)

prev

link to the previous page (optional)

self

link to this page

next

link to the next page (optional)

last

link to the last page (optional)