Skip to content

kintone/kintone-rest-client-java

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
api
api
 
 
docs
docs
 
 
gradle/wrapper
gradle/wrapper
 
 
src
src
 
 
.gitignore
.gitignore
 
 
README.md
README.md
 
 
build.gradle
build.gradle
 
 
build.sbt
build.sbt
 
 
git_push.sh
git_push.sh
 
 
gradle.properties
gradle.properties
 
 
gradlew
gradlew
 
 
gradlew.bat
gradlew.bat
 
 
pom.xml
pom.xml
 
 
settings.gradle
settings.gradle
 
 

Repository files navigation

kintone-rest-client

REST API SPEC

  • API version: 0.0.1
    • Generator version: 7.11.0-SNAPSHOT

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 (3.8.3+)/Gradle (7.2+)

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.kintone</groupId>
  <artifactId>kintone-rest-client</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'kintone-rest-client' jar has been published to maven central.
    mavenLocal()       // Needed if the 'kintone-rest-client' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "com.kintone:kintone-rest-client:0.0.1-SNAPSHOT"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/kintone-rest-client-0.0.1-SNAPSHOT.jar
  • target/lib/*.jar

Getting Started

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

// 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.model.*;
import com.kintone.kintone_rest_client.api.AppApi;

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

    AppApi apiInstance = new AppApi(defaultClient);
    Long app = 56L; // Long | 
    List<String> fields = Arrays.asList(); // List<String> | 
    Long revision = 56L; // Long | 
    try {
      DeletePreviewAppFormFieldsResponse result = apiInstance.deletePreviewAppFormFields(app, fields, revision);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AppApi#deletePreviewAppFormFields");
      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

Class Method HTTP request Description
AppApi deletePreviewAppFormFields DELETE /k/v1/preview/app/form/fields.json
AppApi deployApp POST /k/v1/preview/app/deploy.json
AppApi getApp GET /k/v1/app.json
AppApi getAppAcl GET /k/v1/app/acl.json
AppApi getAppActions GET /k/v1/app/actions.json
AppApi getAppAdminNotes GET /k/v1/app/adminNotes.json
AppApi getAppCustomize GET /k/v1/app/customize.json
AppApi getAppFormFields GET /k/v1/app/form/fields.json
AppApi getAppFormLayout GET /k/v1/app/form/layout.json
AppApi getAppNotificationsGeneral GET /k/v1/app/notifications/general.json
AppApi getAppNotificationsPerRecord GET /k/v1/app/notifications/perRecord.json
AppApi getAppNotificationsReminder GET /k/v1/app/notifications/reminder.json
AppApi getAppPlugins GET /k/v1/app/plugins.json
AppApi getAppReports GET /k/v1/app/reports.json
AppApi getAppSettings GET /k/v1/app/settings.json
AppApi getAppStatus GET /k/v1/app/status.json
AppApi getAppViews GET /k/v1/app/views.json
AppApi getApps GET /k/v1/apps.json
AppApi getAppsStatistics GET /k/v1/apps/statistics.json
AppApi getFieldAcl GET /k/v1/field/acl.json
AppApi getForm GET /k/v1/form.json
AppApi getPreviewAppAcl GET /k/v1/preview/app/acl.json
AppApi getPreviewAppActions GET /k/v1/preview/app/actions.json
AppApi getPreviewAppAdminNotes GET /k/v1/preview/app/adminNotes.json
AppApi getPreviewAppCustomize GET /k/v1/preview/app/customize.json
AppApi getPreviewAppDeploy GET /k/v1/preview/app/deploy.json
AppApi getPreviewAppFormFields GET /k/v1/preview/app/form/fields.json
AppApi getPreviewAppFormLayout GET /k/v1/preview/app/form/layout.json
AppApi getPreviewAppNotificationsGeneral GET /k/v1/preview/app/notifications/general.json
AppApi getPreviewAppNotificationsPerRecord GET /k/v1/preview/app/notifications/perRecord.json
AppApi getPreviewAppNotificationsReminder GET /k/v1/preview/app/notifications/reminder.json
AppApi getPreviewAppPlugins GET /k/v1/preview/app/plugins.json
AppApi getPreviewAppReports GET /k/v1/preview/app/reports.json
AppApi getPreviewAppSettings GET /k/v1/preview/app/settings.json
AppApi getPreviewAppStatus GET /k/v1/preview/app/status.json
AppApi getPreviewAppViews GET /k/v1/preview/app/views.json
AppApi getPreviewFieldAcl GET /k/v1/preview/field/acl.json
AppApi getPreviewForm GET /k/v1/preview/form.json
AppApi getPreviewRecordAcl GET /k/v1/preview/record/acl.json
AppApi getRecordAcl GET /k/v1/record/acl.json
AppApi postAppMove POST /k/v1/app/move.json
AppApi postPreviewApp POST /k/v1/preview/app.json
AppApi postPreviewAppFormFields POST /k/v1/preview/app/form/fields.json
AppApi postPreviewAppPlugins POST /k/v1/preview/app/plugins.json
AppApi putAppAcl PUT /k/v1/app/acl.json
AppApi putFieldAcl PUT /k/v1/field/acl.json
AppApi putPreviewAppAcl PUT /k/v1/preview/app/acl.json
AppApi putPreviewAppActions PUT /k/v1/preview/app/actions.json
AppApi putPreviewAppAdminNotes PUT /k/v1/preview/app/adminNotes.json
AppApi putPreviewAppCustomize PUT /k/v1/preview/app/customize.json
AppApi putPreviewAppFormFields PUT /k/v1/preview/app/form/fields.json
AppApi putPreviewAppFormLayout PUT /k/v1/preview/app/form/layout.json
AppApi putPreviewAppNotificationsGeneral PUT /k/v1/preview/app/notifications/general.json
AppApi putPreviewAppNotificationsPerRecord PUT /k/v1/preview/app/notifications/perRecord.json
AppApi putPreviewAppNotificationsReminder PUT /k/v1/preview/app/notifications/reminder.json
AppApi putPreviewAppReports PUT /k/v1/preview/app/reports.json
AppApi putPreviewAppSettings PUT /k/v1/preview/app/settings.json
AppApi putPreviewAppStatus PUT /k/v1/preview/app/status.json
AppApi putPreviewAppViews PUT /k/v1/preview/app/views.json
AppApi putPreviewFieldAcl PUT /k/v1/preview/field/acl.json
AppApi putPreviewRecordAcl PUT /k/v1/preview/record/acl.json
AppApi putRecordAcl PUT /k/v1/record/acl.json
FileApi downloadFile GET /k/v1/file.json
FileApi uploadFile POST /k/v1/file.json
PluginApi deletePlugin DELETE /k/v1/plugin.json
PluginApi getPluginApps GET /k/v1/plugin/apps.json
PluginApi getPlugins GET /k/v1/plugins.json
PluginApi getPluginsRequired GET /k/v1/plugins/required.json
PluginApi postPlugin POST /k/v1/plugin.json
PluginApi putPlugin PUT /k/v1/plugin.json
RecordApi deleteRecordComment DELETE /k/v1/record/comment.json
RecordApi deleteRecords DELETE /k/v1/records.json
RecordApi deleteRecordsCursor DELETE /k/v1/records/cursor.json
RecordApi getRecord GET /k/v1/record.json
RecordApi getRecordComments GET /k/v1/record/comments.json
RecordApi getRecords GET /k/v1/records.json
RecordApi getRecordsAclEvaluate GET /k/v1/records/acl/evaluate.json
RecordApi getRecordsCursor GET /k/v1/records/cursor.json
RecordApi postBulkRequest POST /k/v1/bulkRequest.json
RecordApi postRecord POST /k/v1/record.json
RecordApi postRecordComment POST /k/v1/record/comment.json
RecordApi postRecords POST /k/v1/records.json
RecordApi postRecordsCursor POST /k/v1/records/cursor.json
RecordApi putRecord PUT /k/v1/record.json
RecordApi putRecordAssignees PUT /k/v1/record/assignees.json
RecordApi putRecordStatus PUT /k/v1/record/status.json
RecordApi putRecords PUT /k/v1/records.json
RecordApi putRecordsStatus PUT /k/v1/records/status.json
SpaceApi deleteGuests DELETE /k/v1/guests.json
SpaceApi deleteSpace DELETE /k/v1/space.json
SpaceApi getSpace GET /k/v1/space.json
SpaceApi getSpaceMembers GET /k/v1/space/members.json
SpaceApi getSpacesStatistics GET /k/v1/spaces/statistics.json
SpaceApi postGuests POST /k/v1/guests.json
SpaceApi postSpaceThread POST /k/v1/space/thread.json
SpaceApi postSpaceThreadComment POST /k/v1/space/thread/comment.json
SpaceApi postTemplateSpace POST /k/v1/template/space.json
SpaceApi putSpace PUT /k/v1/space.json
SpaceApi putSpaceBody PUT /k/v1/space/body.json
SpaceApi putSpaceGuests PUT /k/v1/space/guests.json
SpaceApi putSpaceMembers PUT /k/v1/space/members.json
SpaceApi putSpaceThread PUT /k/v1/space/thread.json

Documentation for Models

Documentation for Authorization

Endpoints do not require authorization.

Recommendation

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

Author

About

kintone REST API Client for Java

Resources

Readme

Code of conduct

Code of conduct
Activity
Custom properties

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages