Skip to content

Latest commit

 

History

History
196 lines (131 loc) · 6.57 KB

ObjectEzsigndiscussionApi.md

File metadata and controls

196 lines (131 loc) · 6.57 KB
Raw

eZmaxAPI\ObjectEzsigndiscussionApi

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
ezsigndiscussionCreateObjectV1() POST /1/object/ezsigndiscussion Create a new Ezsigndiscussion
ezsigndiscussionDeleteObjectV1() DELETE /1/object/ezsigndiscussion/{pkiEzsigndiscussionID} Delete an existing Ezsigndiscussion
ezsigndiscussionGetObjectV2() GET /2/object/ezsigndiscussion/{pkiEzsigndiscussionID} Retrieve an existing Ezsigndiscussion

ezsigndiscussionCreateObjectV1()

ezsigndiscussionCreateObjectV1($ezsigndiscussionCreateObjectV1Request): \eZmaxAPI\Model\EzsigndiscussionCreateObjectV1Response

Create a new Ezsigndiscussion

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\ObjectEzsigndiscussionApi(
    // 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
);
$ezsigndiscussionCreateObjectV1Request = new \eZmaxAPI\Model\EzsigndiscussionCreateObjectV1Request(); // \eZmaxAPI\Model\EzsigndiscussionCreateObjectV1Request

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

Parameters

Name Type Description Notes
ezsigndiscussionCreateObjectV1Request \eZmaxAPI\Model\EzsigndiscussionCreateObjectV1Request

Return type

\eZmaxAPI\Model\EzsigndiscussionCreateObjectV1Response

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]

ezsigndiscussionDeleteObjectV1()

ezsigndiscussionDeleteObjectV1($pkiEzsigndiscussionID): \eZmaxAPI\Model\EzsigndiscussionDeleteObjectV1Response

Delete an existing Ezsigndiscussion

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\ObjectEzsigndiscussionApi(
    // 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
);
$pkiEzsigndiscussionID = 56; // int | The unique ID of the Ezsigndiscussion

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

Parameters

Name Type Description Notes
pkiEzsigndiscussionID int The unique ID of the Ezsigndiscussion

Return type

\eZmaxAPI\Model\EzsigndiscussionDeleteObjectV1Response

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]

ezsigndiscussionGetObjectV2()

ezsigndiscussionGetObjectV2($pkiEzsigndiscussionID): \eZmaxAPI\Model\EzsigndiscussionGetObjectV2Response

Retrieve an existing Ezsigndiscussion

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\ObjectEzsigndiscussionApi(
    // 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
);
$pkiEzsigndiscussionID = 56; // int | The unique ID of the Ezsigndiscussion

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

Parameters

Name Type Description Notes
pkiEzsigndiscussionID int The unique ID of the Ezsigndiscussion

Return type

\eZmaxAPI\Model\EzsigndiscussionGetObjectV2Response

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]