eZmaxAPI\ObjectEzdoctemplatedocumentApi

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
ezdoctemplatedocumentCreateObjectV1()	POST /1/object/ezdoctemplatedocument	Create a new Ezdoctemplatedocument
ezdoctemplatedocumentDownloadV1()	GET /1/object/ezdoctemplatedocument/{pkiEzdoctemplatedocumentID}/download	Retrieve the content
ezdoctemplatedocumentEditObjectV1()	PUT /1/object/ezdoctemplatedocument/{pkiEzdoctemplatedocumentID}	Edit an existing Ezdoctemplatedocument
ezdoctemplatedocumentGetAutocompleteV2()	GET /2/object/ezdoctemplatedocument/getAutocomplete/{sSelector}	Retrieve Ezdoctemplatedocuments and IDs
ezdoctemplatedocumentGetListV1()	GET /1/object/ezdoctemplatedocument/getList	Retrieve Ezdoctemplatedocument list
ezdoctemplatedocumentGetObjectV2()	GET /2/object/ezdoctemplatedocument/{pkiEzdoctemplatedocumentID}	Retrieve an existing Ezdoctemplatedocument
ezdoctemplatedocumentPatchObjectV1()	PATCH /1/object/ezdoctemplatedocument/{pkiEzdoctemplatedocumentID}	Patch an existing Ezdoctemplatedocument

`ezdoctemplatedocumentCreateObjectV1()`

ezdoctemplatedocumentCreateObjectV1($ezdoctemplatedocumentCreateObjectV1Request): \eZmaxAPI\Model\EzdoctemplatedocumentCreateObjectV1Response

Create a new Ezdoctemplatedocument

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\ObjectEzdoctemplatedocumentApi(
    // 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
);
$ezdoctemplatedocumentCreateObjectV1Request = new \eZmaxAPI\Model\EzdoctemplatedocumentCreateObjectV1Request(); // \eZmaxAPI\Model\EzdoctemplatedocumentCreateObjectV1Request

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

Parameters

Name	Type	Description	Notes
ezdoctemplatedocumentCreateObjectV1Request	\eZmaxAPI\Model\EzdoctemplatedocumentCreateObjectV1Request

Return type

\eZmaxAPI\Model\EzdoctemplatedocumentCreateObjectV1Response

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]

`ezdoctemplatedocumentDownloadV1()`

ezdoctemplatedocumentDownloadV1($pkiEzdoctemplatedocumentID)

Retrieve the content

Using this endpoint, you can retrieve the content of an ezdoctemplatedocument.

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');

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


$apiInstance = new eZmaxAPI\Api\ObjectEzdoctemplatedocumentApi(
    // 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
);
$pkiEzdoctemplatedocumentID = 56; // int

