Skip to content

Latest commit

 

History

History
864 lines (650 loc) · 25.3 KB

SpaceApi.md

File metadata and controls

864 lines (650 loc) · 25.3 KB

SpaceApi

All URIs are relative to http://localhost

Method HTTP request Description
deleteGuests DELETE /k/v1/guests.json
deleteSpace DELETE /k/v1/space.json
getSpace GET /k/v1/space.json
getSpaceMembers GET /k/v1/space/members.json
getSpacesStatistics GET /k/v1/spaces/statistics.json
postGuests POST /k/v1/guests.json
postSpaceThread POST /k/v1/space/thread.json
postSpaceThreadComment POST /k/v1/space/thread/comment.json
postTemplateSpace POST /k/v1/template/space.json
putSpace PUT /k/v1/space.json
putSpaceBody PUT /k/v1/space/body.json
putSpaceGuests PUT /k/v1/space/guests.json
putSpaceMembers PUT /k/v1/space/members.json
putSpaceThread PUT /k/v1/space/thread.json

deleteGuests

Object deleteGuests(guests)

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

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

    SpaceApi apiInstance = new SpaceApi(defaultClient);
    List<String> guests = Arrays.asList(); // List<String> | 
    try {
      Object result = apiInstance.deleteGuests(guests);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SpaceApi#deleteGuests");
      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
guests List<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 guests/delete -

deleteSpace

Object deleteSpace(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.SpaceApi;

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

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

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 space/delete -

getSpace

GetSpaceResponse getSpace(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.SpaceApi;

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

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

GetSpaceResponse

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 space/get -

getSpaceMembers

GetSpaceMembersResponse getSpaceMembers(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.SpaceApi;

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

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

GetSpaceMembersResponse

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 space/members/get -

getSpacesStatistics

GetSpacesStatisticsResponse getSpacesStatistics(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.SpaceApi;

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

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

GetSpacesStatisticsResponse

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 spaces/statistics/get -

postGuests

Object postGuests(postGuestsRequest)

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

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

    SpaceApi apiInstance = new SpaceApi(defaultClient);
    PostGuestsRequest postGuestsRequest = new PostGuestsRequest(); // PostGuestsRequest | 
    try {
      Object result = apiInstance.postGuests(postGuestsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SpaceApi#postGuests");
      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
postGuestsRequest PostGuestsRequest

Return type

Object

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 guests/post -

postSpaceThread

PostSpaceThreadResponse postSpaceThread(postSpaceThreadRequest)

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

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

    SpaceApi apiInstance = new SpaceApi(defaultClient);
    PostSpaceThreadRequest postSpaceThreadRequest = new PostSpaceThreadRequest(); // PostSpaceThreadRequest | 
    try {
      PostSpaceThreadResponse result = apiInstance.postSpaceThread(postSpaceThreadRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SpaceApi#postSpaceThread");
      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
postSpaceThreadRequest PostSpaceThreadRequest

Return type

PostSpaceThreadResponse

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 space/thread/post -

postSpaceThreadComment

PostSpaceThreadCommentResponse postSpaceThreadComment(postSpaceThreadCommentRequest)

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

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

    SpaceApi apiInstance = new SpaceApi(defaultClient);
    PostSpaceThreadCommentRequest postSpaceThreadCommentRequest = new PostSpaceThreadCommentRequest(); // PostSpaceThreadCommentRequest | 
    try {
      PostSpaceThreadCommentResponse result = apiInstance.postSpaceThreadComment(postSpaceThreadCommentRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SpaceApi#postSpaceThreadComment");
      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
postSpaceThreadCommentRequest PostSpaceThreadCommentRequest

Return type

PostSpaceThreadCommentResponse

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 space/thread/comment/post -

postTemplateSpace

PostTemplateSpaceResponse postTemplateSpace(postTemplateSpaceRequest)

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

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

    SpaceApi apiInstance = new SpaceApi(defaultClient);
    PostTemplateSpaceRequest postTemplateSpaceRequest = new PostTemplateSpaceRequest(); // PostTemplateSpaceRequest | 
    try {
      PostTemplateSpaceResponse result = apiInstance.postTemplateSpace(postTemplateSpaceRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SpaceApi#postTemplateSpace");
      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
postTemplateSpaceRequest PostTemplateSpaceRequest

Return type

PostTemplateSpaceResponse

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 template/space/post -

putSpace

Object putSpace(putSpaceRequest)

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

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

    SpaceApi apiInstance = new SpaceApi(defaultClient);
    PutSpaceRequest putSpaceRequest = new PutSpaceRequest(); // PutSpaceRequest | 
    try {
      Object result = apiInstance.putSpace(putSpaceRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SpaceApi#putSpace");
      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
putSpaceRequest PutSpaceRequest

Return type

Object

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 space/put -

putSpaceBody

Object putSpaceBody(putSpaceBodyRequest)

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

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

    SpaceApi apiInstance = new SpaceApi(defaultClient);
    PutSpaceBodyRequest putSpaceBodyRequest = new PutSpaceBodyRequest(); // PutSpaceBodyRequest | 
    try {
      Object result = apiInstance.putSpaceBody(putSpaceBodyRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SpaceApi#putSpaceBody");
      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
putSpaceBodyRequest PutSpaceBodyRequest

Return type

Object

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 space/body/put -

putSpaceGuests

Object putSpaceGuests(putSpaceGuestsRequest)

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

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

    SpaceApi apiInstance = new SpaceApi(defaultClient);
    PutSpaceGuestsRequest putSpaceGuestsRequest = new PutSpaceGuestsRequest(); // PutSpaceGuestsRequest | 
    try {
      Object result = apiInstance.putSpaceGuests(putSpaceGuestsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SpaceApi#putSpaceGuests");
      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
putSpaceGuestsRequest PutSpaceGuestsRequest

Return type

Object

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 space/guests/put -

putSpaceMembers

Object putSpaceMembers(putSpaceMembersRequest)

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

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

    SpaceApi apiInstance = new SpaceApi(defaultClient);
    PutSpaceMembersRequest putSpaceMembersRequest = new PutSpaceMembersRequest(); // PutSpaceMembersRequest | 
    try {
      Object result = apiInstance.putSpaceMembers(putSpaceMembersRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SpaceApi#putSpaceMembers");
      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
putSpaceMembersRequest PutSpaceMembersRequest

Return type

Object

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 space/members/put -

putSpaceThread

Object putSpaceThread(putSpaceThreadRequest)

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

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

    SpaceApi apiInstance = new SpaceApi(defaultClient);
    PutSpaceThreadRequest putSpaceThreadRequest = new PutSpaceThreadRequest(); // PutSpaceThreadRequest | 
    try {
      Object result = apiInstance.putSpaceThread(putSpaceThreadRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SpaceApi#putSpaceThread");
      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
putSpaceThreadRequest PutSpaceThreadRequest

Return type

Object

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 space/thread/put -