Skip to content

Latest commit

 

History

History
265 lines (179 loc) · 9.09 KB

ObjectDiscussionAPI.md

File metadata and controls

265 lines (179 loc) · 9.09 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

    open class func discussionCreateObjectV1(discussionCreateObjectV1Request: DiscussionCreateObjectV1Request, completion: @escaping (_ data: DiscussionCreateObjectV1Response?, _ error: Error?) -> Void)

Create a new Discussion

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let discussionCreateObjectV1Request = discussion-createObject-v1-Request(aObjDiscussion: [discussion-RequestCompound(pkiDiscussionID: 123, sDiscussionDescription: "sDiscussionDescription_example", bDiscussionClosed: true)]) // DiscussionCreateObjectV1Request | 

// Create a new Discussion
ObjectDiscussionAPI.discussionCreateObjectV1(discussionCreateObjectV1Request: discussionCreateObjectV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
discussionCreateObjectV1Request DiscussionCreateObjectV1Request

Return type

DiscussionCreateObjectV1Response

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]

discussionDeleteObjectV1

    open class func discussionDeleteObjectV1(pkiDiscussionID: Int, completion: @escaping (_ data: DiscussionDeleteObjectV1Response?, _ error: Error?) -> Void)

Delete an existing Discussion

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiDiscussionID = 987 // Int | The unique ID of the Discussion

// Delete an existing Discussion
ObjectDiscussionAPI.discussionDeleteObjectV1(pkiDiscussionID: pkiDiscussionID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

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

Return type

DiscussionDeleteObjectV1Response

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]

discussionGetObjectV2

    open class func discussionGetObjectV2(pkiDiscussionID: Int, completion: @escaping (_ data: DiscussionGetObjectV2Response?, _ error: Error?) -> Void)

Retrieve an existing Discussion

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiDiscussionID = 987 // Int | The unique ID of the Discussion

// Retrieve an existing Discussion
ObjectDiscussionAPI.discussionGetObjectV2(pkiDiscussionID: pkiDiscussionID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

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

Return type

DiscussionGetObjectV2Response

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]

discussionPatchObjectV1

    open class func discussionPatchObjectV1(pkiDiscussionID: Int, discussionPatchObjectV1Request: DiscussionPatchObjectV1Request, completion: @escaping (_ data: DiscussionPatchObjectV1Response?, _ error: Error?) -> Void)

Patch an existing Discussion

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiDiscussionID = 987 // Int | The unique ID of the Discussion
let discussionPatchObjectV1Request = discussion-patchObject-v1-Request(objDiscussion: discussion-RequestPatch(sDiscussionDescription: "sDiscussionDescription_example", bDiscussionClosed: true)) // DiscussionPatchObjectV1Request | 

// Patch an existing Discussion
ObjectDiscussionAPI.discussionPatchObjectV1(pkiDiscussionID: pkiDiscussionID, discussionPatchObjectV1Request: discussionPatchObjectV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

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

Return type

DiscussionPatchObjectV1Response

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]

discussionUpdateDiscussionreadstatusV1

    open class func discussionUpdateDiscussionreadstatusV1(pkiDiscussionID: Int, discussionUpdateDiscussionreadstatusV1Request: DiscussionUpdateDiscussionreadstatusV1Request, completion: @escaping (_ data: DiscussionUpdateDiscussionreadstatusV1Response?, _ error: Error?) -> Void)

Update the read status of the discussion

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiDiscussionID = 987 // Int | 
let discussionUpdateDiscussionreadstatusV1Request = discussion-updateDiscussionreadstatus-v1-Request(dtDiscussionreadstatusDate: "dtDiscussionreadstatusDate_example") // DiscussionUpdateDiscussionreadstatusV1Request | 

// Update the read status of the discussion
ObjectDiscussionAPI.discussionUpdateDiscussionreadstatusV1(pkiDiscussionID: pkiDiscussionID, discussionUpdateDiscussionreadstatusV1Request: discussionUpdateDiscussionreadstatusV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiDiscussionID Int
discussionUpdateDiscussionreadstatusV1Request DiscussionUpdateDiscussionreadstatusV1Request

Return type

DiscussionUpdateDiscussionreadstatusV1Response

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]