Skip to content

Latest commit

 

History

History
537 lines (342 loc) · 18.3 KB

ObjectEzsignbulksendApi.md

File metadata and controls

537 lines (342 loc) · 18.3 KB
Raw

ObjectEzsignbulksendApi

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

Method HTTP request Description
ezsignbulksendCreateEzsignbulksendtransmissionV1 POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/createEzsignbulksendtransmission Create a new Ezsignbulksendtransmission in the Ezsignbulksend
ezsignbulksendCreateObjectV1 POST /1/object/ezsignbulksend Create a new Ezsignbulksend
ezsignbulksendDeleteObjectV1 DELETE /1/object/ezsignbulksend/{pkiEzsignbulksendID} Delete an existing Ezsignbulksend
ezsignbulksendEditObjectV1 PUT /1/object/ezsignbulksend/{pkiEzsignbulksendID} Edit an existing Ezsignbulksend
ezsignbulksendGetCsvTemplateV1 GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getCsvTemplate Retrieve an existing Ezsignbulksend's empty Csv template
ezsignbulksendGetEzsignbulksendtransmissionsV1 GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getEzsignbulksendtransmissions Retrieve an existing Ezsignbulksend's Ezsignbulksendtransmissions
ezsignbulksendGetEzsignsignaturesAutomaticV1 GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getEzsignsignaturesAutomatic Retrieve an existing Ezsignbulksend's automatic Ezsignsignatures
ezsignbulksendGetFormsDataV1 GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getFormsData Retrieve an existing Ezsignbulksend's forms data
ezsignbulksendGetListV1 GET /1/object/ezsignbulksend/getList Retrieve Ezsignbulksend list
ezsignbulksendGetObjectV2 GET /2/object/ezsignbulksend/{pkiEzsignbulksendID} Retrieve an existing Ezsignbulksend
ezsignbulksendReorderV1 POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/reorder Reorder Ezsignbulksenddocumentmappings in the Ezsignbulksend

ezsignbulksendCreateEzsignbulksendtransmissionV1

EzsignbulksendCreateEzsignbulksendtransmissionV1Response ezsignbulksendCreateEzsignbulksendtransmissionV1(pkiEzsignbulksendID, ezsignbulksendCreateEzsignbulksendtransmissionV1Request)

Create a new Ezsignbulksendtransmission in the Ezsignbulksend

Example

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

