Skip to content

DocumentFoldersApi.md

Latest commit

 

History

History
360 lines (281 loc) · 12.8 KB

DocumentFoldersApi.md

File metadata and controls

360 lines (281 loc) · 12.8 KB

DocumentFoldersApi

All URIs are relative to http://localhost

Method HTTP request Description
addFolder POST /folders Add document folder
deleteFolder DELETE /folders/{indexKey} Delete document folder
getFolderDocuments GET /folders Get document folders
getFolderPermissions GET /folders/{indexKey}/permissions Get folder permissions
setFolderPermissions PUT /folders/permissions Sets Folder Permissions

addFolder

AddFolderResponse addFolder(addFolderRequest, siteId, shareKey)

Add document folder

Creates a new folder

Example

// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.DocumentFoldersApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    DocumentFoldersApi apiInstance = new DocumentFoldersApi(defaultClient);
    AddFolderRequest addFolderRequest = new AddFolderRequest(); // AddFolderRequest | 
    String siteId = "siteId_example"; // String | Site Identifier
    String shareKey = "shareKey_example"; // String | Share Identifier
    try {
      AddFolderResponse result = apiInstance.addFolder(addFolderRequest, siteId, shareKey);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentFoldersApi#addFolder");
      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
addFolderRequest AddFolderRequest
siteId String Site Identifier [optional]
shareKey String Share Identifier [optional]

Return type

AddFolderResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 201 CREATED * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -

deleteFolder

DeleteFolderResponse deleteFolder(indexKey, siteId, shareKey)

Delete document folder

Delete a specific folder; folder must be empty

Example

// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.DocumentFoldersApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    DocumentFoldersApi apiInstance = new DocumentFoldersApi(defaultClient);
    String indexKey = "indexKey_example"; // String | Index Key Identifier
    String siteId = "siteId_example"; // String | Site Identifier
    String shareKey = "shareKey_example"; // String | Share Identifier
    try {
      DeleteFolderResponse result = apiInstance.deleteFolder(indexKey, siteId, shareKey);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentFoldersApi#deleteFolder");
      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
indexKey String Index Key Identifier
siteId String Site Identifier [optional]
shareKey String Share Identifier [optional]

Return type

DeleteFolderResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 200 OK * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -

getFolderDocuments

GetFoldersResponse getFolderDocuments(siteId, indexKey, path, limit, shareKey, next)

Get document folders

Get list of documents in a folder

Example

// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.DocumentFoldersApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    DocumentFoldersApi apiInstance = new DocumentFoldersApi(defaultClient);
    String siteId = "siteId_example"; // String | Site Identifier
    String indexKey = "indexKey_example"; // String | Index Key Identifier
    String path = "path_example"; // String | Path query parameter (must be URL Encoded)
    String limit = "10"; // String | Limit Results
    String shareKey = "shareKey_example"; // String | Share Identifier
    String next = "next_example"; // String | Next page of results token
    try {
      GetFoldersResponse result = apiInstance.getFolderDocuments(siteId, indexKey, path, limit, shareKey, next);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentFoldersApi#getFolderDocuments");
      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
siteId String Site Identifier [optional]
indexKey String Index Key Identifier [optional]
path String Path query parameter (must be URL Encoded) [optional]
limit String Limit Results [optional] [default to 10]
shareKey String Share Identifier [optional]
next String Next page of results token [optional]

Return type

GetFoldersResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 200 OK * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -

getFolderPermissions

GetFolderPermissionsResponse getFolderPermissions(indexKey, siteId)

Get folder permissions

Get list of permissions for a folder

Example

// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.DocumentFoldersApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    DocumentFoldersApi apiInstance = new DocumentFoldersApi(defaultClient);
    String indexKey = "indexKey_example"; // String | Index Key Identifier
    String siteId = "siteId_example"; // String | Site Identifier
    try {
      GetFolderPermissionsResponse result = apiInstance.getFolderPermissions(indexKey, siteId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentFoldersApi#getFolderPermissions");
      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
indexKey String Index Key Identifier
siteId String Site Identifier [optional]

Return type

GetFolderPermissionsResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 200 OK * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -

setFolderPermissions

SetResponse setFolderPermissions(setFolderPermissionsRequest, siteId)

Sets Folder Permissions

Sets a folders permissions NOTE: Can only be called be ADMIN or GOVERN.

Example

// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.DocumentFoldersApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    DocumentFoldersApi apiInstance = new DocumentFoldersApi(defaultClient);
    SetFolderPermissionsRequest setFolderPermissionsRequest = new SetFolderPermissionsRequest(); // SetFolderPermissionsRequest | 
    String siteId = "siteId_example"; // String | Site Identifier
    try {
      SetResponse result = apiInstance.setFolderPermissions(setFolderPermissionsRequest, siteId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentFoldersApi#setFolderPermissions");
      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
setFolderPermissionsRequest SetFolderPermissionsRequest
siteId String Site Identifier [optional]

Return type

SetResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 200 OK * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -