Skip to content

Search Related Items

connectcases_search_related_items R Documentation

Description

Searches for related items that are associated with a case.

If no filters are provided, this returns all related items associated with a case.

Usage

connectcases_search_related_items(caseId, domainId, filters, maxResults,
  nextToken)

Arguments

caseId

[required] A unique identifier of the case.

domainId

[required] The unique identifier of the Cases domain.

filters

The list of types of related items and their parameters to use for filtering.

maxResults

The maximum number of results to return per page.

nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Value

A list with the following syntax: 

list(
  nextToken = "string",
  relatedItems = list(
    list(
      associationTime = as.POSIXct(
        "2015-01-01"
      ),
      content = list(
        comment = list(
          body = "string",
          contentType = "Text/Plain"
        ),
        contact = list(
          channel = "string",
          connectedToSystemTime = as.POSIXct(
            "2015-01-01"
          ),
          contactArn = "string"
        ),
        file = list(
          fileArn = "string"
        )
      ),
      performedBy = list(
        userArn = "string"
      ),
      relatedItemId = "string",
      tags = list(
        "string"
      ),
      type = "Contact"|"Comment"|"File"
    )
  )
)

Request syntax

svc$search_related_items(
  caseId = "string",
  domainId = "string",
  filters = list(
    list(
      comment = list(),
      contact = list(
        channel = list(
          "string"
        ),
        contactArn = "string"
      ),
      file = list(
        fileArn = "string"
      )
    )
  ),
  maxResults = 123,
  nextToken = "string"
)