Skip to content

TaskApi.md

Latest commit

 

History

History
218 lines (157 loc) · 6.43 KB

TaskApi.md

File metadata and controls

218 lines (157 loc) · 6.43 KB
Raw

TaskApi

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

Method HTTP request Description
createIncident POST /api/v1/incidents Creates a Task for the test results. Returns the created Task detail.
get4 GET /api/v1/incidents/{id} Returns a Task detail.
update1 PUT /api/v1/incidents Updates a Task detail. Returns the updated Task detail.

createIncident

IncidentResource createIncident(incidentResource)

Creates a Task for the test results. Returns the created Task 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.TaskApi;

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

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

Return type

IncidentResource

Authorization

basicScheme

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

get4

IncidentResource get4(id)

Returns a Task 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.TaskApi;

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

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

IncidentResource

Authorization

basicScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 OK -

update1

IncidentResource update1(incidentResource)

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

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

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

Return type

IncidentResource

Authorization

basicScheme

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -