formkiq_client.DocumentsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
add_document	POST /documents	Add new document
add_document_upload	POST /documents/upload	Add large document
compress_documents	POST /documents/compress	Compress multiple documents into a .zip file
delete_document	DELETE /documents/{documentId}	Delete document
delete_published_document_content	DELETE /publications/{documentId}	Delete published document's contents
get_document	GET /documents/{documentId}	Get document
get_document_content	GET /documents/{documentId}/content	Get document's contents
get_document_id_upload	GET /documents/{documentId}/upload	Get url to update large document
get_document_syncs	GET /documents/{documentId}/syncs	Get document syncs
get_document_upload	GET /documents/upload	Get url to add large document
get_document_url	GET /documents/{documentId}/url	Get document content url
get_documents	GET /documents	Get Documents listing
get_published_document_content	GET /publications/{documentId}	Get published document's contents
set_document_restore	PUT /documents/{documentId}/restore	Restore soft deleted document
update_document	PATCH /documents/{documentId}	Update document

add_document

AddDocumentResponse add_document(add_document_request, site_id=site_id, share_key=share_key)

Add new document

Creates a new document; body may include document content if less than 5 MB See POST /documents/{documentId}/tags for adding tags to document schema See POST /documents/{documentId}/actions for adding actions to document schema

Example

import formkiq_client
from formkiq_client.models.add_document_request import AddDocumentRequest
from formkiq_client.models.add_document_response import AddDocumentResponse
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.DocumentsApi(api_client)
    add_document_request = {"path":"test.txt","contentType":"text/plain","isBase64":false,"content":"This is sample data file","tags":[{"key":"category","value":"sample"},{"key":"players","values":["111","222"]}],"metadata":[{"key":"info","value":"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."}]} # AddDocumentRequest | 
    site_id = 'site_id_example' # str | Site Identifier (optional)
    share_key = 'share_key_example' # str | Share Identifier (optional)

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

Parameters

Name	Type	Description	Notes
add_document_request	AddDocumentRequest
site_id	str	Site Identifier	[optional]
share_key	str	Share Identifier	[optional]

Return type

AddDocumentResponse

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 -
400	400 OK	-

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

add_document_upload

GetDocumentUrlResponse add_document_upload(add_document_upload_request, site_id=site_id, content_length=content_length, duration=duration, share_key=share_key)

Add large document

Returns a URL that can be used to upload document content and create a new document, while allowing metadata to also be sent; this endpoint (whether GET or POST) is required in order to add content that is larger than 5 MB

Example

import formkiq_client
from formkiq_client.models.add_document_upload_request import AddDocumentUploadRequest
from formkiq_client.models.get_document_url_response import GetDocumentUrlResponse
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.DocumentsApi(api_client)
    add_document_upload_request = {"path":"test.txt","contentType":"text/plain","tags":[{"key":"category","value":"sample"},{"key":"players","values":["111","222"]}],"metadata":[{"key":"info","value":"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."}]} # AddDocumentUploadRequest | 
    site_id = 'site_id_example' # str | Site Identifier (optional)
    content_length = 56 # int | Indicates the size of the entity-body (optional)
    duration = 56 # int | Indicates the number of hours request is valid for (optional)
    share_key = 'share_key_example' # str | Share Identifier (optional)

    try:
        # Add large document
        api_response = api_instance.add_document_upload(add_document_upload_request, site_id=site_id, content_length=content_length, duration=duration, share_key=share_key)
        print("The response of DocumentsApi->add_document_upload:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentsApi->add_document_upload: %s\n" % e)

Parameters

Name	Type	Description	Notes
add_document_upload_request	AddDocumentUploadRequest
site_id	str	Site Identifier	[optional]
content_length	int	Indicates the size of the entity-body	[optional]
duration	int	Indicates the number of hours request is valid for	[optional]
share_key	str	Share Identifier	[optional]

Return type

GetDocumentUrlResponse

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]

compress_documents

DocumentsCompressResponse compress_documents(documents_compress_request, site_id=site_id)

Compress multiple documents into a .zip file

