Skip to content

JobApi.md

Latest commit

 

History

History
503 lines (364 loc) · 14.1 KB

JobApi.md

File metadata and controls

503 lines (364 loc) · 14.1 KB
Raw

JobApi

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

Method HTTP request Description
cancel DELETE /api/v1/jobs/{id} Cancels a Job.
get12 GET /api/v1/jobs/{id} Returns a Job detail.
getJob GET /api/v1/jobs/get-job Returns the next queued Job of an Agent.
getLatestJobs GET /api/v1/organizations/{id}/latest-jobs
getLog GET /api/v1/jobs/{id}/get-log Returns a Job's log.
getRunningJobs GET /api/v1/organizations/{id}/running-jobs
updateJob POST /api/v1/jobs/update-job Updates a Job detail. Returns the updated Job detail.

cancel

cancel(id)

Cancels a Job.

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.JobApi;

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");

        JobApi apiInstance = new JobApi(defaultClient);
        String id = "id_example"; // String | 
        try {
            apiInstance.cancel(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobApi#cancel");
            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 String

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 -

get12

JobResource get12(id)

Returns a Job 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.JobApi;

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");

        JobApi apiInstance = new JobApi(defaultClient);
        Long id = 56L; // Long | 
        try {
            JobResource result = apiInstance.get12(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobApi#get12");
            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

JobResource

Authorization

basicScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 OK -

getJob

JobResource getJob(uuid, teamId)

Returns the next queued Job of an Agent.

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.JobApi;

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");

        JobApi apiInstance = new JobApi(defaultClient);
        String uuid = "uuid_example"; // String | 
        Long teamId = 56L; // Long | 
        try {
            JobResource result = apiInstance.getJob(uuid, teamId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobApi#getJob");
            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
uuid String
teamId Long

Return type

JobResource

Authorization

basicScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 OK -

getLatestJobs

PageJobResource getLatestJobs(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.JobApi;

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");

        JobApi apiInstance = new JobApi(defaultClient);
        Long id = 56L; // Long | 
        Pageable pageable = new Pageable(); // Pageable | 
        try {
            PageJobResource result = apiInstance.getLatestJobs(id, pageable);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobApi#getLatestJobs");
            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

PageJobResource

Authorization

basicScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 OK -

getLog

List<BuildLog> getLog(id)

Returns a Job's log.

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.JobApi;

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");

        JobApi apiInstance = new JobApi(defaultClient);
        String id = "id_example"; // String | 
        try {
            List<BuildLog> result = apiInstance.getLog(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobApi#getLog");
            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 String

Return type

List<BuildLog>

Authorization

basicScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 OK -

getRunningJobs

PageJobResource getRunningJobs(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.JobApi;

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");

        JobApi apiInstance = new JobApi(defaultClient);
        Long id = 56L; // Long | 
        Pageable pageable = new Pageable(); // Pageable | 
        try {
            PageJobResource result = apiInstance.getRunningJobs(id, pageable);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobApi#getRunningJobs");
            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

PageJobResource

Authorization

basicScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 OK -

updateJob

JobResource updateJob(jobResource)

Updates a Job detail. Returns the updated Job 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.JobApi;

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");

        JobApi apiInstance = new JobApi(defaultClient);
        JobResource jobResource = new JobResource(); // JobResource | 
        try {
            JobResource result = apiInstance.updateJob(jobResource);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobApi#updateJob");
            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
jobResource JobResource

Return type

JobResource

Authorization

basicScheme

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -