Skip to content

Latest commit

 

History

History
355 lines (228 loc) · 12.2 KB

ObjectEzsignfoldertypeApi.md

File metadata and controls

355 lines (228 loc) · 12.2 KB
Raw

ObjectEzsignfoldertypeApi

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

Method HTTP request Description
ezsignfoldertypeCreateObjectV2 POST /2/object/ezsignfoldertype Create a new Ezsignfoldertype
ezsignfoldertypeEditObjectV1 PUT /1/object/ezsignfoldertype/{pkiEzsignfoldertypeID} Edit an existing Ezsignfoldertype
ezsignfoldertypeEditObjectV2 PUT /2/object/ezsignfoldertype/{pkiEzsignfoldertypeID} Edit an existing Ezsignfoldertype
ezsignfoldertypeGetAutocompleteV2 GET /2/object/ezsignfoldertype/getAutocomplete/{sSelector} Retrieve Ezsignfoldertypes and IDs
ezsignfoldertypeGetListV1 GET /1/object/ezsignfoldertype/getList Retrieve Ezsignfoldertype list
ezsignfoldertypeGetObjectV2 GET /2/object/ezsignfoldertype/{pkiEzsignfoldertypeID} Retrieve an existing Ezsignfoldertype
ezsignfoldertypeGetObjectV3 GET /3/object/ezsignfoldertype/{pkiEzsignfoldertypeID} Retrieve an existing Ezsignfoldertype

ezsignfoldertypeCreateObjectV2

EzsignfoldertypeCreateObjectV2Response ezsignfoldertypeCreateObjectV2(ezsignfoldertypeCreateObjectV2Request)

Create a new Ezsignfoldertype

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

Example

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

