Skip to content

Latest commit

 

History

History
538 lines (388 loc) · 18.4 KB

ObjectEzsigntemplateApi.md

File metadata and controls

538 lines (388 loc) · 18.4 KB
Raw

ObjectEzsigntemplateApi

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

Method HTTP request Description
ezsigntemplateCopyV1 POST /1/object/ezsigntemplate/{pkiEzsigntemplateID}/copy Copy the Ezsigntemplate
ezsigntemplateCreateObjectV1 POST /1/object/ezsigntemplate Create a new Ezsigntemplate
ezsigntemplateCreateObjectV2 POST /2/object/ezsigntemplate Create a new Ezsigntemplate
ezsigntemplateDeleteObjectV1 DELETE /1/object/ezsigntemplate/{pkiEzsigntemplateID} Delete an existing Ezsigntemplate
ezsigntemplateEditObjectV1 PUT /1/object/ezsigntemplate/{pkiEzsigntemplateID} Edit an existing Ezsigntemplate
ezsigntemplateEditObjectV2 PUT /2/object/ezsigntemplate/{pkiEzsigntemplateID} Edit an existing Ezsigntemplate
ezsigntemplateGetAutocompleteV2 GET /2/object/ezsigntemplate/getAutocomplete/{sSelector} Retrieve Ezsigntemplates and IDs
ezsigntemplateGetListV1 GET /1/object/ezsigntemplate/getList Retrieve Ezsigntemplate list
ezsigntemplateGetObjectV1 GET /1/object/ezsigntemplate/{pkiEzsigntemplateID} Retrieve an existing Ezsigntemplate
ezsigntemplateGetObjectV2 GET /2/object/ezsigntemplate/{pkiEzsigntemplateID} Retrieve an existing Ezsigntemplate

ezsigntemplateCopyV1

EzsigntemplateCopyV1Response ezsigntemplateCopyV1(pkiEzsigntemplateID, ezsigntemplateCopyV1Request)

Copy the Ezsigntemplate

Example

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

