ObjectEzsignformfieldgroupApi.md

EZmaxApiDefinitionFull.ObjectEzsignformfieldgroupApi

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

Method	HTTP request	Description
ezsignformfieldgroupCreateObjectV1	POST /1/object/ezsignformfieldgroup	Create a new Ezsignformfieldgroup
ezsignformfieldgroupDeleteObjectV1	DELETE /1/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID}	Delete an existing Ezsignformfieldgroup
ezsignformfieldgroupEditObjectV1	PUT /1/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID}	Edit an existing Ezsignformfieldgroup
ezsignformfieldgroupGetObjectV2	GET /2/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID}	Retrieve an existing Ezsignformfieldgroup

ezsignformfieldgroupCreateObjectV1

EzsignformfieldgroupCreateObjectV1Response ezsignformfieldgroupCreateObjectV1(EzsignformfieldgroupCreateObjectV1Request)

Create a new Ezsignformfieldgroup

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.ObjectEzsignformfieldgroupApi();
let EzsignformfieldgroupCreateObjectV1Request = new EZmaxApiDefinitionFull.EzsignformfieldgroupCreateObjectV1Request(); // EzsignformfieldgroupCreateObjectV1Request | 
apiInstance.ezsignformfieldgroupCreateObjectV1(EzsignformfieldgroupCreateObjectV1Request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
EzsignformfieldgroupCreateObjectV1Request	EzsignformfieldgroupCreateObjectV1Request

Return type

EzsignformfieldgroupCreateObjectV1Response

Authorization

Authorization

HTTP request headers

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

ezsignformfieldgroupDeleteObjectV1

EzsignformfieldgroupDeleteObjectV1Response ezsignformfieldgroupDeleteObjectV1(pkiEzsignformfieldgroupID)

Delete an existing Ezsignformfieldgroup

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.ObjectEzsignformfieldgroupApi();
let pkiEzsignformfieldgroupID = 56; // Number | 
apiInstance.ezsignformfieldgroupDeleteObjectV1(pkiEzsignformfieldgroupID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
pkiEzsignformfieldgroupID	Number

Return type

EzsignformfieldgroupDeleteObjectV1Response

Authorization

Authorization

HTTP request headers

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

ezsignformfieldgroupEditObjectV1

EzsignformfieldgroupEditObjectV1Response ezsignformfieldgroupEditObjectV1(pkiEzsignformfieldgroupID, EzsignformfieldgroupEditObjectV1Request)

Edit an existing Ezsignformfieldgroup

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.ObjectEzsignformfieldgroupApi();
let pkiEzsignformfieldgroupID = 56; // Number | 
let EzsignformfieldgroupEditObjectV1Request = new EZmaxApiDefinitionFull.EzsignformfieldgroupEditObjectV1Request(); // EzsignformfieldgroupEditObjectV1Request | 
apiInstance.ezsignformfieldgroupEditObjectV1(pkiEzsignformfieldgroupID, EzsignformfieldgroupEditObjectV1Request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
pkiEzsignformfieldgroupID	Number
EzsignformfieldgroupEditObjectV1Request	EzsignformfieldgroupEditObjectV1Request

Return type

EzsignformfieldgroupEditObjectV1Response

Authorization

Authorization

HTTP request headers

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

ezsignformfieldgroupGetObjectV2

EzsignformfieldgroupGetObjectV2Response ezsignformfieldgroupGetObjectV2(pkiEzsignformfieldgroupID)

Retrieve an existing Ezsignformfieldgroup

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.ObjectEzsignformfieldgroupApi();
let pkiEzsignformfieldgroupID = 56; // Number | 
apiInstance.ezsignformfieldgroupGetObjectV2(pkiEzsignformfieldgroupID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
pkiEzsignformfieldgroupID	Number

Return type

EzsignformfieldgroupGetObjectV2Response

Authorization

Authorization

HTTP request headers

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