Test Studio Scheduling Service API Documentation

This documentation explains the use of the Test Studio Scheduling Service API. The Test Studio Scheduling Service handles all test run scheduling and execution in a distributed installation of Test Studio. The Storage Service API exposes this data using a RESTful web interface. The API exposes a set of endpoints that correspond to types of information about the Scheduling Service. The format for making calls to a specific endpoint is documented in the page for that endpoint.

Applications of the API

The Scheduling Service API allows developers to access data about the state of their Test Studio scheduling, including scheduled test runs and registered remote execution machines. A custom application can then format this information to produce reporting in arbitrary formats. This may facilitate reporting in custom formats or in formats compatible with proprietary technologies.

The Scheduling Service API also exposes calls to add data to the Scheduling Service, including the creation of new scheduled test runs. The Scheduling Service API validates objects sent with API calls before making changes to the Scheduling Service to prevent unexpected behaviors.

HasActiveActions

Endpoint for active test runs.
Example Telerik.TestStudio.Shared.Communication.Transports.TestListExecutionStatus object:

{
    "Id": "GUID",
    "TestListId": "GUID",
    "NumberOfMinutesToKeepResults": "int",
    "ResultWritten": "boolean"
}

GET /HasActiveActions Returns true if the some jobs are

Parameters

/HasActiveActions

Returns

true - if you have runned jobs otherwise else

HTTP Status

Reason

200

OK

Home

Execution Manager Endpoint list and Kill endpoint for testing

GET /Home List of Execution manager api endpoints

This is obsolete with the new documentation provider

Parameters

/Home

Returns

Array of strings describing available endpoints

HTTP Status

Reason

200

OK

DELETE /Home Kill Command when running as a process

kill command will not work when insalled as a Windows service

Parameters

/Home

Returns

202 Accepted

HTTP Status

Reason

202

Accepted

LicensingInfo

License Info operations
Example LicenseInfo object:

{
    "AllocatedUsers": "int",
    "MachineKey": "string"
}

GET /LicensingInfo Licensing Info about the execution manager

Currently only used to add execution server's machine to license.

Parameters

/LicensingInfo

Returns

LicenseInfo object containing number of allocated users and the MachineKey
Example:

{
    "AllocatedUsers": "int",
    "MachineKey": "string"
}

HTTP Status

Reason

200

OK

JobRuns

Endpoint for active test runs.
Example Telerik.TestStudio.Shared.Communication.Transports.TestListExecutionStatus object:

{
    "Id": "GUID",
    "TestListId": "GUID",
    "NumberOfMinutesToKeepResults": "int",
    "ResultWritten": "boolean"
}

GET /JobRuns Gets active TestList Execution Statuses

Only gets TestList runs that are currently being processed by the Execution Manager.

Parameters

/JobRuns

Returns

Dictionary of key value pairs where the key is a GUID and the value is a Telerik.TestStudio.Shared.Communication.Transports.TestListExecutionStatus object
Example:

{
    "GUID": {
        "Id": "GUID",
        "TestListId": "GUID",
        "NumberOfMinutesToKeepResults": "int",
        "ResultWritten": "boolean"
    }
}

HTTP Status

Reason

200

OK

GET /JobRuns/{id} Get active TestList Execution Status by id

Only gets a TestList run that is currently being processed by the Execution Manager.

Parameters

/JobRuns/{id}

id [Guid] required

Returns

a Telerik.TestStudio.Shared.Communication.Transports.TestListExecutionStatus object
Example:

{
    "Id": "GUID",
    "TestListId": "GUID",
    "NumberOfMinutesToKeepResults": "int",
    "ResultWritten": "boolean"
}

HTTP Status

Reason

200

OK

Log

HEAD /Log

Parameters

/Log

Returns

DELETE /Log

Parameters

/Log

Returns

POST /Log

Parameters

/Log?enableFlag={enableFlag}

enableFlag [Boolean] required

Returns

GET /Log

Parameters

/Log

Returns

Ping

Execution Manager status check