ObjectEzsignfoldertypeApi apiInstance = new ObjectEzsignfoldertypeApi();
EzsignfoldertypeCreateObjectV2Request ezsignfoldertypeCreateObjectV2Request = new EzsignfoldertypeCreateObjectV2Request(); // EzsignfoldertypeCreateObjectV2Request | 
try {
    EzsignfoldertypeCreateObjectV2Response result = apiInstance.ezsignfoldertypeCreateObjectV2(ezsignfoldertypeCreateObjectV2Request);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectEzsignfoldertypeApi#ezsignfoldertypeCreateObjectV2");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
ezsignfoldertypeCreateObjectV2Request EzsignfoldertypeCreateObjectV2Request

Return type

EzsignfoldertypeCreateObjectV2Response

Authorization

Authorization

HTTP request headers

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

ezsignfoldertypeEditObjectV1

EzsignfoldertypeEditObjectV1Response ezsignfoldertypeEditObjectV1(pkiEzsignfoldertypeID, ezsignfoldertypeEditObjectV1Request)

Edit an existing Ezsignfoldertype

Example

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

ObjectEzsignfoldertypeApi apiInstance = new ObjectEzsignfoldertypeApi();
Integer pkiEzsignfoldertypeID = null; // Integer | 
EzsignfoldertypeEditObjectV1Request ezsignfoldertypeEditObjectV1Request = new EzsignfoldertypeEditObjectV1Request(); // EzsignfoldertypeEditObjectV1Request | 
try {
    EzsignfoldertypeEditObjectV1Response result = apiInstance.ezsignfoldertypeEditObjectV1(pkiEzsignfoldertypeID, ezsignfoldertypeEditObjectV1Request);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectEzsignfoldertypeApi#ezsignfoldertypeEditObjectV1");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
pkiEzsignfoldertypeID Integer [default to null]
ezsignfoldertypeEditObjectV1Request EzsignfoldertypeEditObjectV1Request

Return type

EzsignfoldertypeEditObjectV1Response

Authorization

Authorization

HTTP request headers

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

ezsignfoldertypeEditObjectV2

EzsignfoldertypeEditObjectV2Response ezsignfoldertypeEditObjectV2(pkiEzsignfoldertypeID, ezsignfoldertypeEditObjectV2Request)

Edit an existing Ezsignfoldertype

Example

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

ObjectEzsignfoldertypeApi apiInstance = new ObjectEzsignfoldertypeApi();
Integer pkiEzsignfoldertypeID = null; // Integer | 
EzsignfoldertypeEditObjectV2Request ezsignfoldertypeEditObjectV2Request = new EzsignfoldertypeEditObjectV2Request(); // EzsignfoldertypeEditObjectV2Request | 
try {
    EzsignfoldertypeEditObjectV2Response result = apiInstance.ezsignfoldertypeEditObjectV2(pkiEzsignfoldertypeID, ezsignfoldertypeEditObjectV2Request);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectEzsignfoldertypeApi#ezsignfoldertypeEditObjectV2");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
pkiEzsignfoldertypeID Integer [default to null]
ezsignfoldertypeEditObjectV2Request EzsignfoldertypeEditObjectV2Request

Return type

EzsignfoldertypeEditObjectV2Response

Authorization

Authorization

HTTP request headers

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

ezsignfoldertypeGetAutocompleteV2

EzsignfoldertypeGetAutocompleteV2Response ezsignfoldertypeGetAutocompleteV2(sSelector, eFilterActive, sQuery, acceptLanguage)

Retrieve Ezsignfoldertypes and IDs

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

Example

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

ObjectEzsignfoldertypeApi apiInstance = new ObjectEzsignfoldertypeApi();
String sSelector = null; // String | The type of Ezsignfoldertypes 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 {
    EzsignfoldertypeGetAutocompleteV2Response result = apiInstance.ezsignfoldertypeGetAutocompleteV2(sSelector, eFilterActive, sQuery, acceptLanguage);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectEzsignfoldertypeApi#ezsignfoldertypeGetAutocompleteV2");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
sSelector String The type of Ezsignfoldertypes to return [default to null] [enum: Active, All, EzsigntemplateEdit, EzsigntemplateUsergroup]
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

EzsignfoldertypeGetAutocompleteV2Response

Authorization

Authorization

HTTP request headers

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

ezsignfoldertypeGetListV1

EzsignfoldertypeGetListV1Response ezsignfoldertypeGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter)

Retrieve Ezsignfoldertype list

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

Example

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

ObjectEzsignfoldertypeApi apiInstance = new ObjectEzsignfoldertypeApi();
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 {
    EzsignfoldertypeGetListV1Response result = apiInstance.ezsignfoldertypeGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectEzsignfoldertypeApi#ezsignfoldertypeGetListV1");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
eOrderBy String Specify how you want the results to be sorted [optional] [default to null] [enum: pkiEzsignfoldertypeID_ASC, pkiEzsignfoldertypeID_DESC, eEzsignfoldertypePrivacylevel_ASC, eEzsignfoldertypePrivacylevel_DESC, sEzsignfoldertypeNameX_ASC, sEzsignfoldertypeNameX_DESC, bEzsignfoldertypeIsactive_ASC, bEzsignfoldertypeIsactive_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

EzsignfoldertypeGetListV1Response

Authorization

Authorization

HTTP request headers

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

ezsignfoldertypeGetObjectV2

EzsignfoldertypeGetObjectV2Response ezsignfoldertypeGetObjectV2(pkiEzsignfoldertypeID)

Retrieve an existing Ezsignfoldertype

Example

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

ObjectEzsignfoldertypeApi apiInstance = new ObjectEzsignfoldertypeApi();
Integer pkiEzsignfoldertypeID = null; // Integer | 
try {
    EzsignfoldertypeGetObjectV2Response result = apiInstance.ezsignfoldertypeGetObjectV2(pkiEzsignfoldertypeID);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectEzsignfoldertypeApi#ezsignfoldertypeGetObjectV2");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
pkiEzsignfoldertypeID Integer [default to null]

Return type

EzsignfoldertypeGetObjectV2Response

Authorization

Authorization

HTTP request headers

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

ezsignfoldertypeGetObjectV3

EzsignfoldertypeGetObjectV3Response ezsignfoldertypeGetObjectV3(pkiEzsignfoldertypeID)

Retrieve an existing Ezsignfoldertype

Example

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

ObjectEzsignfoldertypeApi apiInstance = new ObjectEzsignfoldertypeApi();
Integer pkiEzsignfoldertypeID = null; // Integer | 
try {
    EzsignfoldertypeGetObjectV3Response result = apiInstance.ezsignfoldertypeGetObjectV3(pkiEzsignfoldertypeID);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectEzsignfoldertypeApi#ezsignfoldertypeGetObjectV3");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
pkiEzsignfoldertypeID Integer [default to null]

Return type

EzsignfoldertypeGetObjectV3Response

Authorization

Authorization

HTTP request headers

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