...
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
Code Block | ||
---|---|---|
| ||
{
"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,
"Expands": [
"FieldValues",
"FieldControls",
"ExecutionPackagePath",
"ScriptPackagePath"
],
"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
...
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
Code Block | ||
---|---|---|
| ||
{ "Enabled": false } |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 |
Response Body
Code Block | ||
---|---|---|
| ||
{ "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, "Expands": [ "FieldValues", "FieldControls", "ExecutionPackagePath", "ScriptPackagePath" ], "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
...
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 - this demonstrates passing in a full FieldValues object where you can specify additional options such as SubType, Default path etc.
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. |
$expand | FieldValues | include FieldValues object in response |
Request Body
Code Block | ||
---|---|---|
| ||
{ "ScheduleId": "b7c458e9-d207-4998-bad0-3aff0e6fa365", "Name"Id": null: "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, "FieldValues": { "DefaultPath": "c:\\testdata\\", "Type": "NUnit" }, "SkipIfFilesUnchanged": true } |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 |
Response Body
Code Block | ||
---|---|---|
| ||
{ "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, "Expands": [ "FieldControls", "ExecutionPackagePath", "ScriptPackagePath" ], "FieldValues": { "Type": "NUnit", "FieldControlValuesDefaultPath": null, "FieldValuesXsltFile": null }, "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
Update (replace) the import configuration - this demonstrates supplying SubType in-line.
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
Code Block | ||
---|---|---|
| ||
{
"ScheduleId": "b7c458e9-d207-4998-bad0-3aff0e6fa365",
"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
}
|
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 |
Response Body
Code Block | ||
---|---|---|
| ||
{
"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,
"Expands": [
"FieldValues",
"FieldControls",
"ExecutionPackagePath",
"ScriptPackagePath"
],
"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
...