Skip to content

Latest commit

 

History

History
176 lines (119 loc) · 7.03 KB

ObjectEzsigntemplateglobalApi.md

File metadata and controls

176 lines (119 loc) · 7.03 KB
Raw

eZmaxApi.ObjectEzsigntemplateglobalApi

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

Method HTTP request Description
ezsigntemplateglobal_get_autocomplete_v2 GET /2/object/ezsigntemplateglobal/getAutocomplete/{sSelector} Retrieve Ezsigntemplateglobals and IDs
ezsigntemplateglobal_get_object_v2 GET /2/object/ezsigntemplateglobal/{pkiEzsigntemplateglobalID} Retrieve an existing Ezsigntemplateglobal

ezsigntemplateglobal_get_autocomplete_v2

EzsigntemplateglobalGetAutocompleteV2Response ezsigntemplateglobal_get_autocomplete_v2(s_selector, e_filter_active=e_filter_active, s_query=s_query, accept_language=accept_language)

Retrieve Ezsigntemplateglobals and IDs

Get the list of Ezsigntemplateglobal to be used in a dropdown or autocomplete control.

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.ezsigntemplateglobal_get_autocomplete_v2_response import EzsigntemplateglobalGetAutocompleteV2Response
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.ObjectEzsigntemplateglobalApi(api_client)
    s_selector = 's_selector_example' # str | The type of Ezsigntemplateglobals 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 Ezsigntemplateglobals and IDs
        api_response = api_instance.ezsigntemplateglobal_get_autocomplete_v2(s_selector, e_filter_active=e_filter_active, s_query=s_query, accept_language=accept_language)
        print("The response of ObjectEzsigntemplateglobalApi->ezsigntemplateglobal_get_autocomplete_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsigntemplateglobalApi->ezsigntemplateglobal_get_autocomplete_v2: %s\n" % e)

Parameters

Name Type Description Notes
s_selector str The type of Ezsigntemplateglobals 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]

Return type

EzsigntemplateglobalGetAutocompleteV2Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • 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]

ezsigntemplateglobal_get_object_v2

EzsigntemplateglobalGetObjectV2Response ezsigntemplateglobal_get_object_v2(pki_ezsigntemplateglobal_id)

Retrieve an existing Ezsigntemplateglobal

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.ezsigntemplateglobal_get_object_v2_response import EzsigntemplateglobalGetObjectV2Response
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.ObjectEzsigntemplateglobalApi(api_client)
    pki_ezsigntemplateglobal_id = 56 # int | 

    try:
        # Retrieve an existing Ezsigntemplateglobal
        api_response = api_instance.ezsigntemplateglobal_get_object_v2(pki_ezsigntemplateglobal_id)
        print("The response of ObjectEzsigntemplateglobalApi->ezsigntemplateglobal_get_object_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsigntemplateglobalApi->ezsigntemplateglobal_get_object_v2: %s\n" % e)

Parameters

Name Type Description Notes
pki_ezsigntemplateglobal_id int

Return type

EzsigntemplateglobalGetObjectV2Response

Authorization

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]