use EzmaxApi::Object::ObjectEzsigntemplatedocumentApi;
All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
Method | HTTP request | Description |
---|---|---|
ezsigntemplatedocument_create_object_v1 | POST /1/object/ezsigntemplatedocument | Create a new Ezsigntemplatedocument |
ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1 | PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplateformfieldgroups | Edit multiple Ezsigntemplateformfieldgroups |
ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1 | PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplatesignatures | Edit multiple Ezsigntemplatesignatures |
ezsigntemplatedocument_edit_object_v1 | PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} | Edit an existing Ezsigntemplatedocument |
ezsigntemplatedocument_flatten_v1 | POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/flatten | Flatten |
ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1 | GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatedocumentpages | Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatedocumentpages |
ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1 | GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplateformfieldgroups | Retrieve an existing Ezsigntemplatedocument's Ezsigntemplateformfieldgroups |
ezsigntemplatedocument_get_ezsigntemplatesignatures_v1 | GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatesignatures | Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatesignatures |
ezsigntemplatedocument_get_object_v2 | GET /2/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} | Retrieve an existing Ezsigntemplatedocument |
ezsigntemplatedocument_get_words_positions_v1 | POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getWordsPositions | Retrieve positions X,Y of given words from a Ezsigntemplatedocument |
ezsigntemplatedocument_patch_object_v1 | PATCH /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} | Patch an existing Ezsigntemplatedocument |
EzsigntemplatedocumentCreateObjectV1Response ezsigntemplatedocument_create_object_v1(ezsigntemplatedocument_create_object_v1_request => $ezsigntemplatedocument_create_object_v1_request)
Create a new Ezsigntemplatedocument
The endpoint allows to create one or many elements at once.
use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplatedocumentApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplatedocumentApi->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 $ezsigntemplatedocument_create_object_v1_request = EzmaxApi::Object::EzsigntemplatedocumentCreateObjectV1Request->new(); # EzsigntemplatedocumentCreateObjectV1Request |
eval {
my $result = $api_instance->ezsigntemplatedocument_create_object_v1(ezsigntemplatedocument_create_object_v1_request => $ezsigntemplatedocument_create_object_v1_request);
print Dumper($result);
};
if ($@) {
warn "Exception when calling ObjectEzsigntemplatedocumentApi->ezsigntemplatedocument_create_object_v1: $@\n";
}
Name | Type | Description | Notes |
---|---|---|---|
ezsigntemplatedocument_create_object_v1_request | EzsigntemplatedocumentCreateObjectV1Request |
EzsigntemplatedocumentCreateObjectV1Response
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1(pki_ezsigntemplatedocument_id => $pki_ezsigntemplatedocument_id, ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request => $ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request)
Edit multiple Ezsigntemplateformfieldgroups
Using this endpoint, you can edit multiple Ezsigntemplateformfieldgroups at the same time.
use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplatedocumentApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplatedocumentApi->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_ezsigntemplatedocument_id = 56; # int |
my $ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request = EzmaxApi::Object::EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request->new(); # EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request |
eval {
my $result = $api_instance->ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1(pki_ezsigntemplatedocument_id => $pki_ezsigntemplatedocument_id, ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request => $ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request);
print Dumper($result);
};
if ($@) {
warn "Exception when calling ObjectEzsigntemplatedocumentApi->ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1: $@\n";
}
Name | Type | Description | Notes |
---|---|---|---|
pki_ezsigntemplatedocument_id | int | ||
ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request | EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request |
EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1(pki_ezsigntemplatedocument_id => $pki_ezsigntemplatedocument_id, ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request => $ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request)
Edit multiple Ezsigntemplatesignatures
Using this endpoint, you can edit multiple Ezsigntemplatesignatures at the same time.
use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplatedocumentApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplatedocumentApi->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_ezsigntemplatedocument_id = 56; # int |
my $ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request = EzmaxApi::Object::EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request->new(); # EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request |
eval {
my $result = $api_instance->ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1(pki_ezsigntemplatedocument_id => $pki_ezsigntemplatedocument_id, ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request => $ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request);
print Dumper($result);
};
if ($@) {
warn "Exception when calling ObjectEzsigntemplatedocumentApi->ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1: $@\n";
}
Name | Type | Description | Notes |
---|---|---|---|
pki_ezsigntemplatedocument_id | int | ||
ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request | EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request |
EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EzsigntemplatedocumentEditObjectV1Response ezsigntemplatedocument_edit_object_v1(pki_ezsigntemplatedocument_id => $pki_ezsigntemplatedocument_id, ezsigntemplatedocument_edit_object_v1_request => $ezsigntemplatedocument_edit_object_v1_request)
Edit an existing Ezsigntemplatedocument
use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplatedocumentApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplatedocumentApi->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_ezsigntemplatedocument_id = 56; # int |
my $ezsigntemplatedocument_edit_object_v1_request = EzmaxApi::Object::EzsigntemplatedocumentEditObjectV1Request->new(); # EzsigntemplatedocumentEditObjectV1Request |
eval {
my $result = $api_instance->ezsigntemplatedocument_edit_object_v1(pki_ezsigntemplatedocument_id => $pki_ezsigntemplatedocument_id, ezsigntemplatedocument_edit_object_v1_request => $ezsigntemplatedocument_edit_object_v1_request);
print Dumper($result);
};
if ($@) {
warn "Exception when calling ObjectEzsigntemplatedocumentApi->ezsigntemplatedocument_edit_object_v1: $@\n";
}
Name | Type | Description | Notes |
---|---|---|---|
pki_ezsigntemplatedocument_id | int | ||
ezsigntemplatedocument_edit_object_v1_request | EzsigntemplatedocumentEditObjectV1Request |
EzsigntemplatedocumentEditObjectV1Response
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EzsigntemplatedocumentFlattenV1Response ezsigntemplatedocument_flatten_v1(pki_ezsigntemplatedocument_id => $pki_ezsigntemplatedocument_id, body => $body)
Flatten
Flatten an Ezsigntemplatedocument signatures, forms and annotations. This process finalizes the PDF so that the forms and annotations become part of the document content and cannot be edited.
use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplatedocumentApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplatedocumentApi->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_ezsigntemplatedocument_id = 56; # int |
my $body = EzmaxApi::Object::object->new(); # object |
eval {
my $result = $api_instance->ezsigntemplatedocument_flatten_v1(pki_ezsigntemplatedocument_id => $pki_ezsigntemplatedocument_id, body => $body);
print Dumper($result);
};
if ($@) {
warn "Exception when calling ObjectEzsigntemplatedocumentApi->ezsigntemplatedocument_flatten_v1: $@\n";
}
Name | Type | Description | Notes |
---|---|---|---|
pki_ezsigntemplatedocument_id | int | ||
body | object |
EzsigntemplatedocumentFlattenV1Response
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1(pki_ezsigntemplatedocument_id => $pki_ezsigntemplatedocument_id)
Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatedocumentpages
use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplatedocumentApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplatedocumentApi->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_ezsigntemplatedocument_id = 56; # int |
eval {
my $result = $api_instance->ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1(pki_ezsigntemplatedocument_id => $pki_ezsigntemplatedocument_id);
print Dumper($result);
};
if ($@) {
warn "Exception when calling ObjectEzsigntemplatedocumentApi->ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1: $@\n";
}
Name | Type | Description | Notes |
---|---|---|---|
pki_ezsigntemplatedocument_id | int |
EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1(pki_ezsigntemplatedocument_id => $pki_ezsigntemplatedocument_id)
Retrieve an existing Ezsigntemplatedocument's Ezsigntemplateformfieldgroups
use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplatedocumentApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplatedocumentApi->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_ezsigntemplatedocument_id = 56; # int |
eval {
my $result = $api_instance->ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1(pki_ezsigntemplatedocument_id => $pki_ezsigntemplatedocument_id);
print Dumper($result);
};
if ($@) {
warn "Exception when calling ObjectEzsigntemplatedocumentApi->ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1: $@\n";
}
Name | Type | Description | Notes |
---|---|---|---|
pki_ezsigntemplatedocument_id | int |
EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response ezsigntemplatedocument_get_ezsigntemplatesignatures_v1(pki_ezsigntemplatedocument_id => $pki_ezsigntemplatedocument_id)
Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatesignatures
use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplatedocumentApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplatedocumentApi->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_ezsigntemplatedocument_id = 56; # int |
eval {
my $result = $api_instance->ezsigntemplatedocument_get_ezsigntemplatesignatures_v1(pki_ezsigntemplatedocument_id => $pki_ezsigntemplatedocument_id);
print Dumper($result);
};
if ($@) {
warn "Exception when calling ObjectEzsigntemplatedocumentApi->ezsigntemplatedocument_get_ezsigntemplatesignatures_v1: $@\n";
}
Name | Type | Description | Notes |
---|---|---|---|
pki_ezsigntemplatedocument_id | int |
EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EzsigntemplatedocumentGetObjectV2Response ezsigntemplatedocument_get_object_v2(pki_ezsigntemplatedocument_id => $pki_ezsigntemplatedocument_id)
Retrieve an existing Ezsigntemplatedocument
use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplatedocumentApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplatedocumentApi->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_ezsigntemplatedocument_id = 56; # int |
eval {
my $result = $api_instance->ezsigntemplatedocument_get_object_v2(pki_ezsigntemplatedocument_id => $pki_ezsigntemplatedocument_id);
print Dumper($result);
};
if ($@) {
warn "Exception when calling ObjectEzsigntemplatedocumentApi->ezsigntemplatedocument_get_object_v2: $@\n";
}
Name | Type | Description | Notes |
---|---|---|---|
pki_ezsigntemplatedocument_id | int |
EzsigntemplatedocumentGetObjectV2Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EzsigntemplatedocumentGetWordsPositionsV1Response ezsigntemplatedocument_get_words_positions_v1(pki_ezsigntemplatedocument_id => $pki_ezsigntemplatedocument_id, ezsigntemplatedocument_get_words_positions_v1_request => $ezsigntemplatedocument_get_words_positions_v1_request)
Retrieve positions X,Y of given words from a Ezsigntemplatedocument
use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplatedocumentApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplatedocumentApi->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_ezsigntemplatedocument_id = 56; # int |
my $ezsigntemplatedocument_get_words_positions_v1_request = EzmaxApi::Object::EzsigntemplatedocumentGetWordsPositionsV1Request->new(); # EzsigntemplatedocumentGetWordsPositionsV1Request |
eval {
my $result = $api_instance->ezsigntemplatedocument_get_words_positions_v1(pki_ezsigntemplatedocument_id => $pki_ezsigntemplatedocument_id, ezsigntemplatedocument_get_words_positions_v1_request => $ezsigntemplatedocument_get_words_positions_v1_request);
print Dumper($result);
};
if ($@) {
warn "Exception when calling ObjectEzsigntemplatedocumentApi->ezsigntemplatedocument_get_words_positions_v1: $@\n";
}
Name | Type | Description | Notes |
---|---|---|---|
pki_ezsigntemplatedocument_id | int | ||
ezsigntemplatedocument_get_words_positions_v1_request | EzsigntemplatedocumentGetWordsPositionsV1Request |
EzsigntemplatedocumentGetWordsPositionsV1Response
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EzsigntemplatedocumentPatchObjectV1Response ezsigntemplatedocument_patch_object_v1(pki_ezsigntemplatedocument_id => $pki_ezsigntemplatedocument_id, ezsigntemplatedocument_patch_object_v1_request => $ezsigntemplatedocument_patch_object_v1_request)
Patch an existing Ezsigntemplatedocument
use Data::Dumper;
use EzmaxApi::ObjectEzsigntemplatedocumentApi;
my $api_instance = EzmaxApi::ObjectEzsigntemplatedocumentApi->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_ezsigntemplatedocument_id = 56; # int |
my $ezsigntemplatedocument_patch_object_v1_request = EzmaxApi::Object::EzsigntemplatedocumentPatchObjectV1Request->new(); # EzsigntemplatedocumentPatchObjectV1Request |
eval {
my $result = $api_instance->ezsigntemplatedocument_patch_object_v1(pki_ezsigntemplatedocument_id => $pki_ezsigntemplatedocument_id, ezsigntemplatedocument_patch_object_v1_request => $ezsigntemplatedocument_patch_object_v1_request);
print Dumper($result);
};
if ($@) {
warn "Exception when calling ObjectEzsigntemplatedocumentApi->ezsigntemplatedocument_patch_object_v1: $@\n";
}
Name | Type | Description | Notes |
---|---|---|---|
pki_ezsigntemplatedocument_id | int | ||
ezsigntemplatedocument_patch_object_v1_request | EzsigntemplatedocumentPatchObjectV1Request |
EzsigntemplatedocumentPatchObjectV1Response
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]