GET /Ping Simple test to see if execution manager service is available

Response content does not matter. As long as 200 OK is received the execution manager is available.

Parameters

/Ping

Returns

ping

HTTP Status

Reason

200

OK

Jobs

Execution Manager job scheduling.
Example Telerik.TestStudio.Shared.Communication.Transports.Job object:

{
    "Id": "GUID",
    "Path": "string",
    "PathType": "integer",
    "Credentials": {
        "StorageUri": "string"
    },
    "MachinesToUse": [
        "machine1",
        "machine2"
    ],
    "Schedule": {
        "DayOfMonth": "optional integer",
        "DayOrdinal": "optional integer",
        "DaysOfWeekMask": "integer",
        "FirstDayOfWeek": "integer",
        "Frequency": "integer",
        "Interval": "integer",
        "IsRecurring": "boolean",
        "MaxOccurences": "optional integer",
        "MonthOfYear": "optional integer",
        "RecursUntil": "optional DateTime",
        "TimeToRun": "DateTime"
    },
    "Notification": {
        "AttachAiiResult": "boolean",
        "AttachExcel": "boolean",
        "AttachWord": "boolean",
        "EmailsList": [
            "a@company.com",
            "b@company.com"
        ],
        "Notify": "integer",
        "ShowFailureInformation": "boolean",
        "ShowGeneralInformation": "boolean",
        "Subject": "email subject",
        "TextAfter": "text",
        "TextBefore": "text",
        "TextBetween": "text"
    },
    "ProjectInfo": {
        "ProjectSourceLocation": "path",
        "SchedulingServerUri": "http://localhost:8015",
        "SourceControlServerAddress": "http://tfs.host.domain:port",
        "ProjectRemotePath": "uri",
        "UseSourceControlVersion": "boolean"
    },
    "RootFolder": "string",
    "Distributed": "boolean"
}

Job.PathType allowable values:

0 = RelativeToProjectOnDisk
1 = AbsoluteOnDisk
2 = Guid
3 = SourceControlWithLocalResults
4 = SourceControlWithCloudResults

Job.NotificationSettings.Notify allowable values:

0 = NeverNotify
1 = OnCompleteOrFailure
2 = OnExecutionFailure
3 = OnTestFailure

Job.Schedule.DaysOfWeekMask allowable values:

0 = None
1 = Sunday
2 = Monday
4 = Tuesday
8 = Wednesday
16 = Thursday
32 = Friday
62 = WeekDays
64 = Saturday
65 = WeekendDays
127 = EveryDay

Job.Schedule.FirstDayOfWeek allowable values:

0 = Sunday
1 = Monday
2 = Tuesday
3 = Wednesday
4 = Thursday
5 = Friday
6 = Saturday

Job.Schedule.Frequency allowable values:

0 = None
1 = Secondly
2 = Minutely
3 = Hourly
4 = Daily
5 = Weekly
6 = Monthly
7 = Yearly
8 = Continuous

GET /Jobs Get all jobs scheduled on the execution manager

Get all jobs scheduled on the execution manager

Parameters

/Jobs

Returns

An array of Telerik.TestStudio.Shared.Communication.Transports.Job objects
Example:

[
    {
        "Id": "GUID",
        "Path": "string",
        "PathType": "integer",
        "Credentials": {
            "StorageUri": "string"
        },
        "MachinesToUse": [
            "machine1",
            "machine2"
        ],
        "Schedule": {
            "DayOfMonth": "optional integer",
            "DayOrdinal": "optional integer",
            "DaysOfWeekMask": "integer",
            "FirstDayOfWeek": "integer",
            "Frequency": "integer",
            "Interval": "integer",
            "IsRecurring": "boolean",
            "MaxOccurences": "optional integer",
            "MonthOfYear": "optional integer",
            "RecursUntil": "optional DateTime",
            "TimeToRun": "DateTime"
        },
        "Notification": {
            "AttachAiiResult": "boolean",
            "AttachExcel": "boolean",
            "AttachWord": "boolean",
            "EmailsList": [
                "a@company.com",
                "b@company.com"
            ],
            "Notify": "integer",
            "ShowFailureInformation": "boolean",
            "ShowGeneralInformation": "boolean",
            "Subject": "email subject",
            "TextAfter": "text",
            "TextBefore": "text",
            "TextBetween": "text"
        },
        "ProjectInfo": {
            "ProjectSourceLocation": "path",
            "SchedulingServerUri": "http://localhost:8015",
            "SourceControlServerAddress": "http://tfs.host.domain:port",
            "ProjectRemotePath": "uri",
            "UseSourceControlVersion": "boolean"
        },
        "RootFolder": "string",
        "Distributed": "boolean"
    }
]

Job.PathType allowable values:

0 = RelativeToProjectOnDisk
1 = AbsoluteOnDisk
2 = Guid
3 = SourceControlWithLocalResults
4 = SourceControlWithCloudResults

Job.NotificationSettings.Notify allowable values:

0 = NeverNotify
1 = OnCompleteOrFailure
2 = OnExecutionFailure
3 = OnTestFailure

Job.Schedule.DaysOfWeekMask allowable values:

0 = None
1 = Sunday
2 = Monday
4 = Tuesday
8 = Wednesday
16 = Thursday
32 = Friday
62 = WeekDays
64 = Saturday
65 = WeekendDays
127 = EveryDay

Job.Schedule.FirstDayOfWeek allowable values:

0 = Sunday
1 = Monday
2 = Tuesday
3 = Wednesday
4 = Thursday
5 = Friday
6 = Saturday

Job.Schedule.Frequency allowable values:

0 = None
1 = Secondly
2 = Minutely
3 = Hourly
4 = Daily
5 = Weekly
6 = Monthly
7 = Yearly
8 = Continuous

HTTP Status

Reason

200

OK

GET /Jobs/{id} Get job scheduled on the execution manager by job id

Get a job scheduled on the execution manager.

Parameters

/Jobs/{id}

id [Guid] required

Job id

Returns

Telerik.TestStudio.Shared.Communication.Transports.Job object or null
Example:

{
    "Id": "GUID",
    "Path": "string",
    "PathType": "integer",
    "Credentials": {
        "StorageUri": "string"
    },
    "MachinesToUse": [
        "machine1",
        "machine2"
    ],
    "Schedule": {
        "DayOfMonth": "optional integer",
        "DayOrdinal": "optional integer",
        "DaysOfWeekMask": "integer",
        "FirstDayOfWeek": "integer",
        "Frequency": "integer",
        "Interval": "integer",
        "IsRecurring": "boolean",
        "MaxOccurences": "optional integer",
        "MonthOfYear": "optional integer",
        "RecursUntil": "optional DateTime",
        "TimeToRun": "DateTime"
    },
    "Notification": {
        "AttachAiiResult": "boolean",
        "AttachExcel": "boolean",
        "AttachWord": "boolean",
        "EmailsList": [
            "a@company.com",
            "b@company.com"
        ],
        "Notify": "integer",
        "ShowFailureInformation": "boolean",
        "ShowGeneralInformation": "boolean",
        "Subject": "email subject",
        "TextAfter": "text",
        "TextBefore": "text",
        "TextBetween": "text"
    },
    "ProjectInfo": {
        "ProjectSourceLocation": "path",
        "SchedulingServerUri": "http://localhost:8015",
        "SourceControlServerAddress": "http://tfs.host.domain:port",
        "ProjectRemotePath": "uri",
        "UseSourceControlVersion": "boolean"
    },
    "RootFolder": "string",
    "Distributed": "boolean"
}

Job.PathType allowable values:

0 = RelativeToProjectOnDisk
1 = AbsoluteOnDisk
2 = Guid
3 = SourceControlWithLocalResults
4 = SourceControlWithCloudResults

Job.NotificationSettings.Notify allowable values:

0 = NeverNotify
1 = OnCompleteOrFailure
2 = OnExecutionFailure
3 = OnTestFailure

