/AWS1/IF_CNT=>SEARCHUSERS()¶
About SearchUsers¶
Searches users in an Amazon Connect instance, with optional filtering.
AfterContactWorkTimeLimit is returned in milliseconds.
Method Signature¶
METHODS /AWS1/IF_CNT~SEARCHUSERS
IMPORTING
!IV_INSTANCEID TYPE /AWS1/CNTINSTANCEID OPTIONAL
!IV_NEXTTOKEN TYPE /AWS1/CNTNEXTTOKEN2500 OPTIONAL
!IV_MAXRESULTS TYPE /AWS1/CNTMAXRESULT500 OPTIONAL
!IO_SEARCHFILTER TYPE REF TO /AWS1/CL_CNTUSERSEARCHFILTER OPTIONAL
!IO_SEARCHCRITERIA TYPE REF TO /AWS1/CL_CNTUSERSEARCHCRITERIA OPTIONAL
RETURNING
VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntsearchusersrsp
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/CNTNEXTTOKEN2500 /AWS1/CNTNEXTTOKEN2500¶
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/CNTMAXRESULT500 /AWS1/CNTMAXRESULT500¶
The maximum number of results to return per page.
io_searchfilter TYPE REF TO /AWS1/CL_CNTUSERSEARCHFILTER /AWS1/CL_CNTUSERSEARCHFILTER¶
Filters to be applied to search results.
io_searchcriteria TYPE REF TO /AWS1/CL_CNTUSERSEARCHCRITERIA /AWS1/CL_CNTUSERSEARCHCRITERIA¶
SearchCriteria
RETURNING¶
oo_output TYPE REF TO /aws1/cl_cntsearchusersrsp /AWS1/CL_CNTSEARCHUSERSRSP¶
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->searchusers(
io_searchcriteria = new /aws1/cl_cntusersearchcriteria(
io_hierarchygroupcondition = new /aws1/cl_cnthierarchygroupcond(
iv_hierarchygroupmatchtype = |string|
iv_value = |string|
)
io_listcondition = new /aws1/cl_cntlistcondition(
it_conditions = VALUE /aws1/cl_cntcondition=>tt_conditions(
(
new /aws1/cl_cntcondition(
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|
)
)
)
)
iv_targetlisttype = |string|
)
io_stringcondition = new /aws1/cl_cntstringcondition(
iv_comparisontype = |string|
iv_fieldname = |string|
iv_value = |string|
)
it_andconditions = VALUE /aws1/cl_cntusersearchcriteria=>tt_usersearchconditionlist(
(
new /aws1/cl_cntusersearchcriteria(
io_hierarchygroupcondition = new /aws1/cl_cnthierarchygroupcond(
iv_hierarchygroupmatchtype = |string|
iv_value = |string|
)
io_listcondition = new /aws1/cl_cntlistcondition(
it_conditions = VALUE /aws1/cl_cntcondition=>tt_conditions(
(
new /aws1/cl_cntcondition(
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|
)
)
)
)
iv_targetlisttype = |string|
)
io_stringcondition = new /aws1/cl_cntstringcondition(
iv_comparisontype = |string|
iv_fieldname = |string|
iv_value = |string|
)
it_orconditions = VALUE /aws1/cl_cntusersearchcriteria=>tt_usersearchconditionlist(
)
)
)
)
it_orconditions = VALUE /aws1/cl_cntusersearchcriteria=>tt_usersearchconditionlist(
(
new /aws1/cl_cntusersearchcriteria(
io_hierarchygroupcondition = new /aws1/cl_cnthierarchygroupcond(
iv_hierarchygroupmatchtype = |string|
iv_value = |string|
)
io_listcondition = new /aws1/cl_cntlistcondition(
it_conditions = VALUE /aws1/cl_cntcondition=>tt_conditions(
(
new /aws1/cl_cntcondition(
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|
)
)
)
)
iv_targetlisttype = |string|
)
io_stringcondition = new /aws1/cl_cntstringcondition(
iv_comparisontype = |string|
iv_fieldname = |string|
iv_value = |string|
)
it_andconditions = VALUE /aws1/cl_cntusersearchcriteria=>tt_usersearchconditionlist(
)
)
)
)
)
io_searchfilter = new /aws1/cl_cntusersearchfilter(
io_tagfilter = new /aws1/cl_cntctlplanetagfilter(
io_tagcondition = new /aws1/cl_cnttagcondition(
iv_tagkey = |string|
iv_tagvalue = |string|
)
it_andconditions = VALUE /aws1/cl_cnttagcondition=>tt_tagandconditionlist(
(
new /aws1/cl_cnttagcondition(
iv_tagkey = |string|
iv_tagvalue = |string|
)
)
)
it_orconditions = VALUE /aws1/cl_cnttagcondition=>tt_tagorconditionlist(
(
VALUE /aws1/cl_cnttagcondition=>tt_tagandconditionlist(
(
new /aws1/cl_cnttagcondition(
iv_tagkey = |string|
iv_tagvalue = |string|
)
)
)
)
)
)
io_userattributefilter = new /aws1/cl_cntctlplaneuserattr00(
io_andcondition = new /aws1/cl_cntattrandcondition(
io_hierarchygroupcondition = new /aws1/cl_cnthierarchygroupcond(
iv_hierarchygroupmatchtype = |string|
iv_value = |string|
)
it_tagconditions = VALUE /aws1/cl_cnttagcondition=>tt_tagandconditionlist(
(
new /aws1/cl_cnttagcondition(
iv_tagkey = |string|
iv_tagvalue = |string|
)
)
)
)
io_hierarchygroupcondition = new /aws1/cl_cnthierarchygroupcond(
iv_hierarchygroupmatchtype = |string|
iv_value = |string|
)
io_tagcondition = new /aws1/cl_cnttagcondition(
iv_tagkey = |string|
iv_tagvalue = |string|
)
it_orconditions = VALUE /aws1/cl_cntattrandcondition=>tt_attributeorconditionlist(
(
new /aws1/cl_cntattrandcondition(
io_hierarchygroupcondition = new /aws1/cl_cnthierarchygroupcond(
iv_hierarchygroupmatchtype = |string|
iv_value = |string|
)
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_users( ) into lo_row.
lo_row_1 = lo_row.
IF lo_row_1 IS NOT INITIAL.
lv_arn = lo_row_1->get_arn( ).
lv_directoryuserid = lo_row_1->get_directoryuserid( ).
lv_hierarchygroupid = lo_row_1->get_hierarchygroupid( ).
lv_userid = lo_row_1->get_id( ).
lo_useridentityinfolite = lo_row_1->get_identityinfo( ).
IF lo_useridentityinfolite IS NOT INITIAL.
lv_agentfirstname = lo_useridentityinfolite->get_firstname( ).
lv_agentlastname = lo_useridentityinfolite->get_lastname( ).
ENDIF.
lo_userphoneconfig = lo_row_1->get_phoneconfig( ).
IF lo_userphoneconfig IS NOT INITIAL.
lv_phonetype = lo_userphoneconfig->get_phonetype( ).
lv_autoaccept = lo_userphoneconfig->get_autoaccept( ).
lv_aftercontactworktimelim = lo_userphoneconfig->get_afrcontactworktimelimit( ).
lv_phonenumber = lo_userphoneconfig->get_deskphonenumber( ).
lv_persistentconnection = lo_userphoneconfig->get_persistentconnection( ).
ENDIF.
lv_routingprofileid = lo_row_1->get_routingprofileid( ).
LOOP AT lo_row_1->get_securityprofileids( ) into lo_row_2.
lo_row_3 = lo_row_2.
IF lo_row_3 IS NOT INITIAL.
lv_securityprofileid = lo_row_3->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_row_1->get_tags( ) into ls_row_4.
lv_key = ls_row_4-key.
lo_value = ls_row_4-value.
IF lo_value IS NOT INITIAL.
lv_tagvalue = lo_value->get_value( ).
ENDIF.
ENDLOOP.
lv_agentusername = lo_row_1->get_username( ).
ENDIF.
ENDLOOP.
lv_nexttoken2500 = lo_result->get_nexttoken( ).
lv_approximatetotalcount = lo_result->get_approximatetotalcount( ).
ENDIF.