val apiInstance = ObjectEzsigntemplateApi()
val pkiEzsigntemplateID : kotlin.Int = 56 // kotlin.Int | 
val ezsigntemplateCopyV1Request : EzsigntemplateCopyV1Request =  // EzsigntemplateCopyV1Request | 
try {
    val result : EzsigntemplateCopyV1Response = apiInstance.ezsigntemplateCopyV1(pkiEzsigntemplateID, ezsigntemplateCopyV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigntemplateApi#ezsigntemplateCopyV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigntemplateApi#ezsigntemplateCopyV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigntemplateID kotlin.Int
ezsigntemplateCopyV1Request EzsigntemplateCopyV1Request

Return type

EzsigntemplateCopyV1Response

Authorization

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

HTTP request headers

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

ezsigntemplateCreateObjectV1

EzsigntemplateCreateObjectV1Response ezsigntemplateCreateObjectV1(ezsigntemplateCreateObjectV1Request)

Create a new Ezsigntemplate

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

Example

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

val apiInstance = ObjectEzsigntemplateApi()
val ezsigntemplateCreateObjectV1Request : EzsigntemplateCreateObjectV1Request =  // EzsigntemplateCreateObjectV1Request | 
try {
    val result : EzsigntemplateCreateObjectV1Response = apiInstance.ezsigntemplateCreateObjectV1(ezsigntemplateCreateObjectV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigntemplateApi#ezsigntemplateCreateObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigntemplateApi#ezsigntemplateCreateObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
ezsigntemplateCreateObjectV1Request EzsigntemplateCreateObjectV1Request

Return type

EzsigntemplateCreateObjectV1Response

Authorization

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

HTTP request headers

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

ezsigntemplateCreateObjectV2

EzsigntemplateCreateObjectV2Response ezsigntemplateCreateObjectV2(ezsigntemplateCreateObjectV2Request)

Create a new Ezsigntemplate

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

Example

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

val apiInstance = ObjectEzsigntemplateApi()
val ezsigntemplateCreateObjectV2Request : EzsigntemplateCreateObjectV2Request =  // EzsigntemplateCreateObjectV2Request | 
try {
    val result : EzsigntemplateCreateObjectV2Response = apiInstance.ezsigntemplateCreateObjectV2(ezsigntemplateCreateObjectV2Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigntemplateApi#ezsigntemplateCreateObjectV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigntemplateApi#ezsigntemplateCreateObjectV2")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
ezsigntemplateCreateObjectV2Request EzsigntemplateCreateObjectV2Request

Return type

EzsigntemplateCreateObjectV2Response

Authorization

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

HTTP request headers

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

ezsigntemplateDeleteObjectV1

EzsigntemplateDeleteObjectV1Response ezsigntemplateDeleteObjectV1(pkiEzsigntemplateID)

Delete an existing Ezsigntemplate

Example

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

val apiInstance = ObjectEzsigntemplateApi()
val pkiEzsigntemplateID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsigntemplateDeleteObjectV1Response = apiInstance.ezsigntemplateDeleteObjectV1(pkiEzsigntemplateID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigntemplateApi#ezsigntemplateDeleteObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigntemplateApi#ezsigntemplateDeleteObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigntemplateID kotlin.Int

Return type

EzsigntemplateDeleteObjectV1Response

Authorization

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

HTTP request headers

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

ezsigntemplateEditObjectV1

EzsigntemplateEditObjectV1Response ezsigntemplateEditObjectV1(pkiEzsigntemplateID, ezsigntemplateEditObjectV1Request)

Edit an existing Ezsigntemplate

Example

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

val apiInstance = ObjectEzsigntemplateApi()
val pkiEzsigntemplateID : kotlin.Int = 56 // kotlin.Int | 
val ezsigntemplateEditObjectV1Request : EzsigntemplateEditObjectV1Request =  // EzsigntemplateEditObjectV1Request | 
try {
    val result : EzsigntemplateEditObjectV1Response = apiInstance.ezsigntemplateEditObjectV1(pkiEzsigntemplateID, ezsigntemplateEditObjectV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigntemplateApi#ezsigntemplateEditObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigntemplateApi#ezsigntemplateEditObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigntemplateID kotlin.Int
ezsigntemplateEditObjectV1Request EzsigntemplateEditObjectV1Request

Return type

EzsigntemplateEditObjectV1Response

Authorization

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

HTTP request headers

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

ezsigntemplateEditObjectV2

EzsigntemplateEditObjectV2Response ezsigntemplateEditObjectV2(pkiEzsigntemplateID, ezsigntemplateEditObjectV2Request)

Edit an existing Ezsigntemplate

Example

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

val apiInstance = ObjectEzsigntemplateApi()
val pkiEzsigntemplateID : kotlin.Int = 56 // kotlin.Int | 
val ezsigntemplateEditObjectV2Request : EzsigntemplateEditObjectV2Request =  // EzsigntemplateEditObjectV2Request | 
try {
    val result : EzsigntemplateEditObjectV2Response = apiInstance.ezsigntemplateEditObjectV2(pkiEzsigntemplateID, ezsigntemplateEditObjectV2Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigntemplateApi#ezsigntemplateEditObjectV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigntemplateApi#ezsigntemplateEditObjectV2")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigntemplateID kotlin.Int
ezsigntemplateEditObjectV2Request EzsigntemplateEditObjectV2Request

Return type

EzsigntemplateEditObjectV2Response

Authorization

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

HTTP request headers

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

ezsigntemplateGetAutocompleteV2

EzsigntemplateGetAutocompleteV2Response ezsigntemplateGetAutocompleteV2(sSelector, eFilterActive, sQuery, acceptLanguage)

Retrieve Ezsigntemplates and IDs

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

Example

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

val apiInstance = ObjectEzsigntemplateApi()
val sSelector : kotlin.String = sSelector_example // kotlin.String | The type of Ezsigntemplates 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 : EzsigntemplateGetAutocompleteV2Response = apiInstance.ezsigntemplateGetAutocompleteV2(sSelector, eFilterActive, sQuery, acceptLanguage)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigntemplateApi#ezsigntemplateGetAutocompleteV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigntemplateApi#ezsigntemplateGetAutocompleteV2")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
sSelector kotlin.String The type of Ezsigntemplates 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

EzsigntemplateGetAutocompleteV2Response

Authorization

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

HTTP request headers

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

ezsigntemplateGetListV1

EzsigntemplateGetListV1Response ezsigntemplateGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter)

Retrieve Ezsigntemplate list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eEzsigntemplateType | Company<br>Team<br>User<br>Usergroup |

Example

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

val apiInstance = ObjectEzsigntemplateApi()
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 : EzsigntemplateGetListV1Response = apiInstance.ezsigntemplateGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigntemplateApi#ezsigntemplateGetListV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigntemplateApi#ezsigntemplateGetListV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
eOrderBy kotlin.String Specify how you want the results to be sorted [optional] [enum: pkiEzsigntemplateID_ASC, pkiEzsigntemplateID_DESC, fkiTeamID_ASC, fkiTeamID_DESC, fkiEzsignfoldertypeID_ASC, fkiEzsignfoldertypeID_DESC, fkiUserIDOwner_ASC, fkiUserIDOwner_DESC, fkiLanguageID_ASC, fkiLanguageID_DESC, eEzsigntemplateType_ASC, eEzsigntemplateType_DESC, sEzsigntemplateDescription_ASC, sEzsigntemplateDescription_DESC, sEzsigntemplatedocumentDescription_ASC, sEzsigntemplatedocumentDescription_DESC, iEzsigntemplatedocumentPagetotal_ASC, iEzsigntemplatedocumentPagetotal_DESC, iEzsigntemplateSignaturetotal_ASC, iEzsigntemplateSignaturetotal_DESC, sEzsignfoldertypeNameX_ASC, sEzsignfoldertypeNameX_DESC, eEzsigntemplateType_ASC, eEzsigntemplateType_DESC]
iRowMax kotlin.Int [optional]
iRowOffset kotlin.Int [optional] [default to 0]
acceptLanguage HeaderAcceptLanguage [optional] [enum: *, en, fr]
sFilter kotlin.String [optional]

Return type

EzsigntemplateGetListV1Response

Authorization

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

HTTP request headers

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

ezsigntemplateGetObjectV1

EzsigntemplateGetObjectV1Response ezsigntemplateGetObjectV1(pkiEzsigntemplateID)

Retrieve an existing Ezsigntemplate

Example

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

val apiInstance = ObjectEzsigntemplateApi()
val pkiEzsigntemplateID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsigntemplateGetObjectV1Response = apiInstance.ezsigntemplateGetObjectV1(pkiEzsigntemplateID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigntemplateApi#ezsigntemplateGetObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigntemplateApi#ezsigntemplateGetObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigntemplateID kotlin.Int

Return type

EzsigntemplateGetObjectV1Response

Authorization

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

HTTP request headers

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

ezsigntemplateGetObjectV2

EzsigntemplateGetObjectV2Response ezsigntemplateGetObjectV2(pkiEzsigntemplateID)

Retrieve an existing Ezsigntemplate

Example

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

val apiInstance = ObjectEzsigntemplateApi()
val pkiEzsigntemplateID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsigntemplateGetObjectV2Response = apiInstance.ezsigntemplateGetObjectV2(pkiEzsigntemplateID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigntemplateApi#ezsigntemplateGetObjectV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigntemplateApi#ezsigntemplateGetObjectV2")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigntemplateID kotlin.Int

Return type

EzsigntemplateGetObjectV2Response

Authorization

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

HTTP request headers

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