Skip to content

ObjectAttachmentApi.md

Latest commit

 

History

History
139 lines (93 loc) · 4.32 KB

ObjectAttachmentApi.md

File metadata and controls

139 lines (93 loc) · 4.32 KB

eZmaxAPI\ObjectAttachmentApi

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
attachmentDownloadV1() GET /1/object/attachment/{pkiAttachmentID}/download Retrieve the content
attachmentGetAttachmentlogsV1() GET /1/object/attachment/{pkiAttachmentID}/getAttachmentlogs Retrieve the Attachmentlogs

attachmentDownloadV1()

attachmentDownloadV1($pkiAttachmentID)

Retrieve the content

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

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\ObjectAttachmentApi(
    // 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
);
$pkiAttachmentID = 56; // int

try {
    $apiInstance->attachmentDownloadV1($pkiAttachmentID);
} catch (Exception $e) {
    echo 'Exception when calling ObjectAttachmentApi->attachmentDownloadV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiAttachmentID 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]

attachmentGetAttachmentlogsV1()

attachmentGetAttachmentlogsV1($pkiAttachmentID): \eZmaxAPI\Model\AttachmentGetAttachmentlogsV1Response

Retrieve the Attachmentlogs

Using this endpoint, you can retrieve the Attachmentlogs of an attachment.

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\ObjectAttachmentApi(
    // 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
);
$pkiAttachmentID = 56; // int

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

Parameters

Name Type Description Notes
pkiAttachmentID int

Return type

\eZmaxAPI\Model\AttachmentGetAttachmentlogsV1Response

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]