Skip to content

Latest commit

 

History

History
156 lines (104 loc) · 4.98 KB

ExamineObjectsApi.md

File metadata and controls

156 lines (104 loc) · 4.98 KB
Raw

formkiq_client.ExamineObjectsApi

All URIs are relative to http://localhost

Method HTTP request Description
get_examine_pdf GET /objects/examine/{id}/pdf Add Examine Pdf
get_examine_pdf_url GET /objects/examine/pdf Add Examine Pdf

get_examine_pdf

GetExaminePdfResponse get_examine_pdf(id, site_id=site_id)

Add Examine Pdf

Get PDF details File must have been uploaded previously using the GET /objects/examine/pdf API.

Example

import formkiq_client
from formkiq_client.models.get_examine_pdf_response import GetExaminePdfResponse
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.ExamineObjectsApi(api_client)
    id = 'id_example' # str | Identifier
    site_id = 'site_id_example' # str | Site Identifier (optional)

    try:
        # Add Examine Pdf
        api_response = api_instance.get_examine_pdf(id, site_id=site_id)
        print("The response of ExamineObjectsApi->get_examine_pdf:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExamineObjectsApi->get_examine_pdf: %s\n" % e)

Parameters

Name Type Description Notes
id str Identifier
site_id str Site Identifier [optional]

Return type

GetExaminePdfResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 201 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_examine_pdf_url

GetExaminePdfUrlResponse get_examine_pdf_url(site_id=site_id)

Add Examine Pdf

Get Signed URL for PDF Object Upload of a document to be examined by calling GET /objects/examine/{id}/pdf

Example

import formkiq_client
from formkiq_client.models.get_examine_pdf_url_response import GetExaminePdfUrlResponse
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.ExamineObjectsApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier (optional)

    try:
        # Add Examine Pdf
        api_response = api_instance.get_examine_pdf_url(site_id=site_id)
        print("The response of ExamineObjectsApi->get_examine_pdf_url:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExamineObjectsApi->get_examine_pdf_url: %s\n" % e)

Parameters

Name Type Description Notes
site_id str Site Identifier [optional]

Return type

GetExaminePdfUrlResponse

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]