Skip to content

Latest commit

 

History

History
428 lines (291 loc) · 15.6 KB

ObjectDomainApi.md

File metadata and controls

428 lines (291 loc) · 15.6 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_autocomplete_v2 GET /2/object/domain/getAutocomplete/{sSelector} Retrieve Domain and IDs
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

DomainCreateObjectV1Response domain_create_object_v1(domain_create_object_v1_request)

Create a new Domain

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

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.domain_create_object_v1_request import DomainCreateObjectV1Request
from eZmaxApi.models.domain_create_object_v1_response import DomainCreateObjectV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectDomainApi(api_client)
    domain_create_object_v1_request = eZmaxApi.DomainCreateObjectV1Request() # DomainCreateObjectV1Request | 

    try:
        # Create a new Domain
        api_response = api_instance.domain_create_object_v1(domain_create_object_v1_request)
        print("The response of ObjectDomainApi->domain_create_object_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectDomainApi->domain_create_object_v1: %s\n" % e)

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

HTTP response details

Status code Description Response headers
201 Successful response -

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

domain_delete_object_v1

DomainDeleteObjectV1Response domain_delete_object_v1(pki_domain_id)

Delete an existing Domain

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.domain_delete_object_v1_response import DomainDeleteObjectV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectDomainApi(api_client)
    pki_domain_id = 56 # int | The unique ID of the Domain

    try:
        # Delete an existing Domain
        api_response = api_instance.domain_delete_object_v1(pki_domain_id)
        print("The response of ObjectDomainApi->domain_delete_object_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectDomainApi->domain_delete_object_v1: %s\n" % e)

Parameters

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

Return type

DomainDeleteObjectV1Response

Authorization

Authorization

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful response -
404 The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body -

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

domain_get_autocomplete_v2

DomainGetAutocompleteV2Response domain_get_autocomplete_v2(s_selector, e_filter_active=e_filter_active, s_query=s_query, accept_language=accept_language)

Retrieve Domain and IDs

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

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.domain_get_autocomplete_v2_response import DomainGetAutocompleteV2Response
from eZmaxApi.models.header_accept_language import HeaderAcceptLanguage
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectDomainApi(api_client)
    s_selector = 's_selector_example' # str | The type of Domain to return
    e_filter_active = Active # str | Specify which results we want to display. (optional) (default to Active)
    s_query = 's_query_example' # str | Allow to filter the returned results (optional)
    accept_language = eZmaxApi.HeaderAcceptLanguage() # HeaderAcceptLanguage |  (optional)

    try:
        # Retrieve Domain and IDs
        api_response = api_instance.domain_get_autocomplete_v2(s_selector, e_filter_active=e_filter_active, s_query=s_query, accept_language=accept_language)
        print("The response of ObjectDomainApi->domain_get_autocomplete_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectDomainApi->domain_get_autocomplete_v2: %s\n" % e)

Parameters

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

Return type

DomainGetAutocompleteV2Response

Authorization

Authorization

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful response -

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

domain_get_list_v1

DomainGetListV1Response domain_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 Domain list

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.domain_get_list_v1_response import DomainGetListV1Response
from eZmaxApi.models.header_accept_language import HeaderAcceptLanguage
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectDomainApi(api_client)
    e_order_by = 'e_order_by_example' # str | Specify how you want the results to be sorted (optional)
    i_row_max = 56 # int |  (optional)
    i_row_offset = 0 # int |  (optional) (default to 0)
    accept_language = eZmaxApi.HeaderAcceptLanguage() # HeaderAcceptLanguage |  (optional)
    s_filter = 's_filter_example' # str |  (optional)

    try:
        # Retrieve Domain list
        api_response = api_instance.domain_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("The response of ObjectDomainApi->domain_get_list_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectDomainApi->domain_get_list_v1: %s\n" % e)

Parameters

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

Return type

DomainGetListV1Response

Authorization

Authorization

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful response -
406 The URL is valid, but one of the Accept header is not defined or invalid. For example, you set the header "Accept: application/json" but the function can only return "Content-type: image/png" -

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

domain_get_object_v2

DomainGetObjectV2Response domain_get_object_v2(pki_domain_id)

Retrieve an existing Domain

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.domain_get_object_v2_response import DomainGetObjectV2Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectDomainApi(api_client)
    pki_domain_id = 56 # int | The unique ID of the Domain

    try:
        # Retrieve an existing Domain
        api_response = api_instance.domain_get_object_v2(pki_domain_id)
        print("The response of ObjectDomainApi->domain_get_object_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectDomainApi->domain_get_object_v2: %s\n" % e)

Parameters

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

Return type

DomainGetObjectV2Response

Authorization

Authorization

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful response -
404 The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body -

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