Skip to content

Latest commit

 

History

History
220 lines (149 loc) · 6.8 KB

ObjectDomainAPI.md

File metadata and controls

220 lines (149 loc) · 6.8 KB

ObjectDomainAPI

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

Method HTTP request Description
domainCreateObjectV1 POST /1/object/domain Create a new Domain
domainDeleteObjectV1 DELETE /1/object/domain/{pkiDomainID} Delete an existing Domain
domainGetListV1 GET /1/object/domain/getList Retrieve Domain list
domainGetObjectV2 GET /2/object/domain/{pkiDomainID} Retrieve an existing Domain

domainCreateObjectV1

    open class func domainCreateObjectV1(domainCreateObjectV1Request: DomainCreateObjectV1Request, completion: @escaping (_ data: DomainCreateObjectV1Response?, _ error: Error?) -> Void)

Create a new Domain

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 domainCreateObjectV1Request = domain-createObject-v1-Request(aObjDomain: [domain-RequestCompound(pkiDomainID: 123, sDomainName: "sDomainName_example")]) // DomainCreateObjectV1Request | 

// Create a new Domain
ObjectDomainAPI.domainCreateObjectV1(domainCreateObjectV1Request: domainCreateObjectV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
domainCreateObjectV1Request DomainCreateObjectV1Request

Return type

DomainCreateObjectV1Response

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]

domainDeleteObjectV1

    open class func domainDeleteObjectV1(pkiDomainID: Int, completion: @escaping (_ data: DomainDeleteObjectV1Response?, _ error: Error?) -> Void)

Delete an existing Domain

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

// Delete an existing Domain
ObjectDomainAPI.domainDeleteObjectV1(pkiDomainID: pkiDomainID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiDomainID Int The unique ID of the Domain

Return type

DomainDeleteObjectV1Response

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]

domainGetListV1

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

Retrieve Domain 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 Domain list
ObjectDomainAPI.domainGetListV1(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

DomainGetListV1Response

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]

domainGetObjectV2

    open class func domainGetObjectV2(pkiDomainID: Int, completion: @escaping (_ data: DomainGetObjectV2Response?, _ error: Error?) -> Void)

Retrieve an existing Domain

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

// Retrieve an existing Domain
ObjectDomainAPI.domainGetObjectV2(pkiDomainID: pkiDomainID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiDomainID Int The unique ID of the Domain

Return type

DomainGetObjectV2Response

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]