Resource: Automated Test Schedule Import Configuration ( /api/automatedtestschedule/{scheduleId}/importconfiguration/{configId} )
Automated Test Schedule Import Configuration resource
Methods
DELETE
Removes a configuration from an 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 remove the configuration from the automated test schedule. |
| 404 - NotFound | Returned if schedule or configuration does not exist. |
Remove an import configuration from an automated test schedule (Duette Schedule)
Request Headers
| Key | Value | Description |
|---|---|---|
| Accept | application/json |
Request Parameters
| Key | Value | Description |
|---|---|---|
| {scheduleId} | B7C458E9-D207-4998-BAD0-3AFF0E6FA365 | Unique identifier of the schedule the import configuration belongs to. |
| {configId} | 62FF8D7C-9256-4C6B-B889-3600F675F5A7 | Unique identifier of the import configuration. |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Status Code
200 - OK
GET
Retrieves a configuration for an 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 view the automated test schedule configuration. |
| 404 - NotFound | Returned if schedule or configuration does not exist. |
Retrieve a single import configuration associated with automated test schedule (Duette Schedule)
Request Headers
| Key | Value | Description |
|---|---|---|
| Content-type | application/json | |
| Accept | application/json |
Request Parameters
| Key | Value | Description |
|---|---|---|
| {scheduleId} | B7C458E9-D207-4998-BAD0-3AFF0E6FA365 | Unique identifier of the schedule the import configuration belongs to. |
| {configId} | 62FF8D7C-9256-4C6B-B889-3600F675F5A7 | Unique identifier of the import configuration. |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
{
"ScheduleId": "b7c458e9-d207-4998-bad0-3aff0e6fa365",
"Id": "62ff8d7c-9256-4c6b-b889-3600f675f5a7",
"Name": "All NUnit Results",
"Type": "UnitTest",
"SubType": "NUnit",
"SourcePath": "C:\\testdata\\{name}.xml",
"NameTemplate": "{name}",
"CombineResults": false,
"ScriptPackageId": "05ec0839-3c87-41ce-9940-fd142563c28f",
"ExecutionPackageId": "6ee31f73-b36a-4288-9ce9-23281054e365",
"MaximumNumberOfResultsRetained": 10,
"SkipIfFilesUnchanged": true,
"Description": "DefaultPath: N/A, XSLT File: N/A",
"Enabled": true,
"Self": "http://localhost/api/automatedtestschedule/b7c458e9-d207-4998-bad0-3aff0e6fa365/importconfiguration/62ff8d7c-9256-4c6b-b889-3600f675f5a7",
"Links": [
{
"Href": "http://localhost/api/automatedtestschedule/b7c458e9-d207-4998-bad0-3aff0e6fa365",
"Rel": "Schedule"
}
]
}
Status Code
200 - OK
PATCH
Patches a configuration in an automated test schedule (currently only allows changing the 'Enabled' property).
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 patch the automated test schedule the configuration belongs to. |
| 404 - NotFound | Returned if schedule or configuration does not exist. |
Disable an enabled import configuration
Request Headers
| Key | Value | Description |
|---|---|---|
| Content-type | application/json | |
| Accept | application/json |
Request Parameters
| Key | Value | Description |
|---|---|---|
| {scheduleId} | B7C458E9-D207-4998-BAD0-3AFF0E6FA365 | Unique identifier of the schedule the import configuration belongs to. |
| {configId} | 62FF8D7C-9256-4C6B-B889-3600F675F5A7 | Unique identifier of the import configuration. |
Request Body
{
"Enabled": false
}
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
{
"ScheduleId": "b7c458e9-d207-4998-bad0-3aff0e6fa365",
"Id": "62ff8d7c-9256-4c6b-b889-3600f675f5a7",
"Name": "All NUnit Results",
"Type": "UnitTest",
"SubType": "NUnit",
"SourcePath": "C:\\testdata\\{name}.xml",
"NameTemplate": "{name}",
"CombineResults": false,
"ScriptPackageId": "05ec0839-3c87-41ce-9940-fd142563c28f",
"ExecutionPackageId": "6ee31f73-b36a-4288-9ce9-23281054e365",
"MaximumNumberOfResultsRetained": 10,
"SkipIfFilesUnchanged": true,
"Description": "DefaultPath: N/A, XSLT File: N/A",
"Enabled": false,
"Self": "http://localhost/api/automatedtestschedule/b7c458e9-d207-4998-bad0-3aff0e6fa365/importconfiguration/62ff8d7c-9256-4c6b-b889-3600f675f5a7",
"Links": [
{
"Href": "http://localhost/api/automatedtestschedule/b7c458e9-d207-4998-bad0-3aff0e6fa365",
"Rel": "Schedule"
}
]
}
Status Code
200 - OK
PUT
Updates a configuration in an 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 update the automated test schedule the configuration belongs to. |
| 404 - NotFound | Returned if schedule or configuration does not exist. |
Update (replace) the import configuration
Request Headers
| Key | Value | Description |
|---|---|---|
| Content-type | application/json | |
| Accept | application/json |
Request Parameters
| Key | Value | Description |
|---|---|---|
| {scheduleId} | B7C458E9-D207-4998-BAD0-3AFF0E6FA365 | Unique identifier of the schedule the import configuration belongs to. |
| {configId} | 62FF8D7C-9256-4C6B-B889-3600F675F5A7 | Unique identifier of the import configuration. |
Request Body
{
"ScheduleId": "b7c458e9-d207-4998-bad0-3aff0e6fa365",
"Id": null,
"Name": "All NUnit Results",
"Type": "UnitTest",
"SourcePath": "C:\\testdata\\{name}.xml",
"NameTemplate": "{name}",
"CombineResults": false,
"ScriptPackageId": "05ec0839-3c87-41ce-9940-fd142563c28f",
"ExecutionPackageId": "6ee31f73-b36a-4288-9ce9-23281054e365",
"MaximumNumberOfResultsRetained": 10,
"FieldControlValues": null,
"FieldValues": null,
"SkipIfFilesUnchanged": true
}
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
{
"ScheduleId": "b7c458e9-d207-4998-bad0-3aff0e6fa365",
"Id": "62ff8d7c-9256-4c6b-b889-3600f675f5a7",
"Name": "All NUnit Results",
"Type": "UnitTest",
"SubType": "NUnit",
"SourcePath": "C:\\testdata\\{name}.xml",
"NameTemplate": "{name}",
"CombineResults": false,
"ScriptPackageId": "05ec0839-3c87-41ce-9940-fd142563c28f",
"ExecutionPackageId": "6ee31f73-b36a-4288-9ce9-23281054e365",
"MaximumNumberOfResultsRetained": 10,
"SkipIfFilesUnchanged": true,
"Description": "DefaultPath: N/A, XSLT File: N/A",
"Enabled": true,
"Self": "http://localhost/api/automatedtestschedule/b7c458e9-d207-4998-bad0-3aff0e6fa365/importconfiguration/62ff8d7c-9256-4c6b-b889-3600f675f5a7",
"Links": [
{
"Href": "http://localhost/api/automatedtestschedule/b7c458e9-d207-4998-bad0-3aff0e6fa365",
"Rel": "Schedule"
}
]
}
Status Code
200 - OK