Skip to content

Latest commit

 

History

History
251 lines (167 loc) · 9.34 KB

ObjectEzsigndiscussionApi.md

File metadata and controls

251 lines (167 loc) · 9.34 KB

eZmaxApi.ObjectEzsigndiscussionApi

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

Method HTTP request Description
ezsigndiscussion_create_object_v1 POST /1/object/ezsigndiscussion Create a new Ezsigndiscussion
ezsigndiscussion_delete_object_v1 DELETE /1/object/ezsigndiscussion/{pkiEzsigndiscussionID} Delete an existing Ezsigndiscussion
ezsigndiscussion_get_object_v2 GET /2/object/ezsigndiscussion/{pkiEzsigndiscussionID} Retrieve an existing Ezsigndiscussion

ezsigndiscussion_create_object_v1

EzsigndiscussionCreateObjectV1Response ezsigndiscussion_create_object_v1(ezsigndiscussion_create_object_v1_request)

Create a new Ezsigndiscussion

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

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.ezsigndiscussion_create_object_v1_request import EzsigndiscussionCreateObjectV1Request
from eZmaxApi.models.ezsigndiscussion_create_object_v1_response import EzsigndiscussionCreateObjectV1Response
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.ObjectEzsigndiscussionApi(api_client)
    ezsigndiscussion_create_object_v1_request = eZmaxApi.EzsigndiscussionCreateObjectV1Request() # EzsigndiscussionCreateObjectV1Request | 

    try:
        # Create a new Ezsigndiscussion
        api_response = api_instance.ezsigndiscussion_create_object_v1(ezsigndiscussion_create_object_v1_request)
        print("The response of ObjectEzsigndiscussionApi->ezsigndiscussion_create_object_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsigndiscussionApi->ezsigndiscussion_create_object_v1: %s\n" % e)

Parameters

Name Type Description Notes
ezsigndiscussion_create_object_v1_request EzsigndiscussionCreateObjectV1Request

Return type

EzsigndiscussionCreateObjectV1Response

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]

ezsigndiscussion_delete_object_v1

EzsigndiscussionDeleteObjectV1Response ezsigndiscussion_delete_object_v1(pki_ezsigndiscussion_id)

Delete an existing Ezsigndiscussion

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.ezsigndiscussion_delete_object_v1_response import EzsigndiscussionDeleteObjectV1Response
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.ObjectEzsigndiscussionApi(api_client)
    pki_ezsigndiscussion_id = 56 # int | The unique ID of the Ezsigndiscussion

    try:
        # Delete an existing Ezsigndiscussion
        api_response = api_instance.ezsigndiscussion_delete_object_v1(pki_ezsigndiscussion_id)
        print("The response of ObjectEzsigndiscussionApi->ezsigndiscussion_delete_object_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsigndiscussionApi->ezsigndiscussion_delete_object_v1: %s\n" % e)

Parameters

Name Type Description Notes
pki_ezsigndiscussion_id int The unique ID of the Ezsigndiscussion

Return type

EzsigndiscussionDeleteObjectV1Response

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]

ezsigndiscussion_get_object_v2

EzsigndiscussionGetObjectV2Response ezsigndiscussion_get_object_v2(pki_ezsigndiscussion_id)

Retrieve an existing Ezsigndiscussion

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.ezsigndiscussion_get_object_v2_response import EzsigndiscussionGetObjectV2Response
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.ObjectEzsigndiscussionApi(api_client)
    pki_ezsigndiscussion_id = 56 # int | The unique ID of the Ezsigndiscussion

    try:
        # Retrieve an existing Ezsigndiscussion
        api_response = api_instance.ezsigndiscussion_get_object_v2(pki_ezsigndiscussion_id)
        print("The response of ObjectEzsigndiscussionApi->ezsigndiscussion_get_object_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsigndiscussionApi->ezsigndiscussion_get_object_v2: %s\n" % e)

Parameters

Name Type Description Notes
pki_ezsigndiscussion_id int The unique ID of the Ezsigndiscussion

Return type

EzsigndiscussionGetObjectV2Response

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]