Skip to content

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. When no value is provided, 25 is the default.

  • 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",
  auditEvents = list(
    list(
      eventId = "string",
      type = "Case.Created"|"Case.Updated"|"RelatedItem.Created"|"RelatedItem.Deleted"|"RelatedItem.Updated",
      relatedItemType = "Contact"|"Comment"|"File"|"Sla"|"ConnectCase"|"Custom",
      performedTime = as.POSIXct(
        "2015-01-01"
      ),
      fields = list(
        list(
          eventFieldId = "string",
          oldValue = list(
            stringValue = "string",
            doubleValue = 123.0,
            booleanValue = TRUE|FALSE,
            emptyValue = list(),
            userArnValue = "string"
          ),
          newValue = list(
            stringValue = "string",
            doubleValue = 123.0,
            booleanValue = TRUE|FALSE,
            emptyValue = list(),
            userArnValue = "string"
          )
        )
      ),
      performedBy = list(
        user = list(
          userArn = "string",
          customEntity = "string"
        ),
        iamPrincipalArn = "string"
      )
    )
  )
)

Request syntax

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