Skip to content

Latest commit

 

History

History
223 lines (151 loc) · 7.13 KB

ObjectSignatureApi.md

File metadata and controls

223 lines (151 loc) · 7.13 KB

EzmaxApi::ObjectSignatureApi

Load the API package

use EzmaxApi::Object::ObjectSignatureApi;

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

Method HTTP request Description
signature_create_object_v1 POST /1/object/signature Create a new Signature
signature_delete_object_v1 DELETE /1/object/signature/{pkiSignatureID} Delete an existing Signature
signature_edit_object_v1 PUT /1/object/signature/{pkiSignatureID} Edit an existing Signature
signature_get_object_v2 GET /2/object/signature/{pkiSignatureID} Retrieve an existing Signature

signature_create_object_v1

SignatureCreateObjectV1Response signature_create_object_v1(signature_create_object_v1_request => $signature_create_object_v1_request)

Create a new Signature

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

Example

use Data::Dumper;
use EzmaxApi::ObjectSignatureApi;
my $api_instance = EzmaxApi::ObjectSignatureApi->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 $signature_create_object_v1_request = EzmaxApi::Object::SignatureCreateObjectV1Request->new(); # SignatureCreateObjectV1Request | 

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

Parameters

Name Type Description Notes
signature_create_object_v1_request SignatureCreateObjectV1Request

Return type

SignatureCreateObjectV1Response

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]

signature_delete_object_v1

SignatureDeleteObjectV1Response signature_delete_object_v1(pki_signature_id => $pki_signature_id)

Delete an existing Signature

Example

use Data::Dumper;
use EzmaxApi::ObjectSignatureApi;
my $api_instance = EzmaxApi::ObjectSignatureApi->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_signature_id = 56; # int | The unique ID of the Signature

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

Parameters

Name Type Description Notes
pki_signature_id int The unique ID of the Signature

Return type

SignatureDeleteObjectV1Response

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]

signature_edit_object_v1

SignatureEditObjectV1Response signature_edit_object_v1(pki_signature_id => $pki_signature_id, signature_edit_object_v1_request => $signature_edit_object_v1_request)

Edit an existing Signature

Example

use Data::Dumper;
use EzmaxApi::ObjectSignatureApi;
my $api_instance = EzmaxApi::ObjectSignatureApi->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_signature_id = 56; # int | The unique ID of the Signature
my $signature_edit_object_v1_request = EzmaxApi::Object::SignatureEditObjectV1Request->new(); # SignatureEditObjectV1Request | 

eval {
    my $result = $api_instance->signature_edit_object_v1(pki_signature_id => $pki_signature_id, signature_edit_object_v1_request => $signature_edit_object_v1_request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectSignatureApi->signature_edit_object_v1: $@\n";
}

Parameters

Name Type Description Notes
pki_signature_id int The unique ID of the Signature
signature_edit_object_v1_request SignatureEditObjectV1Request

Return type

SignatureEditObjectV1Response

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]

signature_get_object_v2

SignatureGetObjectV2Response signature_get_object_v2(pki_signature_id => $pki_signature_id)

Retrieve an existing Signature

Example

use Data::Dumper;
use EzmaxApi::ObjectSignatureApi;
my $api_instance = EzmaxApi::ObjectSignatureApi->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_signature_id = 56; # int | The unique ID of the Signature

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

Parameters

Name Type Description Notes
pki_signature_id int The unique ID of the Signature

Return type

SignatureGetObjectV2Response

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]