Search Cases

connectcases_search_cases

R Documentation

Searches for cases within their associated Cases domain

Description

Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents.

For customer_id you must provide the full customer profile ARN in this format: ⁠ arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles domain name/profiles/profile ID⁠.

Usage

connectcases_search_cases(domainId, fields, filter, maxResults,
  nextToken, searchTerm, sorts)

Arguments

domainId

[required] The unique identifier of the Cases domain.

fields

The list of field identifiers to be returned as part of the response.

filter

A list of filter objects.

maxResults

The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.

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.

searchTerm

A word or phrase used to perform a quick search.

sorts

A list of sorts where each sort specifies a field and their sort order to be applied to the results.

Value

A list with the following syntax:

list(
  cases = list(
    list(
      caseId = "string",
      fields = list(
        list(
          id = "string",
          value = list(
            booleanValue = TRUE|FALSE,
            doubleValue = 123.0,
            emptyValue = list(),
            stringValue = "string",
            userArnValue = "string"
          )
        )
      ),
      tags = list(
        "string"
      ),
      templateId = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$search_cases(
  domainId = "string",
  fields = list(
    list(
      id = "string"
    )
  ),
  filter = list(
    andAll = list(
      list()
    ),
    field = list(
      contains = list(
        id = "string",
        value = list(
          booleanValue = TRUE|FALSE,
          doubleValue = 123.0,
          emptyValue = list(),
          stringValue = "string",
          userArnValue = "string"
        )
      ),
      equalTo = list(
        id = "string",
        value = list(
          booleanValue = TRUE|FALSE,
          doubleValue = 123.0,
          emptyValue = list(),
          stringValue = "string",
          userArnValue = "string"
        )
      ),
      greaterThan = list(
        id = "string",
        value = list(
          booleanValue = TRUE|FALSE,
          doubleValue = 123.0,
          emptyValue = list(),
          stringValue = "string",
          userArnValue = "string"
        )
      ),
      greaterThanOrEqualTo = list(
        id = "string",
        value = list(
          booleanValue = TRUE|FALSE,
          doubleValue = 123.0,
          emptyValue = list(),
          stringValue = "string",
          userArnValue = "string"
        )
      ),
      lessThan = list(
        id = "string",
        value = list(
          booleanValue = TRUE|FALSE,
          doubleValue = 123.0,
          emptyValue = list(),
          stringValue = "string",
          userArnValue = "string"
        )
      ),
      lessThanOrEqualTo = list(
        id = "string",
        value = list(
          booleanValue = TRUE|FALSE,
          doubleValue = 123.0,
          emptyValue = list(),
          stringValue = "string",
          userArnValue = "string"
        )
      )
    ),
    not = list(),
    orAll = list(
      list()
    )
  ),
  maxResults = 123,
  nextToken = "string",
  searchTerm = "string",
  sorts = list(
    list(
      fieldId = "string",
      sortOrder = "Asc"|"Desc"
    )
  )
)