API - Test run suites

List

Description: Provides a paginated list of all test run suites within a given test run

Endpoint: <base_url>/projects/{project_id}/runs/{run_id}/run_suites.json

Request: GET

Formats supported: JSON

Params:

• project_id - {Integer} The associated project ID (Required)
• run_id - {Integer} The associated run ID (Required)
• page - {Integer} of the page (Default: 1)

Response

{
  "pagination": { .... },
  "run_suites": [
    { 
      ....
    },
    {
      ....
    }
  ]
}

Example ruby request

HTTParty.get('https://api.testlodge.com/v1/account/1/projects/1/runs/1/run_suites.json')

Example Response

Response code: 200

{
  "pagination": { 
    "total_entries":2,
    "total_pages":1,
    "current_page":1,
    "next_page":null,
    "previous_page":null,
    "per_page":20 
  },
  "run_suites":[{
    "id":1,
    "title":"run suite title",
    "selected_configuration":"OSX, Safari",
    "incomplete_number":10,
    "passed_number":9,
    "skipped_number":0,
    "failed_number":1,
    "run_id":1,
    "user_id":2,
    "created_at":"2014-02-26T14:33:58Z",
    "updated_at":"2014-02-26T14:33:58Z"
  },
  { .... }]
}

Show

Description: Get the details for a test run suite.

Endpoint: <base_url>/projects/{project_id}/runs/{run_id}/run_suites/{id}.json

Request: GET

Formats supported: JSON

Params:

• project_id - {Integer} The associated project ID (Required)
• run_id - {Integer} The associated run ID (Required)
• id - {Integer} The test run suite ID (Required)

Response

{ 
   ....
}

Example ruby request

HTTParty.get('https://api.testlodge.com/v1/account/1/projects/1/runs/1/run_suites/1.json)

Example Response

Response code: 200

{
    "id":1,
    "title":"Test suite name",
    "selected_configuration":"OSX, Safari",
    "incomplete_number":10,
    "passed_number":9,
    "skipped_number":0,
    "failed_number":1,
    "run_id":1,
    "user_id":2,
    "created_at":"2014-02-26T14:33:58Z",
    "updated_at":"2014-02-26T14:33:58Z"
}