Skip to content

Latest commit

 

History

History
168 lines (114 loc) · 6.5 KB

ObjectDiscussionAPI.md

File metadata and controls

168 lines (114 loc) · 6.5 KB
Raw

ObjectDiscussionAPI

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

Method HTTP request Description
ObjectDiscussionAPI_discussionCreateObjectV1 POST /1/object/discussion Create a new Discussion
ObjectDiscussionAPI_discussionDeleteObjectV1 DELETE /1/object/discussion/{pkiDiscussionID} Delete an existing Discussion
ObjectDiscussionAPI_discussionGetObjectV2 GET /2/object/discussion/{pkiDiscussionID} Retrieve an existing Discussion
ObjectDiscussionAPI_discussionPatchObjectV1 PATCH /1/object/discussion/{pkiDiscussionID} Patch an existing Discussion
ObjectDiscussionAPI_discussionUpdateDiscussionreadstatusV1 POST /1/object/discussion/{pkiDiscussionID}/updateDiscussionreadstatus Update the read status of the discussion

ObjectDiscussionAPI_discussionCreateObjectV1

// Create a new Discussion
//
// The endpoint allows to create one or many elements at once.
//
discussion_create_object_v1_response_t* ObjectDiscussionAPI_discussionCreateObjectV1(apiClient_t *apiClient, discussion_create_object_v1_request_t *discussion_create_object_v1_request);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
discussion_create_object_v1_request discussion_create_object_v1_request_t *

Return type

discussion_create_object_v1_response_t *

Authorization

Authorization

HTTP request headers

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

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

ObjectDiscussionAPI_discussionDeleteObjectV1

// Delete an existing Discussion
//
// 
//
discussion_delete_object_v1_response_t* ObjectDiscussionAPI_discussionDeleteObjectV1(apiClient_t *apiClient, int *pkiDiscussionID);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiDiscussionID int * The unique ID of the Discussion

Return type

discussion_delete_object_v1_response_t *

Authorization

Authorization

HTTP request headers

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

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

ObjectDiscussionAPI_discussionGetObjectV2

// Retrieve an existing Discussion
//
// 
//
discussion_get_object_v2_response_t* ObjectDiscussionAPI_discussionGetObjectV2(apiClient_t *apiClient, int *pkiDiscussionID);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiDiscussionID int * The unique ID of the Discussion

Return type

discussion_get_object_v2_response_t *

Authorization

Authorization

HTTP request headers

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

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

ObjectDiscussionAPI_discussionPatchObjectV1

// Patch an existing Discussion
//
// 
//
discussion_patch_object_v1_response_t* ObjectDiscussionAPI_discussionPatchObjectV1(apiClient_t *apiClient, int *pkiDiscussionID, discussion_patch_object_v1_request_t *discussion_patch_object_v1_request);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiDiscussionID int * The unique ID of the Discussion
discussion_patch_object_v1_request discussion_patch_object_v1_request_t *

Return type

discussion_patch_object_v1_response_t *

Authorization

Authorization

HTTP request headers

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

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

ObjectDiscussionAPI_discussionUpdateDiscussionreadstatusV1

// Update the read status of the discussion
//
discussion_update_discussionreadstatus_v1_response_t* ObjectDiscussionAPI_discussionUpdateDiscussionreadstatusV1(apiClient_t *apiClient, int *pkiDiscussionID, discussion_update_discussionreadstatus_v1_request_t *discussion_update_discussionreadstatus_v1_request);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiDiscussionID int *
discussion_update_discussionreadstatus_v1_request discussion_update_discussionreadstatus_v1_request_t *

Return type

discussion_update_discussionreadstatus_v1_response_t *

Authorization

Authorization

HTTP request headers

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

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