Skip to content
This repository has been archived by the owner on Apr 14, 2024. It is now read-only.

Latest commit

 

History

History
594 lines (399 loc) · 20 KB

ObjectEzsignbulksendApi.md

File metadata and controls

594 lines (399 loc) · 20 KB

EZmaxApiDefinitionFull.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 EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectEzsignbulksendApi();
let pkiEzsignbulksendID = 56; // Number | 
let EzsignbulksendCreateEzsignbulksendtransmissionV1Request = new EZmaxApiDefinitionFull.EzsignbulksendCreateEzsignbulksendtransmissionV1Request(); // EzsignbulksendCreateEzsignbulksendtransmissionV1Request | 
apiInstance.ezsignbulksendCreateEzsignbulksendtransmissionV1(pkiEzsignbulksendID, EzsignbulksendCreateEzsignbulksendtransmissionV1Request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pkiEzsignbulksendID Number
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 EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectEzsignbulksendApi();
let EzsignbulksendCreateObjectV1Request = new EZmaxApiDefinitionFull.EzsignbulksendCreateObjectV1Request(); // EzsignbulksendCreateObjectV1Request | 
apiInstance.ezsignbulksendCreateObjectV1(EzsignbulksendCreateObjectV1Request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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 EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectEzsignbulksendApi();
let pkiEzsignbulksendID = 56; // Number | 
apiInstance.ezsignbulksendDeleteObjectV1(pkiEzsignbulksendID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pkiEzsignbulksendID Number

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 EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectEzsignbulksendApi();
let pkiEzsignbulksendID = 56; // Number | 
let EzsignbulksendEditObjectV1Request = new EZmaxApiDefinitionFull.EzsignbulksendEditObjectV1Request(); // EzsignbulksendEditObjectV1Request | 
apiInstance.ezsignbulksendEditObjectV1(pkiEzsignbulksendID, EzsignbulksendEditObjectV1Request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pkiEzsignbulksendID Number
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 EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectEzsignbulksendApi();
let pkiEzsignbulksendID = 56; // Number | 
let eCsvSeparator = "eCsvSeparator_example"; // String | Separator that will be used to separate fields
apiInstance.ezsignbulksendGetCsvTemplateV1(pkiEzsignbulksendID, eCsvSeparator, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pkiEzsignbulksendID Number
eCsvSeparator String Separator that will be used to separate fields

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 EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectEzsignbulksendApi();
let pkiEzsignbulksendID = 56; // Number | 
apiInstance.ezsignbulksendGetEzsignbulksendtransmissionsV1(pkiEzsignbulksendID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pkiEzsignbulksendID Number

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 EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectEzsignbulksendApi();
let pkiEzsignbulksendID = 56; // Number | 
apiInstance.ezsignbulksendGetEzsignsignaturesAutomaticV1(pkiEzsignbulksendID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pkiEzsignbulksendID Number

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 EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectEzsignbulksendApi();
let pkiEzsignbulksendID = 56; // Number | 
apiInstance.ezsignbulksendGetFormsDataV1(pkiEzsignbulksendID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pkiEzsignbulksendID Number

Return type

EzsignbulksendGetFormsDataV1Response

Authorization

Authorization

HTTP request headers

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

ezsignbulksendGetListV1

EzsignbulksendGetListV1Response ezsignbulksendGetListV1(opts)

Retrieve Ezsignbulksend list

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

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectEzsignbulksendApi();
let opts = {
  'eOrderBy': "eOrderBy_example", // String | Specify how you want the results to be sorted
  'iRowMax': 10000, // Number | 
  'iRowOffset': 0, // Number | 
  'Accept_Language': new EZmaxApiDefinitionFull.HeaderAcceptLanguage(), // HeaderAcceptLanguage | 
  'sFilter': "sFilter_example" // String | 
};
apiInstance.ezsignbulksendGetListV1(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
eOrderBy String Specify how you want the results to be sorted [optional]
iRowMax Number [optional] [default to 10000]
iRowOffset Number [optional] [default to 0]
Accept_Language HeaderAcceptLanguage [optional]
sFilter String [optional]

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 EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectEzsignbulksendApi();
let pkiEzsignbulksendID = 56; // Number | 
apiInstance.ezsignbulksendGetObjectV2(pkiEzsignbulksendID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pkiEzsignbulksendID Number

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 EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectEzsignbulksendApi();
let pkiEzsignbulksendID = 56; // Number | 
let EzsignbulksendReorderV1Request = new EZmaxApiDefinitionFull.EzsignbulksendReorderV1Request(); // EzsignbulksendReorderV1Request | 
apiInstance.ezsignbulksendReorderV1(pkiEzsignbulksendID, EzsignbulksendReorderV1Request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pkiEzsignbulksendID Number
EzsignbulksendReorderV1Request EzsignbulksendReorderV1Request

Return type

EzsignbulksendReorderV1Response

Authorization

Authorization

HTTP request headers

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