Skip to content

Latest commit

 

History

History
305 lines (215 loc) · 8.66 KB

ObjectDomainApi.md

File metadata and controls

305 lines (215 loc) · 8.66 KB

EzmaxApi::ObjectDomainApi

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

Method HTTP request Description
domain_create_object_v1 POST /1/object/domain Create a new Domain
domain_delete_object_v1 DELETE /1/object/domain/{pkiDomainID} Delete an existing Domain
domain_get_list_v1 GET /1/object/domain/getList Retrieve Domain list
domain_get_object_v2 GET /2/object/domain/{pkiDomainID} Retrieve an existing Domain

domain_create_object_v1

domain_create_object_v1(domain_create_object_v1_request)

Create a new Domain

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

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectDomainApi.new
domain_create_object_v1_request = EzmaxApi::DomainCreateObjectV1Request.new({a_obj_domain: [EzmaxApi::DomainRequestCompound.new({s_domain_name: 'ezsign.ca'})]}) # DomainCreateObjectV1Request | 

begin
  # Create a new Domain
  result = api_instance.domain_create_object_v1(domain_create_object_v1_request)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectDomainApi->domain_create_object_v1: #{e}"
end

Using the domain_create_object_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> domain_create_object_v1_with_http_info(domain_create_object_v1_request)

begin
  # Create a new Domain
  data, status_code, headers = api_instance.domain_create_object_v1_with_http_info(domain_create_object_v1_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DomainCreateObjectV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectDomainApi->domain_create_object_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
domain_create_object_v1_request DomainCreateObjectV1Request

Return type

DomainCreateObjectV1Response

Authorization

Authorization

HTTP request headers

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

domain_delete_object_v1

domain_delete_object_v1(pki_domain_id)

Delete an existing Domain

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectDomainApi.new
pki_domain_id = 56 # Integer | The unique ID of the Domain

begin
  # Delete an existing Domain
  result = api_instance.domain_delete_object_v1(pki_domain_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectDomainApi->domain_delete_object_v1: #{e}"
end

Using the domain_delete_object_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> domain_delete_object_v1_with_http_info(pki_domain_id)

begin
  # Delete an existing Domain
  data, status_code, headers = api_instance.domain_delete_object_v1_with_http_info(pki_domain_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DomainDeleteObjectV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectDomainApi->domain_delete_object_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_domain_id Integer The unique ID of the Domain

Return type

DomainDeleteObjectV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

domain_get_list_v1

domain_get_list_v1(opts)

Retrieve Domain list

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectDomainApi.new
opts = {
  e_order_by: 'pkiDomainID_ASC', # String | Specify how you want the results to be sorted
  i_row_max: 56, # Integer | 
  i_row_offset: 56, # Integer | 
  accept_language: EzmaxApi::HeaderAcceptLanguage::, # HeaderAcceptLanguage | 
  s_filter: 's_filter_example' # String | 
}

begin
  # Retrieve Domain list
  result = api_instance.domain_get_list_v1(opts)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectDomainApi->domain_get_list_v1: #{e}"
end

Using the domain_get_list_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> domain_get_list_v1_with_http_info(opts)

begin
  # Retrieve Domain list
  data, status_code, headers = api_instance.domain_get_list_v1_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DomainGetListV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectDomainApi->domain_get_list_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
e_order_by String Specify how you want the results to be sorted [optional]
i_row_max Integer [optional]
i_row_offset Integer [optional][default to 0]
accept_language HeaderAcceptLanguage [optional]
s_filter String [optional]

Return type

DomainGetListV1Response

Authorization

Authorization

HTTP request headers

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

domain_get_object_v2

domain_get_object_v2(pki_domain_id)

Retrieve an existing Domain

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectDomainApi.new
pki_domain_id = 56 # Integer | The unique ID of the Domain

begin
  # Retrieve an existing Domain
  result = api_instance.domain_get_object_v2(pki_domain_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectDomainApi->domain_get_object_v2: #{e}"
end

Using the domain_get_object_v2_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> domain_get_object_v2_with_http_info(pki_domain_id)

begin
  # Retrieve an existing Domain
  data, status_code, headers = api_instance.domain_get_object_v2_with_http_info(pki_domain_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DomainGetObjectV2Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectDomainApi->domain_get_object_v2_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_domain_id Integer The unique ID of the Domain

Return type

DomainGetObjectV2Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json