SEARCHEVALUATIONFORMS()`¶

About SearchEvaluationForms¶

Searches evaluation forms in an Amazon Connect 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 Amazon Connect endpoints and quotas.

Method Signature¶

METHODS /AWS1/IF_CNT~SEARCHEVALUATIONFORMS
  IMPORTING
    !IV_INSTANCEID TYPE /AWS1/CNTINSTANCEID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CNTNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/CNTMAXRESULT100 OPTIONAL
    !IO_SEARCHCRITERIA TYPE REF TO /AWS1/CL_CNTEVALFORMSEARCHCRIT OPTIONAL
    !IO_SEARCHFILTER TYPE REF TO /AWS1/CL_CNTEVALFORMSRCHFILTER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntsearchevalformsrsp
  RAISING
    /AWS1/CX_CNTINTERNALSERVICEEX
    /AWS1/CX_CNTINVALIDPARAMETEREX
    /AWS1/CX_CNTINVALIDREQUESTEX
    /AWS1/CX_CNTRESOURCENOTFOUNDEX
    /AWS1/CX_CNTTHROTTLINGEX
    /AWS1/CX_CNTCLIENTEXC
    /AWS1/CX_CNTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_instanceid` `TYPE /AWS1/CNTINSTANCEID` `/AWS1/CNTINSTANCEID`¶

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

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/CNTNEXTTOKEN` `/AWS1/CNTNEXTTOKEN`¶

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.

`iv_maxresults` `TYPE /AWS1/CNTMAXRESULT100` `/AWS1/CNTMAXRESULT100`¶

The maximum number of results to return per page.

`io_searchcriteria` `TYPE REF TO /AWS1/CL_CNTEVALFORMSEARCHCRIT` `/AWS1/CL_CNTEVALFORMSEARCHCRIT`¶

The search criteria to be used to return evaluation forms.

`io_searchfilter` `TYPE REF TO /AWS1/CL_CNTEVALFORMSRCHFILTER` `/AWS1/CL_CNTEVALFORMSRCHFILTER`¶

Filters to be applied to search results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cntsearchevalformsrsp` `/AWS1/CL_CNTSEARCHEVALFORMSRSP`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->searchevaluationforms(
  io_searchcriteria = new /aws1/cl_cntevalformsearchcrit(
    io_booleancondition = new /aws1/cl_cntbooleancondition(
      iv_comparisontype = |string|
      iv_fieldname = |string|
    )
    io_datetimecondition = new /aws1/cl_cntdatetimecondition(
      iv_comparisontype = |string|
      iv_fieldname = |string|
      iv_maxvalue = |string|
      iv_minvalue = |string|
    )
    io_numbercondition = new /aws1/cl_cntnumbercondition(
      iv_comparisontype = |string|
      iv_fieldname = |string|
      iv_maxvalue = 123
      iv_minvalue = 123
    )
    io_stringcondition = new /aws1/cl_cntstringcondition(
      iv_comparisontype = |string|
      iv_fieldname = |string|
      iv_value = |string|
    )
    it_andconditions = VALUE /aws1/cl_cntevalformsearchcrit=>tt_evalformsearchconditionlist(
      (
        new /aws1/cl_cntevalformsearchcrit(
          io_booleancondition = new /aws1/cl_cntbooleancondition(
            iv_comparisontype = |string|
            iv_fieldname = |string|
          )
          io_datetimecondition = new /aws1/cl_cntdatetimecondition(
            iv_comparisontype = |string|
            iv_fieldname = |string|
            iv_maxvalue = |string|
            iv_minvalue = |string|
          )
          io_numbercondition = new /aws1/cl_cntnumbercondition(
            iv_comparisontype = |string|
            iv_fieldname = |string|
            iv_maxvalue = 123
            iv_minvalue = 123
          )
          io_stringcondition = new /aws1/cl_cntstringcondition(
            iv_comparisontype = |string|
            iv_fieldname = |string|
            iv_value = |string|
          )
          it_orconditions = VALUE /aws1/cl_cntevalformsearchcrit=>tt_evalformsearchconditionlist(
          )
        )
      )
    )
    it_orconditions = VALUE /aws1/cl_cntevalformsearchcrit=>tt_evalformsearchconditionlist(
      (
        new /aws1/cl_cntevalformsearchcrit(
          io_booleancondition = new /aws1/cl_cntbooleancondition(
            iv_comparisontype = |string|
            iv_fieldname = |string|
          )
          io_datetimecondition = new /aws1/cl_cntdatetimecondition(
            iv_comparisontype = |string|
            iv_fieldname = |string|
            iv_maxvalue = |string|
            iv_minvalue = |string|
          )
          io_numbercondition = new /aws1/cl_cntnumbercondition(
            iv_comparisontype = |string|
            iv_fieldname = |string|
            iv_maxvalue = 123
            iv_minvalue = 123
          )
          io_stringcondition = new /aws1/cl_cntstringcondition(
            iv_comparisontype = |string|
            iv_fieldname = |string|
            iv_value = |string|
          )
          it_andconditions = VALUE /aws1/cl_cntevalformsearchcrit=>tt_evalformsearchconditionlist(
          )
        )
      )
    )
  )
  io_searchfilter = new /aws1/cl_cntevalformsrchfilter(
    io_attributefilter = new /aws1/cl_cntctlplaneattrfilter(
      io_andcondition = new /aws1/cl_cntcommonattrandcond(
        it_tagconditions = VALUE /aws1/cl_cnttagcondition=>tt_tagandconditionlist(
          (
            new /aws1/cl_cnttagcondition(
              iv_tagkey = |string|
              iv_tagvalue = |string|
            )
          )
        )
      )
      io_tagcondition = new /aws1/cl_cnttagcondition(
        iv_tagkey = |string|
        iv_tagvalue = |string|
      )
      it_orconditions = VALUE /aws1/cl_cntcommonattrandcond=>tt_commonattrorconditionlist(
        (
          new /aws1/cl_cntcommonattrandcond(
            it_tagconditions = VALUE /aws1/cl_cnttagcondition=>tt_tagandconditionlist(
              (
                new /aws1/cl_cnttagcondition(
                  iv_tagkey = |string|
                  iv_tagvalue = |string|
                )
              )
            )
          )
        )
      )
    )
  )
  iv_instanceid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_evalformsearchsummlist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_resourceid = lo_row_1->get_evaluationformid( ).
      lv_arn = lo_row_1->get_evaluationformarn( ).
      lv_evaluationformtitle = lo_row_1->get_title( ).
      lv_evaluationformversionst = lo_row_1->get_status( ).
      lv_evaluationformdescripti = lo_row_1->get_description( ).
      lv_timestamp = lo_row_1->get_createdtime( ).
      lv_arn = lo_row_1->get_createdby( ).
      lv_timestamp = lo_row_1->get_lastmodifiedtime( ).
      lv_arn = lo_row_1->get_lastmodifiedby( ).
      lv_timestamp = lo_row_1->get_lastactivatedtime( ).
      lv_arn = lo_row_1->get_lastactivatedby( ).
      lv_versionnumber = lo_row_1->get_latestversion( ).
      lv_versionnumber = lo_row_1->get_activeversion( ).
      lv_boolean = lo_row_1->get_autoevaluationenabled( ).
      LOOP AT lo_row_1->get_tags( ) into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_tagvalue = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
  lv_approximatetotalcount = lo_result->get_approximatetotalcount( ).
ENDIF.

/AWS1/IF_CNT=>SEARCHEVALUATIONFORMS()¶