EzmaxApi::ObjectEzsigntemplateApi

Load the API package

use EzmaxApi::Object::ObjectEzsigntemplateApi;

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

Method	HTTP request	Description
ezsigntemplate_copy_v1	POST /1/object/ezsigntemplate/{pkiEzsigntemplateID}/copy	Copy the Ezsigntemplate
ezsigntemplate_create_object_v1	POST /1/object/ezsigntemplate	Create a new Ezsigntemplate
ezsigntemplate_create_object_v2	POST /2/object/ezsigntemplate	Create a new Ezsigntemplate
ezsigntemplate_delete_object_v1	DELETE /1/object/ezsigntemplate/{pkiEzsigntemplateID}	Delete an existing Ezsigntemplate
ezsigntemplate_edit_object_v1	PUT /1/object/ezsigntemplate/{pkiEzsigntemplateID}	Edit an existing Ezsigntemplate
ezsigntemplate_edit_object_v2	PUT /2/object/ezsigntemplate/{pkiEzsigntemplateID}	Edit an existing Ezsigntemplate
ezsigntemplate_get_autocomplete_v2	GET /2/object/ezsigntemplate/getAutocomplete/{sSelector}	Retrieve Ezsigntemplates and IDs
ezsigntemplate_get_list_v1	GET /1/object/ezsigntemplate/getList	Retrieve Ezsigntemplate list
ezsigntemplate_get_object_v1	GET /1/object/ezsigntemplate/{pkiEzsigntemplateID}	Retrieve an existing Ezsigntemplate
ezsigntemplate_get_object_v2	GET /2/object/ezsigntemplate/{pkiEzsigntemplateID}	Retrieve an existing Ezsigntemplate

ezsigntemplate_copy_v1

EzsigntemplateCopyV1Response ezsigntemplate_copy_v1(pki_ezsigntemplate_id => $pki_ezsigntemplate_id, ezsigntemplate_copy_v1_request => $ezsigntemplate_copy_v1_request)

Copy the Ezsigntemplate

Example

