Help Contents

 

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

This is a collection resource for schedules associated with an automated tests schedule configuration set (Duette schedule).

This resource supports the following methods: GET, POST

Methods

GET


Retrieves information about an automated test schedule set's schedules.

This method supports the OData parameters $filter, $top, $take, $orderby and $inlinecount. See OData Topic for more details.

Required Permissions

  • Resources/ExternalLinks

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 the request was completed successfully.
403 - ForbiddenReturned if you do not have permission to view this resource.

Example - Get All Schedules for an Automated Test (Duette) schedule set

An Example of retrieving all schedules.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
{id}B7C458E9-D207-4998-BAD0-3AFF0E6FA365The ID of the automated test schedule set (Duette Schedule) to retrieve schedules for.

Response Headers

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

Response Body

{
  "Items": [
    {
      "Configuration": {
        "PeriodInMinutes": 15,
        "Type": "Periodic"
      },
      "ScheduleId": "b7c458e9-d207-4998-bad0-3aff0e6fa365",
      "Id": "bbd69b4e-4cfe-435d-8a5d-634a3cc11732",
      "Description": "Periodic (repeating every 15 minutes)",
      "Enabled": true,
      "IsRunning": false,
      "StatusMessage": "Import Completed (Started At: 5/10/2012 12:36:52 p.m., Duration: 00:00:00.0810046)",
      "LastRun": "2012-10-04T23:36:00Z",
      "NextRun": "2012-10-04T23:51:00Z",
      "Self": "http://localhost/api/automatedtestschedule/b7c458e9-d207-4998-bad0-3aff0e6fa365/schedules/bbd69b4e-4cfe-435d-8a5d-634a3cc11732"
    },
    {
      "Configuration": {
        "Type": "AdHoc"
      },
      "ScheduleId": "b7c458e9-d207-4998-bad0-3aff0e6fa365",
      "Id": "437246d4-c1ec-4da2-a4a7-2371847a1be1",
      "Description": "Ad-hoc",
      "Enabled": true,
      "IsRunning": false,
      "StatusMessage": "Idle",
      "LastRun": null,
      "NextRun": null,
      "Self": "http://localhost/api/automatedtestschedule/b7c458e9-d207-4998-bad0-3aff0e6fa365/schedules/437246d4-c1ec-4da2-a4a7-2371847a1be1"
    }
  ],
  "Self": "http://localhost/api/api/automatedtestschedule/91C059B3-F0D8-4507-9D02-B80AA3DF50F2/schedules"
}

Status Code

200 - OK

POST


Creates a new schedule for importing results.

Required Permissions

  • Resources/ExternalLinks

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 the new schedule was created successfully.
403 - ForbiddenReturned if the user does not have permission to add a new schedule.

Example - Create a new Schedule

An Example of creating a new schedule for the automated test schedule set (Duette Schedule).

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
{id}B7C458E9-D207-4998-BAD0-3AFF0E6FA365The ID of the automated test schedule set (Duette Schedule) to add a schedule to.

Request Body

{
  "Configuration": {
    "Type": "AdHoc"
  },
  "Enabled": true
}

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8
Locationhttp://localhost/api/synchronizer/91C059B3-F0D8-4507-9D02-B80AA3DF50F2/schedule/BBD69B4E-4CFE-435D-8A5D-634A3CC11732

Response Body

{
  "Configuration": {
    "Type": "AdHoc"
  },
  "ScheduleId": "b7c458e9-d207-4998-bad0-3aff0e6fa365",
  "Id": "437246d4-c1ec-4da2-a4a7-2371847a1be1",
  "Description": "Ad-hoc",
  "Enabled": true,
  "IsRunning": false,
  "StatusMessage": "Idle",
  "LastRun": null,
  "NextRun": null,
  "Self": "http://localhost/api/automatedtestschedule/b7c458e9-d207-4998-bad0-3aff0e6fa365/schedules/437246d4-c1ec-4da2-a4a7-2371847a1be1"
}

Status Code

201 - Created