Skip to content

Latest commit

 

History

History
214 lines (151 loc) · 5.93 KB

ObjectSubnetApi.md

File metadata and controls

214 lines (151 loc) · 5.93 KB
Raw

ObjectSubnetApi

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

Method HTTP request Description
subnetCreateObjectV1 POST /1/object/subnet Create a new Subnet
subnetDeleteObjectV1 DELETE /1/object/subnet/{pkiSubnetID} Delete an existing Subnet
subnetEditObjectV1 PUT /1/object/subnet/{pkiSubnetID} Edit an existing Subnet
subnetGetObjectV2 GET /2/object/subnet/{pkiSubnetID} Retrieve an existing Subnet

subnetCreateObjectV1

SubnetCreateObjectV1Response subnetCreateObjectV1(subnetCreateObjectV1Request)

Create a new Subnet

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

Example

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

val apiInstance = ObjectSubnetApi()
val subnetCreateObjectV1Request : SubnetCreateObjectV1Request =  // SubnetCreateObjectV1Request | 
try {
    val result : SubnetCreateObjectV1Response = apiInstance.subnetCreateObjectV1(subnetCreateObjectV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectSubnetApi#subnetCreateObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectSubnetApi#subnetCreateObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
subnetCreateObjectV1Request SubnetCreateObjectV1Request

Return type

SubnetCreateObjectV1Response

Authorization

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

HTTP request headers

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

subnetDeleteObjectV1

SubnetDeleteObjectV1Response subnetDeleteObjectV1(pkiSubnetID)

Delete an existing Subnet

Example

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

val apiInstance = ObjectSubnetApi()
val pkiSubnetID : kotlin.Int = 56 // kotlin.Int | The unique ID of the Subnet
try {
    val result : SubnetDeleteObjectV1Response = apiInstance.subnetDeleteObjectV1(pkiSubnetID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectSubnetApi#subnetDeleteObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectSubnetApi#subnetDeleteObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiSubnetID kotlin.Int The unique ID of the Subnet

Return type

SubnetDeleteObjectV1Response

Authorization

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

HTTP request headers

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

subnetEditObjectV1

SubnetEditObjectV1Response subnetEditObjectV1(pkiSubnetID, subnetEditObjectV1Request)

Edit an existing Subnet

Example

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

val apiInstance = ObjectSubnetApi()
val pkiSubnetID : kotlin.Int = 56 // kotlin.Int | The unique ID of the Subnet
val subnetEditObjectV1Request : SubnetEditObjectV1Request =  // SubnetEditObjectV1Request | 
try {
    val result : SubnetEditObjectV1Response = apiInstance.subnetEditObjectV1(pkiSubnetID, subnetEditObjectV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectSubnetApi#subnetEditObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectSubnetApi#subnetEditObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiSubnetID kotlin.Int The unique ID of the Subnet
subnetEditObjectV1Request SubnetEditObjectV1Request

Return type

SubnetEditObjectV1Response

Authorization

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

HTTP request headers

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

subnetGetObjectV2

SubnetGetObjectV2Response subnetGetObjectV2(pkiSubnetID)

Retrieve an existing Subnet

Example

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

val apiInstance = ObjectSubnetApi()
val pkiSubnetID : kotlin.Int = 56 // kotlin.Int | The unique ID of the Subnet
try {
    val result : SubnetGetObjectV2Response = apiInstance.subnetGetObjectV2(pkiSubnetID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectSubnetApi#subnetGetObjectV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectSubnetApi#subnetGetObjectV2")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiSubnetID kotlin.Int The unique ID of the Subnet

Return type

SubnetGetObjectV2Response

Authorization

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

HTTP request headers

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