try {
    $apiInstance->ezdoctemplatedocumentDownloadV1($pkiEzdoctemplatedocumentID);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzdoctemplatedocumentApi->ezdoctemplatedocumentDownloadV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzdoctemplatedocumentID	int

Return type

void (empty response body)

Authorization

Authorization, Presigned

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`ezdoctemplatedocumentEditObjectV1()`

ezdoctemplatedocumentEditObjectV1($pkiEzdoctemplatedocumentID, $ezdoctemplatedocumentEditObjectV1Request): \eZmaxAPI\Model\EzdoctemplatedocumentEditObjectV1Response

Edit an existing Ezdoctemplatedocument

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\ObjectEzdoctemplatedocumentApi(
    // 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
);
$pkiEzdoctemplatedocumentID = 56; // int | The unique ID of the Ezdoctemplatedocument
$ezdoctemplatedocumentEditObjectV1Request = new \eZmaxAPI\Model\EzdoctemplatedocumentEditObjectV1Request(); // \eZmaxAPI\Model\EzdoctemplatedocumentEditObjectV1Request

try {
    $result = $apiInstance->ezdoctemplatedocumentEditObjectV1($pkiEzdoctemplatedocumentID, $ezdoctemplatedocumentEditObjectV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzdoctemplatedocumentApi->ezdoctemplatedocumentEditObjectV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzdoctemplatedocumentID	int	The unique ID of the Ezdoctemplatedocument
ezdoctemplatedocumentEditObjectV1Request	\eZmaxAPI\Model\EzdoctemplatedocumentEditObjectV1Request

Return type

\eZmaxAPI\Model\EzdoctemplatedocumentEditObjectV1Response

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]

`ezdoctemplatedocumentGetAutocompleteV2()`

ezdoctemplatedocumentGetAutocompleteV2($sSelector, $eType, $fkiEzsignfoldertypeID, $eFilterActive, $sQuery, $acceptLanguage): \eZmaxAPI\Model\EzdoctemplatedocumentGetAutocompleteV2Response

Retrieve Ezdoctemplatedocuments and IDs

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

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\ObjectEzdoctemplatedocumentApi(
    // 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
);
$sSelector = 'sSelector_example'; // string | The type of Ezdoctemplatedocuments to return
$eType = 'CompanyEzsignfoldertype'; // string | The type of Ezdoctemplatedocument
$fkiEzsignfoldertypeID = 'fkiEzsignfoldertypeID_example'; // string | Specify which fkiEzsignfoldertypeID we want to display. only used when eType = Ezsignfoldertype
$eFilterActive = 'Active'; // string | Specify which results we want to display.
$sQuery = 'sQuery_example'; // string | Allow to filter the returned results
$acceptLanguage = new \eZmaxAPI\Model\\eZmaxAPI\Model\HeaderAcceptLanguage(); // \eZmaxAPI\Model\HeaderAcceptLanguage

try {
    $result = $apiInstance->ezdoctemplatedocumentGetAutocompleteV2($sSelector, $eType, $fkiEzsignfoldertypeID, $eFilterActive, $sQuery, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzdoctemplatedocumentApi->ezdoctemplatedocumentGetAutocompleteV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
sSelector	string	The type of Ezdoctemplatedocuments to return
eType	string	The type of Ezdoctemplatedocument	[default to 'CompanyEzsignfoldertype']
fkiEzsignfoldertypeID	string	Specify which fkiEzsignfoldertypeID we want to display. only used when eType = Ezsignfoldertype	[optional]
eFilterActive	string	Specify which results we want to display.	[optional] [default to 'Active']
sQuery	string	Allow to filter the returned results	[optional]
acceptLanguage	\eZmaxAPI\Model\HeaderAcceptLanguage		[optional]

Return type

\eZmaxAPI\Model\EzdoctemplatedocumentGetAutocompleteV2Response

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]

`ezdoctemplatedocumentGetListV1()`

ezdoctemplatedocumentGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter): \eZmaxAPI\Model\EzdoctemplatedocumentGetListV1Response

Retrieve Ezdoctemplatedocument list

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\ObjectEzdoctemplatedocumentApi(
    // 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
);
$eOrderBy = 'eOrderBy_example'; // string | Specify how you want the results to be sorted
$iRowMax = 56; // int
$iRowOffset = 0; // int
$acceptLanguage = new \eZmaxAPI\Model\\eZmaxAPI\Model\HeaderAcceptLanguage(); // \eZmaxAPI\Model\HeaderAcceptLanguage
$sFilter = 'sFilter_example'; // string

try {
    $result = $apiInstance->ezdoctemplatedocumentGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzdoctemplatedocumentApi->ezdoctemplatedocumentGetListV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
eOrderBy	string	Specify how you want the results to be sorted	[optional]
iRowMax	int		[optional]
iRowOffset	int		[optional] [default to 0]
acceptLanguage	\eZmaxAPI\Model\HeaderAcceptLanguage		[optional]
sFilter	string		[optional]

Return type

\eZmaxAPI\Model\EzdoctemplatedocumentGetListV1Response

Authorization

HTTP request headers

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

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

`ezdoctemplatedocumentGetObjectV2()`

ezdoctemplatedocumentGetObjectV2($pkiEzdoctemplatedocumentID): \eZmaxAPI\Model\EzdoctemplatedocumentGetObjectV2Response

Retrieve an existing Ezdoctemplatedocument

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\ObjectEzdoctemplatedocumentApi(
    // 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
);
$pkiEzdoctemplatedocumentID = 56; // int | The unique ID of the Ezdoctemplatedocument

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

Parameters

Name	Type	Description	Notes
pkiEzdoctemplatedocumentID	int	The unique ID of the Ezdoctemplatedocument

Return type

\eZmaxAPI\Model\EzdoctemplatedocumentGetObjectV2Response

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]

`ezdoctemplatedocumentPatchObjectV1()`

ezdoctemplatedocumentPatchObjectV1($pkiEzdoctemplatedocumentID, $ezdoctemplatedocumentPatchObjectV1Request): \eZmaxAPI\Model\EzdoctemplatedocumentPatchObjectV1Response

Patch an existing Ezdoctemplatedocument

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\ObjectEzdoctemplatedocumentApi(
    // 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
);
$pkiEzdoctemplatedocumentID = 56; // int | The unique ID of the Ezdoctemplatedocument
$ezdoctemplatedocumentPatchObjectV1Request = new \eZmaxAPI\Model\EzdoctemplatedocumentPatchObjectV1Request(); // \eZmaxAPI\Model\EzdoctemplatedocumentPatchObjectV1Request

try {
    $result = $apiInstance->ezdoctemplatedocumentPatchObjectV1($pkiEzdoctemplatedocumentID, $ezdoctemplatedocumentPatchObjectV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzdoctemplatedocumentApi->ezdoctemplatedocumentPatchObjectV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzdoctemplatedocumentID	int	The unique ID of the Ezdoctemplatedocument
ezdoctemplatedocumentPatchObjectV1Request	\eZmaxAPI\Model\EzdoctemplatedocumentPatchObjectV1Request

Return type

\eZmaxAPI\Model\EzdoctemplatedocumentPatchObjectV1Response

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]

Files

ObjectEzdoctemplatedocumentApi.md

Latest commit

History

ObjectEzdoctemplatedocumentApi.md

File metadata and controls

eZmaxAPI\ObjectEzdoctemplatedocumentApi

ezdoctemplatedocumentCreateObjectV1()

Example

Parameters

Return type

Authorization

HTTP request headers

ezdoctemplatedocumentDownloadV1()

Example

Parameters

Return type

Authorization

HTTP request headers

ezdoctemplatedocumentEditObjectV1()

Example

Parameters

Return type

Authorization

HTTP request headers

ezdoctemplatedocumentGetAutocompleteV2()

Example

Parameters

Return type

Authorization

HTTP request headers

ezdoctemplatedocumentGetListV1()

Example

Parameters

Return type

Authorization

HTTP request headers

ezdoctemplatedocumentGetObjectV2()

Example

Parameters

Return type

Authorization

HTTP request headers

ezdoctemplatedocumentPatchObjectV1()

Example

Parameters

Return type

Authorization

HTTP request headers

`ezdoctemplatedocumentCreateObjectV1()`

`ezdoctemplatedocumentDownloadV1()`

`ezdoctemplatedocumentEditObjectV1()`

`ezdoctemplatedocumentGetAutocompleteV2()`

`ezdoctemplatedocumentGetListV1()`

`ezdoctemplatedocumentGetObjectV2()`

`ezdoctemplatedocumentPatchObjectV1()`