Create Related Item
connectcases_create_related_item | R Documentation |
Creates a related item (comments, tasks, and contacts) and associates it with a case¶
Description¶
Creates a related item (comments, tasks, and contacts) and associates it with a case.
-
A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a
contactArn
). All Related Items have their own internal identifier, therelatedItemArn
. Examples of related items includecomments
andcontacts
. -
If you provide a value for
performedBy.userArn
you must also have DescribeUser permission on the ARN of the user that you provide. -
The
type
field is reserved for internal use only.
Usage¶
connectcases_create_related_item(caseId, content, domainId, performedBy,
type)
Arguments¶
caseId |
[required] A unique identifier of the case. |
content |
[required] The content of a related item to be created. |
domainId |
[required] The unique identifier of the Cases domain. |
performedBy |
Represents the creator of the related item. |
type |
[required] The type of a related item. |
Value¶
A list with the following syntax:
list(
relatedItemArn = "string",
relatedItemId = "string"
)
Request syntax¶
svc$create_related_item(
caseId = "string",
content = list(
comment = list(
body = "string",
contentType = "Text/Plain"
),
contact = list(
contactArn = "string"
),
file = list(
fileArn = "string"
)
),
domainId = "string",
performedBy = list(
userArn = "string"
),
type = "Contact"|"Comment"|"File"
)