JarCasting
JarCasting JarCasting

Katalon TestOps Client OpenAPI

Katalon TestOps Client generated by OpenAPI

License

License
Categories

Categories

CLI User Interface
GroupId

GroupId

com.katalon.testops
ArtifactId

ArtifactId

testops-client-openapi
Last Version

Last Version

1.0.1
Release Date

Release Date
Type

Type

jar
Description

Description

Katalon TestOps Client OpenAPI
Katalon TestOps Client generated by OpenAPI
Project URL

Project URL

https://github.com/katalon-studio/testops-client-openapi-java
Project Organization

Project Organization

Katalon, LLC.
Source Code Management

Source Code Management

https://github.com/katalon-studio/testops-client-openapi-java

Download testops-client-openapi

Filename Size
testops-client-openapi-1.0.1.pom
testops-client-openapi-1.0.1.jar 375 KB
testops-client-openapi-1.0.1-sources.jar 170 KB
testops-client-openapi-1.0.1-javadoc.jar 947 KB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/com.katalon.testops/testops-client-openapi/ -->
<dependency>
    <groupId>com.katalon.testops</groupId>
    <artifactId>testops-client-openapi</artifactId>
    <version>1.0.1</version>
</dependency>
// https://jarcasting.com/artifacts/com.katalon.testops/testops-client-openapi/
implementation 'com.katalon.testops:testops-client-openapi:1.0.1'
// https://jarcasting.com/artifacts/com.katalon.testops/testops-client-openapi/
implementation ("com.katalon.testops:testops-client-openapi:1.0.1")
'com.katalon.testops:testops-client-openapi:jar:1.0.1'
<dependency org="com.katalon.testops" name="testops-client-openapi" rev="1.0.1">
  <artifact name="testops-client-openapi" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.katalon.testops', module='testops-client-openapi', version='1.0.1')
)
libraryDependencies += "com.katalon.testops" % "testops-client-openapi" % "1.0.1"
[com.katalon.testops/testops-client-openapi "1.0.1"]

Dependencies

compile (7)

Group / Artifact Type Version
io.swagger.core.v3 : swagger-annotations jar 2.0.0
org.springframework : spring-web jar 4.3.9.RELEASE
com.fasterxml.jackson.core : jackson-core jar 2.8.9
com.fasterxml.jackson.core : jackson-annotations jar 2.8.9
com.fasterxml.jackson.core : jackson-databind jar 2.8.9
com.fasterxml.jackson.jaxrs : jackson-jaxrs-json-provider jar 2.8.9
com.github.joschi.jackson : jackson-datatype-threetenbp jar 2.6.4

test (1)

Group / Artifact Type Version
junit : junit jar 4.13.1

Project Modules

There are no modules declared in this project.

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

