Skip to content

Latest commit

 

History

History
210 lines (151 loc) · 6.89 KB

ObjectEzsignannotationApi.md

File metadata and controls

210 lines (151 loc) · 6.89 KB

ObjectEzsignannotationApi

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

Method HTTP request Description
ezsignannotationCreateObjectV1 POST /1/object/ezsignannotation Create a new Ezsignannotation
ezsignannotationDeleteObjectV1 DELETE /1/object/ezsignannotation/{pkiEzsignannotationID} Delete an existing Ezsignannotation
ezsignannotationEditObjectV1 PUT /1/object/ezsignannotation/{pkiEzsignannotationID} Edit an existing Ezsignannotation
ezsignannotationGetObjectV2 GET /2/object/ezsignannotation/{pkiEzsignannotationID} Retrieve an existing Ezsignannotation

ezsignannotationCreateObjectV1

EzsignannotationCreateObjectV1Response ezsignannotationCreateObjectV1(ezsignannotationCreateObjectV1Request)

Create a new Ezsignannotation

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

Example

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

val apiInstance = ObjectEzsignannotationApi()
val ezsignannotationCreateObjectV1Request : EzsignannotationCreateObjectV1Request =  // EzsignannotationCreateObjectV1Request | 
try {
    val result : EzsignannotationCreateObjectV1Response = apiInstance.ezsignannotationCreateObjectV1(ezsignannotationCreateObjectV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignannotationApi#ezsignannotationCreateObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignannotationApi#ezsignannotationCreateObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
ezsignannotationCreateObjectV1Request EzsignannotationCreateObjectV1Request

Return type

EzsignannotationCreateObjectV1Response

Authorization

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

HTTP request headers

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

ezsignannotationDeleteObjectV1

EzsignannotationDeleteObjectV1Response ezsignannotationDeleteObjectV1(pkiEzsignannotationID)

Delete an existing Ezsignannotation

Example

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

val apiInstance = ObjectEzsignannotationApi()
val pkiEzsignannotationID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsignannotationDeleteObjectV1Response = apiInstance.ezsignannotationDeleteObjectV1(pkiEzsignannotationID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignannotationApi#ezsignannotationDeleteObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignannotationApi#ezsignannotationDeleteObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignannotationID kotlin.Int

Return type

EzsignannotationDeleteObjectV1Response

Authorization

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

HTTP request headers

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

ezsignannotationEditObjectV1

EzsignannotationEditObjectV1Response ezsignannotationEditObjectV1(pkiEzsignannotationID, ezsignannotationEditObjectV1Request)

Edit an existing Ezsignannotation

Example

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

val apiInstance = ObjectEzsignannotationApi()
val pkiEzsignannotationID : kotlin.Int = 56 // kotlin.Int | 
val ezsignannotationEditObjectV1Request : EzsignannotationEditObjectV1Request =  // EzsignannotationEditObjectV1Request | 
try {
    val result : EzsignannotationEditObjectV1Response = apiInstance.ezsignannotationEditObjectV1(pkiEzsignannotationID, ezsignannotationEditObjectV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignannotationApi#ezsignannotationEditObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignannotationApi#ezsignannotationEditObjectV1")
    e.printStackTrace()
}

Parameters

| pkiEzsignannotationID | kotlin.Int| | |

Name Type Description Notes
ezsignannotationEditObjectV1Request EzsignannotationEditObjectV1Request

Return type

EzsignannotationEditObjectV1Response

Authorization

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

HTTP request headers

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

ezsignannotationGetObjectV2

EzsignannotationGetObjectV2Response ezsignannotationGetObjectV2(pkiEzsignannotationID)

Retrieve an existing Ezsignannotation

Example

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

val apiInstance = ObjectEzsignannotationApi()
val pkiEzsignannotationID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsignannotationGetObjectV2Response = apiInstance.ezsignannotationGetObjectV2(pkiEzsignannotationID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignannotationApi#ezsignannotationGetObjectV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignannotationApi#ezsignannotationGetObjectV2")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignannotationID kotlin.Int

Return type

EzsignannotationGetObjectV2Response

Authorization

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

HTTP request headers

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