Skip to content

Latest commit

 

History

History
428 lines (310 loc) · 15.3 KB

ObjectUsergroupexternalApi.md

File metadata and controls

428 lines (310 loc) · 15.3 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

UsergroupexternalCreateObjectV1Response usergroupexternalCreateObjectV1(usergroupexternalCreateObjectV1Request)

Create a new Usergroupexternal

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

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectUsergroupexternalApi()
val usergroupexternalCreateObjectV1Request : UsergroupexternalCreateObjectV1Request =  // UsergroupexternalCreateObjectV1Request | 
try {
    val result : UsergroupexternalCreateObjectV1Response = apiInstance.usergroupexternalCreateObjectV1(usergroupexternalCreateObjectV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectUsergroupexternalApi#usergroupexternalCreateObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectUsergroupexternalApi#usergroupexternalCreateObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
usergroupexternalCreateObjectV1Request UsergroupexternalCreateObjectV1Request

Return type

UsergroupexternalCreateObjectV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

usergroupexternalDeleteObjectV1

UsergroupexternalDeleteObjectV1Response usergroupexternalDeleteObjectV1(pkiUsergroupexternalID)

Delete an existing Usergroupexternal

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectUsergroupexternalApi()
val pkiUsergroupexternalID : kotlin.Int = 56 // kotlin.Int | The unique ID of the Usergroupexternal
try {
    val result : UsergroupexternalDeleteObjectV1Response = apiInstance.usergroupexternalDeleteObjectV1(pkiUsergroupexternalID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectUsergroupexternalApi#usergroupexternalDeleteObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectUsergroupexternalApi#usergroupexternalDeleteObjectV1")
    e.printStackTrace()
}

Parameters

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

Return type

UsergroupexternalDeleteObjectV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

usergroupexternalEditObjectV1

UsergroupexternalEditObjectV1Response usergroupexternalEditObjectV1(pkiUsergroupexternalID, usergroupexternalEditObjectV1Request)

Edit an existing Usergroupexternal

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectUsergroupexternalApi()
val pkiUsergroupexternalID : kotlin.Int = 56 // kotlin.Int | The unique ID of the Usergroupexternal
val usergroupexternalEditObjectV1Request : UsergroupexternalEditObjectV1Request =  // UsergroupexternalEditObjectV1Request | 
try {
    val result : UsergroupexternalEditObjectV1Response = apiInstance.usergroupexternalEditObjectV1(pkiUsergroupexternalID, usergroupexternalEditObjectV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectUsergroupexternalApi#usergroupexternalEditObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectUsergroupexternalApi#usergroupexternalEditObjectV1")
    e.printStackTrace()
}

Parameters

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

Return type

UsergroupexternalEditObjectV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

usergroupexternalGetAutocompleteV2

UsergroupexternalGetAutocompleteV2Response usergroupexternalGetAutocompleteV2(sSelector, eFilterActive, sQuery, acceptLanguage)

Retrieve Usergroupexternals and IDs

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

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectUsergroupexternalApi()
val sSelector : kotlin.String = sSelector_example // kotlin.String | The type of Usergroupexternals to return
val eFilterActive : kotlin.String = eFilterActive_example // kotlin.String | Specify which results we want to display.
val sQuery : kotlin.String = sQuery_example // kotlin.String | Allow to filter the returned results
val acceptLanguage : HeaderAcceptLanguage =  // HeaderAcceptLanguage | 
try {
    val result : UsergroupexternalGetAutocompleteV2Response = apiInstance.usergroupexternalGetAutocompleteV2(sSelector, eFilterActive, sQuery, acceptLanguage)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectUsergroupexternalApi#usergroupexternalGetAutocompleteV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectUsergroupexternalApi#usergroupexternalGetAutocompleteV2")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
sSelector kotlin.String The type of Usergroupexternals to return [enum: All]
eFilterActive kotlin.String Specify which results we want to display. [optional] [default to Active] [enum: All, Active, Inactive]
sQuery kotlin.String Allow to filter the returned results [optional]
acceptLanguage HeaderAcceptLanguage [optional] [enum: *, en, fr]

Return type

UsergroupexternalGetAutocompleteV2Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

usergroupexternalGetListV1

UsergroupexternalGetListV1Response usergroupexternalGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter)

Retrieve Usergroupexternal list

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectUsergroupexternalApi()
val eOrderBy : kotlin.String = eOrderBy_example // kotlin.String | Specify how you want the results to be sorted
val iRowMax : kotlin.Int = 56 // kotlin.Int | 
val iRowOffset : kotlin.Int = 56 // kotlin.Int | 
val acceptLanguage : HeaderAcceptLanguage =  // HeaderAcceptLanguage | 
val sFilter : kotlin.String = sFilter_example // kotlin.String | 
try {
    val result : UsergroupexternalGetListV1Response = apiInstance.usergroupexternalGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectUsergroupexternalApi#usergroupexternalGetListV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectUsergroupexternalApi#usergroupexternalGetListV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
eOrderBy kotlin.String Specify how you want the results to be sorted [optional] [enum: pkiUsergroupexternalID_ASC, pkiUsergroupexternalID_DESC, sUsergroupexternalName_ASC, sUsergroupexternalName_DESC, sUsergroupexternalID_ASC, sUsergroupexternalID_DESC]
iRowMax kotlin.Int [optional]
iRowOffset kotlin.Int [optional] [default to 0]
acceptLanguage HeaderAcceptLanguage [optional] [enum: *, en, fr]
sFilter kotlin.String [optional]

Return type

UsergroupexternalGetListV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

usergroupexternalGetObjectV2

UsergroupexternalGetObjectV2Response usergroupexternalGetObjectV2(pkiUsergroupexternalID)

Retrieve an existing Usergroupexternal

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectUsergroupexternalApi()
val pkiUsergroupexternalID : kotlin.Int = 56 // kotlin.Int | The unique ID of the Usergroupexternal
try {
    val result : UsergroupexternalGetObjectV2Response = apiInstance.usergroupexternalGetObjectV2(pkiUsergroupexternalID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectUsergroupexternalApi#usergroupexternalGetObjectV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectUsergroupexternalApi#usergroupexternalGetObjectV2")
    e.printStackTrace()
}

Parameters

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

Return type

UsergroupexternalGetObjectV2Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

usergroupexternalGetUsergroupexternalmembershipsV1

UsergroupexternalGetUsergroupexternalmembershipsV1Response usergroupexternalGetUsergroupexternalmembershipsV1(pkiUsergroupexternalID)

Retrieve an existing Usergroupexternal's Usergroupexternalmemberships

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectUsergroupexternalApi()
val pkiUsergroupexternalID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : UsergroupexternalGetUsergroupexternalmembershipsV1Response = apiInstance.usergroupexternalGetUsergroupexternalmembershipsV1(pkiUsergroupexternalID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectUsergroupexternalApi#usergroupexternalGetUsergroupexternalmembershipsV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectUsergroupexternalApi#usergroupexternalGetUsergroupexternalmembershipsV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiUsergroupexternalID kotlin.Int

Return type

UsergroupexternalGetUsergroupexternalmembershipsV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

usergroupexternalGetUsergroupsV1

UsergroupexternalGetUsergroupsV1Response usergroupexternalGetUsergroupsV1(pkiUsergroupexternalID)

Get Usergroupexternal's Usergroups

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectUsergroupexternalApi()
val pkiUsergroupexternalID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : UsergroupexternalGetUsergroupsV1Response = apiInstance.usergroupexternalGetUsergroupsV1(pkiUsergroupexternalID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectUsergroupexternalApi#usergroupexternalGetUsergroupsV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectUsergroupexternalApi#usergroupexternalGetUsergroupsV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiUsergroupexternalID kotlin.Int

Return type

UsergroupexternalGetUsergroupsV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json