Skip to content

Latest commit

 

History

History
557 lines (387 loc) · 20.3 KB

ObjectUsergroupApi.md

File metadata and controls

557 lines (387 loc) · 20.3 KB

openapi.api.ObjectUsergroupApi

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
usergroupCreateObjectV1 POST /1/object/usergroup Create a new Usergroup
usergroupEditObjectV1 PUT /1/object/usergroup/{pkiUsergroupID} Edit an existing Usergroup
usergroupEditPermissionsV1 PUT /1/object/usergroup/{pkiUsergroupID}/editPermissions Edit multiple Permissions
usergroupEditUsergroupdelegationsV1 PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupdelegations Edit multiple Usergroupdelegations
usergroupEditUsergroupmembershipsV1 PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupmemberships Edit multiple Usergroupmemberships
usergroupGetAutocompleteV2 GET /2/object/usergroup/getAutocomplete/{sSelector} Retrieve Usergroups and IDs
usergroupGetListV1 GET /1/object/usergroup/getList Retrieve Usergroup list
usergroupGetObjectV2 GET /2/object/usergroup/{pkiUsergroupID} Retrieve an existing Usergroup
usergroupGetPermissionsV1 GET /1/object/usergroup/{pkiUsergroupID}/getPermissions Retrieve an existing Usergroup's Permissions
usergroupGetUsergroupdelegationsV1 GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupdelegations Retrieve an existing Usergroup's Usergroupdelegations
usergroupGetUsergroupmembershipsV1 GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupmemberships Retrieve an existing Usergroup's Usergroupmemberships

usergroupCreateObjectV1

UsergroupCreateObjectV1Response usergroupCreateObjectV1(usergroupCreateObjectV1Request)

Create a new Usergroup

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 = ObjectUsergroupApi();
final usergroupCreateObjectV1Request = UsergroupCreateObjectV1Request(); // UsergroupCreateObjectV1Request | 

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

Parameters

Name Type Description Notes
usergroupCreateObjectV1Request UsergroupCreateObjectV1Request

Return type

UsergroupCreateObjectV1Response

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]

usergroupEditObjectV1

UsergroupEditObjectV1Response usergroupEditObjectV1(pkiUsergroupID, usergroupEditObjectV1Request)

Edit an existing Usergroup

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 = ObjectUsergroupApi();
final pkiUsergroupID = 56; // int | 
final usergroupEditObjectV1Request = UsergroupEditObjectV1Request(); // UsergroupEditObjectV1Request | 

try {
    final result = api_instance.usergroupEditObjectV1(pkiUsergroupID, usergroupEditObjectV1Request);
    print(result);
} catch (e) {
    print('Exception when calling ObjectUsergroupApi->usergroupEditObjectV1: $e\n');
}

Parameters

Name Type Description Notes
pkiUsergroupID int
usergroupEditObjectV1Request UsergroupEditObjectV1Request

Return type

UsergroupEditObjectV1Response

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]

usergroupEditPermissionsV1

UsergroupEditPermissionsV1Response usergroupEditPermissionsV1(pkiUsergroupID, usergroupEditPermissionsV1Request)

Edit multiple Permissions

Using this endpoint, you can edit multiple Permissions at the same time.

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 = ObjectUsergroupApi();
final pkiUsergroupID = 56; // int | 
final usergroupEditPermissionsV1Request = UsergroupEditPermissionsV1Request(); // UsergroupEditPermissionsV1Request | 

try {
    final result = api_instance.usergroupEditPermissionsV1(pkiUsergroupID, usergroupEditPermissionsV1Request);
    print(result);
} catch (e) {
    print('Exception when calling ObjectUsergroupApi->usergroupEditPermissionsV1: $e\n');
}

Parameters

Name Type Description Notes
pkiUsergroupID int
usergroupEditPermissionsV1Request UsergroupEditPermissionsV1Request

Return type

UsergroupEditPermissionsV1Response

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]

usergroupEditUsergroupdelegationsV1

UsergroupEditUsergroupdelegationsV1Response usergroupEditUsergroupdelegationsV1(pkiUsergroupID, usergroupEditUsergroupdelegationsV1Request)

Edit multiple Usergroupdelegations

Edit multiple Usergroupdelegations

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 = ObjectUsergroupApi();
final pkiUsergroupID = 56; // int | 
final usergroupEditUsergroupdelegationsV1Request = UsergroupEditUsergroupdelegationsV1Request(); // UsergroupEditUsergroupdelegationsV1Request | 

try {
    final result = api_instance.usergroupEditUsergroupdelegationsV1(pkiUsergroupID, usergroupEditUsergroupdelegationsV1Request);
    print(result);
} catch (e) {
    print('Exception when calling ObjectUsergroupApi->usergroupEditUsergroupdelegationsV1: $e\n');
}

Parameters

Name Type Description Notes
pkiUsergroupID int
usergroupEditUsergroupdelegationsV1Request UsergroupEditUsergroupdelegationsV1Request

Return type

UsergroupEditUsergroupdelegationsV1Response

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]

