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
ezsigntemplateCreateObjectV3	POST /3/object/ezsigntemplate	Create a new Ezsigntemplate
ezsigntemplateDeleteObjectV1	DELETE /1/object/ezsigntemplate/{pkiEzsigntemplateID}	Delete an existing Ezsigntemplate
ezsigntemplateEditObjectV3	PUT /3/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
ezsigntemplateGetObjectV3	GET /3/object/ezsigntemplate/{pkiEzsigntemplateID}	Retrieve an existing Ezsigntemplate

ezsigntemplateCopyV1

    open class func ezsigntemplateCopyV1(pkiEzsigntemplateID: Int, ezsigntemplateCopyV1Request: EzsigntemplateCopyV1Request, completion: @escaping (_ data: EzsigntemplateCopyV1Response?, _ error: Error?) -> Void)

Copy the Ezsigntemplate

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 pkiEzsigntemplateID = 987 // Int | 
let ezsigntemplateCopyV1Request = ezsigntemplate-copy-v1-Request(aFkiEzsignfoldertypeID: [123], bCopyCompany: false, bCopyUser: false) // EzsigntemplateCopyV1Request | 

// Copy the Ezsigntemplate
ObjectEzsigntemplateAPI.ezsigntemplateCopyV1(pkiEzsigntemplateID: pkiEzsigntemplateID, ezsigntemplateCopyV1Request: ezsigntemplateCopyV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsigntemplateID	Int
ezsigntemplateCopyV1Request	EzsigntemplateCopyV1Request

Return type

EzsigntemplateCopyV1Response

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]

ezsigntemplateCreateObjectV3

    open class func ezsigntemplateCreateObjectV3(ezsigntemplateCreateObjectV3Request: EzsigntemplateCreateObjectV3Request, completion: @escaping (_ data: EzsigntemplateCreateObjectV3Response?, _ error: Error?) -> Void)

Create a new Ezsigntemplate

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 ezsigntemplateCreateObjectV3Request = ezsigntemplate-createObject-v3-Request(aObjEzsigntemplate: [ezsigntemplate-RequestCompoundV3(pkiEzsigntemplateID: 123, fkiEzsignfoldertypeID: 123, fkiLanguageID: 123, fkiEzdoctemplatedocumentID: 123, sEzsigntemplateDescription: "sEzsigntemplateDescription_example", sEzsigntemplateExternaldescription: "sEzsigntemplateExternaldescription_example", tEzsigntemplateComment: "", eEzsigntemplateRecognition: Field-eEzsigntemplateRecognition(), sEzsigntemplateFilenameregexp: "sEzsigntemplateFilenameregexp_example", bEzsigntemplateAdminonly: false, eEzsigntemplateType: Field-eEzsigntemplateType())]) // EzsigntemplateCreateObjectV3Request | 

// Create a new Ezsigntemplate
ObjectEzsigntemplateAPI.ezsigntemplateCreateObjectV3(ezsigntemplateCreateObjectV3Request: ezsigntemplateCreateObjectV3Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
ezsigntemplateCreateObjectV3Request	EzsigntemplateCreateObjectV3Request

Return type

EzsigntemplateCreateObjectV3Response

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]

ezsigntemplateDeleteObjectV1

    open class func ezsigntemplateDeleteObjectV1(pkiEzsigntemplateID: Int, completion: @escaping (_ data: EzsigntemplateDeleteObjectV1Response?, _ error: Error?) -> Void)

Delete an existing Ezsigntemplate

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

// Delete an existing Ezsigntemplate
ObjectEzsigntemplateAPI.ezsigntemplateDeleteObjectV1(pkiEzsigntemplateID: pkiEzsigntemplateID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsigntemplateID	Int

Return type

EzsigntemplateDeleteObjectV1Response

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]

ezsigntemplateEditObjectV3

    open class func ezsigntemplateEditObjectV3(pkiEzsigntemplateID: Int, ezsigntemplateEditObjectV3Request: EzsigntemplateEditObjectV3Request, completion: @escaping (_ data: EzsigntemplateEditObjectV3Response?, _ error: Error?) -> Void)

