TeamApi

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

Method	HTTP request	Description
create3	POST /api/v1/teams	Creates a new Team. Returns the created Team detail.
delete4	DELETE /api/v1/teams/{id}	Delete a Team. Returns the delete Team detail.
get7	GET /api/v1/teams/{id}	Returns a Team detail.
list2	GET /api/v1/teams	Returns all Teams of the current User.
update4	PUT /api/v1/teams	Updates a Team detail. Returns the updated Team detail.
updateUserTeam	PUT /api/v1/permission/team/user	Updates the role of a User in a Team. Returns the updated detail.

create3

TeamResource create3(teamResource)

Creates a new Team. Returns the created Team 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.TeamApi;

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

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

Return type

TeamResource

Authorization

basicScheme

HTTP request headers

Content-Type: application/json
Accept: /

HTTP response details

Status code	Description	Response headers
200	OK	-

delete4

TeamResource delete4(id)

Delete a Team. Returns the delete Team 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.TeamApi;

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

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

TeamResource

Authorization

basicScheme

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

Status code	Description	Response headers
200	OK	-

get7

TeamResource get7(id)

Returns a Team 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.TeamApi;

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

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

TeamResource

Authorization

basicScheme

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

Status code	Description	Response headers
200	OK	-

list2

PageTeamResource list2(pageable)

Returns all Teams of the current User.

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

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

        TeamApi apiInstance = new TeamApi(defaultClient);
        Pageable pageable = new Pageable(); // Pageable | 
        try {
            PageTeamResource result = apiInstance.list2(pageable);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamApi#list2");
            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

Return type

PageTeamResource

Authorization

basicScheme

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

Status code	Description	Response headers
200	OK	-

update4

TeamResource update4(teamResource)

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

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

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

Return type

TeamResource

Authorization

basicScheme

HTTP request headers

Content-Type: application/json
Accept: /

HTTP response details

Status code	Description	Response headers
200	OK	-

updateUserTeam

UserTeamResource updateUserTeam(userTeamResource)

Updates the role of a User in a Team. Returns the updated detail.

The user issuing this request must be the Admin of the team.

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

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

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

Return type

UserTeamResource

Authorization

basicScheme

HTTP request headers

Content-Type: application/json
Accept: /

HTTP response details

Status code	Description	Response headers
200	OK	-

Uh oh!

FilesExpand file tree

TeamApi.md

Latest commit

History

TeamApi.md

File metadata and controls

TeamApi

create3

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete4

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get7

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list2

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update4

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateUserTeam

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details