Compress documents into an .ZIP archive file, and returns a S3 presigned url for the location of the archive file. The operation is async and processing time depends on the number and size of documents included; a 404 status code is returned until the file is ready.

Example

import formkiq_client
from formkiq_client.models.documents_compress_request import DocumentsCompressRequest
from formkiq_client.models.documents_compress_response import DocumentsCompressResponse
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.DocumentsApi(api_client)
    documents_compress_request = formkiq_client.DocumentsCompressRequest() # DocumentsCompressRequest | 
    site_id = 'site_id_example' # str | Site Identifier (optional)

    try:
        # Compress multiple documents into a .zip file
        api_response = api_instance.compress_documents(documents_compress_request, site_id=site_id)
        print("The response of DocumentsApi->compress_documents:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentsApi->compress_documents: %s\n" % e)

Parameters

Name	Type	Description	Notes
documents_compress_request	DocumentsCompressRequest
site_id	str	Site Identifier	[optional]

Return type

DocumentsCompressResponse

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_document

DeleteResponse delete_document(document_id, site_id=site_id, soft_delete=soft_delete)

Delete document

Delete a document's details, i.e., metadata, contents, etc SoftDelete: The SoftDelete parameter allows for the temporary removal of a document's metadata, attributes, etc from being retrieved from all API requests. The document can be permanently deleted by calling the DELETE /documents/{documentId} with softDelete=false or restored using the PUT /documents/{documentId}/restore. Only the GET /documents?deleted=true will return all the soft deleted documents.

Example

import formkiq_client
from formkiq_client.models.delete_response import DeleteResponse
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.DocumentsApi(api_client)
    document_id = 'document_id_example' # str | Document Identifier
    site_id = 'site_id_example' # str | Site Identifier (optional)
    soft_delete = True # bool | Whether to soft delete document (optional)

    try:
        # Delete document
        api_response = api_instance.delete_document(document_id, site_id=site_id, soft_delete=soft_delete)
        print("The response of DocumentsApi->delete_document:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentsApi->delete_document: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	Document Identifier
site_id	str	Site Identifier	[optional]
soft_delete	bool	Whether to soft delete document	[optional]

Return type

DeleteResponse

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]

delete_published_document_content

DeleteResponse delete_published_document_content(document_id, site_id=site_id)

Delete published document's contents

Delete a published document's contents. Certain content types, text/*, application/json, and application/x-www-form-urlencoded. return the "content" field, while all other content types return a 'contentUrl' for retrieving the content.

Example

