Skip to content

ExecutionApi.md

Latest commit

 

History

History
937 lines (684 loc) · 28.4 KB

ExecutionApi.md

File metadata and controls

937 lines (684 loc) · 28.4 KB
Raw

ExecutionApi

All URIs are relative to http://localhost:8443

Method HTTP request Description
bulkDownload GET /api/v1/executions/download Exports and downloads multiple Executions. Returns the archive file comprising the Execution summaries.
delete1 DELETE /api/v1/executions Deletes multiple Executions. Returns the deleted Execution details.
download1 GET /api/v1/executions/{id}/download Exports and downloads an Execution. Returns the Execution summary file.
downloadFile GET /api/v1/executions/{id}/download-file Downloads all uploaded files of an Execution. Returns the archive file comprising all Execution's files.
get1 GET /api/v1/executions/{id} Returns an Execution detail.
getLatestExecutions GET /api/v1/organizations/{id}/latest-executions
linkRelease POST /api/v1/executions/{id}/link-release Link an Execution to a Release. Returns the updated Execution detail.
list GET /api/v1/executions
reImportExecution POST /api/v1/executions/reimport Re-imports an Execution. Returns the newly imported Execution detail.
rerunExecution POST /api/v1/executions/{id}/rerun Rerun an Execution.
shareExecutionReport POST /api/v1/executions/{id}/share-report Allow users to send email with attached execution reports [PDF].
terminatedExecution POST /api/v1/executions/terminate Terminates a running Execution. Returns the terminated Execution detail.
unlinkRelease POST /api/v1/executions/{id}/unlink-release Unlink an Execution to a Release. Returns the updated Execution detail.

bulkDownload

bulkDownload(id, projectId, fileType)

Exports and downloads multiple Executions. Returns the archive file comprising the Execution summaries.

Example

