Skip to content

Latest commit

 

History

History
265 lines (189 loc) · 8.41 KB

ObjectDiscussionApi.md

File metadata and controls

265 lines (189 loc) · 8.41 KB
Raw

ObjectDiscussionApi

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

Method HTTP request Description
discussionCreateObjectV1 POST /1/object/discussion Create a new Discussion
discussionDeleteObjectV1 DELETE /1/object/discussion/{pkiDiscussionID} Delete an existing Discussion
discussionGetObjectV2 GET /2/object/discussion/{pkiDiscussionID} Retrieve an existing Discussion
discussionPatchObjectV1 PATCH /1/object/discussion/{pkiDiscussionID} Patch an existing Discussion
discussionUpdateDiscussionreadstatusV1 POST /1/object/discussion/{pkiDiscussionID}/updateDiscussionreadstatus Update the read status of the discussion

discussionCreateObjectV1

DiscussionCreateObjectV1Response discussionCreateObjectV1(discussionCreateObjectV1Request)

Create a new Discussion

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

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectDiscussionApi()
val discussionCreateObjectV1Request : DiscussionCreateObjectV1Request =  // DiscussionCreateObjectV1Request | 
try {
    val result : DiscussionCreateObjectV1Response = apiInstance.discussionCreateObjectV1(discussionCreateObjectV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectDiscussionApi#discussionCreateObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectDiscussionApi#discussionCreateObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
discussionCreateObjectV1Request DiscussionCreateObjectV1Request

Return type

DiscussionCreateObjectV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

discussionDeleteObjectV1

DiscussionDeleteObjectV1Response discussionDeleteObjectV1(pkiDiscussionID)

Delete an existing Discussion

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectDiscussionApi()
val pkiDiscussionID : kotlin.Int = 56 // kotlin.Int | The unique ID of the Discussion
try {
    val result : DiscussionDeleteObjectV1Response = apiInstance.discussionDeleteObjectV1(pkiDiscussionID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectDiscussionApi#discussionDeleteObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectDiscussionApi#discussionDeleteObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiDiscussionID kotlin.Int The unique ID of the Discussion

Return type

DiscussionDeleteObjectV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

discussionGetObjectV2

DiscussionGetObjectV2Response discussionGetObjectV2(pkiDiscussionID)

Retrieve an existing Discussion

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectDiscussionApi()
val pkiDiscussionID : kotlin.Int = 56 // kotlin.Int | The unique ID of the Discussion
try {
    val result : DiscussionGetObjectV2Response = apiInstance.discussionGetObjectV2(pkiDiscussionID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectDiscussionApi#discussionGetObjectV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectDiscussionApi#discussionGetObjectV2")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiDiscussionID kotlin.Int The unique ID of the Discussion

Return type

DiscussionGetObjectV2Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

discussionPatchObjectV1

DiscussionPatchObjectV1Response discussionPatchObjectV1(pkiDiscussionID, discussionPatchObjectV1Request)

Patch an existing Discussion

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectDiscussionApi()
val pkiDiscussionID : kotlin.Int = 56 // kotlin.Int | The unique ID of the Discussion
val discussionPatchObjectV1Request : DiscussionPatchObjectV1Request =  // DiscussionPatchObjectV1Request | 
try {
    val result : DiscussionPatchObjectV1Response = apiInstance.discussionPatchObjectV1(pkiDiscussionID, discussionPatchObjectV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectDiscussionApi#discussionPatchObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectDiscussionApi#discussionPatchObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiDiscussionID kotlin.Int The unique ID of the Discussion
discussionPatchObjectV1Request DiscussionPatchObjectV1Request

Return type

DiscussionPatchObjectV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

discussionUpdateDiscussionreadstatusV1

DiscussionUpdateDiscussionreadstatusV1Response discussionUpdateDiscussionreadstatusV1(pkiDiscussionID, discussionUpdateDiscussionreadstatusV1Request)

Update the read status of the discussion

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectDiscussionApi()
val pkiDiscussionID : kotlin.Int = 56 // kotlin.Int | 
val discussionUpdateDiscussionreadstatusV1Request : DiscussionUpdateDiscussionreadstatusV1Request =  // DiscussionUpdateDiscussionreadstatusV1Request | 
try {
    val result : DiscussionUpdateDiscussionreadstatusV1Response = apiInstance.discussionUpdateDiscussionreadstatusV1(pkiDiscussionID, discussionUpdateDiscussionreadstatusV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectDiscussionApi#discussionUpdateDiscussionreadstatusV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectDiscussionApi#discussionUpdateDiscussionreadstatusV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiDiscussionID kotlin.Int
discussionUpdateDiscussionreadstatusV1Request DiscussionUpdateDiscussionreadstatusV1Request

Return type

DiscussionUpdateDiscussionreadstatusV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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