eZmaxApi.ObjectEzsigntemplatepublicApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Method	HTTP request	Description
ezsigntemplatepublic_create_ezsignfolder_v1	POST /1/object/ezsigntemplatepublic/createEzsignfolder	Create an Ezsignfolder
ezsigntemplatepublic_create_object_v1	POST /1/object/ezsigntemplatepublic	Create a new Ezsigntemplatepublic
ezsigntemplatepublic_delete_object_v1	DELETE /1/object/ezsigntemplatepublic/{pkiEzsigntemplatepublicID}	Delete an existing Ezsigntemplatepublic
ezsigntemplatepublic_edit_object_v1	PUT /1/object/ezsigntemplatepublic/{pkiEzsigntemplatepublicID}	Edit an existing Ezsigntemplatepublic
ezsigntemplatepublic_get_ezsigntemplatepublic_details_v1	POST /1/object/ezsigntemplatepublic/getEzsigntemplatepublicDetails	Retrieve the Ezsigntemplatepublic details
ezsigntemplatepublic_get_forms_data_v1	GET /1/object/ezsigntemplatepublic/{pkiEzsigntemplatepublicID}/getFormsData	Retrieve an existing Ezsigntemplatepublic's forms data
ezsigntemplatepublic_get_list_v1	GET /1/object/ezsigntemplatepublic/getList	Retrieve Ezsigntemplatepublic list
ezsigntemplatepublic_get_object_v2	GET /2/object/ezsigntemplatepublic/{pkiEzsigntemplatepublicID}	Retrieve an existing Ezsigntemplatepublic
ezsigntemplatepublic_reset_limit_exceeded_counter_v1	POST /1/object/ezsigntemplatepublic/{pkiEzsigntemplatepublicID}/resetLimitExceededCounter	Reset the limit exceeded counter
ezsigntemplatepublic_reset_url_v1	POST /1/object/ezsigntemplatepublic/{pkiEzsigntemplatepublicID}/resetUrl	Reset the Ezsigntemplatepublic url

ezsigntemplatepublic_create_ezsignfolder_v1

EzsigntemplatepublicCreateEzsignfolderV1Response ezsigntemplatepublic_create_ezsignfolder_v1(ezsigntemplatepublic_create_ezsignfolder_v1_request)

Create an Ezsignfolder

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsigntemplatepublic_create_ezsignfolder_v1_request import EzsigntemplatepublicCreateEzsignfolderV1Request
from eZmaxApi.models.ezsigntemplatepublic_create_ezsignfolder_v1_response import EzsigntemplatepublicCreateEzsignfolderV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# 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.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsigntemplatepublicApi(api_client)
    ezsigntemplatepublic_create_ezsignfolder_v1_request = eZmaxApi.EzsigntemplatepublicCreateEzsignfolderV1Request() # EzsigntemplatepublicCreateEzsignfolderV1Request | 

    try:
        # Create an Ezsignfolder
        api_response = api_instance.ezsigntemplatepublic_create_ezsignfolder_v1(ezsigntemplatepublic_create_ezsignfolder_v1_request)
        print("The response of ObjectEzsigntemplatepublicApi->ezsigntemplatepublic_create_ezsignfolder_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsigntemplatepublicApi->ezsigntemplatepublic_create_ezsignfolder_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
ezsigntemplatepublic_create_ezsignfolder_v1_request	EzsigntemplatepublicCreateEzsignfolderV1Request

Return type

EzsigntemplatepublicCreateEzsignfolderV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

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

ezsigntemplatepublic_create_object_v1

EzsigntemplatepublicCreateObjectV1Response ezsigntemplatepublic_create_object_v1(ezsigntemplatepublic_create_object_v1_request)

Create a new Ezsigntemplatepublic

The endpoint allows to create one or many elements at once.

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsigntemplatepublic_create_object_v1_request import EzsigntemplatepublicCreateObjectV1Request
from eZmaxApi.models.ezsigntemplatepublic_create_object_v1_response import EzsigntemplatepublicCreateObjectV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# 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.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsigntemplatepublicApi(api_client)
    ezsigntemplatepublic_create_object_v1_request = eZmaxApi.EzsigntemplatepublicCreateObjectV1Request() # EzsigntemplatepublicCreateObjectV1Request | 

    try:
        # Create a new Ezsigntemplatepublic
        api_response = api_instance.ezsigntemplatepublic_create_object_v1(ezsigntemplatepublic_create_object_v1_request)
        print("The response of ObjectEzsigntemplatepublicApi->ezsigntemplatepublic_create_object_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsigntemplatepublicApi->ezsigntemplatepublic_create_object_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
ezsigntemplatepublic_create_object_v1_request	EzsigntemplatepublicCreateObjectV1Request

Return type

EzsigntemplatepublicCreateObjectV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Successful response	-

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

ezsigntemplatepublic_delete_object_v1

EzsigntemplatepublicDeleteObjectV1Response ezsigntemplatepublic_delete_object_v1(pki_ezsigntemplatepublic_id)

Delete an existing Ezsigntemplatepublic

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsigntemplatepublic_delete_object_v1_response import EzsigntemplatepublicDeleteObjectV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# 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.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsigntemplatepublicApi(api_client)
    pki_ezsigntemplatepublic_id = 56 # int | The unique ID of the Ezsigntemplatepublic

    try:
        # Delete an existing Ezsigntemplatepublic
        api_response = api_instance.ezsigntemplatepublic_delete_object_v1(pki_ezsigntemplatepublic_id)
        print("The response of ObjectEzsigntemplatepublicApi->ezsigntemplatepublic_delete_object_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsigntemplatepublicApi->ezsigntemplatepublic_delete_object_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsigntemplatepublic_id	int	The unique ID of the Ezsigntemplatepublic

Return type

EzsigntemplatepublicDeleteObjectV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

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

ezsigntemplatepublic_edit_object_v1

EzsigntemplatepublicEditObjectV1Response ezsigntemplatepublic_edit_object_v1(pki_ezsigntemplatepublic_id, ezsigntemplatepublic_edit_object_v1_request)

Edit an existing Ezsigntemplatepublic

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsigntemplatepublic_edit_object_v1_request import EzsigntemplatepublicEditObjectV1Request
from eZmaxApi.models.ezsigntemplatepublic_edit_object_v1_response import EzsigntemplatepublicEditObjectV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# 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.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsigntemplatepublicApi(api_client)
    pki_ezsigntemplatepublic_id = 56 # int | The unique ID of the Ezsigntemplatepublic
    ezsigntemplatepublic_edit_object_v1_request = eZmaxApi.EzsigntemplatepublicEditObjectV1Request() # EzsigntemplatepublicEditObjectV1Request | 

    try:
        # Edit an existing Ezsigntemplatepublic
        api_response = api_instance.ezsigntemplatepublic_edit_object_v1(pki_ezsigntemplatepublic_id, ezsigntemplatepublic_edit_object_v1_request)
        print("The response of ObjectEzsigntemplatepublicApi->ezsigntemplatepublic_edit_object_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsigntemplatepublicApi->ezsigntemplatepublic_edit_object_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsigntemplatepublic_id	int	The unique ID of the Ezsigntemplatepublic
ezsigntemplatepublic_edit_object_v1_request	EzsigntemplatepublicEditObjectV1Request

Return type

EzsigntemplatepublicEditObjectV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

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

ezsigntemplatepublic_get_ezsigntemplatepublic_details_v1

EzsigntemplatepublicGetEzsigntemplatepublicDetailsV1Response ezsigntemplatepublic_get_ezsigntemplatepublic_details_v1(ezsigntemplatepublic_get_ezsigntemplatepublic_details_v1_request)

Retrieve the Ezsigntemplatepublic details

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsigntemplatepublic_get_ezsigntemplatepublic_details_v1_request import EzsigntemplatepublicGetEzsigntemplatepublicDetailsV1Request
from eZmaxApi.models.ezsigntemplatepublic_get_ezsigntemplatepublic_details_v1_response import EzsigntemplatepublicGetEzsigntemplatepublicDetailsV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# 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.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsigntemplatepublicApi(api_client)
    ezsigntemplatepublic_get_ezsigntemplatepublic_details_v1_request = eZmaxApi.EzsigntemplatepublicGetEzsigntemplatepublicDetailsV1Request() # EzsigntemplatepublicGetEzsigntemplatepublicDetailsV1Request | 

    try:
        # Retrieve the Ezsigntemplatepublic details
        api_response = api_instance.ezsigntemplatepublic_get_ezsigntemplatepublic_details_v1(ezsigntemplatepublic_get_ezsigntemplatepublic_details_v1_request)
        print("The response of ObjectEzsigntemplatepublicApi->ezsigntemplatepublic_get_ezsigntemplatepublic_details_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsigntemplatepublicApi->ezsigntemplatepublic_get_ezsigntemplatepublic_details_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
ezsigntemplatepublic_get_ezsigntemplatepublic_details_v1_request	EzsigntemplatepublicGetEzsigntemplatepublicDetailsV1Request

Return type

EzsigntemplatepublicGetEzsigntemplatepublicDetailsV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

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

ezsigntemplatepublic_get_forms_data_v1

EzsigntemplatepublicGetFormsDataV1Response ezsigntemplatepublic_get_forms_data_v1(pki_ezsigntemplatepublic_id)

Retrieve an existing Ezsigntemplatepublic's forms data

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsigntemplatepublic_get_forms_data_v1_response import EzsigntemplatepublicGetFormsDataV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# 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.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsigntemplatepublicApi(api_client)
    pki_ezsigntemplatepublic_id = 56 # int | 

    try:
        # Retrieve an existing Ezsigntemplatepublic's forms data
        api_response = api_instance.ezsigntemplatepublic_get_forms_data_v1(pki_ezsigntemplatepublic_id)
        print("The response of ObjectEzsigntemplatepublicApi->ezsigntemplatepublic_get_forms_data_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsigntemplatepublicApi->ezsigntemplatepublic_get_forms_data_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsigntemplatepublic_id	int

Return type

EzsigntemplatepublicGetFormsDataV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/zip

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
406	The URL is valid, but one of the Accept header is not defined or invalid. For example, you set the header "Accept: application/json" but the function can only return "Content-type: image/png"	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

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

ezsigntemplatepublic_get_list_v1

EzsigntemplatepublicGetListV1Response ezsigntemplatepublic_get_list_v1(e_order_by=e_order_by, i_row_max=i_row_max, i_row_offset=i_row_offset, accept_language=accept_language, s_filter=s_filter)

Retrieve Ezsigntemplatepublic list

Enum values that can be filtered in query parameter sFilter:

Variable	Valid values
eEzsigntemplatepublicLimittype	Hour Day Month Total

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsigntemplatepublic_get_list_v1_response import EzsigntemplatepublicGetListV1Response
from eZmaxApi.models.header_accept_language import HeaderAcceptLanguage
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# 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.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsigntemplatepublicApi(api_client)
    e_order_by = 'e_order_by_example' # str | Specify how you want the results to be sorted (optional)
    i_row_max = 56 # int |  (optional)
    i_row_offset = 0 # int |  (optional) (default to 0)
    accept_language = eZmaxApi.HeaderAcceptLanguage() # HeaderAcceptLanguage |  (optional)
    s_filter = 's_filter_example' # str |  (optional)

    try:
        # Retrieve Ezsigntemplatepublic list
        api_response = api_instance.ezsigntemplatepublic_get_list_v1(e_order_by=e_order_by, i_row_max=i_row_max, i_row_offset=i_row_offset, accept_language=accept_language, s_filter=s_filter)
        print("The response of ObjectEzsigntemplatepublicApi->ezsigntemplatepublic_get_list_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsigntemplatepublicApi->ezsigntemplatepublic_get_list_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
e_order_by	str	Specify how you want the results to be sorted	[optional]
i_row_max	int		[optional]
i_row_offset	int		[optional] [default to 0]
accept_language	HeaderAcceptLanguage		[optional]
s_filter	str		[optional]

Return type

EzsigntemplatepublicGetListV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

HTTP response details

Status code	Description	Response headers
200	Successful response	-
406	The URL is valid, but one of the Accept header is not defined or invalid. For example, you set the header "Accept: application/json" but the function can only return "Content-type: image/png"	-

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

ezsigntemplatepublic_get_object_v2

EzsigntemplatepublicGetObjectV2Response ezsigntemplatepublic_get_object_v2(pki_ezsigntemplatepublic_id)

Retrieve an existing Ezsigntemplatepublic

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsigntemplatepublic_get_object_v2_response import EzsigntemplatepublicGetObjectV2Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# 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.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsigntemplatepublicApi(api_client)
    pki_ezsigntemplatepublic_id = 56 # int | The unique ID of the Ezsigntemplatepublic

    try:
        # Retrieve an existing Ezsigntemplatepublic
        api_response = api_instance.ezsigntemplatepublic_get_object_v2(pki_ezsigntemplatepublic_id)
        print("The response of ObjectEzsigntemplatepublicApi->ezsigntemplatepublic_get_object_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsigntemplatepublicApi->ezsigntemplatepublic_get_object_v2: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsigntemplatepublic_id	int	The unique ID of the Ezsigntemplatepublic

Return type

EzsigntemplatepublicGetObjectV2Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

ezsigntemplatepublic_reset_limit_exceeded_counter_v1

EzsigntemplatepublicResetLimitExceededCounterV1Response ezsigntemplatepublic_reset_limit_exceeded_counter_v1(pki_ezsigntemplatepublic_id, body)

Reset the limit exceeded counter

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsigntemplatepublic_reset_limit_exceeded_counter_v1_response import EzsigntemplatepublicResetLimitExceededCounterV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# 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.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsigntemplatepublicApi(api_client)
    pki_ezsigntemplatepublic_id = 56 # int | 
    body = None # object | 

    try:
        # Reset the limit exceeded counter
        api_response = api_instance.ezsigntemplatepublic_reset_limit_exceeded_counter_v1(pki_ezsigntemplatepublic_id, body)
        print("The response of ObjectEzsigntemplatepublicApi->ezsigntemplatepublic_reset_limit_exceeded_counter_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsigntemplatepublicApi->ezsigntemplatepublic_reset_limit_exceeded_counter_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsigntemplatepublic_id	int
body	object

Return type

EzsigntemplatepublicResetLimitExceededCounterV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-

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

ezsigntemplatepublic_reset_url_v1

EzsigntemplatepublicResetUrlV1Response ezsigntemplatepublic_reset_url_v1(pki_ezsigntemplatepublic_id, body)

Reset the Ezsigntemplatepublic url

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsigntemplatepublic_reset_url_v1_response import EzsigntemplatepublicResetUrlV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# 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.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsigntemplatepublicApi(api_client)
    pki_ezsigntemplatepublic_id = 56 # int | 
    body = None # object | 

    try:
        # Reset the Ezsigntemplatepublic url
        api_response = api_instance.ezsigntemplatepublic_reset_url_v1(pki_ezsigntemplatepublic_id, body)
        print("The response of ObjectEzsigntemplatepublicApi->ezsigntemplatepublic_reset_url_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsigntemplatepublicApi->ezsigntemplatepublic_reset_url_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsigntemplatepublic_id	int
body	object

Return type

EzsigntemplatepublicResetUrlV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-

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

Files

ObjectEzsigntemplatepublicApi.md

Latest commit

History

ObjectEzsigntemplatepublicApi.md

File metadata and controls

eZmaxApi.ObjectEzsigntemplatepublicApi

ezsigntemplatepublic_create_ezsignfolder_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsigntemplatepublic_create_object_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsigntemplatepublic_delete_object_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsigntemplatepublic_edit_object_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsigntemplatepublic_get_ezsigntemplatepublic_details_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsigntemplatepublic_get_forms_data_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsigntemplatepublic_get_list_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsigntemplatepublic_get_object_v2

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsigntemplatepublic_reset_limit_exceeded_counter_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsigntemplatepublic_reset_url_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details