usergroupEditUsergroupmembershipsV1

UsergroupEditUsergroupmembershipsV1Response usergroupEditUsergroupmembershipsV1(pkiUsergroupID, usergroupEditUsergroupmembershipsV1Request)

Edit multiple Usergroupmemberships

Using this endpoint, you can edit multiple Usergroupmemberships at the same time.

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 = ObjectUsergroupApi();
final pkiUsergroupID = 56; // int | 
final usergroupEditUsergroupmembershipsV1Request = UsergroupEditUsergroupmembershipsV1Request(); // UsergroupEditUsergroupmembershipsV1Request | 

try {
    final result = api_instance.usergroupEditUsergroupmembershipsV1(pkiUsergroupID, usergroupEditUsergroupmembershipsV1Request);
    print(result);
} catch (e) {
    print('Exception when calling ObjectUsergroupApi->usergroupEditUsergroupmembershipsV1: $e\n');
}

Parameters

Name Type Description Notes
pkiUsergroupID int
usergroupEditUsergroupmembershipsV1Request UsergroupEditUsergroupmembershipsV1Request

Return type

UsergroupEditUsergroupmembershipsV1Response

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]

usergroupGetAutocompleteV2

UsergroupGetAutocompleteV2Response usergroupGetAutocompleteV2(sSelector, eFilterActive, sQuery, acceptLanguage)

Retrieve Usergroups and IDs

Get the list of Usergroup to be used in a dropdown or autocomplete control.

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 = ObjectUsergroupApi();
final sSelector = sSelector_example; // String | The type of Usergroups to return
final eFilterActive = eFilterActive_example; // String | Specify which results we want to display.
final sQuery = sQuery_example; // String | Allow to filter the returned results
final acceptLanguage = ; // HeaderAcceptLanguage | 

try {
    final result = api_instance.usergroupGetAutocompleteV2(sSelector, eFilterActive, sQuery, acceptLanguage);
    print(result);
} catch (e) {
    print('Exception when calling ObjectUsergroupApi->usergroupGetAutocompleteV2: $e\n');
}

Parameters

Name Type Description Notes
sSelector String The type of Usergroups to return
eFilterActive String Specify which results we want to display. [optional] [default to 'Active']
sQuery String Allow to filter the returned results [optional]
acceptLanguage HeaderAcceptLanguage [optional]

Return type

UsergroupGetAutocompleteV2Response

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]

usergroupGetListV1

UsergroupGetListV1Response usergroupGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter)

Retrieve Usergroup list

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 = ObjectUsergroupApi();
final eOrderBy = eOrderBy_example; // String | Specify how you want the results to be sorted
final iRowMax = 56; // int | 
final iRowOffset = 56; // int | 
final acceptLanguage = ; // HeaderAcceptLanguage | 
final sFilter = sFilter_example; // String | 

try {
    final result = api_instance.usergroupGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter);
    print(result);
} catch (e) {
    print('Exception when calling ObjectUsergroupApi->usergroupGetListV1: $e\n');
}

Parameters

Name Type Description Notes
eOrderBy String Specify how you want the results to be sorted [optional]
iRowMax int [optional]
iRowOffset int [optional] [default to 0]
acceptLanguage HeaderAcceptLanguage [optional]
sFilter String [optional]

Return type

UsergroupGetListV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

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

usergroupGetObjectV2

UsergroupGetObjectV2Response usergroupGetObjectV2(pkiUsergroupID)

Retrieve an existing Usergroup

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 = ObjectUsergroupApi();
final pkiUsergroupID = 56; // int | 

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

Parameters

Name Type Description Notes
pkiUsergroupID int

Return type

UsergroupGetObjectV2Response

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]

usergroupGetPermissionsV1

UsergroupGetPermissionsV1Response usergroupGetPermissionsV1(pkiUsergroupID)

Retrieve an existing Usergroup's Permissions

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 = ObjectUsergroupApi();
final pkiUsergroupID = 56; // int | 

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

Parameters

Name Type Description Notes
pkiUsergroupID int

Return type

UsergroupGetPermissionsV1Response

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]

usergroupGetUsergroupdelegationsV1

UsergroupGetUsergroupdelegationsV1Response usergroupGetUsergroupdelegationsV1(pkiUsergroupID)

Retrieve an existing Usergroup's Usergroupdelegations

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 = ObjectUsergroupApi();
final pkiUsergroupID = 56; // int | 

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

Parameters

Name Type Description Notes
pkiUsergroupID int

Return type

UsergroupGetUsergroupdelegationsV1Response

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]

usergroupGetUsergroupmembershipsV1

UsergroupGetUsergroupmembershipsV1Response usergroupGetUsergroupmembershipsV1(pkiUsergroupID)

Retrieve an existing Usergroup's Usergroupmemberships

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 = ObjectUsergroupApi();
final pkiUsergroupID = 56; // int | 

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

Parameters

Name Type Description Notes
pkiUsergroupID int

Return type

UsergroupGetUsergroupmembershipsV1Response

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]