Skip to content

Latest commit

 

History

History
256 lines (172 loc) · 10.2 KB

ObjectDiscussionmessageApi.md

File metadata and controls

256 lines (172 loc) · 10.2 KB
Raw

eZmaxApi.ObjectDiscussionmessageApi

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

Method HTTP request Description
discussionmessage_create_object_v1 POST /1/object/discussionmessage Create a new Discussionmessage
discussionmessage_delete_object_v1 DELETE /1/object/discussionmessage/{pkiDiscussionmessageID} Delete an existing Discussionmessage
discussionmessage_patch_object_v1 PATCH /1/object/discussionmessage/{pkiDiscussionmessageID} Patch an existing Discussionmessage

discussionmessage_create_object_v1

DiscussionmessageCreateObjectV1Response discussionmessage_create_object_v1(discussionmessage_create_object_v1_request)

Create a new Discussionmessage

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

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.discussionmessage_create_object_v1_request import DiscussionmessageCreateObjectV1Request
from eZmaxApi.models.discussionmessage_create_object_v1_response import DiscussionmessageCreateObjectV1Response
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.ObjectDiscussionmessageApi(api_client)
    discussionmessage_create_object_v1_request = eZmaxApi.DiscussionmessageCreateObjectV1Request() # DiscussionmessageCreateObjectV1Request | 

    try:
        # Create a new Discussionmessage
        api_response = api_instance.discussionmessage_create_object_v1(discussionmessage_create_object_v1_request)
        print("The response of ObjectDiscussionmessageApi->discussionmessage_create_object_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectDiscussionmessageApi->discussionmessage_create_object_v1: %s\n" % e)

Parameters

Name Type Description Notes
discussionmessage_create_object_v1_request DiscussionmessageCreateObjectV1Request

Return type

DiscussionmessageCreateObjectV1Response

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]

discussionmessage_delete_object_v1

DiscussionmessageDeleteObjectV1Response discussionmessage_delete_object_v1(pki_discussionmessage_id)

Delete an existing Discussionmessage

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.discussionmessage_delete_object_v1_response import DiscussionmessageDeleteObjectV1Response
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.ObjectDiscussionmessageApi(api_client)
    pki_discussionmessage_id = 56 # int | The unique ID of the Discussionmessage

    try:
        # Delete an existing Discussionmessage
        api_response = api_instance.discussionmessage_delete_object_v1(pki_discussionmessage_id)
        print("The response of ObjectDiscussionmessageApi->discussionmessage_delete_object_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectDiscussionmessageApi->discussionmessage_delete_object_v1: %s\n" % e)

Parameters

Name Type Description Notes
pki_discussionmessage_id int The unique ID of the Discussionmessage

Return type

DiscussionmessageDeleteObjectV1Response

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 -
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]

discussionmessage_patch_object_v1

DiscussionmessagePatchObjectV1Response discussionmessage_patch_object_v1(pki_discussionmessage_id, discussionmessage_patch_object_v1_request)

Patch an existing Discussionmessage

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.discussionmessage_patch_object_v1_request import DiscussionmessagePatchObjectV1Request
from eZmaxApi.models.discussionmessage_patch_object_v1_response import DiscussionmessagePatchObjectV1Response
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.ObjectDiscussionmessageApi(api_client)
    pki_discussionmessage_id = 56 # int | The unique ID of the Discussionmessage
    discussionmessage_patch_object_v1_request = eZmaxApi.DiscussionmessagePatchObjectV1Request() # DiscussionmessagePatchObjectV1Request | 

    try:
        # Patch an existing Discussionmessage
        api_response = api_instance.discussionmessage_patch_object_v1(pki_discussionmessage_id, discussionmessage_patch_object_v1_request)
        print("The response of ObjectDiscussionmessageApi->discussionmessage_patch_object_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectDiscussionmessageApi->discussionmessage_patch_object_v1: %s\n" % e)

Parameters

Name Type Description Notes
pki_discussionmessage_id int The unique ID of the Discussionmessage
discussionmessage_patch_object_v1_request DiscussionmessagePatchObjectV1Request

Return type

DiscussionmessagePatchObjectV1Response

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]