formkiq_client.DocumentFoldersApi

All URIs are relative to http://localhost

Method	HTTP request	Description
add_folder	POST /folders	Add document folder
delete_folder	DELETE /folders/{indexKey}	Delete document folder
get_folder_documents	GET /folders	Get document folders
get_folder_permissions	GET /folders/{indexKey}/permissions	Get folder permissions
set_folder_permissions	PUT /folders/permissions	Sets Folder Permissions

add_folder

AddFolderResponse add_folder(add_folder_request, site_id=site_id, share_key=share_key)

Add document folder

Creates a new folder

Example

import formkiq_client
from formkiq_client.models.add_folder_request import AddFolderRequest
from formkiq_client.models.add_folder_response import AddFolderResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.DocumentFoldersApi(api_client)
    add_folder_request = formkiq_client.AddFolderRequest() # AddFolderRequest | 
    site_id = 'site_id_example' # str | Site Identifier (optional)
    share_key = 'share_key_example' # str | Share Identifier (optional)

    try:
        # Add document folder
        api_response = api_instance.add_folder(add_folder_request, site_id=site_id, share_key=share_key)
        print("The response of DocumentFoldersApi->add_folder:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentFoldersApi->add_folder: %s\n" % e)

Parameters

Name	Type	Description	Notes
add_folder_request	AddFolderRequest
site_id	str	Site Identifier	[optional]
share_key	str	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 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_folder

DeleteFolderResponse delete_folder(index_key, site_id=site_id, share_key=share_key)

Delete document folder

Delete a specific folder; folder must be empty

Example

import formkiq_client
from formkiq_client.models.delete_folder_response import DeleteFolderResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.DocumentFoldersApi(api_client)
    index_key = 'index_key_example' # str | Index Key Identifier
    site_id = 'site_id_example' # str | Site Identifier (optional)
    share_key = 'share_key_example' # str | Share Identifier (optional)

    try:
        # Delete document folder
        api_response = api_instance.delete_folder(index_key, site_id=site_id, share_key=share_key)
        print("The response of DocumentFoldersApi->delete_folder:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentFoldersApi->delete_folder: %s\n" % e)

Parameters

Name	Type	Description	Notes
index_key	str	Index Key Identifier
site_id	str	Site Identifier	[optional]
share_key	str	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 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_folder_documents

GetFoldersResponse get_folder_documents(site_id=site_id, index_key=index_key, path=path, limit=limit, share_key=share_key, next=next)

Get document folders

Get list of documents in a folder

Example

import formkiq_client
from formkiq_client.models.get_folders_response import GetFoldersResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.DocumentFoldersApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier (optional)
    index_key = 'index_key_example' # str | Index Key Identifier (optional)
    path = 'path_example' # str | Path query parameter (must be URL Encoded) (optional)
    limit = '10' # str | Limit Results (optional) (default to '10')
    share_key = 'share_key_example' # str | Share Identifier (optional)
    next = 'next_example' # str | Next page of results token (optional)

    try:
        # Get document folders
        api_response = api_instance.get_folder_documents(site_id=site_id, index_key=index_key, path=path, limit=limit, share_key=share_key, next=next)
        print("The response of DocumentFoldersApi->get_folder_documents:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentFoldersApi->get_folder_documents: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier	[optional]
index_key	str	Index Key Identifier	[optional]
path	str	Path query parameter (must be URL Encoded)	[optional]
limit	str	Limit Results	[optional] [default to '10']
share_key	str	Share Identifier	[optional]
next	str	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 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_folder_permissions

GetFolderPermissionsResponse get_folder_permissions(index_key, site_id=site_id)

Get folder permissions

Get list of permissions for a folder

Example

import formkiq_client
from formkiq_client.models.get_folder_permissions_response import GetFolderPermissionsResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.DocumentFoldersApi(api_client)
    index_key = 'index_key_example' # str | Index Key Identifier
    site_id = 'site_id_example' # str | Site Identifier (optional)

    try:
        # Get folder permissions
        api_response = api_instance.get_folder_permissions(index_key, site_id=site_id)
        print("The response of DocumentFoldersApi->get_folder_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentFoldersApi->get_folder_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
index_key	str	Index Key Identifier
site_id	str	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 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_folder_permissions

SetResponse set_folder_permissions(set_folder_permissions_request, site_id=site_id)

Sets Folder Permissions

Sets a folders permissions

NOTE: Can only be called be ADMIN or GOVERN.

Example

import formkiq_client
from formkiq_client.models.set_folder_permissions_request import SetFolderPermissionsRequest
from formkiq_client.models.set_response import SetResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.DocumentFoldersApi(api_client)
    set_folder_permissions_request = formkiq_client.SetFolderPermissionsRequest() # SetFolderPermissionsRequest | 
    site_id = 'site_id_example' # str | Site Identifier (optional)

    try:
        # Sets Folder Permissions
        api_response = api_instance.set_folder_permissions(set_folder_permissions_request, site_id=site_id)
        print("The response of DocumentFoldersApi->set_folder_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentFoldersApi->set_folder_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
set_folder_permissions_request	SetFolderPermissionsRequest
site_id	str	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 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Navigation Menu

Uh oh!

formkiq_client.DocumentFoldersApi

add_folder

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_folder

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_folder_documents

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_folder_permissions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

set_folder_permissions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

Uh oh!

FilesExpand file tree

DocumentFoldersApi.md

Latest commit

History

DocumentFoldersApi.md

File metadata and controls

formkiq_client.DocumentFoldersApi

add_folder

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_folder

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_folder_documents

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_folder_permissions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

set_folder_permissions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details