use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplateApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplateApi->new(

    # Configure API key authorization: Authorization
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $pki_ezsigntemplate_id = 56; # int | 
my $ezsigntemplate_copy_v1_request = EzmaxApi::Object::EzsigntemplateCopyV1Request->new(); # EzsigntemplateCopyV1Request | 

eval {
    my $result = $api_instance->ezsigntemplate_copy_v1(pki_ezsigntemplate_id => $pki_ezsigntemplate_id, ezsigntemplate_copy_v1_request => $ezsigntemplate_copy_v1_request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectEzsigntemplateApi->ezsigntemplate_copy_v1: $@\n";
}

Parameters

Name	Type	Description	Notes
pki_ezsigntemplate_id	int
ezsigntemplate_copy_v1_request	EzsigntemplateCopyV1Request

Return type

EzsigntemplateCopyV1Response

Authorization

HTTP request headers

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

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

ezsigntemplate_create_object_v1

EzsigntemplateCreateObjectV1Response ezsigntemplate_create_object_v1(ezsigntemplate_create_object_v1_request => $ezsigntemplate_create_object_v1_request)

Create a new Ezsigntemplate

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

Example

use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplateApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplateApi->new(

    # Configure API key authorization: Authorization
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $ezsigntemplate_create_object_v1_request = EzmaxApi::Object::EzsigntemplateCreateObjectV1Request->new(); # EzsigntemplateCreateObjectV1Request | 

eval {
    my $result = $api_instance->ezsigntemplate_create_object_v1(ezsigntemplate_create_object_v1_request => $ezsigntemplate_create_object_v1_request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectEzsigntemplateApi->ezsigntemplate_create_object_v1: $@\n";
}

Parameters

Name	Type	Description	Notes
ezsigntemplate_create_object_v1_request	EzsigntemplateCreateObjectV1Request

Return type

EzsigntemplateCreateObjectV1Response

Authorization

HTTP request headers

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

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

ezsigntemplate_create_object_v2

EzsigntemplateCreateObjectV2Response ezsigntemplate_create_object_v2(ezsigntemplate_create_object_v2_request => $ezsigntemplate_create_object_v2_request)

Create a new Ezsigntemplate

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

Example

use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplateApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplateApi->new(

    # Configure API key authorization: Authorization
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $ezsigntemplate_create_object_v2_request = EzmaxApi::Object::EzsigntemplateCreateObjectV2Request->new(); # EzsigntemplateCreateObjectV2Request | 

eval {
    my $result = $api_instance->ezsigntemplate_create_object_v2(ezsigntemplate_create_object_v2_request => $ezsigntemplate_create_object_v2_request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectEzsigntemplateApi->ezsigntemplate_create_object_v2: $@\n";
}

Parameters

Name	Type	Description	Notes
ezsigntemplate_create_object_v2_request	EzsigntemplateCreateObjectV2Request

Return type

EzsigntemplateCreateObjectV2Response

Authorization

HTTP request headers

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

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

ezsigntemplate_delete_object_v1

EzsigntemplateDeleteObjectV1Response ezsigntemplate_delete_object_v1(pki_ezsigntemplate_id => $pki_ezsigntemplate_id)

Delete an existing Ezsigntemplate

Example

use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplateApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplateApi->new(

    # Configure API key authorization: Authorization
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $pki_ezsigntemplate_id = 56; # int | 

eval {
    my $result = $api_instance->ezsigntemplate_delete_object_v1(pki_ezsigntemplate_id => $pki_ezsigntemplate_id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectEzsigntemplateApi->ezsigntemplate_delete_object_v1: $@\n";
}

Parameters

Name	Type	Description	Notes
pki_ezsigntemplate_id	int

Return type

EzsigntemplateDeleteObjectV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ezsigntemplate_edit_object_v1

EzsigntemplateEditObjectV1Response ezsigntemplate_edit_object_v1(pki_ezsigntemplate_id => $pki_ezsigntemplate_id, ezsigntemplate_edit_object_v1_request => $ezsigntemplate_edit_object_v1_request)

Edit an existing Ezsigntemplate

Example

use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplateApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplateApi->new(

    # Configure API key authorization: Authorization
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $pki_ezsigntemplate_id = 56; # int | 
my $ezsigntemplate_edit_object_v1_request = EzmaxApi::Object::EzsigntemplateEditObjectV1Request->new(); # EzsigntemplateEditObjectV1Request | 

eval {
    my $result = $api_instance->ezsigntemplate_edit_object_v1(pki_ezsigntemplate_id => $pki_ezsigntemplate_id, ezsigntemplate_edit_object_v1_request => $ezsigntemplate_edit_object_v1_request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectEzsigntemplateApi->ezsigntemplate_edit_object_v1: $@\n";
}

Parameters

Name	Type	Description	Notes
pki_ezsigntemplate_id	int
ezsigntemplate_edit_object_v1_request	EzsigntemplateEditObjectV1Request

Return type

EzsigntemplateEditObjectV1Response

Authorization

HTTP request headers

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

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

ezsigntemplate_edit_object_v2

EzsigntemplateEditObjectV2Response ezsigntemplate_edit_object_v2(pki_ezsigntemplate_id => $pki_ezsigntemplate_id, ezsigntemplate_edit_object_v2_request => $ezsigntemplate_edit_object_v2_request)

Edit an existing Ezsigntemplate

Example

use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplateApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplateApi->new(

    # Configure API key authorization: Authorization
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $pki_ezsigntemplate_id = 56; # int | 
my $ezsigntemplate_edit_object_v2_request = EzmaxApi::Object::EzsigntemplateEditObjectV2Request->new(); # EzsigntemplateEditObjectV2Request | 

eval {
    my $result = $api_instance->ezsigntemplate_edit_object_v2(pki_ezsigntemplate_id => $pki_ezsigntemplate_id, ezsigntemplate_edit_object_v2_request => $ezsigntemplate_edit_object_v2_request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectEzsigntemplateApi->ezsigntemplate_edit_object_v2: $@\n";
}

Parameters

Name	Type	Description	Notes
pki_ezsigntemplate_id	int
ezsigntemplate_edit_object_v2_request	EzsigntemplateEditObjectV2Request

Return type

EzsigntemplateEditObjectV2Response

Authorization

HTTP request headers

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

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

ezsigntemplate_get_autocomplete_v2

EzsigntemplateGetAutocompleteV2Response ezsigntemplate_get_autocomplete_v2(s_selector => $s_selector, e_filter_active => $e_filter_active, s_query => $s_query, accept_language => $accept_language)

Retrieve Ezsigntemplates and IDs

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

Example

use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplateApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplateApi->new(

    # Configure API key authorization: Authorization
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $s_selector = "s_selector_example"; # string | The type of Ezsigntemplates to return
my $e_filter_active = 'Active'; # string | Specify which results we want to display.
my $s_query = "s_query_example"; # string | Allow to filter the returned results
my $accept_language = new EzmaxApi.HeaderAcceptLanguage(); # HeaderAcceptLanguage | 

eval {
    my $result = $api_instance->ezsigntemplate_get_autocomplete_v2(s_selector => $s_selector, e_filter_active => $e_filter_active, s_query => $s_query, accept_language => $accept_language);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectEzsigntemplateApi->ezsigntemplate_get_autocomplete_v2: $@\n";
}

Parameters

Name	Type	Description	Notes
s_selector	string	The type of Ezsigntemplates to return
e_filter_active	string	Specify which results we want to display.	[optional] [default to 'Active']
s_query	string	Allow to filter the returned results	[optional]
accept_language	HeaderAcceptLanguage		[optional]

Return type

EzsigntemplateGetAutocompleteV2Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ezsigntemplate_get_list_v1

EzsigntemplateGetListV1Response ezsigntemplate_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 Ezsigntemplate list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eEzsigntemplateType | Company
Team
User
Usergroup |

Example

use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplateApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplateApi->new(

    # Configure API key authorization: Authorization
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $e_order_by = "e_order_by_example"; # string | Specify how you want the results to be sorted
my $i_row_max = 56; # int | 
my $i_row_offset = 0; # int | 
my $accept_language = new EzmaxApi.HeaderAcceptLanguage(); # HeaderAcceptLanguage | 
my $s_filter = "s_filter_example"; # string | 

eval {
    my $result = $api_instance->ezsigntemplate_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 Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectEzsigntemplateApi->ezsigntemplate_get_list_v1: $@\n";
}

Parameters

Name	Type	Description	Notes
e_order_by	string	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	string		[optional]

Return type

EzsigntemplateGetListV1Response

Authorization

HTTP request headers

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

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

ezsigntemplate_get_object_v1

EzsigntemplateGetObjectV1Response ezsigntemplate_get_object_v1(pki_ezsigntemplate_id => $pki_ezsigntemplate_id)

Retrieve an existing Ezsigntemplate

Example

use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplateApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplateApi->new(

    # Configure API key authorization: Authorization
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $pki_ezsigntemplate_id = 56; # int | 

eval {
    my $result = $api_instance->ezsigntemplate_get_object_v1(pki_ezsigntemplate_id => $pki_ezsigntemplate_id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectEzsigntemplateApi->ezsigntemplate_get_object_v1: $@\n";
}

Parameters

Name	Type	Description	Notes
pki_ezsigntemplate_id	int

Return type

EzsigntemplateGetObjectV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ezsigntemplate_get_object_v2

EzsigntemplateGetObjectV2Response ezsigntemplate_get_object_v2(pki_ezsigntemplate_id => $pki_ezsigntemplate_id)

Retrieve an existing Ezsigntemplate

Example

use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplateApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplateApi->new(

    # Configure API key authorization: Authorization
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $pki_ezsigntemplate_id = 56; # int | 

eval {
    my $result = $api_instance->ezsigntemplate_get_object_v2(pki_ezsigntemplate_id => $pki_ezsigntemplate_id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectEzsigntemplateApi->ezsigntemplate_get_object_v2: $@\n";
}

Parameters

Name	Type	Description	Notes
pki_ezsigntemplate_id	int

Return type

EzsigntemplateGetObjectV2Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

Files

ObjectEzsigntemplateApi.md

Latest commit

History

ObjectEzsigntemplateApi.md

File metadata and controls

EzmaxApi::ObjectEzsigntemplateApi

Load the API package

ezsigntemplate_copy_v1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigntemplate_create_object_v1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigntemplate_create_object_v2

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigntemplate_delete_object_v1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigntemplate_edit_object_v1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigntemplate_edit_object_v2

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigntemplate_get_autocomplete_v2

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigntemplate_get_list_v1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigntemplate_get_object_v1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigntemplate_get_object_v2

Example

Parameters

Return type

Authorization

HTTP request headers