Skip to content

Latest commit

 

History

History
475 lines (327 loc) · 15.4 KB

ObjectApikeyAPI.md

File metadata and controls

475 lines (327 loc) · 15.4 KB

ObjectApikeyAPI

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

Method HTTP request Description
apikeyCreateObjectV2 POST /2/object/apikey Create a new Apikey
apikeyEditObjectV1 PUT /1/object/apikey/{pkiApikeyID} Edit an existing Apikey
apikeyEditPermissionsV1 PUT /1/object/apikey/{pkiApikeyID}/editPermissions Edit multiple Permissions
apikeyGetCorsV1 GET /1/object/apikey/{pkiApikeyID}/getCors Retrieve an existing Apikey's cors
apikeyGetListV1 GET /1/object/apikey/getList Retrieve Apikey list
apikeyGetObjectV2 GET /2/object/apikey/{pkiApikeyID} Retrieve an existing Apikey
apikeyGetPermissionsV1 GET /1/object/apikey/{pkiApikeyID}/getPermissions Retrieve an existing Apikey's Permissions
apikeyGetSubnetsV1 GET /1/object/apikey/{pkiApikeyID}/getSubnets Retrieve an existing Apikey's subnets
apikeyRegenerateV1 POST /1/object/apikey/{pkiApikeyID}/regenerate Regenerate the Apikey

apikeyCreateObjectV2

    open class func apikeyCreateObjectV2(apikeyCreateObjectV2Request: ApikeyCreateObjectV2Request, completion: @escaping (_ data: ApikeyCreateObjectV2Response?, _ error: Error?) -> Void)

Create a new Apikey

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 apikeyCreateObjectV2Request = apikey-createObject-v2-Request(aObjApikey: [apikey-RequestCompound(pkiApikeyID: 123, fkiUserID: 123, objApikeyDescription: Multilingual-ApikeyDescription(sApikeyDescription1: "sApikeyDescription1_example", sApikeyDescription2: "sApikeyDescription2_example"), bApikeyIsactive: true, bApikeyIssigned: true)]) // ApikeyCreateObjectV2Request | 

// Create a new Apikey
ObjectApikeyAPI.apikeyCreateObjectV2(apikeyCreateObjectV2Request: apikeyCreateObjectV2Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
apikeyCreateObjectV2Request ApikeyCreateObjectV2Request

Return type

ApikeyCreateObjectV2Response

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]

apikeyEditObjectV1

    open class func apikeyEditObjectV1(pkiApikeyID: Int, apikeyEditObjectV1Request: ApikeyEditObjectV1Request, completion: @escaping (_ data: ApikeyEditObjectV1Response?, _ error: Error?) -> Void)

Edit an existing Apikey

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 pkiApikeyID = 987 // Int | The unique ID of the Apikey
let apikeyEditObjectV1Request = apikey-editObject-v1-Request(objApikey: apikey-RequestCompound(pkiApikeyID: 123, fkiUserID: 123, objApikeyDescription: Multilingual-ApikeyDescription(sApikeyDescription1: "sApikeyDescription1_example", sApikeyDescription2: "sApikeyDescription2_example"), bApikeyIsactive: true, bApikeyIssigned: true)) // ApikeyEditObjectV1Request | 

// Edit an existing Apikey
ObjectApikeyAPI.apikeyEditObjectV1(pkiApikeyID: pkiApikeyID, apikeyEditObjectV1Request: apikeyEditObjectV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiApikeyID Int The unique ID of the Apikey
apikeyEditObjectV1Request ApikeyEditObjectV1Request

Return type

ApikeyEditObjectV1Response

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]

