Search Evaluation Forms

connect_search_evaluation_forms

R Documentation

Searches evaluation forms in an Connect Customer instance, with optional filtering¶

Description¶

Searches evaluation forms in an Connect Customer instance, with optional filtering.

Use cases

Following are common uses cases for this API:

List all evaluation forms in an instance.
Find all evaluation forms that meet specific criteria, such as Title, Description, Status, and more.
Find all evaluation forms that are tagged with a specific set of tags.

Important things to know

A Search operation, unlike a List operation, takes time to index changes to resource (create, update or delete). If you don't see updated information for recently changed contact evaluations, try calling the API again in a few seconds.

Endpoints: See Connect Customer endpoints and quotas.

Usage¶

connect_search_evaluation_forms(InstanceId, NextToken, MaxResults,
  SearchCriteria, SearchFilter)

Arguments¶

InstanceId

[required] The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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.

MaxResults

The maximum number of results to return per page.

SearchCriteria

The search criteria to be used to return evaluation forms.

Filters to be applied to search results.

Value¶

A list with the following syntax:

list(
  EvaluationFormSearchSummaryList = list(
    list(
      EvaluationFormId = "string",
      EvaluationFormArn = "string",
      Title = "string",
      Status = "DRAFT"|"ACTIVE",
      Description = "string",
      CreatedTime = as.POSIXct(
        "2015-01-01"
      ),
      CreatedBy = "string",
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedBy = "string",
      LastActivatedTime = as.POSIXct(
        "2015-01-01"
      ),
      LastActivatedBy = "string",
      LatestVersion = 123,
      ActiveVersion = 123,
      AutoEvaluationEnabled = TRUE|FALSE,
      EvaluationFormLanguage = "de-DE"|"en-US"|"es-ES"|"fr-FR"|"it-IT"|"pt-BR"|"ja-JP"|"ko-KR"|"zh-CN",
      ContactInteractionType = "AGENT"|"AUTOMATED"|"CUSTOMER",
      Tags = list(
        "string"
      )
    )
  ),
  NextToken = "string",
  ApproximateTotalCount = 123
)

Request syntax¶

svc$search_evaluation_forms(
  InstanceId = "string",
  NextToken = "string",
  MaxResults = 123,
  SearchCriteria = list(
    OrConditions = list(
      list()
    ),
    AndConditions = list(
      list()
    ),
    StringCondition = list(
      FieldName = "string",
      Value = "string",
      ComparisonType = "STARTS_WITH"|"CONTAINS"|"EXACT"
    ),
    NumberCondition = list(
      FieldName = "string",
      MinValue = 123,
      MaxValue = 123,
      ComparisonType = "GREATER_OR_EQUAL"|"GREATER"|"LESSER_OR_EQUAL"|"LESSER"|"EQUAL"|"NOT_EQUAL"|"RANGE"
    ),
    BooleanCondition = list(
      FieldName = "string",
      ComparisonType = "IS_TRUE"|"IS_FALSE"
    ),
    DateTimeCondition = list(
      FieldName = "string",
      MinValue = "string",
      MaxValue = "string",
      ComparisonType = "GREATER_THAN"|"LESS_THAN"|"GREATER_THAN_OR_EQUAL_TO"|"LESS_THAN_OR_EQUAL_TO"|"EQUAL_TO"|"RANGE"
    )
  ),
  SearchFilter = list(
    AttributeFilter = list(
      OrConditions = list(
        list(
          TagConditions = list(
            list(
              TagKey = "string",
              TagValue = "string"
            )
          )
        )
      ),
      AndCondition = list(
        TagConditions = list(
          list(
            TagKey = "string",
            TagValue = "string"
          )
        )
      ),
      TagCondition = list(
        TagKey = "string",
        TagValue = "string"
      )
    )
  )
)