ToolsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
countUniqueFieldsTools	GET /api/v1/tools/count/{field}	ToolController@count
createTools	POST /api/v1/tools	ToolController@store
createToolsByTeamV2	POST /api/v2/teams/{teamId}/tools	ToolController@store
createToolsIntegrations	POST /api/v1/integrations/tools	IntegrationToolController@store
deleteTools	DELETE /api/v1/tools/{id}	ToolController@destroy
deleteToolsByTeamidV2	DELETE /api/v2/teams/{teamId}/tools/{id}	TeamToolController@destroy
deleteToolsIntegrations	DELETE /api/v1/integrations/tools/{id}	IntegrationToolController@destroy
editTools	PATCH /api/v1/tools/{id}	ToolController@edit
editToolsByTeamidV2	PATCH /api/v2/teams/{teamId}/tools/{id}	TeamToolController@edit
editToolsIntegrations	PATCH /api/v1/integrations/tools/{id}	IntegrationToolController@edit
fetchAllTools	GET /api/v1/tools	Fetch all tools
fetchAllToolsIntegrations	GET /api/v1/integrations/tools	IntegrationToolController@index
fetchAllToolsV2	GET /api/v2/tools	ToolController@indexActive
fetchTools	GET /api/v1/tools/{id}	ToolController@show
fetchToolsIntegrations	GET /api/v1/integrations/tools/{id}	IntegrationToolController@show
fetchToolsV2	GET /api/v2/tools/{id}	ToolController@showActive
updateTools	PUT /api/v1/tools/{id}	ToolController@update
updateToolsByTeamidV2	PUT /api/v2/teams/{teamId}/tools/{id}	TeamToolController@update
updateToolsIntegrations	PUT /api/v1/integrations/tools/{id}	IntegrationToolController@update

countUniqueFieldsTools

CountUniqueFieldsCollections200Response countUniqueFieldsTools(field, teamId)

ToolController@count

Get Counts for distinct entries of a field in the model

Example