Job.Schedule.DaysOfWeekMask allowable values:

0 = None
1 = Sunday
2 = Monday
4 = Tuesday
8 = Wednesday
16 = Thursday
32 = Friday
62 = WeekDays
64 = Saturday
65 = WeekendDays
127 = EveryDay

Job.Schedule.FirstDayOfWeek allowable values:

0 = Sunday
1 = Monday
2 = Tuesday
3 = Wednesday
4 = Thursday
5 = Friday
6 = Saturday

Job.Schedule.Frequency allowable values:

0 = None
1 = Secondly
2 = Minutely
3 = Hourly
4 = Daily
5 = Weekly
6 = Monthly
7 = Yearly
8 = Continuous

HTTP Status

Reason

200

OK

POST /Jobs Schedule a new job on the execution manager

Schedules a new job.
Expects a Telerik.TestStudio.Shared.Communication.Transports.Job in the request body.
If no Schedule object is supplied, the job will run immediately.
Credentials is optional. MachinesToUse and ProjectInfo are required to schedule/run a job.
Example:

{
    "Id": "GUID",
    "Path": "string",
    "PathType": "integer",
    "Credentials": {
        "StorageUri": "string"
    },
    "MachinesToUse": [
        "machine1",
        "machine2"
    ],
    "Schedule": {
        "DayOfMonth": "optional integer",
        "DayOrdinal": "optional integer",
        "DaysOfWeekMask": "integer",
        "FirstDayOfWeek": "integer",
        "Frequency": "integer",
        "Interval": "integer",
        "IsRecurring": "boolean",
        "MaxOccurences": "optional integer",
        "MonthOfYear": "optional integer",
        "RecursUntil": "optional DateTime",
        "TimeToRun": "DateTime"
    },
    "Notification": {
        "AttachAiiResult": "boolean",
        "AttachExcel": "boolean",
        "AttachWord": "boolean",
        "EmailsList": [
            "a@company.com",
            "b@company.com"
        ],
        "Notify": "integer",
        "ShowFailureInformation": "boolean",
        "ShowGeneralInformation": "boolean",
        "Subject": "email subject",
        "TextAfter": "text",
        "TextBefore": "text",
        "TextBetween": "text"
    },
    "ProjectInfo": {
        "ProjectSourceLocation": "path",
        "SchedulingServerUri": "http://localhost:8015",
        "SourceControlServerAddress": "http://tfs.host.domain:port",
        "ProjectRemotePath": "uri",
        "UseSourceControlVersion": "boolean"
    },
    "RootFolder": "string",
    "Distributed": "boolean"
}

Job.PathType allowable values:

0 = RelativeToProjectOnDisk
1 = AbsoluteOnDisk
2 = Guid
3 = SourceControlWithLocalResults
4 = SourceControlWithCloudResults

Job.NotificationSettings.Notify allowable values:

0 = NeverNotify
1 = OnCompleteOrFailure
2 = OnExecutionFailure
3 = OnTestFailure

Job.Schedule.DaysOfWeekMask allowable values:

0 = None
1 = Sunday
2 = Monday
4 = Tuesday
8 = Wednesday
16 = Thursday
32 = Friday
62 = WeekDays
64 = Saturday
65 = WeekendDays
127 = EveryDay

Job.Schedule.FirstDayOfWeek allowable values:

0 = Sunday
1 = Monday
2 = Tuesday
3 = Wednesday
4 = Thursday
5 = Friday
6 = Saturday

Job.Schedule.Frequency allowable values:

0 = None
1 = Secondly
2 = Minutely
3 = Hourly
4 = Daily
5 = Weekly
6 = Monthly
7 = Yearly
8 = Continuous

Parameters

/Jobs

job [Job] required

Job object. Should be in request body.

Returns

201 Created with job id in response body.

HTTP Status

Reason

201

Created

500

Internal Server Error

555

Custom: No Drones have been registered with this scheduler

556

Custom: Storage service not reachable

558

Custom: Source control server not reachable

PUT /Jobs/{id} Update scheduled job

Updates only scheduled jobs. If no schedule object is supplied update will be rejected.
Expects a Telerik.TestStudio.Shared.Communication.Transports.Job in the request body. Example:

{
    "Id": "GUID",
    "Path": "string",
    "PathType": "integer",
    "Credentials": {
        "StorageUri": "string"
    },
    "MachinesToUse": [
        "machine1",
        "machine2"
    ],
    "Schedule": {
        "DayOfMonth": "optional integer",
        "DayOrdinal": "optional integer",
        "DaysOfWeekMask": "integer",
        "FirstDayOfWeek": "integer",
        "Frequency": "integer",
        "Interval": "integer",
        "IsRecurring": "boolean",
        "MaxOccurences": "optional integer",
        "MonthOfYear": "optional integer",
        "RecursUntil": "optional DateTime",
        "TimeToRun": "DateTime"
    },
    "Notification": {
        "AttachAiiResult": "boolean",
        "AttachExcel": "boolean",
        "AttachWord": "boolean",
        "EmailsList": [
            "a@company.com",
            "b@company.com"
        ],
        "Notify": "integer",
        "ShowFailureInformation": "boolean",
        "ShowGeneralInformation": "boolean",
        "Subject": "email subject",
        "TextAfter": "text",
        "TextBefore": "text",
        "TextBetween": "text"
    },
    "ProjectInfo": {
        "ProjectSourceLocation": "path",
        "SchedulingServerUri": "http://localhost:8015",
        "SourceControlServerAddress": "http://tfs.host.domain:port",
        "ProjectRemotePath": "uri",
        "UseSourceControlVersion": "boolean"
    },
    "RootFolder": "string",
    "Distributed": "boolean"
}

Job.PathType allowable values:

0 = RelativeToProjectOnDisk
1 = AbsoluteOnDisk
2 = Guid
3 = SourceControlWithLocalResults
4 = SourceControlWithCloudResults

Job.NotificationSettings.Notify allowable values:

0 = NeverNotify
1 = OnCompleteOrFailure
2 = OnExecutionFailure
3 = OnTestFailure

Job.Schedule.DaysOfWeekMask allowable values:

0 = None
1 = Sunday
2 = Monday
4 = Tuesday
8 = Wednesday
16 = Thursday
32 = Friday
62 = WeekDays
64 = Saturday
65 = WeekendDays
127 = EveryDay

Job.Schedule.FirstDayOfWeek allowable values:

0 = Sunday
1 = Monday
2 = Tuesday
3 = Wednesday
4 = Thursday
5 = Friday
6 = Saturday

Job.Schedule.Frequency allowable values:

0 = None
1 = Secondly
2 = Minutely
3 = Hourly
4 = Daily
5 = Weekly
6 = Monthly
7 = Yearly
8 = Continuous

Parameters

/Jobs/{id}

id [Guid] required

Job id

job [Job] required

Job object. Should be in request body.

Returns

202 Accepted

HTTP Status

Reason

202

Accepted

500

Internal Server Error

DELETE /Jobs/{id} Stop scheduled/running job by id

Attempts to stop the specified job in the execution manager.

Parameters

/Jobs/{id}

id [Guid] required

Job Id

Returns

Telerik.TestStudio.Shared.Communication.Transports.JobCancelResult object Example:

{
    "CancelledTestListId": [
        "GUID",
        "GUID"
    ]
}

HTTP Status

Reason

200

OK

DELETE /Jobs Stop all scheduled jobs

Attempts to stop the all jobs in the execution manager

Parameters

/Jobs

Returns

Telerik.TestStudio.Shared.Communication.Transports.JobCancelResult object Example:

{
    "CancelledTestListId": [
        "GUID",
        "GUID"
    ]
}

HTTP Status

Reason

200

OK

MachineReport

GET /MachineReport Get registered remote execution machines

Gets the list of all registered remote execution machines

Parameters

/MachineReport

Returns

Dictionary of registered remote execution machines where the key is the machine name and the value contains machine details. Example:

{
    "machinename": {
        "HostAddress": "http://machine.network.com:55555/",
        "Load": 0.3387502495508121,
        "RunningProcesses": 1,
        "OperatingSystem": "Microsoft Windows NT 6.1.7601 Service Pack 1",
        "State": 0,
        "Details": {
            "MachineName": "machinename",
            "RamMB": 16384,
            "NumberLogicalCores": 8,
            "CurrentRamMB": 7229,
            "CurrentCPUPercentage": 0.3387502495508121,
            "OperatingSystem": {
                "_version": "6.1.7601.65536",
                "_platform": 2,
                "_servicePack": "Service Pack 1"
            },
            "Is64Bit": true,
            "InstalledBrowsers": [
                {
                    "Type": 1,
                    "Version": "9.10.9200.16614"
                },
                {
                    "Type": 2,
                    "Version": "21.0 (en-US)"
                },
                {
                    "Type": 7,
                    "Version": ""
                }
            ]
        }
    }
}

State Lookup:

0 = Alive
1 = Unreachable
2 = Dead
3 = NotReported
4 = Removed

Installed Browsers contains a list of web browsers installed on the execution server.
Browser Type Lookup:

 0 = Not Set,
 1 = Internet Explorer,
 2 = FireFox,
 3 = ASP.NET InProc Host that acts as a browser and request processor,
 4 = Internally used for the UI Designer,
 5 = Safari,
 6 = SLLauncher.exe running Silverlight apps
 7 = Google Chrome
 8 = Native Windows application

HTTP Status

Reason

200

OK

GET /MachineReport/{id} Get registered remnote execution machine by id(name)

Gets a specific registered remote execution machine by id. The id is the machine name.

Parameters

/MachineReport/{id}

id [String] required

Machine id

Returns

Dictionary of registered execution machines where the key is the machine name and the value contains machine details. Example:

{
    "machinename": {
        "HostAddress": "http://machine.network.com:55555/",
        "Load": 0.3387502495508121,
        "RunningProcesses": 1,
        "OperatingSystem": "Microsoft Windows NT 6.1.7601 Service Pack 1",
        "State": 0,
        "Details": {
            "MachineName": "machinename",
            "RamMB": 16384,
            "NumberLogicalCores": 8,
            "CurrentRamMB": 7229,
            "CurrentCPUPercentage": 0.3387502495508121,
            "OperatingSystem": {
                "_version": "6.1.7601.65536",
                "_platform": 2,
                "_servicePack": "Service Pack 1"
            },
            "Is64Bit": true,
            "InstalledBrowsers": [
                {
                    "Type": 1,
                    "Version": "9.10.9200.16614"
                },
                {
                    "Type": 2,
                    "Version": "21.0 (en-US)"
                },
                {
                    "Type": 7,
                    "Version": ""
                }
            ]
        }
    }
}

State Lookup:

0 = Alive
1 = Unreachable
2 = Dead
3 = NotReported
4 = Removed

Installed Browsers contains a list of web browsers installed on the execution server.
Browser Type Lookup:

 0 = Not Set,
 1 = Internet Explorer,
 2 = FireFox,
 3 = ASP.NET InProc Host that acts as a browser and request processor,
 4 = Internally used for the UI Designer,
 5 = Safari,
 6 = SLLauncher.exe running Silverlight apps
 7 = Google Chrome
 8 = Native Windows application

HTTP Status

Reason

200

OK

PUT /MachineReport/{id} Adds or updates a remote execution machine in the execution manager

Expects ProcessManagerReport object in the request body.
Example:

