All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
Method | HTTP request | Description |
---|---|---|
ezsignfoldertype_create_object_v2 | POST /2/object/ezsignfoldertype | Create a new Ezsignfoldertype |
ezsignfoldertype_edit_object_v1 | PUT /1/object/ezsignfoldertype/{pkiEzsignfoldertypeID} | Edit an existing Ezsignfoldertype |
ezsignfoldertype_edit_object_v2 | PUT /2/object/ezsignfoldertype/{pkiEzsignfoldertypeID} | Edit an existing Ezsignfoldertype |
ezsignfoldertype_get_autocomplete_v2 | GET /2/object/ezsignfoldertype/getAutocomplete/{sSelector} | Retrieve Ezsignfoldertypes and IDs |
ezsignfoldertype_get_list_v1 | GET /1/object/ezsignfoldertype/getList | Retrieve Ezsignfoldertype list |
ezsignfoldertype_get_object_v2 | GET /2/object/ezsignfoldertype/{pkiEzsignfoldertypeID} | Retrieve an existing Ezsignfoldertype |
ezsignfoldertype_get_object_v3 | GET /3/object/ezsignfoldertype/{pkiEzsignfoldertypeID} | Retrieve an existing Ezsignfoldertype |
EzsignfoldertypeCreateObjectV2Response ezsignfoldertype_create_object_v2(ezsignfoldertype_create_object_v2_request)
Create a new Ezsignfoldertype
The endpoint allows to create one or many elements at once.
- Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.ezsignfoldertype_create_object_v2_request import EzsignfoldertypeCreateObjectV2Request
from eZmaxApi.models.ezsignfoldertype_create_object_v2_response import EzsignfoldertypeCreateObjectV2Response
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.ObjectEzsignfoldertypeApi(api_client)
ezsignfoldertype_create_object_v2_request = eZmaxApi.EzsignfoldertypeCreateObjectV2Request() # EzsignfoldertypeCreateObjectV2Request |
try:
# Create a new Ezsignfoldertype
api_response = api_instance.ezsignfoldertype_create_object_v2(ezsignfoldertype_create_object_v2_request)
print("The response of ObjectEzsignfoldertypeApi->ezsignfoldertype_create_object_v2:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ObjectEzsignfoldertypeApi->ezsignfoldertype_create_object_v2: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
ezsignfoldertype_create_object_v2_request | EzsignfoldertypeCreateObjectV2Request |
EzsignfoldertypeCreateObjectV2Response
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
201 | Successful response | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EzsignfoldertypeEditObjectV1Response ezsignfoldertype_edit_object_v1(pki_ezsignfoldertype_id, ezsignfoldertype_edit_object_v1_request)
Edit an existing Ezsignfoldertype
- Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.ezsignfoldertype_edit_object_v1_request import EzsignfoldertypeEditObjectV1Request
from eZmaxApi.models.ezsignfoldertype_edit_object_v1_response import EzsignfoldertypeEditObjectV1Response
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.ObjectEzsignfoldertypeApi(api_client)
pki_ezsignfoldertype_id = 56 # int |
ezsignfoldertype_edit_object_v1_request = eZmaxApi.EzsignfoldertypeEditObjectV1Request() # EzsignfoldertypeEditObjectV1Request |
try:
# Edit an existing Ezsignfoldertype
api_response = api_instance.ezsignfoldertype_edit_object_v1(pki_ezsignfoldertype_id, ezsignfoldertype_edit_object_v1_request)
print("The response of ObjectEzsignfoldertypeApi->ezsignfoldertype_edit_object_v1:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ObjectEzsignfoldertypeApi->ezsignfoldertype_edit_object_v1: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
pki_ezsignfoldertype_id | int | ||
ezsignfoldertype_edit_object_v1_request | EzsignfoldertypeEditObjectV1Request |
EzsignfoldertypeEditObjectV1Response
- Content-Type: application/json
- Accept: application/json
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]
EzsignfoldertypeEditObjectV2Response ezsignfoldertype_edit_object_v2(pki_ezsignfoldertype_id, ezsignfoldertype_edit_object_v2_request)
Edit an existing Ezsignfoldertype
- Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.ezsignfoldertype_edit_object_v2_request import EzsignfoldertypeEditObjectV2Request
from eZmaxApi.models.ezsignfoldertype_edit_object_v2_response import EzsignfoldertypeEditObjectV2Response
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.ObjectEzsignfoldertypeApi(api_client)
pki_ezsignfoldertype_id = 56 # int |
ezsignfoldertype_edit_object_v2_request = eZmaxApi.EzsignfoldertypeEditObjectV2Request() # EzsignfoldertypeEditObjectV2Request |
try:
# Edit an existing Ezsignfoldertype
api_response = api_instance.ezsignfoldertype_edit_object_v2(pki_ezsignfoldertype_id, ezsignfoldertype_edit_object_v2_request)
print("The response of ObjectEzsignfoldertypeApi->ezsignfoldertype_edit_object_v2:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ObjectEzsignfoldertypeApi->ezsignfoldertype_edit_object_v2: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
pki_ezsignfoldertype_id | int | ||
ezsignfoldertype_edit_object_v2_request | EzsignfoldertypeEditObjectV2Request |
EzsignfoldertypeEditObjectV2Response
- Content-Type: application/json
- Accept: application/json
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]
EzsignfoldertypeGetAutocompleteV2Response ezsignfoldertype_get_autocomplete_v2(s_selector, e_filter_active=e_filter_active, s_query=s_query, accept_language=accept_language)
Retrieve Ezsignfoldertypes and IDs
Get the list of Ezsignfoldertype to be used in a dropdown or autocomplete control.
- Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.ezsignfoldertype_get_autocomplete_v2_response import EzsignfoldertypeGetAutocompleteV2Response
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.ObjectEzsignfoldertypeApi(api_client)
s_selector = 's_selector_example' # str | The type of Ezsignfoldertypes to return
e_filter_active = 'Active' # str | Specify which results we want to display. (optional) (default to 'Active')
s_query = 's_query_example' # str | Allow to filter the returned results (optional)
accept_language = eZmaxApi.HeaderAcceptLanguage() # HeaderAcceptLanguage | (optional)
try:
# Retrieve Ezsignfoldertypes and IDs
api_response = api_instance.ezsignfoldertype_get_autocomplete_v2(s_selector, e_filter_active=e_filter_active, s_query=s_query, accept_language=accept_language)
print("The response of ObjectEzsignfoldertypeApi->ezsignfoldertype_get_autocomplete_v2:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ObjectEzsignfoldertypeApi->ezsignfoldertype_get_autocomplete_v2: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
s_selector | str | The type of Ezsignfoldertypes to return | |
e_filter_active | str | Specify which results we want to display. | [optional] [default to 'Active'] |
s_query | str | Allow to filter the returned results | [optional] |
accept_language | HeaderAcceptLanguage | [optional] |
EzsignfoldertypeGetAutocompleteV2Response
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Successful response | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EzsignfoldertypeGetListV1Response ezsignfoldertype_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 Ezsignfoldertype list
Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eEzsignfoldertypePrivacylevel | User
Usergroup |
- Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.ezsignfoldertype_get_list_v1_response import EzsignfoldertypeGetListV1Response
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.ObjectEzsignfoldertypeApi(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 Ezsignfoldertype list
api_response = api_instance.ezsignfoldertype_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 ObjectEzsignfoldertypeApi->ezsignfoldertype_get_list_v1:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ObjectEzsignfoldertypeApi->ezsignfoldertype_get_list_v1: %s\n" % e)
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] |
EzsignfoldertypeGetListV1Response
- Content-Type: Not defined
- Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
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]
EzsignfoldertypeGetObjectV2Response ezsignfoldertype_get_object_v2(pki_ezsignfoldertype_id)
Retrieve an existing Ezsignfoldertype
- Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.ezsignfoldertype_get_object_v2_response import EzsignfoldertypeGetObjectV2Response
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.ObjectEzsignfoldertypeApi(api_client)
pki_ezsignfoldertype_id = 56 # int |
try:
# Retrieve an existing Ezsignfoldertype
api_response = api_instance.ezsignfoldertype_get_object_v2(pki_ezsignfoldertype_id)
print("The response of ObjectEzsignfoldertypeApi->ezsignfoldertype_get_object_v2:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ObjectEzsignfoldertypeApi->ezsignfoldertype_get_object_v2: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
pki_ezsignfoldertype_id | int |
EzsignfoldertypeGetObjectV2Response
- Content-Type: Not defined
- Accept: application/json
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]
EzsignfoldertypeGetObjectV3Response ezsignfoldertype_get_object_v3(pki_ezsignfoldertype_id)
Retrieve an existing Ezsignfoldertype
- Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.ezsignfoldertype_get_object_v3_response import EzsignfoldertypeGetObjectV3Response
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.ObjectEzsignfoldertypeApi(api_client)
pki_ezsignfoldertype_id = 56 # int |
try:
# Retrieve an existing Ezsignfoldertype
api_response = api_instance.ezsignfoldertype_get_object_v3(pki_ezsignfoldertype_id)
print("The response of ObjectEzsignfoldertypeApi->ezsignfoldertype_get_object_v3:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ObjectEzsignfoldertypeApi->ezsignfoldertype_get_object_v3: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
pki_ezsignfoldertype_id | int |
EzsignfoldertypeGetObjectV3Response
- Content-Type: Not defined
- Accept: application/json
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]