New Job Scheduling REST API

The New Job Scheduling REST API enables developers to perform certain administrative actions, including managing your Test Execution and Discovery services and integrating Job Scheduling operations as part of a CI/CD process.

Live documentation page

The New Job Scheduling live documentation page allows you to test and experiment with the API. It is accessed directly from the Job Scheduling Portal, by clicking the REST API tab on the left. For details, see REST API Page.

To use the API's methods, you must pass an authentication token. To obtain the token, execute the New Job Scheduling API Login method. There's also a Refresh login method for situations where your token's validity period has expired and you need to renew it.

The following New Job Scheduling REST API methods are available:

Account:

• New Job Scheduling API Login
• Revoke login
• Refresh login

Suite Executions:

• Get suite execution
• Stop suite execution

AdHoc Suites:

• Start adhoc suite execution

Suite Templates:

• Get suite templates
• Get suite template details
• Delete suite template
• Get suite template executions
• Change suite owner
• Start suite execution

Test Discovery Servers:

• Delete Test Discovery Service
• Get Test Discovery Services

Test Execution Servers:

• Delete Test Execution Service
• Get Test Execution Services

Test Executions:

• Get test execution report

Related Topics

• API Support for New Job Scheduling and Job Scheduling (1st Gen)
• New Job Scheduling REST API Response Codes