testops-api

Katalon TestOps API reference

• API version: 1.0.0

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.8+
2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.katalon</groupId>
  <artifactId>testops-api</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "com.katalon:testops-api:0.0.1-SNAPSHOT"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/testops-api-0.0.1-SNAPSHOT.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import com.katalon.testops.api.*;
import com.katalon.testops.api.auth.*;
import com.katalon.testops.api.model.*;
import com.katalon.testops.api.api.AgentApi;

public class AgentApiExample {

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

        AgentApi apiInstance = new AgentApi(defaultClient);
        AgentResource agentResource = new AgentResource(); // AgentResource | 
        try {
            AgentResource result = apiInstance.create(agentResource);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#create");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

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

Documentation for Models

• AgentConfigResource
• AgentResource
• BuildInfo
• BuildLog
• CircleCIAgentResource
• CircleCIConnectionResource
• CircleCIProject
• CommentResource
• ConfigResource
• EnvironmentVariable
• ExecutionRequestResource
• ExecutionResource
• ExecutionShareReportResource
• ExecutionTestCaseResource
• ExecutionTestResultIdentifyResource
• ExecutionTestResultResource
• ExecutionTestSuiteResource
• ExternalIssueResource
• ExternalProjectResource
• ExternalReleaseResource
• FileResource
• GitRepositoryResource
• IncidentExecutionTestResultResource
• IncidentResource
• JobResource
• K8SAgentResource
• OrganizationFeatureFlagResource
• OrganizationResource
• OrganizationTrialRequestResource
• PageBaseResource
• PageExecutionResource
• PageJobResource
• PageProjectResource
• PageTeamResource
• Pageable
• PlatformResource
• ProjectConfigurationResource
• ProjectResource
• ProjectSettingResource
• ReleaseResource
• ReleaseStatisticsResource
• RunConfigurationResource
• SchedulerResource
• SearchConfigResource
• SearchRequest
• SearchRequestCondition
• SearchRequestFunction
• SearchRequestPagination
• SearchRequestSortOrder
• Sort
• TeamResource
• TestCasePlatformStatisticsResource
• TestCaseResource
• TestObjectEntityResource
• TestObjectResource
• TestProjectResource
• TestResultAssertionFailedResource
• TestResultAssertionResource
• TestRunResult
• TestSuiteCollectionEntityResource
• TestSuiteCollectionResource
• TestSuiteResource
• TimeZoneResource
• TimeZoneResourceOffset
• TimeZoneResourceOffsetRules
• TimeZoneResourceOffsetRulesDuration
• TimeZoneResourceOffsetRulesDurationUnits
• TimeZoneResourceOffsetRulesTransitionRules
• TimeZoneResourceOffsetRulesTransitions
• TriggerBuildParameter
• UploadBatchFileResource
• UploadBatchResource
• UploadFileResource
• UserOrganizationFeatureResource
• UserResource
• UserSettingResource
• UserTeamResource

Documentation for Authorization

Authentication schemes defined for the API:

basicScheme

• Type: HTTP basic authentication

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author