Skip to content

Latest commit

 

History

History
155 lines (109 loc) · 4.53 KB

ObjectAttachmentApi.md

File metadata and controls

155 lines (109 loc) · 4.53 KB

EzmaxApi::ObjectAttachmentApi

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

Method HTTP request Description
attachment_download_v1 GET /1/object/attachment/{pkiAttachmentID}/download Retrieve the content
attachment_get_attachmentlogs_v1 GET /1/object/attachment/{pkiAttachmentID}/getAttachmentlogs Retrieve the Attachmentlogs

attachment_download_v1

attachment_download_v1(pki_attachment_id)

Retrieve the content

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

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'

  # Configure API key authorization: Presigned
  config.api_key['sAuthorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['sAuthorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectAttachmentApi.new
pki_attachment_id = 56 # Integer | 

begin
  # Retrieve the content
  api_instance.attachment_download_v1(pki_attachment_id)
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectAttachmentApi->attachment_download_v1: #{e}"
end

Using the attachment_download_v1_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> attachment_download_v1_with_http_info(pki_attachment_id)

begin
  # Retrieve the content
  data, status_code, headers = api_instance.attachment_download_v1_with_http_info(pki_attachment_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectAttachmentApi->attachment_download_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_attachment_id Integer

Return type

nil (empty response body)

Authorization

Authorization, Presigned

HTTP request headers

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

attachment_get_attachmentlogs_v1

attachment_get_attachmentlogs_v1(pki_attachment_id)

Retrieve the Attachmentlogs

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

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectAttachmentApi.new
pki_attachment_id = 56 # Integer | 

begin
  # Retrieve the Attachmentlogs
  result = api_instance.attachment_get_attachmentlogs_v1(pki_attachment_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectAttachmentApi->attachment_get_attachmentlogs_v1: #{e}"
end

Using the attachment_get_attachmentlogs_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> attachment_get_attachmentlogs_v1_with_http_info(pki_attachment_id)

begin
  # Retrieve the Attachmentlogs
  data, status_code, headers = api_instance.attachment_get_attachmentlogs_v1_with_http_info(pki_attachment_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AttachmentGetAttachmentlogsV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectAttachmentApi->attachment_get_attachmentlogs_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_attachment_id Integer

Return type

AttachmentGetAttachmentlogsV1Response

Authorization

Authorization

HTTP request headers

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