Class Method HTTP request Description
AgentApi create POST /api/v1/agent Creates or updates a Local agent. Returns the agent detail.
AgentApi create4 POST /api/v1/circle-ci-agent Creates a new CircleCI agent. Returns the created agent detail.
AgentApi create5 POST /api/v1/k8s-agent Creates a K8S agent. Returns the created agent detail.
AgentApi delete DELETE /api/v1/agent/{id} Deletes a Local agent. Returns the deleted agent detail.
AgentApi generateAgent GET /api/v1/agent Generates the configuration file for the Local agent. Returns the configuration file.
AgentApi get GET /api/v1/agent/{id} Get a Local agent. Returns the agent detail.
AgentApi get11 GET /api/v1/circle-ci-agent/{id} Returns a CircleCI agent detail.
AgentApi get13 GET /api/v1/k8s-agent/{id} Returns a K8S agent detail.
AgentApi getFollowedProjects POST /api/v1/circle-ci-agent/projects
AgentApi update6 PUT /api/v1/circle-ci-agent Updates a CircleCI agent detail. Returns the updated agent detail.
AgentApi update7 PUT /api/v1/k8s-agent Updates a K8S agent detail. Returns the updated agent detail.
AgentApi updateThreshold PUT /api/v1/agent/threshold Updates the threshold for Local agent. Returns the agent detail.
CommentApi create1 POST /api/v1/comments Creates a Comment. Returns the created Comment detail.
CommentApi update PUT /api/v1/comments Updates a Comment detail. Returns the updated Comment detail.
ExecutionApi bulkDownload GET /api/v1/executions/download Exports and downloads multiple Executions. Returns the archive file comprising the Execution summaries.
ExecutionApi delete1 DELETE /api/v1/executions Deletes multiple Executions. Returns the deleted Execution details.
ExecutionApi download1 GET /api/v1/executions/{id}/download Exports and downloads an Execution. Returns the Execution summary file.
ExecutionApi downloadFile GET /api/v1/executions/{id}/download-file Downloads all uploaded files of an Execution. Returns the archive file comprising all Execution's files.
ExecutionApi get1 GET /api/v1/executions/{id} Returns an Execution detail.
ExecutionApi getLatestExecutions GET /api/v1/organizations/{id}/latest-executions
ExecutionApi linkRelease POST /api/v1/executions/{id}/link-release Link an Execution to a Release. Returns the updated Execution detail.
ExecutionApi list GET /api/v1/executions
ExecutionApi reImportExecution POST /api/v1/executions/reimport Re-imports an Execution. Returns the newly imported Execution detail.
ExecutionApi rerunExecution POST /api/v1/executions/{id}/rerun Rerun an Execution.
ExecutionApi shareExecutionReport POST /api/v1/executions/{id}/share-report Allow users to send email with attached execution reports [PDF].
ExecutionApi terminatedExecution POST /api/v1/executions/terminate Terminates a running Execution. Returns the terminated Execution detail.
ExecutionApi unlinkRelease POST /api/v1/executions/{id}/unlink-release Unlink an Execution to a Release. Returns the updated Execution detail.
ExecutionRequestApi download GET /api/v1/requests/{id}/download Downloads an Execution Request report. Returns the report file.
ExecutionRequestApi getExecutionRequest GET /api/v1/requests/{id} Returns an Execution Request detail.
ExecutionTestResultApi get2 GET /api/v1/test-results/{id} Returns an Execution Test Result detail.
ExecutionTestResultApi getStdout GET /api/v1/test-results/logs/{id} Downloads a test result's log. Returns the log file.
ExecutionTestResultApi linkIncidents POST /api/v1/test-results/{id}/incidents Link an Execution Test Result to a Task. Returns the created binding detail.
ExecutionTestResultApi markAsRetested POST /api/v1/test-results/{id}/mask-as-retested
ExecutionTestResultApi unlinkIncidents DELETE /api/v1/test-results/{id}/incidents Unlink an Execution Test Result to a Task. Returns the deleted binding detail.
ExecutionTestSuiteApi get3 GET /api/v1/execution-test-suites/{id} Returns an Execution Test Suite detail.
FileApi download2 GET /api/v1/files/{id} Downloads a file.
FileApi getUploadUrl GET /api/v1/files/upload-url Returns an upload URL.
FileApi getUploadUrls GET /api/v1/files/upload-urls Returns multiple upload URLs.
JobApi cancel DELETE /api/v1/jobs/{id} Cancels a Job.
JobApi get12 GET /api/v1/jobs/{id} Returns a Job detail.
JobApi getJob GET /api/v1/jobs/get-job Returns the next queued Job of an Agent.
JobApi getLatestJobs GET /api/v1/organizations/{id}/latest-jobs
JobApi getLog GET /api/v1/jobs/{id}/get-log Returns a Job's log.
JobApi getRunningJobs GET /api/v1/organizations/{id}/running-jobs
JobApi updateJob POST /api/v1/jobs/update-job Updates a Job detail. Returns the updated Job detail.
KatalonRecorderApi backup POST /api/v1/katalon-recorder/backup Saves a Katalon Recorder backup detail.
KatalonRecorderApi download3 GET /api/v1/katalon-recorder/backup/{id}/download Downloads a Katalon Recorder backup. Returns the backup file.
KatalonRecorderApi upload POST /api/v1/katalon-recorder/test-reports Uploads and processes a Katalon Recorder report.
OrganizationTrialRequestResourceControllerApi getTrialRequest GET /api/v1/organizations/{id}/trial-request Get organization trial request data
OrganizationTrialRequestResourceControllerApi submitTrialRequest POST /api/v1/organizations/{id}/trial-request Submit organization trial request
ProjectApi create2 POST /api/v1/projects Creates a new Project. Returns the created Project detail.
ProjectApi createOrUpdate POST /api/v1/project-settings
ProjectApi createSampleData POST /api/v1/projects/{id}/sample-data Create sample data for project.
ProjectApi delete2 DELETE /api/v1/projects/{id} Deletes a Project. Returns the deleted Project detail.
ProjectApi get5 GET /api/v1/projects/{id} Returns a Project detail.
ProjectApi get6 GET /api/v1/project-settings/{id}
ProjectApi list1 GET /api/v1/projects Returns all Projects of a Team.
ProjectApi update2 PUT /api/v1/projects Updates a Project detail. Returns the updated Project detail.
ProjectApi updateStatus PUT /api/v1/projects/update-status Updates a Project status. Returns the updated Project detail.
ProjectConfigurationResourceControllerApi get14 GET /api/v1/project-configurations/{id}
ProjectConfigurationResourceControllerApi listTimeZones GET /api/v1/time-zones
ProjectConfigurationResourceControllerApi update8 POST /api/v1/project-configurations/{id}
ReleaseApi activeRelease POST /api/v1/releases/{id}/active Open or close a Release. Returns the updated Release detail.
ReleaseApi createOrUpdate1 POST /api/v1/releases Creates or updates a Release. Returns the Release details.
ReleaseApi delete3 DELETE /api/v1/releases/{id} Deletes a Release. Returns the Release details.
ReleaseApi update3 PUT /api/v1/releases Updates a Release. Returns the Release details.
SearchApi search GET /api/v1/search Queries the resources of a specific type by multiple conditions. Returns the pageable resources satisfying the query.
SearchApi search1 POST /api/v1/search Queries the resources of a specific type by multiple conditions. Returns the pageable resources satisfying the query.
SearchApi test GET /api/v1/search/info Returns the search configuration.
TaskApi createIncident POST /api/v1/incidents Creates a Task for the test results. Returns the created Task detail.
TaskApi get4 GET /api/v1/incidents/{id} Returns a Task detail.
TaskApi update1 PUT /api/v1/incidents Updates a Task detail. Returns the updated Task detail.
TeamApi create3 POST /api/v1/teams Creates a new Team. Returns the created Team detail.
TeamApi delete4 DELETE /api/v1/teams/{id} Delete a Team. Returns the delete Team detail.
TeamApi get7 GET /api/v1/teams/{id} Returns a Team detail.
TeamApi list2 GET /api/v1/teams Returns all Teams of the current User.
TeamApi update4 PUT /api/v1/teams Updates a Team detail. Returns the updated Team detail.
TeamApi updateUserTeam PUT /api/v1/permission/team/user Updates the role of a User in a Team. Returns the updated detail.
TestCaseApi get8 GET /api/v1/test-cases/{id} Returns a Test Case detail.
TestCaseApi update5 POST /api/v1/test-cases/update Update a Test Case.
TestObjectApi get15 GET /api/v1/test-object-entities/{id} Returns a Test Object detail.
TestPlanApi createAndTriggerSample POST /api/v1/run-configurations/sample Creates and triggers a sample Test Plan. Returns the created Test Plan detail.
TestPlanApi createOrUpdateConfiguration POST /api/v1/run-configurations Creates or updates a Test Plan. Returns the Test Plan detail.
TestPlanApi delete5 DELETE /api/v1/run-configurations/{id} Deletes a Test Plan. Returns the deleted Test Plan detail.
TestPlanApi linkRelease1 POST /api/v1/run-configurations/{id}/link-release Link an Run Configuration to a Release. Returns the updated Run Configuration detail.
TestPlanApi unlinkRelease1 POST /api/v1/run-configurations/{id}/unlink-release Unlink an Run Configuration to a Release. Returns the updated Run Configuration detail.
TestProjectApi create6 POST /api/v1/test-projects/{id}/schedulers Creates a new schedule for a Test Plan. Returns the created schedule detail.
TestProjectApi createGitRepo POST /api/v1/git/create Creates a Git Test Project. Returns the Git Test Project detail.
TestProjectApi createSample POST /api/v1/test-projects/sample Creates a new sample Test Project. Returns the created Test Project.
TestProjectApi delete6 DELETE /api/v1/test-projects/{id} Deletes a Test Project. Returns the deleted Test Project.
TestProjectApi delete7 DELETE /api/v1/test-projects/{id}/schedulers/{schedulerId} Deletes a schedule. Returns the deleted schedule detail.
TestProjectApi download4 GET /api/v1/test-projects/{id}/download Downloads a Test Project package. Returns the latest Test Project package file.
TestProjectApi get17 GET /api/v1/test-projects/{id} Returns a Test Project detail.
TestProjectApi getScheduler GET /api/v1/test-projects/{id}/schedulers/{schedulerId} Returns a schedule detail.
TestProjectApi getTestProjectGit GET /api/v1/git/{testProjectGitId} Returns a Git Test Project detail.
TestProjectApi refreshTSC POST /api/v1/test-projects/{id}/refresh-tsc Refresh Test Suite Collection list of Git Test Project
TestProjectApi run PUT /api/v1/run-configurations/{id}/execute Executes a Test Plan. Returns the build information.
TestProjectApi update10 PUT /api/v1/test-projects/{id} Updates a Test Project detail. Returns the updated Test Project detail.
TestProjectApi update9 PUT /api/v1/test-projects/{id}/schedulers/{schedulerId} Updates a schedule detail. Returns the updated schedule detail.
TestProjectApi updateGitRepo POST /api/v1/git/update Updates a Git Test Project detail. Returns the updated Git Test Project detail.
TestProjectApi updatePackage POST /api/v1/test-projects/{id}/update-package Update a Test Project package. Returns the updated Test Project detail.
TestProjectApi upload1 POST /api/v1/test-projects/upload Creates a new Test Project. Returns the created Test Project.
TestReportApi processMultipleS3File POST /api/v1/katalon/test-reports/multiple Saves and processes multiple uploaded Katalon reports.
TestReportApi processS3File POST /api/v1/katalon/test-reports Saves and processes the uploaded Katalon reports.
TestReportApi processTestOpsReports POST /api/v1/testops-reports Saves and processes multiple uploaded TestOps reports.
TestReportApi updateResult POST /api/v1/katalon/test-reports/update-result
TestReportApi uploadJUnitReports POST /api/v1/junit/test-reports Uploads and processes the JUnit reports to an Execution.
TestReportApi uploadTestNGReports POST /api/v1/testng/test-reports Uploads and processes the TestNG reports to an execution.
TestSuiteApi get9 GET /api/v1/test-suites/{id} Returns a Test Suite detail.
UserApi assignUserTeam POST /api/v1/users/add Adds users to a Team. Returns the added User detail.
UserApi changeAvatar POST /api/v1/users/avatar Change the avatar of the current User. Returns the updated User detail.
UserApi changeName POST /api/v1/users Change name for current user.
UserApi createOrUpdate2 POST /api/v1/user-settings Updates the User Settings detail. Returns the updated User Settings detail.
UserApi downloadAvatar GET /api/v1/users/avatar Downloads the avatar of the current User. Returns the current avatar file.
UserApi get10 GET /api/v1/user-settings Returns the User Settings detail.
UserApi getMe GET /api/v1/users/me Returns the current User detail.
UserApi removeUser DELETE /api/v1/users/remove Removes a User from a Team. Returns the removed User detail.
WebServiceApi get16 GET /api/v1/test-objects/{id} Returns a Web Service detail.

Documentation for Models

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

com.katalon.testops

Katalon Studio

Katalon Studio: Best automated testing tool for Web, Mobile, & API testing. NOTE: Sample projects have been moved to https://github.com/katalon-studio-samples.

Versions

Version
1.0.1
1.0.0