{
    "ProcessManagerUri": "http://localhost:55555/",
    "AlternateProcessManagerUris": [
        "http://localhost:55555/"
    ],
    "MachineDetail": {
        "MachineName": "MOCK_machine",
        "RamMB": 16384,
        "NumberLogicalCores": 8,
        "CurrentRamMB": 9409,
        "CurrentCPUPercentage": 99.123456789,
        "OperatingSystem": {
            "_version": "6.1.7601.65536",
            "_platform": 2,
            "_servicePack": "Service Pack 1"
        },
        "Is64Bit": true,
        "InstalledBrowsers": [
            {
                "Type": 1,
                "Version": "9.10.9200.16576"
            },
            {
                "Type": 2,
                "Version": "21.0 (en-US)"
            }
        ]
    },
    "Processes": [
        {
            "Name": "profiler",
            "ServicePath": "http://localhost:8032/",
            "FailedPings": 0
        }
    ],
    "State": 0
}

State Lookup:

0 = Alive
1 = Unreachable
2 = Dead
3 = NotReported
4 = Removed

Installed Browsers contains a list of web browsers installed on the execution server.
Browser Type Lookup:

 0 = Not Set,
 1 = Internet Explorer,
 2 = FireFox,
 3 = ASP.NET InProc Host that acts as a browser and request processor,
 4 = Internally used for the UI Designer,
 5 = Safari,
 6 = SLLauncher.exe running Silverlight apps
 7 = Google Chrome
 8 = Native Windows application

Parameters

/MachineReport/{id}

id [String] required

Machine name

report [ProcessManagerReport] required

Should be in the request body.

Returns

204 No Content

HTTP Status

Reason

204

No Content

DELETE /MachineReport/{id} Removes a remote execution machine

Removes a remote execution machine from the execution manager

Parameters

/MachineReport/{id}

id [String] required

machine id is the name of the machine

Returns

200 OK

HTTP Status

Reason

200

OK

Plugins

Execution Manager Plugin operations

GET /Plugins GET installed execution manger plugins

Gets all installed execution manager plugins. Available plugins include Emailer and Bug Tracking

Parameters

/Plugins

Returns

Array of plugins.
Each plugin object has a different structure depending on the plugin type.
Example Emailer plugin:

{
    "Telerik.TestStudio.ExecutionManager.Notifications.Emailer.PostListExecutionEmailer": {
        "Message": "Unable to send email due to uninitialized SMTP settings",
        "CanSendEmail": false,
        "Host": "",
        "Port": 25
    }
}

Example Bug Tracking plugin:

{
    "ArtOfTest.WebAii.Design.Execution.BugTracking.BugTrackingExecutionExtension": null
}

HTTP Status

Reason

200

OK

Processes

GET /Processes/{id} Gets Running TestStudio Processes

Gets running TestStudio remote execution processes on the specified machine

Parameters

/Processes/{id}

id [String] required

Machine Name of execution server

Returns

Array of Telerik.TestStudio.Shared.Communication.Transports.ProcessInformation objects
Example Telerik.TestStudio.Shared.Communication.Transports.ProcessInformation object:

{
    "Name": "executor",
    "ServicePath": "http://name.domain.com:8032/",
    "FailedPings": 0,
    "CurrentCPU": 98.85212,
    "CurrentRAM": 42.515625
}

HTTP Status

Reason

200

OK

StorageService

Storage service operations

GET /StorageService Get storage service url

Gets the url for the storage service that is configured with this execution manager.

Parameters

/StorageService

Returns

The fully qualified storage service url in response body.

HTTP Status

Reason

200

OK

204

No Content: Storage service is not configured to be used with this scheduler.

556

Custom: Storage service is not reachable.

ServiceVersion

Assembly version of this service

GET /ServiceVersion Gets the assembly version of this service

The full assembly version of this service including Major, Minor, Build, and Revision.

Parameters

/ServiceVersion

Returns

Example:

{
    "Major": 1,
    "Minor": 1,
    "Build": 0,
    "Revision": 0
}

HTTP Status

Reason

200

OK

HEAD /ServiceVersion Gets the assembly version of this service

The full assembly version of this service including Major, Minor, Build, and Revision.

Parameters

/ServiceVersion

Returns

Example:

{
    "Major": 1,
    "Minor": 1,
    "Build": 0,
    "Revision": 0
}

HTTP Status

Reason

200

OK