Help Contents

 

Resource: Automated Test Schedule Import Configuration ( /api/automatedtestschedule/{scheduleId}/importconfiguration/{configId} )

Automated Test Schedule Import Configuration resource

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

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

StatusDescription
200 - OKReturned if request completed successfully.
403 - ForbiddenReturned if you do not have permission to remove the configuration from the automated test schedule.
404 - NotFoundReturned if schedule or configuration does not exist.

Example - DELETE

Remove an import configuration from an automated test schedule (Duette Schedule)

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
{scheduleId}B7C458E9-D207-4998-BAD0-3AFF0E6FA365Unique identifier of the schedule the import configuration belongs to.
{configId}62FF8D7C-9256-4C6B-B889-3600F675F5A7Unique identifier of the import configuration.

Response Headers

KeyValueDescription
Content-Typeapplication/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).

StatusDescription
200 - OKReturned if request completed successfully.
403 - ForbiddenReturned if you do not have permission to view the automated test schedule configuration.
404 - NotFoundReturned if schedule or configuration does not exist.

Example - GET

Retrieve a single import configuration associated with automated test schedule (Duette Schedule)

Request Headers

KeyValueDescription
Content-typeapplication/json
Acceptapplication/json

Request Parameters

KeyValueDescription
{scheduleId}B7C458E9-D207-4998-BAD0-3AFF0E6FA365Unique identifier of the schedule the import configuration belongs to.
{configId}62FF8D7C-9256-4C6B-B889-3600F675F5A7Unique identifier of the import configuration.

Response Headers

KeyValueDescription
Content-Typeapplication/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,
  "Expands": [
    "FieldValues",
    "Widgets",
    "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

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

StatusDescription
200 - OKReturned if request completed successfully.
403 - ForbiddenReturned if you do not have permission to patch the automated test schedule the configuration belongs to.
404 - NotFoundReturned if schedule or configuration does not exist.

Example - PATCH

Disable an enabled import configuration

Request Headers

KeyValueDescription
Content-typeapplication/json
Acceptapplication/json

Request Parameters

KeyValueDescription
{scheduleId}B7C458E9-D207-4998-BAD0-3AFF0E6FA365Unique identifier of the schedule the import configuration belongs to.
{configId}62FF8D7C-9256-4C6B-B889-3600F675F5A7Unique identifier of the import configuration.

Request Body

{
  "Enabled": false
}

Response Headers

KeyValueDescription
Content-Typeapplication/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,
  "Expands": [
    "FieldValues",
    "Widgets",
    "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

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

StatusDescription
200 - OKReturned if request completed successfully.
403 - ForbiddenReturned if you do not have permission to update the automated test schedule the configuration belongs to.
404 - NotFoundReturned if schedule or configuration does not exist.

Example - PUT (using FieldValues)

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

KeyValueDescription
Content-typeapplication/json
Acceptapplication/json

Request Parameters

KeyValueDescription
{scheduleId}B7C458E9-D207-4998-BAD0-3AFF0E6FA365Unique identifier of the schedule the import configuration belongs to.
{configId}62FF8D7C-9256-4C6B-B889-3600F675F5A7Unique identifier of the import configuration.
$expandFieldValuesinclude FieldValues object in response

Request Body

{
  "ScheduleId": "b7c458e9-d207-4998-bad0-3aff0e6fa365",
  "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,
  "FieldValues": {
    "DefaultPath": "c:\\testdata\\",
    "Type": "NUnit"
  },
  "SkipIfFilesUnchanged": true
}

Response Headers

KeyValueDescription
Content-Typeapplication/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,
  "Expands": [
    "Widgets",
    "ExecutionPackagePath",
    "ScriptPackagePath"
  ],
  "FieldValues": {
    "Type": "NUnit",
    "DefaultPath": null,
    "XsltFile": 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

Example - PUT (using in-line SubType)

Update (replace) the import configuration - this demonstrates supplying SubType in-line.

Request Headers

KeyValueDescription
Content-typeapplication/json
Acceptapplication/json

Request Parameters

KeyValueDescription
{scheduleId}B7C458E9-D207-4998-BAD0-3AFF0E6FA365Unique identifier of the schedule the import configuration belongs to.
{configId}62FF8D7C-9256-4C6B-B889-3600F675F5A7Unique identifier of the import configuration.

Request Body

{
  "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

KeyValueDescription
Content-Typeapplication/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,
  "Expands": [
    "FieldValues",
    "Widgets",
    "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