Help Contents
-
System Administration
-
User Guide & Application Administration Guide
-
Using Enterprise Tester
-
Application Administration
-
Searching & TQL
-
API
-
API / Permissions
-
Features
-
Resources
-
Agile Run
-
Agile Run All Relationships
-
Agile Run Relationships
-
Agile Runs
-
Agile Run Step Attachments
-
Agile Run Step Incident
-
Agile Run Step Incidents
-
Agile Run Step Result Attachment
-
API / Resources / Resources / Search #1
-
API / Resources / Resources / Search #2
-
Assigned To Search
-
Attachment Contents
-
Automated Test
-
Automated Test All Relationships
-
Automated Test Assignment
-
Automated Test Assignment All Relationships
-
Automated Test Assignment Relationships
-
Automated Test Assignment Runs
-
Automated Test Assignments
-
Automated Test Relationships
-
Automated Test Run
-
Automated Test Run Attachment
-
Automated Test Run Attachments
-
Automated Test Run Data
-
Automated Test Run Incident
-
Automated Test Run Incidents
-
Automated Test Run Node Attachment
-
Automated Test Run Node Attachments
-
Automated Test Run Result Children
-
Automated Test Run Result Node
-
Automated Test Run Result Root Nodes
-
Automated Test Runs
-
Automated Tests
-
Automated Test Schedule
-
Automated Test Schedule Import Configuration
-
Automated Test Schedule Import Configurations
-
Automated Test Schedules
-
Automated Test Schedule Schedule Configuration
-
Automated Test Schedule Schedule Configuration Run
-
Automated Test Schedule Schedule Configurations
-
Automated Test Type
-
Automated Test Types
-
Background Task
-
Background Tasks
-
Custom Field
-
Custom Fields (Resources)
-
Custom Field Type
-
Custom Field Types
-
Event Types Search
-
Execution Package
-
Execution Package Children
-
Execution Packages
-
Export File
-
External Source Metadata
-
External Sources Metadata
-
External System
-
External System's Links
-
External System Link
-
External System Link Copy
-
External System Link Field Values
-
External System Links
-
External System Links Search
-
External System Link Ticket
-
External System Link Ticket Link
-
External Systems
-
External System Type
-
External System Types
-
Grid Widget Data
-
Grid Widget State
-
Grid Widget States
-
Group
-
Group Permission Projects
-
Group Permissions
-
Groups
-
Groups Search
-
Group Users
-
Incident
-
Incident All Relationships
-
Incident Attachment
-
Incident Attachments
-
Incident Comments
-
Incident Relationships
-
Incident Relationships All Relationships
-
Incidents
-
Latest Performance Measurement
-
Mail Queue Messages
-
Mail Sender Settings
-
Notification
-
Notification Entity Type Search
-
Notifications (Resources)
-
Organisation (Resources)
-
Organisation Picklist
-
Organisation Picklist Search
-
Organisation Relationship Types
-
Organisations
-
Permission
-
Permissions (Resources)
-
Project (Resources)
-
Project Assignees
-
Project Categories
-
Project Category
-
Project Category Children
-
Project Group Permissions
-
Project Picklist
-
Project Picklist Search
-
Projects
-
Projects Search
-
Project Templates
-
Project Tickets
-
Project User Permissions
-
Relationship (Resources)
-
Relationships (Resources)
-
Relationship Type (Resources)
-
Relationship Types
-
Requirement
-
Requirement All Relationships
-
Requirement Attachment
-
Requirement Attachments
-
Requirement Children
-
Requirement Comments
-
Requirement Package
-
Requirement Package Children
-
Requirement Packages
-
Requirement Relationships
-
Requirements (Resources)
-
Resources / Custom Fields
-
Resources / Notifications
-
Resources / Organisation
-
Resources / Permissions
-
Resources / Project
-
Resources / Relationship
-
Resources / Relationships
-
Resources / Relationship Type
-
Resources / Requirements
-
Resources / Script
-
Resources / Search
-
Resources / Widgets
-
Root
-
Rover Execution Tree
-
Rover Licensing Info
-
Script's Assignments
-
Script (Resources)
-
Script All Relationships
-
Script Assignment
-
Script Assignment All Relationships
-
Script Assignment Relationships
-
Script Assignment Runs
-
Script Assignments
-
Script Attachment
-
Script Attachments
-
Script Package
-
Script Package Children
-
Script Packages
-
Script Relationships
-
Script Run
-
Script Runs
-
Scripts
-
Search (Resources)
-
Search Index
-
Search Indexes
-
Step Result
-
Step Result Attachment
-
Step Result Attachments
-
Step Result Incident
-
Step Result Incidents
-
Swagger API
-
Swagger API List
-
Synchronizer Schedule
-
Synchronizer Schedule Run
-
Synchronizer Schedules
-
System Event
-
System Events
-
System Info
-
Temporary Attachment Set
-
Temporary Attachment Set Attachment
-
Temporary Attachments Set
-
Test Automated Test Assignments
-
Time Zone
-
User
-
User Groups
-
User Mail
-
User Password
-
User Permission Projects
-
User Permissions
-
Users
-
Users and Group Search
-
Users Search
-
Agile Run
-
Swagger
-
API / Permissions
-
Using Enterprise Tester
-
Platform Plugins
-
Troubleshooting
-
Earlier Versions of this Documentation
-
Support & Bug Fixes
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).
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, "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).
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, "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).
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
{ "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
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, "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
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
{ "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
{ "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