Skip to content

ObjectEzsignannotationApi.md

Latest commit

 

History

History
336 lines (225 loc) · 12.7 KB

ObjectEzsignannotationApi.md

File metadata and controls

336 lines (225 loc) · 12.7 KB

eZmaxApi.ObjectEzsignannotationApi

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

Method HTTP request Description
ezsignannotation_create_object_v1 POST /1/object/ezsignannotation Create a new Ezsignannotation
ezsignannotation_delete_object_v1 DELETE /1/object/ezsignannotation/{pkiEzsignannotationID} Delete an existing Ezsignannotation
ezsignannotation_edit_object_v1 PUT /1/object/ezsignannotation/{pkiEzsignannotationID} Edit an existing Ezsignannotation
ezsignannotation_get_object_v2 GET /2/object/ezsignannotation/{pkiEzsignannotationID} Retrieve an existing Ezsignannotation

ezsignannotation_create_object_v1

EzsignannotationCreateObjectV1Response ezsignannotation_create_object_v1(ezsignannotation_create_object_v1_request)

Create a new Ezsignannotation

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

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.ezsignannotation_create_object_v1_request import EzsignannotationCreateObjectV1Request
from eZmaxApi.models.ezsignannotation_create_object_v1_response import EzsignannotationCreateObjectV1Response
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.ObjectEzsignannotationApi(api_client)
    ezsignannotation_create_object_v1_request = eZmaxApi.EzsignannotationCreateObjectV1Request() # EzsignannotationCreateObjectV1Request | 

    try:
        # Create a new Ezsignannotation
        api_response = api_instance.ezsignannotation_create_object_v1(ezsignannotation_create_object_v1_request)
        print("The response of ObjectEzsignannotationApi->ezsignannotation_create_object_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignannotationApi->ezsignannotation_create_object_v1: %s\n" % e)

Parameters

Name Type Description Notes
ezsignannotation_create_object_v1_request EzsignannotationCreateObjectV1Request

Return type

EzsignannotationCreateObjectV1Response

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]

ezsignannotation_delete_object_v1

EzsignannotationDeleteObjectV1Response ezsignannotation_delete_object_v1(pki_ezsignannotation_id)

Delete an existing Ezsignannotation

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.ezsignannotation_delete_object_v1_response import EzsignannotationDeleteObjectV1Response
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.ObjectEzsignannotationApi(api_client)
    pki_ezsignannotation_id = 56 # int | 

    try:
        # Delete an existing Ezsignannotation
        api_response = api_instance.ezsignannotation_delete_object_v1(pki_ezsignannotation_id)
        print("The response of ObjectEzsignannotationApi->ezsignannotation_delete_object_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignannotationApi->ezsignannotation_delete_object_v1: %s\n" % e)

Parameters

Name Type Description Notes
pki_ezsignannotation_id int

Return type

EzsignannotationDeleteObjectV1Response

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]

ezsignannotation_edit_object_v1

EzsignannotationEditObjectV1Response ezsignannotation_edit_object_v1(pki_ezsignannotation_id, ezsignannotation_edit_object_v1_request)

Edit an existing Ezsignannotation

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.ezsignannotation_edit_object_v1_request import EzsignannotationEditObjectV1Request
from eZmaxApi.models.ezsignannotation_edit_object_v1_response import EzsignannotationEditObjectV1Response
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.ObjectEzsignannotationApi(api_client)
    pki_ezsignannotation_id = 56 # int | 
    ezsignannotation_edit_object_v1_request = eZmaxApi.EzsignannotationEditObjectV1Request() # EzsignannotationEditObjectV1Request | 

    try:
        # Edit an existing Ezsignannotation
        api_response = api_instance.ezsignannotation_edit_object_v1(pki_ezsignannotation_id, ezsignannotation_edit_object_v1_request)
        print("The response of ObjectEzsignannotationApi->ezsignannotation_edit_object_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignannotationApi->ezsignannotation_edit_object_v1: %s\n" % e)

Parameters

Name Type Description Notes
pki_ezsignannotation_id int
ezsignannotation_edit_object_v1_request EzsignannotationEditObjectV1Request

Return type

EzsignannotationEditObjectV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: application/json
  • 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 -
422 The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body -

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

ezsignannotation_get_object_v2

EzsignannotationGetObjectV2Response ezsignannotation_get_object_v2(pki_ezsignannotation_id)

Retrieve an existing Ezsignannotation

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.ezsignannotation_get_object_v2_response import EzsignannotationGetObjectV2Response
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.ObjectEzsignannotationApi(api_client)
    pki_ezsignannotation_id = 56 # int | 

    try:
        # Retrieve an existing Ezsignannotation
        api_response = api_instance.ezsignannotation_get_object_v2(pki_ezsignannotation_id)
        print("The response of ObjectEzsignannotationApi->ezsignannotation_get_object_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignannotationApi->ezsignannotation_get_object_v2: %s\n" % e)

Parameters

Name Type Description Notes
pki_ezsignannotation_id int

Return type

EzsignannotationGetObjectV2Response

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]