Edit an existing Ezsigntemplate

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 pkiEzsigntemplateID = 987 // Int | 
let ezsigntemplateEditObjectV3Request = ezsigntemplate-editObject-v3-Request(objEzsigntemplate: ezsigntemplate-RequestCompoundV3(pkiEzsigntemplateID: 123, fkiEzsignfoldertypeID: 123, fkiLanguageID: 123, fkiEzdoctemplatedocumentID: 123, sEzsigntemplateDescription: "sEzsigntemplateDescription_example", sEzsigntemplateExternaldescription: "sEzsigntemplateExternaldescription_example", tEzsigntemplateComment: "", eEzsigntemplateRecognition: Field-eEzsigntemplateRecognition(), sEzsigntemplateFilenameregexp: "sEzsigntemplateFilenameregexp_example", bEzsigntemplateAdminonly: false, eEzsigntemplateType: Field-eEzsigntemplateType())) // EzsigntemplateEditObjectV3Request | 

// Edit an existing Ezsigntemplate
ObjectEzsigntemplateAPI.ezsigntemplateEditObjectV3(pkiEzsigntemplateID: pkiEzsigntemplateID, ezsigntemplateEditObjectV3Request: ezsigntemplateEditObjectV3Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsigntemplateID	Int
ezsigntemplateEditObjectV3Request	EzsigntemplateEditObjectV3Request

Return type

EzsigntemplateEditObjectV3Response

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]

ezsigntemplateGetAutocompleteV2

    open class func ezsigntemplateGetAutocompleteV2(sSelector: SSelector_ezsigntemplateGetAutocompleteV2, eFilterActive: EFilterActive_ezsigntemplateGetAutocompleteV2? = nil, sQuery: String? = nil, acceptLanguage: HeaderAcceptLanguage? = nil, fkiEzsignfoldertypeID: Int? = nil, completion: @escaping (_ data: EzsigntemplateGetAutocompleteV2Response?, _ error: Error?) -> Void)

Retrieve Ezsigntemplates and IDs

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

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 sSelector = "sSelector_example" // String | The type of Ezsigntemplates to return
let eFilterActive = "eFilterActive_example" // String | Specify which results we want to display. (optional) (default to .active)
let sQuery = "sQuery_example" // String | Allow to filter the returned results (optional)
let acceptLanguage = Header-Accept-Language() // HeaderAcceptLanguage |  (optional)
let fkiEzsignfoldertypeID = 987 // Int | The fkiEzsignfoldertypeID to use with the selector Ezsigntemplatepublic (optional)

// Retrieve Ezsigntemplates and IDs
ObjectEzsigntemplateAPI.ezsigntemplateGetAutocompleteV2(sSelector: sSelector, eFilterActive: eFilterActive, sQuery: sQuery, acceptLanguage: acceptLanguage, fkiEzsignfoldertypeID: fkiEzsignfoldertypeID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
sSelector	String	The type of Ezsigntemplates to return
eFilterActive	String	Specify which results we want to display.	[optional] [default to .active]
sQuery	String	Allow to filter the returned results	[optional]
acceptLanguage	HeaderAcceptLanguage		[optional]
fkiEzsignfoldertypeID	Int	The fkiEzsignfoldertypeID to use with the selector Ezsigntemplatepublic	[optional]

Return type

EzsigntemplateGetAutocompleteV2Response

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]

ezsigntemplateGetListV1

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

Retrieve Ezsigntemplate list

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

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 Ezsigntemplate list
ObjectEzsigntemplateAPI.ezsigntemplateGetListV1(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

EzsigntemplateGetListV1Response

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]

ezsigntemplateGetObjectV3

    open class func ezsigntemplateGetObjectV3(pkiEzsigntemplateID: Int, completion: @escaping (_ data: EzsigntemplateGetObjectV3Response?, _ error: Error?) -> Void)

Retrieve an existing Ezsigntemplate

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

// Retrieve an existing Ezsigntemplate
ObjectEzsigntemplateAPI.ezsigntemplateGetObjectV3(pkiEzsigntemplateID: pkiEzsigntemplateID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsigntemplateID	Int

Return type

EzsigntemplateGetObjectV3Response

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]

Files

ObjectEzsigntemplateAPI.md

Latest commit

History

ObjectEzsigntemplateAPI.md

File metadata and controls

ObjectEzsigntemplateAPI

ezsigntemplateCopyV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigntemplateCreateObjectV3

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigntemplateDeleteObjectV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigntemplateEditObjectV3

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigntemplateGetAutocompleteV2

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigntemplateGetListV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigntemplateGetObjectV3

Example

Parameters

Return type

Authorization

HTTP request headers