Skip to content

Latest commit

 

History

History
161 lines (109 loc) · 4.82 KB

ObjectAttachmentAPI.md

File metadata and controls

161 lines (109 loc) · 4.82 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

    open class func attachmentDownloadV1(pkiAttachmentID: Int, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Retrieve the content

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiAttachmentID = 987 // Int | 

// Retrieve the content
ObjectAttachmentAPI.attachmentDownloadV1(pkiAttachmentID: pkiAttachmentID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

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

    open class func attachmentGetAttachmentlogsV1(pkiAttachmentID: Int, completion: @escaping (_ data: AttachmentGetAttachmentlogsV1Response?, _ error: Error?) -> Void)

Retrieve the Attachmentlogs

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiAttachmentID = 987 // Int | 

// Retrieve the Attachmentlogs
ObjectAttachmentAPI.attachmentGetAttachmentlogsV1(pkiAttachmentID: pkiAttachmentID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiAttachmentID Int

Return type

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]

attachmentGetDownloadUrlV1

    open class func attachmentGetDownloadUrlV1(pkiAttachmentID: Int, completion: @escaping (_ data: AttachmentGetDownloadUrlV1Response?, _ error: Error?) -> Void)

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

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiAttachmentID = 987 // Int | 

// Retrieve a URL to download attachments.
ObjectAttachmentAPI.attachmentGetDownloadUrlV1(pkiAttachmentID: pkiAttachmentID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiAttachmentID Int

Return type

AttachmentGetDownloadUrlV1Response

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]