// Import classes:
import uk.ac.hdruk.gatewayapi.ApiClient;
import uk.ac.hdruk.gatewayapi.ApiException;
import uk.ac.hdruk.gatewayapi.Configuration;
import uk.ac.hdruk.gatewayapi.auth.*;
import uk.ac.hdruk.gatewayapi.models.*;
import uk.ac.hdruk.gatewayapi.api.ToolsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    ToolsApi apiInstance = new ToolsApi(defaultClient);
    String field = "status"; // String | name of the field to perform a count on
    Integer teamId = 1; // Integer | team id
    try {
      CountUniqueFieldsCollections200Response result = apiInstance.countUniqueFieldsTools(field, teamId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ToolsApi#countUniqueFieldsTools");
      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
field	String	name of the field to perform a count on
teamId	Integer	team id

Return type

CountUniqueFieldsCollections200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success response	-

createTools

CreateDarIntegration201Response createTools(createToolsRequest)

ToolController@store

Create a new tool

Example

// Import classes:
import uk.ac.hdruk.gatewayapi.ApiClient;
import uk.ac.hdruk.gatewayapi.ApiException;
import uk.ac.hdruk.gatewayapi.Configuration;
import uk.ac.hdruk.gatewayapi.auth.*;
import uk.ac.hdruk.gatewayapi.models.*;
import uk.ac.hdruk.gatewayapi.api.ToolsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    ToolsApi apiInstance = new ToolsApi(defaultClient);
    CreateToolsRequest createToolsRequest = new CreateToolsRequest(); // CreateToolsRequest | Pass user credentials
    try {
      CreateDarIntegration201Response result = apiInstance.createTools(createToolsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ToolsApi#createTools");
      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
createToolsRequest	CreateToolsRequest	Pass user credentials

Return type

CreateDarIntegration201Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created	-
400	bad request	-
401	Unauthorized	-
500	Error	-

createToolsByTeamV2

CreateDarIntegration201Response createToolsByTeamV2(teamId, createToolsRequest)

ToolController@store

Create a new tool by team v2

Example

// Import classes:
import uk.ac.hdruk.gatewayapi.ApiClient;
import uk.ac.hdruk.gatewayapi.ApiException;
import uk.ac.hdruk.gatewayapi.Configuration;
import uk.ac.hdruk.gatewayapi.auth.*;
import uk.ac.hdruk.gatewayapi.models.*;
import uk.ac.hdruk.gatewayapi.api.ToolsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    ToolsApi apiInstance = new ToolsApi(defaultClient);
    Integer teamId = 1; // Integer | team id
    CreateToolsRequest createToolsRequest = new CreateToolsRequest(); // CreateToolsRequest | Pass user credentials
    try {
      CreateDarIntegration201Response result = apiInstance.createToolsByTeamV2(teamId, createToolsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ToolsApi#createToolsByTeamV2");
      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
teamId	Integer	team id
createToolsRequest	CreateToolsRequest	Pass user credentials

Return type

CreateDarIntegration201Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created	-
400	bad request	-
401	Unauthorized	-
500	Error	-

createToolsIntegrations

CreateDarIntegration201Response createToolsIntegrations(createToolsIntegrationsRequest)

IntegrationToolController@store

Create a new tool

Example

// Import classes:
import uk.ac.hdruk.gatewayapi.ApiClient;
import uk.ac.hdruk.gatewayapi.ApiException;
import uk.ac.hdruk.gatewayapi.Configuration;
import uk.ac.hdruk.gatewayapi.auth.*;
import uk.ac.hdruk.gatewayapi.models.*;
import uk.ac.hdruk.gatewayapi.api.ToolsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    ToolsApi apiInstance = new ToolsApi(defaultClient);
    CreateToolsIntegrationsRequest createToolsIntegrationsRequest = new CreateToolsIntegrationsRequest(); // CreateToolsIntegrationsRequest | Pass user credentials
    try {
      CreateDarIntegration201Response result = apiInstance.createToolsIntegrations(createToolsIntegrationsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ToolsApi#createToolsIntegrations");
      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
createToolsIntegrationsRequest	CreateToolsIntegrationsRequest	Pass user credentials

Return type

CreateDarIntegration201Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created	-
400	bad request	-
401	Unauthorized	-
500	Error	-

deleteTools

DeleteFederation200Response deleteTools(id)

ToolController@destroy

Delete tool by id

Example

// Import classes:
import uk.ac.hdruk.gatewayapi.ApiClient;
import uk.ac.hdruk.gatewayapi.ApiException;
import uk.ac.hdruk.gatewayapi.Configuration;
import uk.ac.hdruk.gatewayapi.auth.*;
import uk.ac.hdruk.gatewayapi.models.*;
import uk.ac.hdruk.gatewayapi.api.ToolsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    ToolsApi apiInstance = new ToolsApi(defaultClient);
    Integer id = 1; // Integer | tool id
    try {
      DeleteFederation200Response result = apiInstance.deleteTools(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ToolsApi#deleteTools");
      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	Integer	tool id

Return type

DeleteFederation200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success response	-
404	Error response	-
401	Unauthorized	-
500	Error	-

deleteToolsByTeamidV2

DeleteFederation200Response deleteToolsByTeamidV2(teamId, id)

TeamToolController@destroy

Delete tool by id and by team_id

Example

// Import classes:
import uk.ac.hdruk.gatewayapi.ApiClient;
import uk.ac.hdruk.gatewayapi.ApiException;
import uk.ac.hdruk.gatewayapi.Configuration;
import uk.ac.hdruk.gatewayapi.auth.*;
import uk.ac.hdruk.gatewayapi.models.*;
import uk.ac.hdruk.gatewayapi.api.ToolsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    ToolsApi apiInstance = new ToolsApi(defaultClient);
    Integer teamId = 1; // Integer | team id
    Integer id = 1; // Integer | tool id
    try {
      DeleteFederation200Response result = apiInstance.deleteToolsByTeamidV2(teamId, id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ToolsApi#deleteToolsByTeamidV2");
      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
teamId	Integer	team id
id	Integer	tool id

Return type

DeleteFederation200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success response	-
404	Error response	-
401	Unauthorized	-
500	Error	-

deleteToolsIntegrations

DeleteFederation200Response deleteToolsIntegrations(id)

IntegrationToolController@destroy

Delete tool by id

Example

// Import classes:
import uk.ac.hdruk.gatewayapi.ApiClient;
import uk.ac.hdruk.gatewayapi.ApiException;
import uk.ac.hdruk.gatewayapi.Configuration;
import uk.ac.hdruk.gatewayapi.auth.*;
import uk.ac.hdruk.gatewayapi.models.*;
import uk.ac.hdruk.gatewayapi.api.ToolsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    ToolsApi apiInstance = new ToolsApi(defaultClient);
    Integer id = 1; // Integer | tool id
    try {
      DeleteFederation200Response result = apiInstance.deleteToolsIntegrations(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ToolsApi#deleteToolsIntegrations");
      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	Integer	tool id

Return type

DeleteFederation200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success response	-
404	Error response	-
401	Unauthorized	-
500	Error	-

editTools

FetchToolsIntegrations200Response editTools(id, updateToolsRequest, unarchive)

ToolController@edit

Edit tool by id

Example

// Import classes:
import uk.ac.hdruk.gatewayapi.ApiClient;
import uk.ac.hdruk.gatewayapi.ApiException;
import uk.ac.hdruk.gatewayapi.Configuration;
import uk.ac.hdruk.gatewayapi.auth.*;
import uk.ac.hdruk.gatewayapi.models.*;
import uk.ac.hdruk.gatewayapi.api.ToolsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    ToolsApi apiInstance = new ToolsApi(defaultClient);
    Integer id = 1; // Integer | tool id
    UpdateToolsRequest updateToolsRequest = new UpdateToolsRequest(); // UpdateToolsRequest | Pass user credentials
    String unarchive = "unarchive_example"; // String | Unarchive a tool
    try {
      FetchToolsIntegrations200Response result = apiInstance.editTools(id, updateToolsRequest, unarchive);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ToolsApi#editTools");
      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	Integer	tool id
updateToolsRequest	UpdateToolsRequest	Pass user credentials
unarchive	String	Unarchive a tool	[optional]

Return type

FetchToolsIntegrations200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Success	-
400	bad request	-
401	Unauthorized	-
500	Error	-

editToolsByTeamidV2

FetchToolsIntegrations200Response editToolsByTeamidV2(teamId, id, updateToolsRequest)

TeamToolController@edit

Edit tool by id and by teamid

Example

// Import classes:
import uk.ac.hdruk.gatewayapi.ApiClient;
import uk.ac.hdruk.gatewayapi.ApiException;
import uk.ac.hdruk.gatewayapi.Configuration;
import uk.ac.hdruk.gatewayapi.auth.*;
import uk.ac.hdruk.gatewayapi.models.*;
import uk.ac.hdruk.gatewayapi.api.ToolsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    ToolsApi apiInstance = new ToolsApi(defaultClient);
    Integer teamId = 1; // Integer | team id
    Integer id = 1; // Integer | tool id
    UpdateToolsRequest updateToolsRequest = new UpdateToolsRequest(); // UpdateToolsRequest | Pass user credentials
    try {
      FetchToolsIntegrations200Response result = apiInstance.editToolsByTeamidV2(teamId, id, updateToolsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ToolsApi#editToolsByTeamidV2");
      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
teamId	Integer	team id
id	Integer	tool id
updateToolsRequest	UpdateToolsRequest	Pass user credentials

Return type

FetchToolsIntegrations200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Success	-
400	bad request	-
401	Unauthorized	-
500	Error	-

editToolsIntegrations

FetchToolsIntegrations200Response editToolsIntegrations(id, updateToolsIntegrationsRequest)

IntegrationToolController@edit

Edit tool by id

Example

// Import classes:
import uk.ac.hdruk.gatewayapi.ApiClient;
import uk.ac.hdruk.gatewayapi.ApiException;
import uk.ac.hdruk.gatewayapi.Configuration;
import uk.ac.hdruk.gatewayapi.auth.*;
import uk.ac.hdruk.gatewayapi.models.*;
import uk.ac.hdruk.gatewayapi.api.ToolsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    ToolsApi apiInstance = new ToolsApi(defaultClient);
    Integer id = 1; // Integer | tool id
    UpdateToolsIntegrationsRequest updateToolsIntegrationsRequest = new UpdateToolsIntegrationsRequest(); // UpdateToolsIntegrationsRequest | Pass user credentials
    try {
      FetchToolsIntegrations200Response result = apiInstance.editToolsIntegrations(id, updateToolsIntegrationsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ToolsApi#editToolsIntegrations");
      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	Integer	tool id
updateToolsIntegrationsRequest	UpdateToolsIntegrationsRequest	Pass user credentials

Return type

FetchToolsIntegrations200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created	-
400	bad request	-
401	Unauthorized	-
500	Error	-

fetchAllTools

FetchAllTools200Response fetchAllTools(teamId, userId, title, sort)

Fetch all tools

Get all tools with optional filters and sorting

Example

// Import classes:
import uk.ac.hdruk.gatewayapi.ApiClient;
import uk.ac.hdruk.gatewayapi.ApiException;
import uk.ac.hdruk.gatewayapi.Configuration;
import uk.ac.hdruk.gatewayapi.auth.*;
import uk.ac.hdruk.gatewayapi.models.*;
import uk.ac.hdruk.gatewayapi.api.ToolsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    ToolsApi apiInstance = new ToolsApi(defaultClient);
    Integer teamId = 56; // Integer | Filter tools by team ID
    Integer userId = 56; // Integer | Filter tools by user ID
    String title = "title_example"; // String | Filter tools by title
    String sort = "name:asc"; // String | Sort tools by a specific field and direction, e.g., 'name:asc' or 'created_at:desc'
    try {
      FetchAllTools200Response result = apiInstance.fetchAllTools(teamId, userId, title, sort);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ToolsApi#fetchAllTools");
      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
teamId	Integer	Filter tools by team ID	[optional]
userId	Integer	Filter tools by user ID	[optional]
title	String	Filter tools by title	[optional]
sort	String	Sort tools by a specific field and direction, e.g., 'name:asc' or 'created_at:desc'	[optional]

Return type

FetchAllTools200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success response	-
400	Bad request response	-
500	Internal server error	-

fetchAllToolsIntegrations

FetchAllToolsIntegrations200Response fetchAllToolsIntegrations()

IntegrationToolController@index

Get All Tools

Example

// Import classes:
import uk.ac.hdruk.gatewayapi.ApiClient;
import uk.ac.hdruk.gatewayapi.ApiException;
import uk.ac.hdruk.gatewayapi.Configuration;
import uk.ac.hdruk.gatewayapi.auth.*;
import uk.ac.hdruk.gatewayapi.models.*;
import uk.ac.hdruk.gatewayapi.api.ToolsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    ToolsApi apiInstance = new ToolsApi(defaultClient);
    try {
      FetchAllToolsIntegrations200Response result = apiInstance.fetchAllToolsIntegrations();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ToolsApi#fetchAllToolsIntegrations");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

FetchAllToolsIntegrations200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success response	-

fetchAllToolsV2

FetchAllTools200Response fetchAllToolsV2(name, sort)

ToolController@indexActive

Get all tools with optional filters and sorting

Example

// Import classes:
import uk.ac.hdruk.gatewayapi.ApiClient;
import uk.ac.hdruk.gatewayapi.ApiException;
import uk.ac.hdruk.gatewayapi.Configuration;
import uk.ac.hdruk.gatewayapi.auth.*;
import uk.ac.hdruk.gatewayapi.models.*;
import uk.ac.hdruk.gatewayapi.api.ToolsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    ToolsApi apiInstance = new ToolsApi(defaultClient);
    String name = "name_example"; // String | Filter tools by name
    String sort = "name:asc"; // String | Sort tools by a specific field and direction, e.g., 'name:asc' or 'created_at:desc'
    try {
      FetchAllTools200Response result = apiInstance.fetchAllToolsV2(name, sort);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ToolsApi#fetchAllToolsV2");
      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
name	String	Filter tools by name	[optional]
sort	String	Sort tools by a specific field and direction, e.g., 'name:asc' or 'created_at:desc'	[optional]

Return type

FetchAllTools200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success response	-
400	Bad request response	-
500	Internal server error	-

fetchTools

FetchToolsIntegrations200Response fetchTools(id, viewType)

ToolController@show

Get tool by id

Example

// Import classes:
import uk.ac.hdruk.gatewayapi.ApiClient;
import uk.ac.hdruk.gatewayapi.ApiException;
import uk.ac.hdruk.gatewayapi.Configuration;
import uk.ac.hdruk.gatewayapi.auth.*;
import uk.ac.hdruk.gatewayapi.models.*;
import uk.ac.hdruk.gatewayapi.api.ToolsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    ToolsApi apiInstance = new ToolsApi(defaultClient);
    Integer id = 1; // Integer | tool id
    String viewType = "full"; // String | Query flag to show full tool data or a trimmed version (defaults to full).
    try {
      FetchToolsIntegrations200Response result = apiInstance.fetchTools(id, viewType);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ToolsApi#fetchTools");
      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	Integer	tool id
viewType	String	Query flag to show full tool data or a trimmed version (defaults to full).	[optional] [default to full]

Return type

FetchToolsIntegrations200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success response	-
401	Unauthorized	-
404	Not found response	-

fetchToolsIntegrations

FetchToolsIntegrations200Response fetchToolsIntegrations(id)

IntegrationToolController@show

Get tool by id

Example

// Import classes:
import uk.ac.hdruk.gatewayapi.ApiClient;
import uk.ac.hdruk.gatewayapi.ApiException;
import uk.ac.hdruk.gatewayapi.Configuration;
import uk.ac.hdruk.gatewayapi.auth.*;
import uk.ac.hdruk.gatewayapi.models.*;
import uk.ac.hdruk.gatewayapi.api.ToolsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    ToolsApi apiInstance = new ToolsApi(defaultClient);
    Integer id = 1; // Integer | tool id
    try {
      FetchToolsIntegrations200Response result = apiInstance.fetchToolsIntegrations(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ToolsApi#fetchToolsIntegrations");
      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	Integer	tool id

Return type

FetchToolsIntegrations200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success response	-
401	Unauthorized	-
404	Not found response	-

fetchToolsV2

FetchToolsIntegrations200Response fetchToolsV2(id)

ToolController@showActive

Get tool by id

Example

// Import classes:
import uk.ac.hdruk.gatewayapi.ApiClient;
import uk.ac.hdruk.gatewayapi.ApiException;
import uk.ac.hdruk.gatewayapi.Configuration;
import uk.ac.hdruk.gatewayapi.auth.*;
import uk.ac.hdruk.gatewayapi.models.*;
import uk.ac.hdruk.gatewayapi.api.ToolsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    ToolsApi apiInstance = new ToolsApi(defaultClient);
    Integer id = 1; // Integer | tool id
    try {
      FetchToolsIntegrations200Response result = apiInstance.fetchToolsV2(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ToolsApi#fetchToolsV2");
      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	Integer	tool id

Return type

FetchToolsIntegrations200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success response	-
401	Unauthorized	-
404	Not found response	-

updateTools

FetchToolsIntegrations200Response updateTools(id, updateToolsRequest)

ToolController@update

Update tool by id

Example

// Import classes:
import uk.ac.hdruk.gatewayapi.ApiClient;
import uk.ac.hdruk.gatewayapi.ApiException;
import uk.ac.hdruk.gatewayapi.Configuration;
import uk.ac.hdruk.gatewayapi.auth.*;
import uk.ac.hdruk.gatewayapi.models.*;
import uk.ac.hdruk.gatewayapi.api.ToolsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    ToolsApi apiInstance = new ToolsApi(defaultClient);
    Integer id = 1; // Integer | tool id
    UpdateToolsRequest updateToolsRequest = new UpdateToolsRequest(); // UpdateToolsRequest | Pass user credentials
    try {
      FetchToolsIntegrations200Response result = apiInstance.updateTools(id, updateToolsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ToolsApi#updateTools");
      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	Integer	tool id
updateToolsRequest	UpdateToolsRequest	Pass user credentials

Return type

FetchToolsIntegrations200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Success	-
400	bad request	-
401	Unauthorized	-
500	Error	-

updateToolsByTeamidV2

FetchToolsIntegrations200Response updateToolsByTeamidV2(teamId, id, updateToolsRequest)

TeamToolController@update

Update tools by team id

Example

// Import classes:
import uk.ac.hdruk.gatewayapi.ApiClient;
import uk.ac.hdruk.gatewayapi.ApiException;
import uk.ac.hdruk.gatewayapi.Configuration;
import uk.ac.hdruk.gatewayapi.auth.*;
import uk.ac.hdruk.gatewayapi.models.*;
import uk.ac.hdruk.gatewayapi.api.ToolsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    ToolsApi apiInstance = new ToolsApi(defaultClient);
    Integer teamId = 1; // Integer | team id
    Integer id = 1; // Integer | tool id
    UpdateToolsRequest updateToolsRequest = new UpdateToolsRequest(); // UpdateToolsRequest | Pass user credentials
    try {
      FetchToolsIntegrations200Response result = apiInstance.updateToolsByTeamidV2(teamId, id, updateToolsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ToolsApi#updateToolsByTeamidV2");
      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
teamId	Integer	team id
id	Integer	tool id
updateToolsRequest	UpdateToolsRequest	Pass user credentials

Return type

FetchToolsIntegrations200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Success	-
400	bad request	-
401	Unauthorized	-
500	Error	-

updateToolsIntegrations

FetchToolsIntegrations200Response updateToolsIntegrations(id, updateToolsIntegrationsRequest)

IntegrationToolController@update

Update tool by id

Example

// Import classes:
import uk.ac.hdruk.gatewayapi.ApiClient;
import uk.ac.hdruk.gatewayapi.ApiException;
import uk.ac.hdruk.gatewayapi.Configuration;
import uk.ac.hdruk.gatewayapi.auth.*;
import uk.ac.hdruk.gatewayapi.models.*;
import uk.ac.hdruk.gatewayapi.api.ToolsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    ToolsApi apiInstance = new ToolsApi(defaultClient);
    Integer id = 1; // Integer | tool id
    UpdateToolsIntegrationsRequest updateToolsIntegrationsRequest = new UpdateToolsIntegrationsRequest(); // UpdateToolsIntegrationsRequest | Pass user credentials
    try {
      FetchToolsIntegrations200Response result = apiInstance.updateToolsIntegrations(id, updateToolsIntegrationsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ToolsApi#updateToolsIntegrations");
      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	Integer	tool id
updateToolsIntegrationsRequest	UpdateToolsIntegrationsRequest	Pass user credentials

Return type

FetchToolsIntegrations200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created	-
400	bad request	-
401	Unauthorized	-
500	Error	-

FilesExpand file tree

ToolsApi.md

Latest commit

History

ToolsApi.md

File metadata and controls

ToolsApi

countUniqueFieldsTools

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createTools

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createToolsByTeamV2

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createToolsIntegrations

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteTools

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteToolsByTeamidV2

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteToolsIntegrations

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

editTools

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

editToolsByTeamidV2

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

editToolsIntegrations

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fetchAllTools

Example

Parameters