Skip to content

Latest commit

 

History

History
384 lines (290 loc) · 11.1 KB

PluginApi.md

File metadata and controls

384 lines (290 loc) · 11.1 KB

PluginApi

All URIs are relative to http://localhost

Method HTTP request Description
deletePlugin DELETE /k/v1/plugin.json
getPluginApps GET /k/v1/plugin/apps.json
getPlugins GET /k/v1/plugins.json
getPluginsRequired GET /k/v1/plugins/required.json
postPlugin POST /k/v1/plugin.json
putPlugin PUT /k/v1/plugin.json

deletePlugin

Object deletePlugin(id)

Example

// Import classes:
import com.kintone.kintone_rest_client.ApiClient;
import com.kintone.kintone_rest_client.ApiException;
import com.kintone.kintone_rest_client.Configuration;
import com.kintone.kintone_rest_client.models.*;
import com.kintone.kintone_rest_client.api.PluginApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");

    PluginApi apiInstance = new PluginApi(defaultClient);
    String id = "id_example"; // String | 
    try {
      Object result = apiInstance.deletePlugin(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PluginApi#deletePlugin");
      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 String

Return type

Object

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 success case of plugin/delete -

getPluginApps

GetPluginAppsResponse getPluginApps(id, offset, limit)

Example

// Import classes:
import com.kintone.kintone_rest_client.ApiClient;
import com.kintone.kintone_rest_client.ApiException;
import com.kintone.kintone_rest_client.Configuration;
import com.kintone.kintone_rest_client.models.*;
import com.kintone.kintone_rest_client.api.PluginApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");

    PluginApi apiInstance = new PluginApi(defaultClient);
    String id = "id_example"; // String | 
    String offset = "offset_example"; // String | 
    String limit = "limit_example"; // String | 
    try {
      GetPluginAppsResponse result = apiInstance.getPluginApps(id, offset, limit);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PluginApi#getPluginApps");
      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 String
offset String [optional]
limit String [optional]

Return type

GetPluginAppsResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 success case of plugin/apps/get -

getPlugins

GetPluginsResponse getPlugins(offset, limit, ids)

Example

// Import classes:
import com.kintone.kintone_rest_client.ApiClient;
import com.kintone.kintone_rest_client.ApiException;
import com.kintone.kintone_rest_client.Configuration;
import com.kintone.kintone_rest_client.models.*;
import com.kintone.kintone_rest_client.api.PluginApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");

    PluginApi apiInstance = new PluginApi(defaultClient);
    String offset = "offset_example"; // String | 
    String limit = "limit_example"; // String | 
    List<String> ids = Arrays.asList(); // List<String> | 
    try {
      GetPluginsResponse result = apiInstance.getPlugins(offset, limit, ids);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PluginApi#getPlugins");
      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
offset String [optional]
limit String [optional]
ids List<String> [optional]

Return type

GetPluginsResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 success case of plugins/get -

getPluginsRequired

GetPluginsRequiredResponse getPluginsRequired(offset, limit)

Example

// Import classes:
import com.kintone.kintone_rest_client.ApiClient;
import com.kintone.kintone_rest_client.ApiException;
import com.kintone.kintone_rest_client.Configuration;
import com.kintone.kintone_rest_client.models.*;
import com.kintone.kintone_rest_client.api.PluginApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");

    PluginApi apiInstance = new PluginApi(defaultClient);
    String offset = "offset_example"; // String | 
    String limit = "limit_example"; // String | 
    try {
      GetPluginsRequiredResponse result = apiInstance.getPluginsRequired(offset, limit);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PluginApi#getPluginsRequired");
      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
offset String [optional]
limit String [optional]

Return type

GetPluginsRequiredResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 success case of plugins/required/get -

postPlugin

PostPluginResponse postPlugin(postPluginRequest)

Example

// Import classes:
import com.kintone.kintone_rest_client.ApiClient;
import com.kintone.kintone_rest_client.ApiException;
import com.kintone.kintone_rest_client.Configuration;
import com.kintone.kintone_rest_client.models.*;
import com.kintone.kintone_rest_client.api.PluginApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");

    PluginApi apiInstance = new PluginApi(defaultClient);
    PostPluginRequest postPluginRequest = new PostPluginRequest(); // PostPluginRequest | 
    try {
      PostPluginResponse result = apiInstance.postPlugin(postPluginRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PluginApi#postPlugin");
      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
postPluginRequest PostPluginRequest

Return type

PostPluginResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 success case of plugin/post -

putPlugin

PutPluginResponse putPlugin(putPluginRequest)

Example

// Import classes:
import com.kintone.kintone_rest_client.ApiClient;
import com.kintone.kintone_rest_client.ApiException;
import com.kintone.kintone_rest_client.Configuration;
import com.kintone.kintone_rest_client.models.*;
import com.kintone.kintone_rest_client.api.PluginApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");

    PluginApi apiInstance = new PluginApi(defaultClient);
    PutPluginRequest putPluginRequest = new PutPluginRequest(); // PutPluginRequest | 
    try {
      PutPluginResponse result = apiInstance.putPlugin(putPluginRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PluginApi#putPlugin");
      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
putPluginRequest PutPluginRequest

Return type

PutPluginResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 success case of plugin/put -