support_add_attachments_to_set: Adds one or more attachments to an attachment set

Description Usage Arguments Value Request syntax

View source: R/support_operations.R

Description

Adds one or more attachments to an attachment set.

An attachment set is a temporary container for attachments that you add to a case or case communication. The set is available for 1 hour after it's created. The expiryTime returned in the response is when the set expires.

Usage

1
support_add_attachments_to_set(attachmentSetId, attachments)

Arguments

attachmentSetId

The ID of the attachment set. If an attachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId is specified, the attachments are added to the specified set, if it exists.

attachments

[required] One or more attachments to add to the set. You can add up to three attachments per set. The size limit is 5 MB per attachment.

In the Attachment object, use the data parameter to specify the contents of the attachment file. In the previous request syntax, the value for data appear as blob, which is represented as a base64-encoded string. The value for fileName is the name of the attachment, such as troubleshoot-screenshot.png.

Value

A list with the following syntax:

1
2
3
4
list(
  attachmentSetId = "string",
  expiryTime = "string"
)

Request syntax

1
2
3
4
5
6
7
8
9
svc$add_attachments_to_set(
  attachmentSetId = "string",
  attachments = list(
    list(
      fileName = "string",
      data = raw
    )
  )
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.