Resource: Automated Test Schedule ( /api/automatedtestschedule/{id} )

Automated Test Schedule resource

This resource supports the following methods: DELETE, GET, PUT

Methods

DELETE

Deletes an existing 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).

Status	Description
200 - OK	Returned if request completed successfully.
403 - Forbidden	Returned if you do not have permission to delete the schedule.
404 - NotFound	Returned if the automated test schedule does not exist.

Example - DELETE

Delete a schedule (including all it's schedule and import configurations)

Request Headers

Key	Value	Description
Accept	application/json

Request Parameters

Key	Value	Description
{id}	B7C458E9-D207-4998-BAD0-3AFF0E6FA365	ID of the schedule to delete

Response Headers

Key	Value	Description
Content-Type	application/json; charset=utf-8

Status Code

200 - OK

GET

Retrieves an automated test schedule by its unique identifier.

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).

Status	Description
200 - OK	Returned if request completed successfully.
404 - NotFound	Returned if the automated test schedule does not exist.

Example - GET

Get details for a schedule

Request Headers

Key	Value	Description
Content-type	application/json
Accept	application/json

Request Parameters

Key	Value	Description
{id}	B7C458E9-D207-4998-BAD0-3AFF0E6FA365	ID of the schedule to retrieve

Response Headers

Key	Value	Description
Content-Type	application/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

200 - OK

PUT

Updates an existing 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).

Status	Description
200 - OK	Returned if request completed successfully.
403 - Forbidden	Returned if the automated test schedule configuration was invalid.
404 - NotFound	Returned if the automated test schedule does not exist.

Example - PUT

Rename the schedule

Request Headers

Key	Value	Description
Content-type	application/json
Accept	application/json

Request Parameters

Key	Value	Description
{id}	B7C458E9-D207-4998-BAD0-3AFF0E6FA365	ID of the schedule to update

Request Body

{
  "Name": "Unit Tests"
}

Response Headers

Key	Value	Description
Content-Type	application/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

200 - OK