Skip to content

Latest commit

 

History

History
397 lines (277 loc) · 16.5 KB

ObjectEzsigntemplatepackageApi.md

File metadata and controls

397 lines (277 loc) · 16.5 KB

EzmaxApi::ObjectEzsigntemplatepackageApi

Load the API package

use EzmaxApi::Object::ObjectEzsigntemplatepackageApi;

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

Method HTTP request Description
ezsigntemplatepackage_create_object_v1 POST /1/object/ezsigntemplatepackage Create a new Ezsigntemplatepackage
ezsigntemplatepackage_delete_object_v1 DELETE /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} Delete an existing Ezsigntemplatepackage
ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1 PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}/editEzsigntemplatepackagesigners Edit multiple Ezsigntemplatepackagesigners
ezsigntemplatepackage_edit_object_v1 PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} Edit an existing Ezsigntemplatepackage
ezsigntemplatepackage_get_autocomplete_v2 GET /2/object/ezsigntemplatepackage/getAutocomplete/{sSelector} Retrieve Ezsigntemplatepackages and IDs
ezsigntemplatepackage_get_list_v1 GET /1/object/ezsigntemplatepackage/getList Retrieve Ezsigntemplatepackage list
ezsigntemplatepackage_get_object_v2 GET /2/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} Retrieve an existing Ezsigntemplatepackage

ezsigntemplatepackage_create_object_v1

EzsigntemplatepackageCreateObjectV1Response ezsigntemplatepackage_create_object_v1(ezsigntemplatepackage_create_object_v1_request => $ezsigntemplatepackage_create_object_v1_request)

Create a new Ezsigntemplatepackage

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

Example

use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplatepackageApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplatepackageApi->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 $ezsigntemplatepackage_create_object_v1_request = EzmaxApi::Object::EzsigntemplatepackageCreateObjectV1Request->new(); # EzsigntemplatepackageCreateObjectV1Request | 

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

Parameters

Name Type Description Notes
ezsigntemplatepackage_create_object_v1_request EzsigntemplatepackageCreateObjectV1Request

Return type

EzsigntemplatepackageCreateObjectV1Response

Authorization

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]

ezsigntemplatepackage_delete_object_v1

EzsigntemplatepackageDeleteObjectV1Response ezsigntemplatepackage_delete_object_v1(pki_ezsigntemplatepackage_id => $pki_ezsigntemplatepackage_id)

Delete an existing Ezsigntemplatepackage

Example

use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplatepackageApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplatepackageApi->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_ezsigntemplatepackage_id = 56; # int | 

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

Parameters

Name Type Description Notes
pki_ezsigntemplatepackage_id int

Return type

EzsigntemplatepackageDeleteObjectV1Response

Authorization

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]

ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1

EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1(pki_ezsigntemplatepackage_id => $pki_ezsigntemplatepackage_id, ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request => $ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request)

Edit multiple Ezsigntemplatepackagesigners

Using this endpoint, you can edit multiple Ezsigntemplatepackagesigners at the same time.

Example

use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplatepackageApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplatepackageApi->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_ezsigntemplatepackage_id = 56; # int | 
my $ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request = EzmaxApi::Object::EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request->new(); # EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request | 

eval {
    my $result = $api_instance->ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1(pki_ezsigntemplatepackage_id => $pki_ezsigntemplatepackage_id, ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request => $ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectEzsigntemplatepackageApi->ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1: $@\n";
}

Parameters

Name Type Description Notes
pki_ezsigntemplatepackage_id int
ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request

Return type

EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response

Authorization

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]

ezsigntemplatepackage_edit_object_v1

EzsigntemplatepackageEditObjectV1Response ezsigntemplatepackage_edit_object_v1(pki_ezsigntemplatepackage_id => $pki_ezsigntemplatepackage_id, ezsigntemplatepackage_edit_object_v1_request => $ezsigntemplatepackage_edit_object_v1_request)

Edit an existing Ezsigntemplatepackage

Example

use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplatepackageApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplatepackageApi->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_ezsigntemplatepackage_id = 56; # int | 
my $ezsigntemplatepackage_edit_object_v1_request = EzmaxApi::Object::EzsigntemplatepackageEditObjectV1Request->new(); # EzsigntemplatepackageEditObjectV1Request | 

eval {
    my $result = $api_instance->ezsigntemplatepackage_edit_object_v1(pki_ezsigntemplatepackage_id => $pki_ezsigntemplatepackage_id, ezsigntemplatepackage_edit_object_v1_request => $ezsigntemplatepackage_edit_object_v1_request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectEzsigntemplatepackageApi->ezsigntemplatepackage_edit_object_v1: $@\n";
}

Parameters

Name Type Description Notes
pki_ezsigntemplatepackage_id int
ezsigntemplatepackage_edit_object_v1_request EzsigntemplatepackageEditObjectV1Request

Return type

EzsigntemplatepackageEditObjectV1Response

Authorization

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]

ezsigntemplatepackage_get_autocomplete_v2

EzsigntemplatepackageGetAutocompleteV2Response ezsigntemplatepackage_get_autocomplete_v2(s_selector => $s_selector, e_filter_active => $e_filter_active, s_query => $s_query, accept_language => $accept_language, fki_ezsignfoldertype_id => $fki_ezsignfoldertype_id)

Retrieve Ezsigntemplatepackages and IDs

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

Example

use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplatepackageApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplatepackageApi->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 Ezsigntemplatepackages 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 | 
my $fki_ezsignfoldertype_id = 56; # int | The fkiEzsignfoldertypeID to use with the selector Ezsigntemplatepublic

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

Parameters

Name Type Description Notes
s_selector string The type of Ezsigntemplatepackages 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]
fki_ezsignfoldertype_id int The fkiEzsignfoldertypeID to use with the selector Ezsigntemplatepublic [optional]

Return type

EzsigntemplatepackageGetAutocompleteV2Response

Authorization

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]

ezsigntemplatepackage_get_list_v1

EzsigntemplatepackageGetListV1Response ezsigntemplatepackage_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 Ezsigntemplatepackage list

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

Example

use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplatepackageApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplatepackageApi->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->ezsigntemplatepackage_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 ObjectEzsigntemplatepackageApi->ezsigntemplatepackage_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

EzsigntemplatepackageGetListV1Response

Authorization

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]

ezsigntemplatepackage_get_object_v2

EzsigntemplatepackageGetObjectV2Response ezsigntemplatepackage_get_object_v2(pki_ezsigntemplatepackage_id => $pki_ezsigntemplatepackage_id)

Retrieve an existing Ezsigntemplatepackage

Example

use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplatepackageApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplatepackageApi->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_ezsigntemplatepackage_id = 56; # int | 

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

Parameters

Name Type Description Notes
pki_ezsigntemplatepackage_id int

Return type

EzsigntemplatepackageGetObjectV2Response

Authorization

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]