import formkiq_client
from formkiq_client.models.delete_response import DeleteResponse
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.DocumentsApi(api_client)
    document_id = 'document_id_example' # str | Document Identifier
    site_id = 'site_id_example' # str | Site Identifier (optional)

    try:
        # Delete published document's contents
        api_response = api_instance.delete_published_document_content(document_id, site_id=site_id)
        print("The response of DocumentsApi->delete_published_document_content:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentsApi->delete_published_document_content: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	Document Identifier
site_id	str	Site Identifier	[optional]

Return type

DeleteResponse

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_document

GetDocumentResponse get_document(document_id, site_id=site_id, share_key=share_key)

Get document

Retrieves a document's details, i.e., metadata

Example

import formkiq_client
from formkiq_client.models.get_document_response import GetDocumentResponse
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.DocumentsApi(api_client)
    document_id = 'document_id_example' # str | Document Identifier
    site_id = 'site_id_example' # str | Site Identifier (optional)
    share_key = 'share_key_example' # str | Share Identifier (optional)

    try:
        # Get document
        api_response = api_instance.get_document(document_id, site_id=site_id, share_key=share_key)
        print("The response of DocumentsApi->get_document:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentsApi->get_document: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	Document Identifier
site_id	str	Site Identifier	[optional]
share_key	str	Share Identifier	[optional]

Return type

GetDocumentResponse

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_document_content

GetDocumentContentResponse get_document_content(document_id, site_id=site_id, version_key=version_key, share_key=share_key)

Get document's contents

Retrieves the content of the document with the specified documentId. - If the content is plain text and under 6 MB, the content will be returned directly. - If the content is plain text but exceeds 6 MB, an error will be returned. - For documents not in plain text format, pre-signed S3 URLs will be returned to download the content from S3. It is recommended to use the /documents/{documentId}/url endpoint to retrieve pre-signed S3 URLs for downloading the content.

Example

import formkiq_client
from formkiq_client.models.get_document_content_response import GetDocumentContentResponse
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.DocumentsApi(api_client)
    document_id = 'document_id_example' # str | Document Identifier
    site_id = 'site_id_example' # str | Site Identifier (optional)
    version_key = 'version_key_example' # str | Version Key (version key required URL encoding) (optional)
    share_key = 'share_key_example' # str | Share Identifier (optional)

    try:
        # Get document's contents
        api_response = api_instance.get_document_content(document_id, site_id=site_id, version_key=version_key, share_key=share_key)
        print("The response of DocumentsApi->get_document_content:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentsApi->get_document_content: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	Document Identifier
site_id	str	Site Identifier	[optional]
version_key	str	Version Key (version key required URL encoding)	[optional]
share_key	str	Share Identifier	[optional]

Return type

GetDocumentContentResponse

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 - * Location -

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

get_document_id_upload

GetDocumentUrlResponse get_document_id_upload(document_id, site_id=site_id, checksum_type=checksum_type, checksum=checksum, content_length=content_length, duration=duration, share_key=share_key)

Get url to update large document

Returns a URL that can be used to upload documents for a specific documentId; this endpoint is required in order to add content that is larger than 5 MB. If versions are enabled, this will create a new version of the document.

Example

import formkiq_client
from formkiq_client.models.get_document_url_response import GetDocumentUrlResponse
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.DocumentsApi(api_client)
    document_id = 'document_id_example' # str | Document Identifier
    site_id = 'site_id_example' # str | Site Identifier (optional)
    checksum_type = 'checksum_type_example' # str | Checksum Type (optional)
    checksum = 'checksum_example' # str | Checksum value (optional)
    content_length = 56 # int | Indicates the size of the entity-body (optional)
    duration = 56 # int | Indicates the number of hours request is valid for (optional)
    share_key = 'share_key_example' # str | Share Identifier (optional)

    try:
        # Get url to update large document
        api_response = api_instance.get_document_id_upload(document_id, site_id=site_id, checksum_type=checksum_type, checksum=checksum, content_length=content_length, duration=duration, share_key=share_key)
        print("The response of DocumentsApi->get_document_id_upload:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentsApi->get_document_id_upload: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	Document Identifier
site_id	str	Site Identifier	[optional]
checksum_type	str	Checksum Type	[optional]
checksum	str	Checksum value	[optional]
content_length	int	Indicates the size of the entity-body	[optional]
duration	int	Indicates the number of hours request is valid for	[optional]
share_key	str	Share Identifier	[optional]

Return type

GetDocumentUrlResponse

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_document_syncs

GetDocumentSyncResponse get_document_syncs(document_id, site_id=site_id, limit=limit, share_key=share_key)

Get document syncs

Retrieve the document syncs with external services status

Example

import formkiq_client
from formkiq_client.models.get_document_sync_response import GetDocumentSyncResponse
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.DocumentsApi(api_client)
    document_id = 'document_id_example' # str | Document Identifier
    site_id = 'site_id_example' # str | Site Identifier (optional)
    limit = '10' # str | Limit Results (optional) (default to '10')
    share_key = 'share_key_example' # str | Share Identifier (optional)

    try:
        # Get document syncs
        api_response = api_instance.get_document_syncs(document_id, site_id=site_id, limit=limit, share_key=share_key)
        print("The response of DocumentsApi->get_document_syncs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentsApi->get_document_syncs: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	Document Identifier
site_id	str	Site Identifier	[optional]
limit	str	Limit Results	[optional] [default to '10']
share_key	str	Share Identifier	[optional]

Return type

GetDocumentSyncResponse

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_document_upload

GetDocumentUrlResponse get_document_upload(path=path, site_id=site_id, checksum_type=checksum_type, checksum=checksum, content_length=content_length, duration=duration, share_key=share_key)

Get url to add large document

Returns a URL that can be used to upload document content and create a new document; this endpoint (whether GET or POST) is required in order to add content that is larger than 5 MB

Example

import formkiq_client
from formkiq_client.models.get_document_url_response import GetDocumentUrlResponse
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.DocumentsApi(api_client)
    path = 'path_example' # str | The upload file's path (optional)
    site_id = 'site_id_example' # str | Site Identifier (optional)
    checksum_type = 'checksum_type_example' # str | Checksum Type (optional)
    checksum = 'checksum_example' # str | Checksum value (optional)
    content_length = 56 # int | Indicates the size of the entity-body (optional)
    duration = 56 # int | Indicates the number of hours request is valid for (optional)
    share_key = 'share_key_example' # str | Share Identifier (optional)

    try:
        # Get url to add large document
        api_response = api_instance.get_document_upload(path=path, site_id=site_id, checksum_type=checksum_type, checksum=checksum, content_length=content_length, duration=duration, share_key=share_key)
        print("The response of DocumentsApi->get_document_upload:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentsApi->get_document_upload: %s\n" % e)

Parameters

Name	Type	Description	Notes
path	str	The upload file's path	[optional]
site_id	str	Site Identifier	[optional]
checksum_type	str	Checksum Type	[optional]
checksum	str	Checksum value	[optional]
content_length	int	Indicates the size of the entity-body	[optional]
duration	int	Indicates the number of hours request is valid for	[optional]
share_key	str	Share Identifier	[optional]

Return type

GetDocumentUrlResponse

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_document_url

GetDocumentUrlResponse get_document_url(document_id, site_id=site_id, version_key=version_key, duration=duration, share_key=share_key, inline=inline)

Get document content url

Returns a URL for the document's contents; this URL will expire (the default is 48 hours)

Example

import formkiq_client
from formkiq_client.models.get_document_url_response import GetDocumentUrlResponse
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.DocumentsApi(api_client)
    document_id = 'document_id_example' # str | Document Identifier
    site_id = 'site_id_example' # str | Site Identifier (optional)
    version_key = 'version_key_example' # str | Version Key (version key required URL encoding) (optional)
    duration = 56 # int | Indicates the number of hours request is valid for (optional)
    share_key = 'share_key_example' # str | Share Identifier (optional)
    inline = False # bool | Set the Content-Disposition to inline (optional) (default to False)

    try:
        # Get document content url
        api_response = api_instance.get_document_url(document_id, site_id=site_id, version_key=version_key, duration=duration, share_key=share_key, inline=inline)
        print("The response of DocumentsApi->get_document_url:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentsApi->get_document_url: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	Document Identifier
site_id	str	Site Identifier	[optional]
version_key	str	Version Key (version key required URL encoding)	[optional]
duration	int	Indicates the number of hours request is valid for	[optional]
share_key	str	Share Identifier	[optional]
inline	bool	Set the Content-Disposition to inline	[optional] [default to False]

Return type

GetDocumentUrlResponse

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_documents

GetDocumentsResponse get_documents(site_id=site_id, action_status=action_status, deleted=deleted, var_date=var_date, tz=tz, next=next, previous=previous, limit=limit)

Get Documents listing

Returns a list of the most recent documents added, ordered by inserted, descending

Example

import formkiq_client
from formkiq_client.models.get_documents_response import GetDocumentsResponse
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.DocumentsApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier (optional)
    action_status = 'action_status_example' # str | Fetch documents with an action status (optional)
    deleted = True # bool | Fetch soft deleted documents (optional)
    var_date = 'var_date_example' # str | Fetch documents inserted on a certain date (yyyy-MM-dd) (optional)
    tz = 'tz_example' # str | UTC offset to apply to date parameter (IE: -0600) (optional)
    next = 'next_example' # str | Next page of results token (optional)
    previous = 'previous_example' # str | Previous page of results token (optional)
    limit = '10' # str | Limit Results (optional) (default to '10')

    try:
        # Get Documents listing
        api_response = api_instance.get_documents(site_id=site_id, action_status=action_status, deleted=deleted, var_date=var_date, tz=tz, next=next, previous=previous, limit=limit)
        print("The response of DocumentsApi->get_documents:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentsApi->get_documents: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier	[optional]
action_status	str	Fetch documents with an action status	[optional]
deleted	bool	Fetch soft deleted documents	[optional]
var_date	str	Fetch documents inserted on a certain date (yyyy-MM-dd)	[optional]
tz	str	UTC offset to apply to date parameter (IE: -0600)	[optional]
next	str	Next page of results token	[optional]
previous	str	Previous page of results token	[optional]
limit	str	Limit Results	[optional] [default to '10']

Return type

GetDocumentsResponse

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_published_document_content

get_published_document_content(document_id, site_id=site_id)

Get published document's contents

Get a published document's contents. Certain content types, text/*, application/json, and application/x-www-form-urlencoded. return the "content" field, while all other content types return a 'contentUrl' for retrieving the content.

Example

import formkiq_client
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.DocumentsApi(api_client)
    document_id = 'document_id_example' # str | Document Identifier
    site_id = 'site_id_example' # str | Site Identifier (optional)

    try:
        # Get published document's contents
        api_instance.get_published_document_content(document_id, site_id=site_id)
    except Exception as e:
        print("Exception when calling DocumentsApi->get_published_document_content: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	Document Identifier
site_id	str	Site Identifier	[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
307	Temporary Redirect	* Location -

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

set_document_restore

SetDocumentRestoreResponse set_document_restore(document_id, site_id=site_id)

Restore soft deleted document

Restores a soft deleted document

Example

import formkiq_client
from formkiq_client.models.set_document_restore_response import SetDocumentRestoreResponse
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.DocumentsApi(api_client)
    document_id = 'document_id_example' # str | Document Identifier
    site_id = 'site_id_example' # str | Site Identifier (optional)

    try:
        # Restore soft deleted document
        api_response = api_instance.set_document_restore(document_id, site_id=site_id)
        print("The response of DocumentsApi->set_document_restore:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentsApi->set_document_restore: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	Document Identifier
site_id	str	Site Identifier	[optional]

Return type

SetDocumentRestoreResponse

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]

update_document

AddDocumentResponse update_document(document_id, update_document_request, site_id=site_id, share_key=share_key)

Update document

Update a document's details, i.e., metadata If no content is specified, the endpoint will return a S3 Presigned that will allow for the uploading of Large document data. NOTE: - provided attributes will overwrite existing matching attribute keys in the document. Attributes not included in the request body will remain unchanged.

Example

import formkiq_client
from formkiq_client.models.add_document_response import AddDocumentResponse
from formkiq_client.models.update_document_request import UpdateDocumentRequest
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.DocumentsApi(api_client)
    document_id = 'document_id_example' # str | Document Identifier
    update_document_request = {"path":"test.txt","contentType":"text/plain","isBase64":false,"content":"This is sample data file","tags":[{"key":"category","value":"sample"},{"key":"players","values":["111","222"]}],"metadata":[{"key":"info","value":"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."}]} # UpdateDocumentRequest | 
    site_id = 'site_id_example' # str | Site Identifier (optional)
    share_key = 'share_key_example' # str | Share Identifier (optional)

    try:
        # Update document
        api_response = api_instance.update_document(document_id, update_document_request, site_id=site_id, share_key=share_key)
        print("The response of DocumentsApi->update_document:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentsApi->update_document: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	Document Identifier
update_document_request	UpdateDocumentRequest
site_id	str	Site Identifier	[optional]
share_key	str	Share Identifier	[optional]

Return type

AddDocumentResponse

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 -
400	400 OK	-

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

Files

DocumentsApi.md

Latest commit

History

DocumentsApi.md

File metadata and controls

formkiq_client.DocumentsApi

add_document

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

add_document_upload

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

compress_documents

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_document

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_published_document_content

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_document

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_document_content

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_document_id_upload

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_document_syncs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_document_upload

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_document_url

Example

Parameters