Skip to content

Latest commit

 

History

History
148 lines (93 loc) · 4.04 KB

ObjectAttachmentApi.md

File metadata and controls

148 lines (93 loc) · 4.04 KB
Raw

ObjectAttachmentApi

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

Method HTTP request Description
attachmentDownloadV1 GET /1/object/attachment/{pkiAttachmentID}/download Retrieve the content
attachmentGetAttachmentlogsV1 GET /1/object/attachment/{pkiAttachmentID}/getAttachmentlogs Retrieve the Attachmentlogs
attachmentGetDownloadUrlV1 GET /1/object/attachment/{pkiAttachmentID}/getDownloadUrl Retrieve a URL to download attachments.

attachmentDownloadV1

attachmentDownloadV1(pkiAttachmentID)

Retrieve the content

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

Example

// Import classes:
//import org.openapitools.client.api.ObjectAttachmentApi;

ObjectAttachmentApi apiInstance = new ObjectAttachmentApi();
Integer pkiAttachmentID = null; // Integer | 
try {
    apiInstance.attachmentDownloadV1(pkiAttachmentID);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectAttachmentApi#attachmentDownloadV1");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
pkiAttachmentID Integer [default to null]

Return type

null (empty response body)

Authorization

Authorization, Presigned

HTTP request headers

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

attachmentGetAttachmentlogsV1

AttachmentGetAttachmentlogsV1Response attachmentGetAttachmentlogsV1(pkiAttachmentID)

Retrieve the Attachmentlogs

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

Example

// Import classes:
//import org.openapitools.client.api.ObjectAttachmentApi;

ObjectAttachmentApi apiInstance = new ObjectAttachmentApi();
Integer pkiAttachmentID = null; // Integer | 
try {
    AttachmentGetAttachmentlogsV1Response result = apiInstance.attachmentGetAttachmentlogsV1(pkiAttachmentID);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectAttachmentApi#attachmentGetAttachmentlogsV1");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
pkiAttachmentID Integer [default to null]

Return type

AttachmentGetAttachmentlogsV1Response

Authorization

Authorization

HTTP request headers

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

attachmentGetDownloadUrlV1

AttachmentGetDownloadUrlV1Response attachmentGetDownloadUrlV1(pkiAttachmentID)

Retrieve a URL to download attachments.

This endpoint returns an URL to download the attachment. These links will expire after 5 minutes so the download of the file should be made soon after retrieving the link.

Example

// Import classes:
//import org.openapitools.client.api.ObjectAttachmentApi;

ObjectAttachmentApi apiInstance = new ObjectAttachmentApi();
Integer pkiAttachmentID = null; // Integer | 
try {
    AttachmentGetDownloadUrlV1Response result = apiInstance.attachmentGetDownloadUrlV1(pkiAttachmentID);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectAttachmentApi#attachmentGetDownloadUrlV1");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
pkiAttachmentID Integer [default to null]

Return type

AttachmentGetDownloadUrlV1Response

Authorization

Authorization

HTTP request headers

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