Skip to content

Latest commit

 

History

History
428 lines (294 loc) · 16 KB

ObjectUsergroupexternalAPI.md

File metadata and controls

428 lines (294 loc) · 16 KB
Raw

ObjectUsergroupexternalAPI

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Method HTTP request Description
usergroupexternalCreateObjectV1 POST /1/object/usergroupexternal Create a new Usergroupexternal
usergroupexternalDeleteObjectV1 DELETE /1/object/usergroupexternal/{pkiUsergroupexternalID} Delete an existing Usergroupexternal
usergroupexternalEditObjectV1 PUT /1/object/usergroupexternal/{pkiUsergroupexternalID} Edit an existing Usergroupexternal
usergroupexternalGetAutocompleteV2 GET /2/object/usergroupexternal/getAutocomplete/{sSelector} Retrieve Usergroupexternals and IDs
usergroupexternalGetListV1 GET /1/object/usergroupexternal/getList Retrieve Usergroupexternal list
usergroupexternalGetObjectV2 GET /2/object/usergroupexternal/{pkiUsergroupexternalID} Retrieve an existing Usergroupexternal
usergroupexternalGetUsergroupexternalmembershipsV1 GET /1/object/usergroupexternal/{pkiUsergroupexternalID}/getUsergroupexternalmemberships Retrieve an existing Usergroupexternal's Usergroupexternalmemberships
usergroupexternalGetUsergroupsV1 GET /1/object/usergroupexternal/{pkiUsergroupexternalID}/getUsergroups Get Usergroupexternal's Usergroups

usergroupexternalCreateObjectV1

    open class func usergroupexternalCreateObjectV1(usergroupexternalCreateObjectV1Request: UsergroupexternalCreateObjectV1Request, completion: @escaping (_ data: UsergroupexternalCreateObjectV1Response?, _ error: Error?) -> Void)

Create a new Usergroupexternal

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 usergroupexternalCreateObjectV1Request = usergroupexternal-createObject-v1-Request(aObjUsergroupexternal: [usergroupexternal-RequestCompound(pkiUsergroupexternalID: 123, sUsergroupexternalName: "sUsergroupexternalName_example", sUsergroupexternalID: "sUsergroupexternalID_example")]) // UsergroupexternalCreateObjectV1Request | 

// Create a new Usergroupexternal
ObjectUsergroupexternalAPI.usergroupexternalCreateObjectV1(usergroupexternalCreateObjectV1Request: usergroupexternalCreateObjectV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
usergroupexternalCreateObjectV1Request UsergroupexternalCreateObjectV1Request

Return type

UsergroupexternalCreateObjectV1Response

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]

usergroupexternalDeleteObjectV1

    open class func usergroupexternalDeleteObjectV1(pkiUsergroupexternalID: Int, completion: @escaping (_ data: UsergroupexternalDeleteObjectV1Response?, _ error: Error?) -> Void)

Delete an existing Usergroupexternal

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 pkiUsergroupexternalID = 987 // Int | The unique ID of the Usergroupexternal

// Delete an existing Usergroupexternal
ObjectUsergroupexternalAPI.usergroupexternalDeleteObjectV1(pkiUsergroupexternalID: pkiUsergroupexternalID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiUsergroupexternalID Int The unique ID of the Usergroupexternal

Return type

UsergroupexternalDeleteObjectV1Response

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]

usergroupexternalEditObjectV1

    open class func usergroupexternalEditObjectV1(pkiUsergroupexternalID: Int, usergroupexternalEditObjectV1Request: UsergroupexternalEditObjectV1Request, completion: @escaping (_ data: UsergroupexternalEditObjectV1Response?, _ error: Error?) -> Void)

