Skip to content

Files

Latest commit

 

History

History
304 lines (208 loc) · 11.7 KB

ObjectDiscussionApi.md

File metadata and controls

304 lines (208 loc) · 11.7 KB

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

-(NSURLSessionTask*) discussionCreateObjectV1WithDiscussionCreateObjectV1Request: (DiscussionCreateObjectV1Request*) discussionCreateObjectV1Request
        completionHandler: (void (^)(DiscussionCreateObjectV1Response* output, NSError* error)) handler;

Create a new Discussion

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

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


DiscussionCreateObjectV1Request* discussionCreateObjectV1Request = [[DiscussionCreateObjectV1Request alloc] init]; // 

ObjectDiscussionApi*apiInstance = [[ObjectDiscussionApi alloc] init];

// Create a new Discussion
[apiInstance discussionCreateObjectV1WithDiscussionCreateObjectV1Request:discussionCreateObjectV1Request
          completionHandler: ^(DiscussionCreateObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectDiscussionApi->discussionCreateObjectV1: %@", error);
                        }
                    }];

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

-(NSURLSessionTask*) discussionDeleteObjectV1WithPkiDiscussionID: (NSNumber*) pkiDiscussionID
        completionHandler: (void (^)(DiscussionDeleteObjectV1Response* output, NSError* error)) handler;

Delete an existing Discussion

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiDiscussionID = @56; // The unique ID of the Discussion

ObjectDiscussionApi*apiInstance = [[ObjectDiscussionApi alloc] init];

// Delete an existing Discussion
[apiInstance discussionDeleteObjectV1WithPkiDiscussionID:pkiDiscussionID
          completionHandler: ^(DiscussionDeleteObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectDiscussionApi->discussionDeleteObjectV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiDiscussionID NSNumber* 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

-(NSURLSessionTask*) discussionGetObjectV2WithPkiDiscussionID: (NSNumber*) pkiDiscussionID
        completionHandler: (void (^)(DiscussionGetObjectV2Response* output, NSError* error)) handler;

Retrieve an existing Discussion

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiDiscussionID = @56; // The unique ID of the Discussion

ObjectDiscussionApi*apiInstance = [[ObjectDiscussionApi alloc] init];

// Retrieve an existing Discussion
[apiInstance discussionGetObjectV2WithPkiDiscussionID:pkiDiscussionID
          completionHandler: ^(DiscussionGetObjectV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectDiscussionApi->discussionGetObjectV2: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiDiscussionID NSNumber* 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

-(NSURLSessionTask*) discussionPatchObjectV1WithPkiDiscussionID: (NSNumber*) pkiDiscussionID
    discussionPatchObjectV1Request: (DiscussionPatchObjectV1Request*) discussionPatchObjectV1Request
        completionHandler: (void (^)(DiscussionPatchObjectV1Response* output, NSError* error)) handler;

Patch an existing Discussion

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiDiscussionID = @56; // The unique ID of the Discussion
DiscussionPatchObjectV1Request* discussionPatchObjectV1Request = [[DiscussionPatchObjectV1Request alloc] init]; // 

ObjectDiscussionApi*apiInstance = [[ObjectDiscussionApi alloc] init];

// Patch an existing Discussion
[apiInstance discussionPatchObjectV1WithPkiDiscussionID:pkiDiscussionID
              discussionPatchObjectV1Request:discussionPatchObjectV1Request
          completionHandler: ^(DiscussionPatchObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectDiscussionApi->discussionPatchObjectV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiDiscussionID NSNumber* 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

-(NSURLSessionTask*) discussionUpdateDiscussionreadstatusV1WithPkiDiscussionID: (NSNumber*) pkiDiscussionID
    discussionUpdateDiscussionreadstatusV1Request: (DiscussionUpdateDiscussionreadstatusV1Request*) discussionUpdateDiscussionreadstatusV1Request
        completionHandler: (void (^)(DiscussionUpdateDiscussionreadstatusV1Response* output, NSError* error)) handler;

Update the read status of the discussion

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiDiscussionID = @56; // 
DiscussionUpdateDiscussionreadstatusV1Request* discussionUpdateDiscussionreadstatusV1Request = [[DiscussionUpdateDiscussionreadstatusV1Request alloc] init]; // 

ObjectDiscussionApi*apiInstance = [[ObjectDiscussionApi alloc] init];

// Update the read status of the discussion
[apiInstance discussionUpdateDiscussionreadstatusV1WithPkiDiscussionID:pkiDiscussionID
              discussionUpdateDiscussionreadstatusV1Request:discussionUpdateDiscussionreadstatusV1Request
          completionHandler: ^(DiscussionUpdateDiscussionreadstatusV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectDiscussionApi->discussionUpdateDiscussionreadstatusV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiDiscussionID NSNumber*
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]