Get Case Audit Events

connectcases_get_case_audit_events

R Documentation

Returns the audit history about a specific case if it exists

Description

Returns the audit history about a specific case if it exists.

Usage

connectcases_get_case_audit_events(caseId, domainId, maxResults,
  nextToken)

Arguments

caseId

[required] A unique identifier of the case.

domainId

[required] The unique identifier of the Cases domain.

maxResults

The maximum number of audit events to return. The current maximum supported value is 25. This is also the default 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.

Value

A list with the following syntax:

list(
  auditEvents = list(
    list(
      eventId = "string",
      fields = list(
        list(
          eventFieldId = "string",
          newValue = list(
            booleanValue = TRUE|FALSE,
            doubleValue = 123.0,
            emptyValue = list(),
            stringValue = "string",
            userArnValue = "string"
          ),
          oldValue = list(
            booleanValue = TRUE|FALSE,
            doubleValue = 123.0,
            emptyValue = list(),
            stringValue = "string",
            userArnValue = "string"
          )
        )
      ),
      performedBy = list(
        iamPrincipalArn = "string",
        user = list(
          userArn = "string"
        )
      ),
      performedTime = as.POSIXct(
        "2015-01-01"
      ),
      relatedItemType = "Contact"|"Comment"|"File",
      type = "Case.Created"|"Case.Updated"|"RelatedItem.Created"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$get_case_audit_events(
  caseId = "string",
  domainId = "string",
  maxResults = 123,
  nextToken = "string"
)