Resource: Automated Test Schedule Schedule Configuration ( /api/automatedtestschedule/{scheduleId}/schedule/{scheduleConfigId} )
Represents a single schedule associated with a synchronization configuration
This resource supports the following methods: DELETE, GET, PATCH, PUT
Methods
DELETE
Deletes a schedule.
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).
| Status | Description |
|---|---|
| 200 - OK | Returned if the request was completed successfully. |
| 403 - Forbidden | Returned if you do not have permission to delete this resource. |
Example of deleting a schedule.
Request Headers
| Key | Value | Description |
|---|---|---|
| Accept | application/json |
Request Parameters
| Key | Value | Description |
|---|---|---|
| {scheduleId} | B7C458E9-D207-4998-BAD0-3AFF0E6FA365 | The ID of the automated test schedule set (Duette Schedule). |
| {scheduleConfigId} | BBD69B4E-4CFE-435D-8A5D-634A3CC11732 | The ID of the schedule configuration to remove. |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Status Code
200 - OK
GET
Retrieves information about a schedule.
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).
| Status | Description |
|---|---|
| 200 - OK | Returned if the request was completed successfully. |
| 403 - Forbidden | Returned if you do not have permission to view this resource. |
Example of retrieving a schedule.
Request Headers
| Key | Value | Description |
|---|---|---|
| Accept | application/json |
Request Parameters
| Key | Value | Description |
|---|---|---|
| {scheduleId} | B7C458E9-D207-4998-BAD0-3AFF0E6FA365 | The ID of the automated test schedule set (Duette Schedule). |
| {scheduleConfigId} | BBD69B4E-4CFE-435D-8A5D-634A3CC11732 | The ID of the schedule configuration. |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
| Code Block | ||
|---|---|---|
| ||
{
"Configuration": {
"PeriodInMinutes": 15,
"Type": "Periodic"
},
"ScheduleId": "b7c458e9-d207-4998-bad0-3aff0e6fa365",
"Id": "bbd69b4e-4cfe-435d-8a5d-634a3cc11732",
"Description": "Periodic (repeating every 15 minutes); Synchronizing from External System; Synchronize Updates",
"Enabled": true,
"IsRunning": false,
"StatusMessage": "Synchronization 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"
}
|
Status Code
200 - OK
PATCH
Patches an existing schedule (the Enabled status property only).
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).
| Status | Description |
|---|---|
| 200 - OK | Returned if the request was completed successfully. |
| 403 - Forbidden | Returned if you do not have permission to update this resource. |
Example of using PATCH to disable the schedule. Note: Currently PATCH only supports changing the 'Enabled' status
Request Headers
| Key | Value | Description |
|---|---|---|
| Accept | application/json |
Request Parameters
| Key | Value | Description |
|---|---|---|
| {scheduleId} | B7C458E9-D207-4998-BAD0-3AFF0E6FA365 | The ID of the automated test schedule set (Duette Schedule). |
| {scheduleConfigId} | BBD69B4E-4CFE-435D-8A5D-634A3CC11732 | The ID of the schedule configuration. |
Request Body
| Code Block | ||
|---|---|---|
| ||
{ "Enabled": false }
|
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
| Code Block | ||
|---|---|---|
| ||
{
"Configuration": {
"PeriodInMinutes": 15,
"Type": "Periodic"
},
"ScheduleId": "b7c458e9-d207-4998-bad0-3aff0e6fa365",
"Id": "bbd69b4e-4cfe-435d-8a5d-634a3cc11732",
"Description": "Periodic (repeating every 15 minutes)",
"Enabled": false,
"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"
}
|
Status Code
200 - OK
PUT
Update an existing schedule.
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).
| Status | Description |
|---|---|
| 200 - OK | Returned if the request was completed successfully. |
| 403 - Forbidden | Returned if you do not have permission to update this resource. |
An example of updating the schedule configuration.
Request Headers
| Key | Value | Description |
|---|---|---|
| Accept | application/json |
Request Parameters
| Key | Value | Description |
|---|---|---|
| {scheduleId} | B7C458E9-D207-4998-BAD0-3AFF0E6FA365 | The ID of the automated test schedule set (Duette Schedule). |
| {scheduleConfigId} | BBD69B4E-4CFE-435D-8A5D-634A3CC11732 | The ID of the schedule configuration. |
Request Body
| Code Block | ||
|---|---|---|
| ||
{
"Configuration": {
"PeriodInMinutes": 15,
"Type": "Periodic"
},
"Enabled": true
}
|
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
| Code Block | ||
|---|---|---|
| ||
{
"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"
}
|
Status Code
200 - OK