Skip to content

Latest commit

 

History

History
261 lines (175 loc) · 9.1 KB

ObjectEzsignformfieldgroupApi.md

File metadata and controls

261 lines (175 loc) · 9.1 KB
Raw

eZmaxAPI\ObjectEzsignformfieldgroupApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest, except if the operation defines another base path.

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()

ezsignformfieldgroupCreateObjectV1($ezsignformfieldgroupCreateObjectV1Request): \eZmaxAPI\Model\EzsignformfieldgroupCreateObjectV1Response

Create a new Ezsignformfieldgroup

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsignformfieldgroupApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$ezsignformfieldgroupCreateObjectV1Request = new \eZmaxAPI\Model\EzsignformfieldgroupCreateObjectV1Request(); // \eZmaxAPI\Model\EzsignformfieldgroupCreateObjectV1Request

try {
    $result = $apiInstance->ezsignformfieldgroupCreateObjectV1($ezsignformfieldgroupCreateObjectV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsignformfieldgroupApi->ezsignformfieldgroupCreateObjectV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
ezsignformfieldgroupCreateObjectV1Request \eZmaxAPI\Model\EzsignformfieldgroupCreateObjectV1Request

Return type

\eZmaxAPI\Model\EzsignformfieldgroupCreateObjectV1Response

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignformfieldgroupDeleteObjectV1()

ezsignformfieldgroupDeleteObjectV1($pkiEzsignformfieldgroupID): \eZmaxAPI\Model\EzsignformfieldgroupDeleteObjectV1Response

Delete an existing Ezsignformfieldgroup

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsignformfieldgroupApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsignformfieldgroupID = 56; // int

try {
    $result = $apiInstance->ezsignformfieldgroupDeleteObjectV1($pkiEzsignformfieldgroupID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsignformfieldgroupApi->ezsignformfieldgroupDeleteObjectV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsignformfieldgroupID int

Return type

\eZmaxAPI\Model\EzsignformfieldgroupDeleteObjectV1Response

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignformfieldgroupEditObjectV1()

ezsignformfieldgroupEditObjectV1($pkiEzsignformfieldgroupID, $ezsignformfieldgroupEditObjectV1Request): \eZmaxAPI\Model\EzsignformfieldgroupEditObjectV1Response

Edit an existing Ezsignformfieldgroup

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsignformfieldgroupApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsignformfieldgroupID = 56; // int
$ezsignformfieldgroupEditObjectV1Request = new \eZmaxAPI\Model\EzsignformfieldgroupEditObjectV1Request(); // \eZmaxAPI\Model\EzsignformfieldgroupEditObjectV1Request

try {
    $result = $apiInstance->ezsignformfieldgroupEditObjectV1($pkiEzsignformfieldgroupID, $ezsignformfieldgroupEditObjectV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsignformfieldgroupApi->ezsignformfieldgroupEditObjectV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsignformfieldgroupID int
ezsignformfieldgroupEditObjectV1Request \eZmaxAPI\Model\EzsignformfieldgroupEditObjectV1Request

Return type

\eZmaxAPI\Model\EzsignformfieldgroupEditObjectV1Response

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignformfieldgroupGetObjectV2()

ezsignformfieldgroupGetObjectV2($pkiEzsignformfieldgroupID): \eZmaxAPI\Model\EzsignformfieldgroupGetObjectV2Response

Retrieve an existing Ezsignformfieldgroup

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsignformfieldgroupApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsignformfieldgroupID = 56; // int

try {
    $result = $apiInstance->ezsignformfieldgroupGetObjectV2($pkiEzsignformfieldgroupID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsignformfieldgroupApi->ezsignformfieldgroupGetObjectV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsignformfieldgroupID int

Return type

\eZmaxAPI\Model\EzsignformfieldgroupGetObjectV2Response

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]