Skip to content

Latest commit

 

History

History
255 lines (173 loc) · 9.04 KB

ObjectDiscussionApi.md

File metadata and controls

255 lines (173 loc) · 9.04 KB

openapi.api.ObjectDiscussionApi

Load the API package

import 'package:openapi/api.dart';

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 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectDiscussionApi();
final discussionCreateObjectV1Request = DiscussionCreateObjectV1Request(); // DiscussionCreateObjectV1Request | 

try {
    final result = api_instance.discussionCreateObjectV1(discussionCreateObjectV1Request);
    print(result);
} catch (e) {
    print('Exception when calling ObjectDiscussionApi->discussionCreateObjectV1: $e\n');
}

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

DiscussionDeleteObjectV1Response discussionDeleteObjectV1(pkiDiscussionID)

Delete an existing Discussion

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectDiscussionApi();
final pkiDiscussionID = 56; // int | The unique ID of the Discussion

try {
    final result = api_instance.discussionDeleteObjectV1(pkiDiscussionID);
    print(result);
} catch (e) {
    print('Exception when calling ObjectDiscussionApi->discussionDeleteObjectV1: $e\n');
}

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

DiscussionGetObjectV2Response discussionGetObjectV2(pkiDiscussionID)

Retrieve an existing Discussion

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectDiscussionApi();
final pkiDiscussionID = 56; // int | The unique ID of the Discussion

try {
    final result = api_instance.discussionGetObjectV2(pkiDiscussionID);
    print(result);
} catch (e) {
    print('Exception when calling ObjectDiscussionApi->discussionGetObjectV2: $e\n');
}

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

DiscussionPatchObjectV1Response discussionPatchObjectV1(pkiDiscussionID, discussionPatchObjectV1Request)

Patch an existing Discussion

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectDiscussionApi();
final pkiDiscussionID = 56; // int | The unique ID of the Discussion
final discussionPatchObjectV1Request = DiscussionPatchObjectV1Request(); // DiscussionPatchObjectV1Request | 

try {
    final result = api_instance.discussionPatchObjectV1(pkiDiscussionID, discussionPatchObjectV1Request);
    print(result);
} catch (e) {
    print('Exception when calling ObjectDiscussionApi->discussionPatchObjectV1: $e\n');
}

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

DiscussionUpdateDiscussionreadstatusV1Response discussionUpdateDiscussionreadstatusV1(pkiDiscussionID, discussionUpdateDiscussionreadstatusV1Request)

Update the read status of the discussion

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectDiscussionApi();
final pkiDiscussionID = 56; // int | 
final discussionUpdateDiscussionreadstatusV1Request = DiscussionUpdateDiscussionreadstatusV1Request(); // DiscussionUpdateDiscussionreadstatusV1Request | 

try {
    final result = api_instance.discussionUpdateDiscussionreadstatusV1(pkiDiscussionID, discussionUpdateDiscussionreadstatusV1Request);
    print(result);
} catch (e) {
    print('Exception when calling ObjectDiscussionApi->discussionUpdateDiscussionreadstatusV1: $e\n');
}

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]