Edit an existing Usergroupexternal

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 pkiUsergroupexternalID = 987 // Int | The unique ID of the Usergroupexternal
let usergroupexternalEditObjectV1Request = usergroupexternal-editObject-v1-Request(objUsergroupexternal: usergroupexternal-RequestCompound(pkiUsergroupexternalID: 123, sUsergroupexternalName: "sUsergroupexternalName_example", sUsergroupexternalID: "sUsergroupexternalID_example")) // UsergroupexternalEditObjectV1Request | 

// Edit an existing Usergroupexternal
ObjectUsergroupexternalAPI.usergroupexternalEditObjectV1(pkiUsergroupexternalID: pkiUsergroupexternalID, usergroupexternalEditObjectV1Request: usergroupexternalEditObjectV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiUsergroupexternalID Int The unique ID of the Usergroupexternal
usergroupexternalEditObjectV1Request UsergroupexternalEditObjectV1Request

Return type

UsergroupexternalEditObjectV1Response

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]

usergroupexternalGetAutocompleteV2

    open class func usergroupexternalGetAutocompleteV2(sSelector: SSelector_usergroupexternalGetAutocompleteV2, eFilterActive: EFilterActive_usergroupexternalGetAutocompleteV2? = nil, sQuery: String? = nil, acceptLanguage: HeaderAcceptLanguage? = nil, completion: @escaping (_ data: UsergroupexternalGetAutocompleteV2Response?, _ error: Error?) -> Void)

Retrieve Usergroupexternals and IDs

Get the list of Usergroupexternal 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 Usergroupexternals 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 Usergroupexternals and IDs
ObjectUsergroupexternalAPI.usergroupexternalGetAutocompleteV2(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 Usergroupexternals 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

UsergroupexternalGetAutocompleteV2Response

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]

usergroupexternalGetListV1

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

Retrieve Usergroupexternal 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 Usergroupexternal list
ObjectUsergroupexternalAPI.usergroupexternalGetListV1(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

UsergroupexternalGetListV1Response

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]

usergroupexternalGetObjectV2

    open class func usergroupexternalGetObjectV2(pkiUsergroupexternalID: Int, completion: @escaping (_ data: UsergroupexternalGetObjectV2Response?, _ error: Error?) -> Void)

Retrieve an existing Usergroupexternal

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 pkiUsergroupexternalID = 987 // Int | The unique ID of the Usergroupexternal

// Retrieve an existing Usergroupexternal
ObjectUsergroupexternalAPI.usergroupexternalGetObjectV2(pkiUsergroupexternalID: pkiUsergroupexternalID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiUsergroupexternalID Int The unique ID of the Usergroupexternal

Return type

UsergroupexternalGetObjectV2Response

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]

usergroupexternalGetUsergroupexternalmembershipsV1

    open class func usergroupexternalGetUsergroupexternalmembershipsV1(pkiUsergroupexternalID: Int, completion: @escaping (_ data: UsergroupexternalGetUsergroupexternalmembershipsV1Response?, _ error: Error?) -> Void)

Retrieve an existing Usergroupexternal's Usergroupexternalmemberships

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

// Retrieve an existing Usergroupexternal's Usergroupexternalmemberships
ObjectUsergroupexternalAPI.usergroupexternalGetUsergroupexternalmembershipsV1(pkiUsergroupexternalID: pkiUsergroupexternalID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiUsergroupexternalID Int

Return type

UsergroupexternalGetUsergroupexternalmembershipsV1Response

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]

usergroupexternalGetUsergroupsV1

    open class func usergroupexternalGetUsergroupsV1(pkiUsergroupexternalID: Int, completion: @escaping (_ data: UsergroupexternalGetUsergroupsV1Response?, _ error: Error?) -> Void)

Get Usergroupexternal's Usergroups

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

// Get Usergroupexternal's Usergroups
ObjectUsergroupexternalAPI.usergroupexternalGetUsergroupsV1(pkiUsergroupexternalID: pkiUsergroupexternalID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiUsergroupexternalID Int

Return type

UsergroupexternalGetUsergroupsV1Response

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]