ObjectUsergroupAPI

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

    open class func usergroupCreateObjectV1(usergroupCreateObjectV1Request: UsergroupCreateObjectV1Request, completion: @escaping (_ data: UsergroupCreateObjectV1Response?, _ error: Error?) -> Void)

Create a new Usergroup

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 usergroupCreateObjectV1Request = usergroup-createObject-v1-Request(aObjUsergroup: [usergroup-RequestCompound(pkiUsergroupID: 123, objUsergroupName: Multilingual-UsergroupName(sUsergroupName1: "sUsergroupName1_example", sUsergroupName2: "sUsergroupName2_example"))]) // UsergroupCreateObjectV1Request | 

// Create a new Usergroup
ObjectUsergroupAPI.usergroupCreateObjectV1(usergroupCreateObjectV1Request: usergroupCreateObjectV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
usergroupCreateObjectV1Request	UsergroupCreateObjectV1Request

Return type

UsergroupCreateObjectV1Response

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

    open class func usergroupEditObjectV1(pkiUsergroupID: Int, usergroupEditObjectV1Request: UsergroupEditObjectV1Request, completion: @escaping (_ data: UsergroupEditObjectV1Response?, _ error: Error?) -> Void)

Edit an existing Usergroup

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 pkiUsergroupID = 987 // Int | 
let usergroupEditObjectV1Request = usergroup-editObject-v1-Request(objUsergroup: usergroup-RequestCompound(pkiUsergroupID: 123, objUsergroupName: Multilingual-UsergroupName(sUsergroupName1: "sUsergroupName1_example", sUsergroupName2: "sUsergroupName2_example"))) // UsergroupEditObjectV1Request | 

// Edit an existing Usergroup
ObjectUsergroupAPI.usergroupEditObjectV1(pkiUsergroupID: pkiUsergroupID, usergroupEditObjectV1Request: usergroupEditObjectV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiUsergroupID	Int
usergroupEditObjectV1Request	UsergroupEditObjectV1Request

Return type

UsergroupEditObjectV1Response

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

    open class func usergroupEditPermissionsV1(pkiUsergroupID: Int, usergroupEditPermissionsV1Request: UsergroupEditPermissionsV1Request, completion: @escaping (_ data: UsergroupEditPermissionsV1Response?, _ error: Error?) -> Void)

Edit multiple Permissions

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

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 pkiUsergroupID = 987 // Int | 
let usergroupEditPermissionsV1Request = usergroup-editPermissions-v1-Request(aObjPermission: [permission-RequestCompound(pkiPermissionID: 123, fkiUserID: 123, fkiApikeyID: 123, fkiUsergroupID: 123, fkiCompanyID: 123, fkiModulesectionID: 123)]) // UsergroupEditPermissionsV1Request | 

// Edit multiple Permissions
ObjectUsergroupAPI.usergroupEditPermissionsV1(pkiUsergroupID: pkiUsergroupID, usergroupEditPermissionsV1Request: usergroupEditPermissionsV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiUsergroupID	Int
usergroupEditPermissionsV1Request	UsergroupEditPermissionsV1Request

Return type

UsergroupEditPermissionsV1Response

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

    open class func usergroupEditUsergroupdelegationsV1(pkiUsergroupID: Int, usergroupEditUsergroupdelegationsV1Request: UsergroupEditUsergroupdelegationsV1Request, completion: @escaping (_ data: UsergroupEditUsergroupdelegationsV1Response?, _ error: Error?) -> Void)

Edit multiple Usergroupdelegations

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 pkiUsergroupID = 987 // Int | 
let usergroupEditUsergroupdelegationsV1Request = usergroup-editUsergroupdelegations-v1-Request(aObjUsergroupdelegation: [usergroupdelegation-RequestCompound(pkiUsergroupdelegationID: 123, fkiUsergroupID: 123, fkiUserID: 123)]) // UsergroupEditUsergroupdelegationsV1Request | 

// Edit multiple Usergroupdelegations
ObjectUsergroupAPI.usergroupEditUsergroupdelegationsV1(pkiUsergroupID: pkiUsergroupID, usergroupEditUsergroupdelegationsV1Request: usergroupEditUsergroupdelegationsV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiUsergroupID	Int
usergroupEditUsergroupdelegationsV1Request	UsergroupEditUsergroupdelegationsV1Request

Return type

UsergroupEditUsergroupdelegationsV1Response

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

    open class func usergroupEditUsergroupmembershipsV1(pkiUsergroupID: Int, usergroupEditUsergroupmembershipsV1Request: UsergroupEditUsergroupmembershipsV1Request, completion: @escaping (_ data: UsergroupEditUsergroupmembershipsV1Response?, _ error: Error?) -> Void)

Edit multiple Usergroupmemberships

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

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 pkiUsergroupID = 987 // Int | 
let usergroupEditUsergroupmembershipsV1Request = usergroup-editUsergroupmemberships-v1-Request(aObjUsergroupmembership: [usergroupmembership-RequestCompound(pkiUsergroupmembershipID: 123, fkiUsergroupID: 123, fkiUserID: 123, fkiUsergroupexternalID: 123)]) // UsergroupEditUsergroupmembershipsV1Request | 

// Edit multiple Usergroupmemberships
ObjectUsergroupAPI.usergroupEditUsergroupmembershipsV1(pkiUsergroupID: pkiUsergroupID, usergroupEditUsergroupmembershipsV1Request: usergroupEditUsergroupmembershipsV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiUsergroupID	Int
usergroupEditUsergroupmembershipsV1Request	UsergroupEditUsergroupmembershipsV1Request

Return type

UsergroupEditUsergroupmembershipsV1Response

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

    open class func usergroupGetAutocompleteV2(sSelector: SSelector_usergroupGetAutocompleteV2, eFilterActive: EFilterActive_usergroupGetAutocompleteV2? = nil, sQuery: String? = nil, acceptLanguage: HeaderAcceptLanguage? = nil, completion: @escaping (_ data: UsergroupGetAutocompleteV2Response?, _ error: Error?) -> Void)

Retrieve Usergroups and IDs

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

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 sSelector = "sSelector_example" // String | The type of Usergroups to return
let eFilterActive = "eFilterActive_example" // String | Specify which results we want to display. (optional) (default to .active)
let sQuery = "sQuery_example" // String | Allow to filter the returned results (optional)
let acceptLanguage = Header-Accept-Language() // HeaderAcceptLanguage |  (optional)

// Retrieve Usergroups and IDs
ObjectUsergroupAPI.usergroupGetAutocompleteV2(sSelector: sSelector, eFilterActive: eFilterActive, sQuery: sQuery, acceptLanguage: acceptLanguage) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

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

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

    open class func usergroupGetListV1(eOrderBy: EOrderBy_usergroupGetListV1? = nil, iRowMax: Int? = nil, iRowOffset: Int? = nil, acceptLanguage: HeaderAcceptLanguage? = nil, sFilter: String? = nil, completion: @escaping (_ data: UsergroupGetListV1Response?, _ error: Error?) -> Void)

Retrieve Usergroup list

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 eOrderBy = "eOrderBy_example" // String | Specify how you want the results to be sorted (optional)
let iRowMax = 987 // Int |  (optional)
let iRowOffset = 987 // Int |  (optional) (default to 0)
let acceptLanguage = Header-Accept-Language() // HeaderAcceptLanguage |  (optional)
let sFilter = "sFilter_example" // String |  (optional)

// Retrieve Usergroup list
ObjectUsergroupAPI.usergroupGetListV1(eOrderBy: eOrderBy, iRowMax: iRowMax, iRowOffset: iRowOffset, acceptLanguage: acceptLanguage, sFilter: sFilter) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

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

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

    open class func usergroupGetObjectV2(pkiUsergroupID: Int, completion: @escaping (_ data: UsergroupGetObjectV2Response?, _ error: Error?) -> Void)

Retrieve an existing Usergroup

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 pkiUsergroupID = 987 // Int | 

// Retrieve an existing Usergroup
ObjectUsergroupAPI.usergroupGetObjectV2(pkiUsergroupID: pkiUsergroupID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiUsergroupID	Int

Return type

UsergroupGetObjectV2Response

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

    open class func usergroupGetPermissionsV1(pkiUsergroupID: Int, completion: @escaping (_ data: UsergroupGetPermissionsV1Response?, _ error: Error?) -> Void)

Retrieve an existing Usergroup's Permissions

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 pkiUsergroupID = 987 // Int | 

// Retrieve an existing Usergroup's Permissions
ObjectUsergroupAPI.usergroupGetPermissionsV1(pkiUsergroupID: pkiUsergroupID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiUsergroupID	Int

Return type

UsergroupGetPermissionsV1Response

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

    open class func usergroupGetUsergroupdelegationsV1(pkiUsergroupID: Int, completion: @escaping (_ data: UsergroupGetUsergroupdelegationsV1Response?, _ error: Error?) -> Void)

Retrieve an existing Usergroup's Usergroupdelegations

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 pkiUsergroupID = 987 // Int | 

// Retrieve an existing Usergroup's Usergroupdelegations
ObjectUsergroupAPI.usergroupGetUsergroupdelegationsV1(pkiUsergroupID: pkiUsergroupID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiUsergroupID	Int

Return type

UsergroupGetUsergroupdelegationsV1Response

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

    open class func usergroupGetUsergroupmembershipsV1(pkiUsergroupID: Int, completion: @escaping (_ data: UsergroupGetUsergroupmembershipsV1Response?, _ error: Error?) -> Void)

Retrieve an existing Usergroup's Usergroupmemberships

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 pkiUsergroupID = 987 // Int | 

// Retrieve an existing Usergroup's Usergroupmemberships
ObjectUsergroupAPI.usergroupGetUsergroupmembershipsV1(pkiUsergroupID: pkiUsergroupID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiUsergroupID	Int

Return type

UsergroupGetUsergroupmembershipsV1Response

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]

Files

ObjectUsergroupAPI.md

Latest commit

History

ObjectUsergroupAPI.md

File metadata and controls

ObjectUsergroupAPI

usergroupCreateObjectV1

Example

Parameters

Return type

Authorization

HTTP request headers

usergroupEditObjectV1

Example

Parameters

Return type

Authorization

HTTP request headers

usergroupEditPermissionsV1

Example

Parameters

Return type

Authorization

HTTP request headers

usergroupEditUsergroupdelegationsV1

Example

Parameters

Return type

Authorization

HTTP request headers

usergroupEditUsergroupmembershipsV1

Example

Parameters

Return type

Authorization

HTTP request headers

usergroupGetAutocompleteV2

Example

Parameters

Return type

Authorization

HTTP request headers

usergroupGetListV1

Example

Parameters

Return type

Authorization

HTTP request headers

usergroupGetObjectV2

Example

Parameters

Return type

Authorization

HTTP request headers

usergroupGetPermissionsV1

Example

Parameters

Return type

Authorization

HTTP request headers

usergroupGetUsergroupdelegationsV1

Example

Parameters

Return type

Authorization

HTTP request headers

usergroupGetUsergroupmembershipsV1

Example

Parameters

Return type

Authorization

HTTP request headers