Help Contents

 

Automated Test Schedules

Resource: Automated Test Schedules ( /api/automatedtestschedules )

Automated Test Schedules (collection) resource

Root Relation: AutomatedTestSchedules

This resource supports the following methods: GET, POST

Methods

GET


Retrieves the list of automated test schedules.

Status Codes

These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).

StatusDescription
200 - OKReturned if request completed successfully.

Example - GET (for all projects)

Retrieves a list of automated test schedules in application (all projects)

Request Headers

KeyValueDescription
Acceptapplication/json

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

{
  "Total": 1,
  "Items": [
    {
      "Id": "b7c458e9-d207-4998-bad0-3aff0e6fa365",
      "Name": "Unit Tests",
      "ProjectId": "42b9a01e-8a84-462c-adb9-3f96d3d7de52",
      "ProjectName": "Project XYZ",
      "Self": "http://localhost/api/automatedtestschedule/b7c458e9-d207-4998-bad0-3aff0e6fa365",
      "Links": [
        {
          "Href": "http://localhost/api/automatedtestschedule/b7c458e9-d207-4998-bad0-3aff0e6fa365/configurations",
          "Rel": "ScheduleConfigurations"
        }
      ]
    },
    {
      "Id": "b7c458e9-d207-4998-bad0-3aff0e6fa365",
      "Name": "Import Selenium Tests",
      "ProjectId": "9e1fe662-c6c0-4dd6-8198-e630e4951f6d",
      "ProjectName": "Project ABC",
      "Self": "http://localhost/api/automatedtestschedule/b7c458e9-d207-4998-bad0-3aff0e6fa365",
      "Links": [
        {
          "Href": "http://localhost/api/automatedtestschedule/b7c458e9-d207-4998-bad0-3aff0e6fa365/configurations",
          "Rel": "ScheduleConfigurations"
        }
      ]
    }
  ],
  "Self": "http://localhost/api/api/automatedtestschedules"
}

Status Code

200 - OK

Example - GET (for project)

An example of retrieving a list of automated test schedules associated with a project.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
projectId42B9A01E-8A84-462C-ADB9-3F96D3D7DE52The ID of the project associated with the list of automated test schedules.

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

{
  "Total": 1,
  "Items": [
    {
      "Id": "b7c458e9-d207-4998-bad0-3aff0e6fa365",
      "Name": "Unit Tests",
      "ProjectId": "42b9a01e-8a84-462c-adb9-3f96d3d7de52",
      "ProjectName": "Project XYZ",
      "Self": "http://localhost/api/automatedtestschedule/b7c458e9-d207-4998-bad0-3aff0e6fa365",
      "Links": [
        {
          "Href": "http://localhost/api/automatedtestschedule/b7c458e9-d207-4998-bad0-3aff0e6fa365/configurations",
          "Rel": "ScheduleConfigurations"
        }
      ]
    }
  ],
  "Self": "http://localhost/api/api/automatedtestschedules?projectId=42B9A01E-8A84-462C-ADB9-3F96D3D7DE52"
}

Status Code

200 - OK

POST


Creates a new automated test schedule.

Status Codes

These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).

StatusDescription
201 - CreatedReturned if request completed successfully.
403 - ForbiddenIf you do not have permission to create a schedule for the select project, or project was invalid.

Example - POST

An example of creating a new test schedule. Note: After creating the schedule you must populate the import and import schedule configurations before the schedule will be usable.

Request Headers

KeyValueDescription
Content-typeapplication/json
Acceptapplication/json

Request Body

{
  "Name": "Unit Tests",
  "ProjectId": "42b9a01e-8a84-462c-adb9-3f96d3d7de52"
}

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

{
  "Id": "b7c458e9-d207-4998-bad0-3aff0e6fa365",
  "Name": "Unit Tests",
  "ProjectId": "42b9a01e-8a84-462c-adb9-3f96d3d7de52",
  "ProjectName": "Project XYZ",
  "Self": "http://localhost/api/automatedtestschedule/b7c458e9-d207-4998-bad0-3aff0e6fa365",
  "Links": [
    {
      "Href": "http://localhost/api/automatedtestschedule/b7c458e9-d207-4998-bad0-3aff0e6fa365/configurations",
      "Rel": "ScheduleConfigurations"
    }
  ]
}

Status Code

201 - Created