Skip to content

DocumentGenerationApi.md

Latest commit

 

History

History
176 lines (122 loc) · 7.24 KB

DocumentGenerationApi.md

File metadata and controls

176 lines (122 loc) · 7.24 KB
Raw

formkiq_client.DocumentGenerationApi

All URIs are relative to http://localhost

Method HTTP request Description
add_document_certification POST /documents/{documentId}/certifications Add Document Certification
add_document_generate POST /documents/{documentId}/generate Add Document Generate

add_document_certification

AddDocumentCertificationResponse add_document_certification(document_id, add_document_certification_request, site_id=site_id, artifact_id=artifact_id)

Add Document Certification

Applies one or more certifications (digital signatures) to a document using one or more certificates. Target determines whether a presigned download is returned, a new version is created, or a new document is created. ; available as an Add-On Module

Example

import formkiq_client
from formkiq_client.models.add_document_certification_request import AddDocumentCertificationRequest
from formkiq_client.models.add_document_certification_response import AddDocumentCertificationResponse
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.DocumentGenerationApi(api_client)
    document_id = 'document_id_example' # str | Document Identifier
    add_document_certification_request = formkiq_client.AddDocumentCertificationRequest() # AddDocumentCertificationRequest | 
    site_id = 'site_id_example' # str | Site Identifier (optional)
    artifact_id = 'artifact_id_example' # str | Artifact Document Identifier (optional)

    try:
        # Add Document Certification
        api_response = api_instance.add_document_certification(document_id, add_document_certification_request, site_id=site_id, artifact_id=artifact_id)
        print("The response of DocumentGenerationApi->add_document_certification:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentGenerationApi->add_document_certification: %s\n" % e)

Parameters

Name Type Description Notes
document_id str Document Identifier
add_document_certification_request AddDocumentCertificationRequest
site_id str Site Identifier [optional]
artifact_id str Artifact Document Identifier [optional]

Return type

AddDocumentCertificationResponse

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 BAD REQUEST -

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

add_document_generate

AddDocumentGenerateResponse add_document_generate(document_id, add_document_generate_request, site_id=site_id, artifact_id=artifact_id)

Add Document Generate

Generates a new document using a specified template file and data sources. This operation allows users to merge data from multiple documents into a template to create a new document in the desired output format (e.g., DOCX).

By Default data source must include a data object, which contains key-value pairs that will be merged into the template. The value can be any valid JSON object. { "data":{}}. The data path can be adjusted via the "dataRoot" field.

; available as an Add-On Module

Example

import formkiq_client
from formkiq_client.models.add_document_generate_request import AddDocumentGenerateRequest
from formkiq_client.models.add_document_generate_response import AddDocumentGenerateResponse
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.DocumentGenerationApi(api_client)
    document_id = 'document_id_example' # str | Document Identifier
    add_document_generate_request = formkiq_client.AddDocumentGenerateRequest() # AddDocumentGenerateRequest | 
    site_id = 'site_id_example' # str | Site Identifier (optional)
    artifact_id = 'artifact_id_example' # str | Artifact Document Identifier (optional)

    try:
        # Add Document Generate
        api_response = api_instance.add_document_generate(document_id, add_document_generate_request, site_id=site_id, artifact_id=artifact_id)
        print("The response of DocumentGenerationApi->add_document_generate:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentGenerationApi->add_document_generate: %s\n" % e)

Parameters

Name Type Description Notes
document_id str Document Identifier
add_document_generate_request AddDocumentGenerateRequest
site_id str Site Identifier [optional]
artifact_id str Artifact Document Identifier [optional]

Return type

AddDocumentGenerateResponse

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]