// Import classes:
import com.katalon.testops.api.ApiClient;
import com.katalon.testops.api.ApiException;
import com.katalon.testops.api.Configuration;
import com.katalon.testops.api.auth.*;
import com.katalon.testops.api.models.*;
import com.katalon.testops.api.api.ExecutionApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost:8443");
        
        // Configure HTTP basic authorization: basicScheme
        HttpBasicAuth basicScheme = (HttpBasicAuth) defaultClient.getAuthentication("basicScheme");
        basicScheme.setUsername("YOUR USERNAME");
        basicScheme.setPassword("YOUR PASSWORD");

        ExecutionApi apiInstance = new ExecutionApi(defaultClient);
        List<Long> id = Arrays.asList(); // List<Long> | 
        Long projectId = 56L; // Long | 
        String fileType = "\"csv\""; // String | 
        try {
            apiInstance.bulkDownload(id, projectId, fileType);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExecutionApi#bulkDownload");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
id List<Long>
projectId Long
fileType String [optional] [default to "csv"]

Return type

null (empty response body)

Authorization

basicScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 OK -

delete1

List<ExecutionResource> delete1(projectId, order)

Deletes multiple Executions. Returns the deleted Execution details.

Example

// Import classes:
import com.katalon.testops.api.ApiClient;
import com.katalon.testops.api.ApiException;
import com.katalon.testops.api.Configuration;
import com.katalon.testops.api.auth.*;
import com.katalon.testops.api.models.*;
import com.katalon.testops.api.api.ExecutionApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost:8443");
        
        // Configure HTTP basic authorization: basicScheme
        HttpBasicAuth basicScheme = (HttpBasicAuth) defaultClient.getAuthentication("basicScheme");
        basicScheme.setUsername("YOUR USERNAME");
        basicScheme.setPassword("YOUR PASSWORD");

        ExecutionApi apiInstance = new ExecutionApi(defaultClient);
        Long projectId = 56L; // Long | 
        List<Long> order = Arrays.asList(); // List<Long> | 
        try {
            List<ExecutionResource> result = apiInstance.delete1(projectId, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExecutionApi#delete1");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
projectId Long
order List<Long>

Return type

List<ExecutionResource>

Authorization

basicScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 OK -

download1

download1(id, fileType)

Exports and downloads an Execution. Returns the Execution summary file.

Example

// Import classes:
import com.katalon.testops.api.ApiClient;
import com.katalon.testops.api.ApiException;
import com.katalon.testops.api.Configuration;
import com.katalon.testops.api.auth.*;
import com.katalon.testops.api.models.*;
import com.katalon.testops.api.api.ExecutionApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost:8443");
        
        // Configure HTTP basic authorization: basicScheme
        HttpBasicAuth basicScheme = (HttpBasicAuth) defaultClient.getAuthentication("basicScheme");
        basicScheme.setUsername("YOUR USERNAME");
        basicScheme.setPassword("YOUR PASSWORD");

        ExecutionApi apiInstance = new ExecutionApi(defaultClient);
        Long id = 56L; // Long | 
        String fileType = "\"csv\""; // String | 
        try {
            apiInstance.download1(id, fileType);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExecutionApi#download1");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
id Long
fileType String [optional] [default to "csv"]

Return type

null (empty response body)

Authorization

basicScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 OK -

downloadFile

downloadFile(id)

Downloads all uploaded files of an Execution. Returns the archive file comprising all Execution's files.

Example

// Import classes:
import com.katalon.testops.api.ApiClient;
import com.katalon.testops.api.ApiException;
import com.katalon.testops.api.Configuration;
import com.katalon.testops.api.auth.*;
import com.katalon.testops.api.models.*;
import com.katalon.testops.api.api.ExecutionApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost:8443");
        
        // Configure HTTP basic authorization: basicScheme
        HttpBasicAuth basicScheme = (HttpBasicAuth) defaultClient.getAuthentication("basicScheme");
        basicScheme.setUsername("YOUR USERNAME");
        basicScheme.setPassword("YOUR PASSWORD");

        ExecutionApi apiInstance = new ExecutionApi(defaultClient);
        Long id = 56L; // Long | 
        try {
            apiInstance.downloadFile(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExecutionApi#downloadFile");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
id Long

Return type

null (empty response body)

Authorization

basicScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 OK -

get1

ExecutionResource get1(id)

Returns an Execution detail.

Example

// Import classes:
import com.katalon.testops.api.ApiClient;
import com.katalon.testops.api.ApiException;
import com.katalon.testops.api.Configuration;
import com.katalon.testops.api.auth.*;
import com.katalon.testops.api.models.*;
import com.katalon.testops.api.api.ExecutionApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost:8443");
        
        // Configure HTTP basic authorization: basicScheme
        HttpBasicAuth basicScheme = (HttpBasicAuth) defaultClient.getAuthentication("basicScheme");
        basicScheme.setUsername("YOUR USERNAME");
        basicScheme.setPassword("YOUR PASSWORD");

        ExecutionApi apiInstance = new ExecutionApi(defaultClient);
        Long id = 56L; // Long | 
        try {
            ExecutionResource result = apiInstance.get1(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExecutionApi#get1");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
id Long

Return type

ExecutionResource

Authorization

basicScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 OK -

getLatestExecutions

PageExecutionResource getLatestExecutions(id, pageable)

Example

// Import classes:
import com.katalon.testops.api.ApiClient;
import com.katalon.testops.api.ApiException;
import com.katalon.testops.api.Configuration;
import com.katalon.testops.api.auth.*;
import com.katalon.testops.api.models.*;
import com.katalon.testops.api.api.ExecutionApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost:8443");
        
        // Configure HTTP basic authorization: basicScheme
        HttpBasicAuth basicScheme = (HttpBasicAuth) defaultClient.getAuthentication("basicScheme");
        basicScheme.setUsername("YOUR USERNAME");
        basicScheme.setPassword("YOUR PASSWORD");

        ExecutionApi apiInstance = new ExecutionApi(defaultClient);
        Long id = 56L; // Long | 
        Pageable pageable = new Pageable(); // Pageable | 
        try {
            PageExecutionResource result = apiInstance.getLatestExecutions(id, pageable);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExecutionApi#getLatestExecutions");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
id Long
pageable Pageable

Return type

PageExecutionResource

Authorization

basicScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 OK -

linkRelease

ExecutionResource linkRelease(id, projectId, releaseId)

Link an Execution to a Release. Returns the updated Execution detail.

Example

// Import classes:
import com.katalon.testops.api.ApiClient;
import com.katalon.testops.api.ApiException;
import com.katalon.testops.api.Configuration;
import com.katalon.testops.api.auth.*;
import com.katalon.testops.api.models.*;
import com.katalon.testops.api.api.ExecutionApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost:8443");
        
        // Configure HTTP basic authorization: basicScheme
        HttpBasicAuth basicScheme = (HttpBasicAuth) defaultClient.getAuthentication("basicScheme");
        basicScheme.setUsername("YOUR USERNAME");
        basicScheme.setPassword("YOUR PASSWORD");

        ExecutionApi apiInstance = new ExecutionApi(defaultClient);
        Long id = 56L; // Long | 
        Long projectId = 56L; // Long | 
        Long releaseId = 56L; // Long | 
        try {
            ExecutionResource result = apiInstance.linkRelease(id, projectId, releaseId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExecutionApi#linkRelease");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
id Long
projectId Long
releaseId Long

Return type

ExecutionResource

Authorization

basicScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 OK -

list

Object list(pageable, batch, projectId, order)

Example

// Import classes:
import com.katalon.testops.api.ApiClient;
import com.katalon.testops.api.ApiException;
import com.katalon.testops.api.Configuration;
import com.katalon.testops.api.auth.*;
import com.katalon.testops.api.models.*;
import com.katalon.testops.api.api.ExecutionApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost:8443");
        
        // Configure HTTP basic authorization: basicScheme
        HttpBasicAuth basicScheme = (HttpBasicAuth) defaultClient.getAuthentication("basicScheme");
        basicScheme.setUsername("YOUR USERNAME");
        basicScheme.setPassword("YOUR PASSWORD");

        ExecutionApi apiInstance = new ExecutionApi(defaultClient);
        Pageable pageable = new Pageable(); // Pageable | 
        String batch = "batch_example"; // String | 
        Long projectId = 56L; // Long | 
        Long order = 56L; // Long | 
        try {
            Object result = apiInstance.list(pageable, batch, projectId, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExecutionApi#list");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
pageable Pageable
batch String [optional]
projectId Long [optional]
order Long [optional]

Return type

Object

Authorization

basicScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 OK -

reImportExecution

ExecutionResource reImportExecution(id)

Re-imports an Execution. Returns the newly imported Execution detail.

Example

// Import classes:
import com.katalon.testops.api.ApiClient;
import com.katalon.testops.api.ApiException;
import com.katalon.testops.api.Configuration;
import com.katalon.testops.api.auth.*;
import com.katalon.testops.api.models.*;
import com.katalon.testops.api.api.ExecutionApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost:8443");
        
        // Configure HTTP basic authorization: basicScheme
        HttpBasicAuth basicScheme = (HttpBasicAuth) defaultClient.getAuthentication("basicScheme");
        basicScheme.setUsername("YOUR USERNAME");
        basicScheme.setPassword("YOUR PASSWORD");

        ExecutionApi apiInstance = new ExecutionApi(defaultClient);
        Long id = 56L; // Long | 
        try {
            ExecutionResource result = apiInstance.reImportExecution(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExecutionApi#reImportExecution");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
id Long

Return type

ExecutionResource

Authorization

basicScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 OK -

rerunExecution

rerunExecution(id)

Rerun an Execution.

Example

// Import classes:
import com.katalon.testops.api.ApiClient;
import com.katalon.testops.api.ApiException;
import com.katalon.testops.api.Configuration;
import com.katalon.testops.api.auth.*;
import com.katalon.testops.api.models.*;
import com.katalon.testops.api.api.ExecutionApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost:8443");
        
        // Configure HTTP basic authorization: basicScheme
        HttpBasicAuth basicScheme = (HttpBasicAuth) defaultClient.getAuthentication("basicScheme");
        basicScheme.setUsername("YOUR USERNAME");
        basicScheme.setPassword("YOUR PASSWORD");

        ExecutionApi apiInstance = new ExecutionApi(defaultClient);
        Long id = 56L; // Long | 
        try {
            apiInstance.rerunExecution(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExecutionApi#rerunExecution");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
id Long

Return type

null (empty response body)

Authorization

basicScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 No Content -

shareExecutionReport

shareExecutionReport(id, executionShareReportResource)

Allow users to send email with attached execution reports [PDF].

Example

// Import classes:
import com.katalon.testops.api.ApiClient;
import com.katalon.testops.api.ApiException;
import com.katalon.testops.api.Configuration;
import com.katalon.testops.api.auth.*;
import com.katalon.testops.api.models.*;
import com.katalon.testops.api.api.ExecutionApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost:8443");
        
        // Configure HTTP basic authorization: basicScheme
        HttpBasicAuth basicScheme = (HttpBasicAuth) defaultClient.getAuthentication("basicScheme");
        basicScheme.setUsername("YOUR USERNAME");
        basicScheme.setPassword("YOUR PASSWORD");

        ExecutionApi apiInstance = new ExecutionApi(defaultClient);
        Long id = 56L; // Long | 
        ExecutionShareReportResource executionShareReportResource = new ExecutionShareReportResource(); // ExecutionShareReportResource | 
        try {
            apiInstance.shareExecutionReport(id, executionShareReportResource);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExecutionApi#shareExecutionReport");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
id Long
executionShareReportResource ExecutionShareReportResource

Return type

null (empty response body)

Authorization

basicScheme

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 No Content -

terminatedExecution

ExecutionResource terminatedExecution(projectId, order)

Terminates a running Execution. Returns the terminated Execution detail.

Example

// Import classes:
import com.katalon.testops.api.ApiClient;
import com.katalon.testops.api.ApiException;
import com.katalon.testops.api.Configuration;
import com.katalon.testops.api.auth.*;
import com.katalon.testops.api.models.*;
import com.katalon.testops.api.api.ExecutionApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost:8443");
        
        // Configure HTTP basic authorization: basicScheme
        HttpBasicAuth basicScheme = (HttpBasicAuth) defaultClient.getAuthentication("basicScheme");
        basicScheme.setUsername("YOUR USERNAME");
        basicScheme.setPassword("YOUR PASSWORD");

        ExecutionApi apiInstance = new ExecutionApi(defaultClient);
        Long projectId = 56L; // Long | 
        Long order = 56L; // Long | 
        try {
            ExecutionResource result = apiInstance.terminatedExecution(projectId, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExecutionApi#terminatedExecution");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
projectId Long
order Long

Return type

ExecutionResource

Authorization

basicScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 OK -

unlinkRelease

ExecutionResource unlinkRelease(id)

Unlink an Execution to a Release. Returns the updated Execution detail.

Example

// Import classes:
import com.katalon.testops.api.ApiClient;
import com.katalon.testops.api.ApiException;
import com.katalon.testops.api.Configuration;
import com.katalon.testops.api.auth.*;
import com.katalon.testops.api.models.*;
import com.katalon.testops.api.api.ExecutionApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost:8443");
        
        // Configure HTTP basic authorization: basicScheme
        HttpBasicAuth basicScheme = (HttpBasicAuth) defaultClient.getAuthentication("basicScheme");
        basicScheme.setUsername("YOUR USERNAME");
        basicScheme.setPassword("YOUR PASSWORD");

        ExecutionApi apiInstance = new ExecutionApi(defaultClient);
        Long id = 56L; // Long | 
        try {
            ExecutionResource result = apiInstance.unlinkRelease(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExecutionApi#unlinkRelease");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
id Long

Return type

ExecutionResource

Authorization

basicScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 OK -