apikeyEditPermissionsV1

    open class func apikeyEditPermissionsV1(pkiApikeyID: Int, apikeyEditPermissionsV1Request: ApikeyEditPermissionsV1Request, completion: @escaping (_ data: ApikeyEditPermissionsV1Response?, _ 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 pkiApikeyID = 987 // Int | 
let apikeyEditPermissionsV1Request = apikey-editPermissions-v1-Request(aObjPermission: [permission-RequestCompound(pkiPermissionID: 123, fkiUserID: 123, fkiApikeyID: 123, fkiUsergroupID: 123, fkiCompanyID: 123, fkiModulesectionID: 123)]) // ApikeyEditPermissionsV1Request | 

// Edit multiple Permissions
ObjectApikeyAPI.apikeyEditPermissionsV1(pkiApikeyID: pkiApikeyID, apikeyEditPermissionsV1Request: apikeyEditPermissionsV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiApikeyID Int
apikeyEditPermissionsV1Request ApikeyEditPermissionsV1Request

Return type

ApikeyEditPermissionsV1Response

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]

apikeyGetCorsV1

    open class func apikeyGetCorsV1(pkiApikeyID: Int, completion: @escaping (_ data: ApikeyGetCorsV1Response?, _ error: Error?) -> Void)

Retrieve an existing Apikey's cors

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

// Retrieve an existing Apikey's cors
ObjectApikeyAPI.apikeyGetCorsV1(pkiApikeyID: pkiApikeyID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiApikeyID Int

Return type

ApikeyGetCorsV1Response

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]

apikeyGetListV1

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

Retrieve Apikey list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---|

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 Apikey list
ObjectApikeyAPI.apikeyGetListV1(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

ApikeyGetListV1Response

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]

apikeyGetObjectV2

    open class func apikeyGetObjectV2(pkiApikeyID: Int, completion: @escaping (_ data: ApikeyGetObjectV2Response?, _ error: Error?) -> Void)

Retrieve an existing Apikey

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

// Retrieve an existing Apikey
ObjectApikeyAPI.apikeyGetObjectV2(pkiApikeyID: pkiApikeyID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiApikeyID Int The unique ID of the Apikey

Return type

ApikeyGetObjectV2Response

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]

apikeyGetPermissionsV1

    open class func apikeyGetPermissionsV1(pkiApikeyID: Int, completion: @escaping (_ data: ApikeyGetPermissionsV1Response?, _ error: Error?) -> Void)

Retrieve an existing Apikey'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 pkiApikeyID = 987 // Int | 

// Retrieve an existing Apikey's Permissions
ObjectApikeyAPI.apikeyGetPermissionsV1(pkiApikeyID: pkiApikeyID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiApikeyID Int

Return type

ApikeyGetPermissionsV1Response

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]

apikeyGetSubnetsV1

    open class func apikeyGetSubnetsV1(pkiApikeyID: Int, completion: @escaping (_ data: ApikeyGetSubnetsV1Response?, _ error: Error?) -> Void)

Retrieve an existing Apikey's subnets

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

// Retrieve an existing Apikey's subnets
ObjectApikeyAPI.apikeyGetSubnetsV1(pkiApikeyID: pkiApikeyID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiApikeyID Int

Return type

ApikeyGetSubnetsV1Response

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]

apikeyRegenerateV1

    open class func apikeyRegenerateV1(pkiApikeyID: Int, apikeyRegenerateV1Request: ApikeyRegenerateV1Request, completion: @escaping (_ data: ApikeyRegenerateV1Response?, _ error: Error?) -> Void)

Regenerate the Apikey

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 pkiApikeyID = 987 // Int | 
let apikeyRegenerateV1Request = apikey-regenerate-v1-Request(bApikeyIssigned: true) // ApikeyRegenerateV1Request | 

// Regenerate the Apikey
ObjectApikeyAPI.apikeyRegenerateV1(pkiApikeyID: pkiApikeyID, apikeyRegenerateV1Request: apikeyRegenerateV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiApikeyID Int
apikeyRegenerateV1Request ApikeyRegenerateV1Request

Return type

ApikeyRegenerateV1Response

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]