ObjectEzsignbulksendApi apiInstance = new ObjectEzsignbulksendApi();
Integer pkiEzsignbulksendID = null; // Integer | 
EzsignbulksendCreateEzsignbulksendtransmissionV1Request ezsignbulksendCreateEzsignbulksendtransmissionV1Request = new EzsignbulksendCreateEzsignbulksendtransmissionV1Request(); // EzsignbulksendCreateEzsignbulksendtransmissionV1Request | 
try {
    EzsignbulksendCreateEzsignbulksendtransmissionV1Response result = apiInstance.ezsignbulksendCreateEzsignbulksendtransmissionV1(pkiEzsignbulksendID, ezsignbulksendCreateEzsignbulksendtransmissionV1Request);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectEzsignbulksendApi#ezsignbulksendCreateEzsignbulksendtransmissionV1");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
pkiEzsignbulksendID Integer [default to null]
ezsignbulksendCreateEzsignbulksendtransmissionV1Request EzsignbulksendCreateEzsignbulksendtransmissionV1Request

Return type

EzsignbulksendCreateEzsignbulksendtransmissionV1Response

Authorization

Authorization

HTTP request headers

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

ezsignbulksendCreateObjectV1

EzsignbulksendCreateObjectV1Response ezsignbulksendCreateObjectV1(ezsignbulksendCreateObjectV1Request)

Create a new Ezsignbulksend

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

Example

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

ObjectEzsignbulksendApi apiInstance = new ObjectEzsignbulksendApi();
EzsignbulksendCreateObjectV1Request ezsignbulksendCreateObjectV1Request = new EzsignbulksendCreateObjectV1Request(); // EzsignbulksendCreateObjectV1Request | 
try {
    EzsignbulksendCreateObjectV1Response result = apiInstance.ezsignbulksendCreateObjectV1(ezsignbulksendCreateObjectV1Request);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectEzsignbulksendApi#ezsignbulksendCreateObjectV1");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
ezsignbulksendCreateObjectV1Request EzsignbulksendCreateObjectV1Request

Return type

EzsignbulksendCreateObjectV1Response

Authorization

Authorization

HTTP request headers

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

ezsignbulksendDeleteObjectV1

EzsignbulksendDeleteObjectV1Response ezsignbulksendDeleteObjectV1(pkiEzsignbulksendID)

Delete an existing Ezsignbulksend

Example

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

ObjectEzsignbulksendApi apiInstance = new ObjectEzsignbulksendApi();
Integer pkiEzsignbulksendID = null; // Integer | 
try {
    EzsignbulksendDeleteObjectV1Response result = apiInstance.ezsignbulksendDeleteObjectV1(pkiEzsignbulksendID);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectEzsignbulksendApi#ezsignbulksendDeleteObjectV1");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
pkiEzsignbulksendID Integer [default to null]

Return type

EzsignbulksendDeleteObjectV1Response

Authorization

Authorization

HTTP request headers

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

ezsignbulksendEditObjectV1

EzsignbulksendEditObjectV1Response ezsignbulksendEditObjectV1(pkiEzsignbulksendID, ezsignbulksendEditObjectV1Request)

Edit an existing Ezsignbulksend

Example

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

ObjectEzsignbulksendApi apiInstance = new ObjectEzsignbulksendApi();
Integer pkiEzsignbulksendID = null; // Integer | 
EzsignbulksendEditObjectV1Request ezsignbulksendEditObjectV1Request = new EzsignbulksendEditObjectV1Request(); // EzsignbulksendEditObjectV1Request | 
try {
    EzsignbulksendEditObjectV1Response result = apiInstance.ezsignbulksendEditObjectV1(pkiEzsignbulksendID, ezsignbulksendEditObjectV1Request);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectEzsignbulksendApi#ezsignbulksendEditObjectV1");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
pkiEzsignbulksendID Integer [default to null]
ezsignbulksendEditObjectV1Request EzsignbulksendEditObjectV1Request

Return type

EzsignbulksendEditObjectV1Response

Authorization

Authorization

HTTP request headers

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

ezsignbulksendGetCsvTemplateV1

String ezsignbulksendGetCsvTemplateV1(pkiEzsignbulksendID, eCsvSeparator)

Retrieve an existing Ezsignbulksend's empty Csv template

Example

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

ObjectEzsignbulksendApi apiInstance = new ObjectEzsignbulksendApi();
Integer pkiEzsignbulksendID = null; // Integer | 
String eCsvSeparator = null; // String | Separator that will be used to separate fields
try {
    String result = apiInstance.ezsignbulksendGetCsvTemplateV1(pkiEzsignbulksendID, eCsvSeparator);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectEzsignbulksendApi#ezsignbulksendGetCsvTemplateV1");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
pkiEzsignbulksendID Integer [default to null]
eCsvSeparator String Separator that will be used to separate fields [default to null] [enum: Comma, Semicolon]

Return type

String

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/csv, application/json

ezsignbulksendGetEzsignbulksendtransmissionsV1

EzsignbulksendGetEzsignbulksendtransmissionsV1Response ezsignbulksendGetEzsignbulksendtransmissionsV1(pkiEzsignbulksendID)

Retrieve an existing Ezsignbulksend's Ezsignbulksendtransmissions

Example

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

ObjectEzsignbulksendApi apiInstance = new ObjectEzsignbulksendApi();
Integer pkiEzsignbulksendID = null; // Integer | 
try {
    EzsignbulksendGetEzsignbulksendtransmissionsV1Response result = apiInstance.ezsignbulksendGetEzsignbulksendtransmissionsV1(pkiEzsignbulksendID);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectEzsignbulksendApi#ezsignbulksendGetEzsignbulksendtransmissionsV1");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
pkiEzsignbulksendID Integer [default to null]

Return type

EzsignbulksendGetEzsignbulksendtransmissionsV1Response

Authorization

Authorization

HTTP request headers

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

ezsignbulksendGetEzsignsignaturesAutomaticV1

EzsignbulksendGetEzsignsignaturesAutomaticV1Response ezsignbulksendGetEzsignsignaturesAutomaticV1(pkiEzsignbulksendID)

Retrieve an existing Ezsignbulksend's automatic Ezsignsignatures

Return the Ezsignsignatures that can be signed by the current user at the current step in the process

Example

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

ObjectEzsignbulksendApi apiInstance = new ObjectEzsignbulksendApi();
Integer pkiEzsignbulksendID = null; // Integer | 
try {
    EzsignbulksendGetEzsignsignaturesAutomaticV1Response result = apiInstance.ezsignbulksendGetEzsignsignaturesAutomaticV1(pkiEzsignbulksendID);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectEzsignbulksendApi#ezsignbulksendGetEzsignsignaturesAutomaticV1");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
pkiEzsignbulksendID Integer [default to null]

Return type

EzsignbulksendGetEzsignsignaturesAutomaticV1Response

Authorization

Authorization

HTTP request headers

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

ezsignbulksendGetFormsDataV1

EzsignbulksendGetFormsDataV1Response ezsignbulksendGetFormsDataV1(pkiEzsignbulksendID)

Retrieve an existing Ezsignbulksend's forms data

Example

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

ObjectEzsignbulksendApi apiInstance = new ObjectEzsignbulksendApi();
Integer pkiEzsignbulksendID = null; // Integer | 
try {
    EzsignbulksendGetFormsDataV1Response result = apiInstance.ezsignbulksendGetFormsDataV1(pkiEzsignbulksendID);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectEzsignbulksendApi#ezsignbulksendGetFormsDataV1");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
pkiEzsignbulksendID Integer [default to null]

Return type

EzsignbulksendGetFormsDataV1Response

Authorization

Authorization

HTTP request headers

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

ezsignbulksendGetListV1

EzsignbulksendGetListV1Response ezsignbulksendGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter)

Retrieve Ezsignbulksend 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.ObjectEzsignbulksendApi;

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

Parameters

Name Type Description Notes
eOrderBy String Specify how you want the results to be sorted [optional] [default to null] [enum: pkiEzsignbulksendID_ASC, pkiEzsignbulksendID_DESC, fkiEzsignfoldertypeID_ASC, fkiEzsignfoldertypeID_DESC, sEzsignbulksendDescription_ASC, sEzsignbulksendDescription_DESC, sEzsignfoldertypeNameX_ASC, sEzsignfoldertypeNameX_DESC, eEzsignfoldertypePrivacylevel_ASC, eEzsignfoldertypePrivacylevel_DESC, bEzsignbulksendNeedvalidation_ASC, bEzsignbulksendNeedvalidation_DESC, iEzsignbulksendtransmission_ASC, iEzsignbulksendtransmission_DESC, iEzsignfolder_ASC, iEzsignfolder_DESC, iEzsigndocument_ASC, iEzsigndocument_DESC, iEzsignsignature_ASC, iEzsignsignature_DESC, iEzsignsignatureSigned_ASC, iEzsignsignatureSigned_DESC, bEzsignbulksendIsactive_ASC, bEzsignbulksendIsactive_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

EzsignbulksendGetListV1Response

Authorization

Authorization

HTTP request headers

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

ezsignbulksendGetObjectV2

EzsignbulksendGetObjectV2Response ezsignbulksendGetObjectV2(pkiEzsignbulksendID)

Retrieve an existing Ezsignbulksend

Example

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

ObjectEzsignbulksendApi apiInstance = new ObjectEzsignbulksendApi();
Integer pkiEzsignbulksendID = null; // Integer | 
try {
    EzsignbulksendGetObjectV2Response result = apiInstance.ezsignbulksendGetObjectV2(pkiEzsignbulksendID);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectEzsignbulksendApi#ezsignbulksendGetObjectV2");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
pkiEzsignbulksendID Integer [default to null]

Return type

EzsignbulksendGetObjectV2Response

Authorization

Authorization

HTTP request headers

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

ezsignbulksendReorderV1

EzsignbulksendReorderV1Response ezsignbulksendReorderV1(pkiEzsignbulksendID, ezsignbulksendReorderV1Request)

Reorder Ezsignbulksenddocumentmappings in the Ezsignbulksend

Example

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

ObjectEzsignbulksendApi apiInstance = new ObjectEzsignbulksendApi();
Integer pkiEzsignbulksendID = null; // Integer | 
EzsignbulksendReorderV1Request ezsignbulksendReorderV1Request = new EzsignbulksendReorderV1Request(); // EzsignbulksendReorderV1Request | 
try {
    EzsignbulksendReorderV1Response result = apiInstance.ezsignbulksendReorderV1(pkiEzsignbulksendID, ezsignbulksendReorderV1Request);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectEzsignbulksendApi#ezsignbulksendReorderV1");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
pkiEzsignbulksendID Integer [default to null]
ezsignbulksendReorderV1Request EzsignbulksendReorderV1Request

Return type

EzsignbulksendReorderV1Response

Authorization

Authorization

HTTP request headers

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