Skip to content

Latest commit

 

History

History
498 lines (318 loc) · 16.5 KB

ObjectEzsigntemplateApi.md

File metadata and controls

498 lines (318 loc) · 16.5 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 org.openapitools.client.api.ObjectEzsigntemplateApi;

ObjectEzsigntemplateApi apiInstance = new ObjectEzsigntemplateApi();
Integer pkiEzsigntemplateID = null; // Integer | 
EzsigntemplateCopyV1Request ezsigntemplateCopyV1Request = new EzsigntemplateCopyV1Request(); // EzsigntemplateCopyV1Request | 
try {
    EzsigntemplateCopyV1Response result = apiInstance.ezsigntemplateCopyV1(pkiEzsigntemplateID, ezsigntemplateCopyV1Request);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectEzsigntemplateApi#ezsigntemplateCopyV1");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
pkiEzsigntemplateID Integer [default to null]
ezsigntemplateCopyV1Request EzsigntemplateCopyV1Request

Return type

EzsigntemplateCopyV1Response

Authorization

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 org.openapitools.client.api.ObjectEzsigntemplateApi;

ObjectEzsigntemplateApi apiInstance = new ObjectEzsigntemplateApi();
EzsigntemplateCreateObjectV1Request ezsigntemplateCreateObjectV1Request = new EzsigntemplateCreateObjectV1Request(); // EzsigntemplateCreateObjectV1Request | 
try {
    EzsigntemplateCreateObjectV1Response result = apiInstance.ezsigntemplateCreateObjectV1(ezsigntemplateCreateObjectV1Request);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectEzsigntemplateApi#ezsigntemplateCreateObjectV1");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
ezsigntemplateCreateObjectV1Request EzsigntemplateCreateObjectV1Request

Return type

EzsigntemplateCreateObjectV1Response

Authorization

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 org.openapitools.client.api.ObjectEzsigntemplateApi;

ObjectEzsigntemplateApi apiInstance = new ObjectEzsigntemplateApi();
EzsigntemplateCreateObjectV2Request ezsigntemplateCreateObjectV2Request = new EzsigntemplateCreateObjectV2Request(); // EzsigntemplateCreateObjectV2Request | 
try {
    EzsigntemplateCreateObjectV2Response result = apiInstance.ezsigntemplateCreateObjectV2(ezsigntemplateCreateObjectV2Request);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectEzsigntemplateApi#ezsigntemplateCreateObjectV2");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
ezsigntemplateCreateObjectV2Request EzsigntemplateCreateObjectV2Request

Return type

EzsigntemplateCreateObjectV2Response

Authorization

Authorization

HTTP request headers

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

ezsigntemplateDeleteObjectV1

EzsigntemplateDeleteObjectV1Response ezsigntemplateDeleteObjectV1(pkiEzsigntemplateID)

Delete an existing Ezsigntemplate

Example

// Import classes:
//import org.openapitools.client.api.ObjectEzsigntemplateApi;

ObjectEzsigntemplateApi apiInstance = new ObjectEzsigntemplateApi();
Integer pkiEzsigntemplateID = null; // Integer | 
try {
    EzsigntemplateDeleteObjectV1Response result = apiInstance.ezsigntemplateDeleteObjectV1(pkiEzsigntemplateID);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectEzsigntemplateApi#ezsigntemplateDeleteObjectV1");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
pkiEzsigntemplateID Integer [default to null]

Return type

EzsigntemplateDeleteObjectV1Response

Authorization

Authorization

HTTP request headers

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

ezsigntemplateEditObjectV1

EzsigntemplateEditObjectV1Response ezsigntemplateEditObjectV1(pkiEzsigntemplateID, ezsigntemplateEditObjectV1Request)

Edit an existing Ezsigntemplate

Example

// Import classes:
//import org.openapitools.client.api.ObjectEzsigntemplateApi;

ObjectEzsigntemplateApi apiInstance = new ObjectEzsigntemplateApi();
Integer pkiEzsigntemplateID = null; // Integer | 
EzsigntemplateEditObjectV1Request ezsigntemplateEditObjectV1Request = new EzsigntemplateEditObjectV1Request(); // EzsigntemplateEditObjectV1Request | 
try {
    EzsigntemplateEditObjectV1Response result = apiInstance.ezsigntemplateEditObjectV1(pkiEzsigntemplateID, ezsigntemplateEditObjectV1Request);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectEzsigntemplateApi#ezsigntemplateEditObjectV1");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
pkiEzsigntemplateID Integer [default to null]
ezsigntemplateEditObjectV1Request EzsigntemplateEditObjectV1Request

Return type

EzsigntemplateEditObjectV1Response

Authorization

Authorization

HTTP request headers

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

ezsigntemplateEditObjectV2

EzsigntemplateEditObjectV2Response ezsigntemplateEditObjectV2(pkiEzsigntemplateID, ezsigntemplateEditObjectV2Request)

Edit an existing Ezsigntemplate

Example

// Import classes:
//import org.openapitools.client.api.ObjectEzsigntemplateApi;

ObjectEzsigntemplateApi apiInstance = new ObjectEzsigntemplateApi();
Integer pkiEzsigntemplateID = null; // Integer | 
EzsigntemplateEditObjectV2Request ezsigntemplateEditObjectV2Request = new EzsigntemplateEditObjectV2Request(); // EzsigntemplateEditObjectV2Request | 
try {
    EzsigntemplateEditObjectV2Response result = apiInstance.ezsigntemplateEditObjectV2(pkiEzsigntemplateID, ezsigntemplateEditObjectV2Request);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectEzsigntemplateApi#ezsigntemplateEditObjectV2");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
pkiEzsigntemplateID Integer [default to null]
ezsigntemplateEditObjectV2Request EzsigntemplateEditObjectV2Request

Return type

EzsigntemplateEditObjectV2Response

Authorization

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 org.openapitools.client.api.ObjectEzsigntemplateApi;

ObjectEzsigntemplateApi apiInstance = new ObjectEzsigntemplateApi();
String sSelector = null; // String | The type of Ezsigntemplates to return
String eFilterActive = Active; // String | Specify which results we want to display.
String sQuery = null; // String | Allow to filter the returned results
HeaderAcceptLanguage acceptLanguage = null; // HeaderAcceptLanguage | 
try {
    EzsigntemplateGetAutocompleteV2Response result = apiInstance.ezsigntemplateGetAutocompleteV2(sSelector, eFilterActive, sQuery, acceptLanguage);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectEzsigntemplateApi#ezsigntemplateGetAutocompleteV2");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
sSelector String The type of Ezsigntemplates to return [default to null] [enum: All]
eFilterActive String Specify which results we want to display. [optional] [default to Active] [enum: All, Active, Inactive]
sQuery String Allow to filter the returned results [optional] [default to null]
acceptLanguage HeaderAcceptLanguage [optional] [default to null] [enum: *, en, fr]

Return type

EzsigntemplateGetAutocompleteV2Response

Authorization

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 org.openapitools.client.api.ObjectEzsigntemplateApi;

ObjectEzsigntemplateApi apiInstance = new ObjectEzsigntemplateApi();
String eOrderBy = null; // String | Specify how you want the results to be sorted
Integer iRowMax = null; // Integer | 
Integer iRowOffset = 0; // Integer | 
HeaderAcceptLanguage acceptLanguage = null; // HeaderAcceptLanguage | 
String sFilter = null; // String | 
try {
    EzsigntemplateGetListV1Response result = apiInstance.ezsigntemplateGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectEzsigntemplateApi#ezsigntemplateGetListV1");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
eOrderBy String Specify how you want the results to be sorted [optional] [default to null] [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 Integer [optional] [default to null]
iRowOffset Integer [optional] [default to 0]
acceptLanguage HeaderAcceptLanguage [optional] [default to null] [enum: *, en, fr]
sFilter String [optional] [default to null]

Return type

EzsigntemplateGetListV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

ezsigntemplateGetObjectV1

EzsigntemplateGetObjectV1Response ezsigntemplateGetObjectV1(pkiEzsigntemplateID)

Retrieve an existing Ezsigntemplate

Example

// Import classes:
//import org.openapitools.client.api.ObjectEzsigntemplateApi;

ObjectEzsigntemplateApi apiInstance = new ObjectEzsigntemplateApi();
Integer pkiEzsigntemplateID = null; // Integer | 
try {
    EzsigntemplateGetObjectV1Response result = apiInstance.ezsigntemplateGetObjectV1(pkiEzsigntemplateID);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectEzsigntemplateApi#ezsigntemplateGetObjectV1");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
pkiEzsigntemplateID Integer [default to null]

Return type

EzsigntemplateGetObjectV1Response

Authorization

Authorization

HTTP request headers

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

ezsigntemplateGetObjectV2

EzsigntemplateGetObjectV2Response ezsigntemplateGetObjectV2(pkiEzsigntemplateID)

Retrieve an existing Ezsigntemplate

Example

// Import classes:
//import org.openapitools.client.api.ObjectEzsigntemplateApi;

ObjectEzsigntemplateApi apiInstance = new ObjectEzsigntemplateApi();
Integer pkiEzsigntemplateID = null; // Integer | 
try {
    EzsigntemplateGetObjectV2Response result = apiInstance.ezsigntemplateGetObjectV2(pkiEzsigntemplateID);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectEzsigntemplateApi#ezsigntemplateGetObjectV2");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
pkiEzsigntemplateID Integer [default to null]

Return type

EzsigntemplateGetObjectV2Response

Authorization

Authorization

HTTP request headers

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