API - Test run sections

List

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

Endpoint: <base_url>/v1/projects/{project_id}/runs/{run_id}/run_sections.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_sections": [
    {
....
},
{
....
}
]
}

Example ruby request

HTTParty.get('https://example.api.testlodge.com/v1/projects/1/runs/1/run_sections.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_sections":[{
    "id":1,
    "title":"run section 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 section.

Endpoint: <base_url>/v1/projects/{project_id}/runs/{run_id}/run_sections/{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 section ID (Required)

Response

{ 
....
}

Example ruby request

HTTParty.get('https://example.api.testlodge.com/v1/projects/1/runs/1/run_sections/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"
}

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

0 comments

Article is closed for comments.