Skip to content

/AWS1/CL_CNK=>LISTTEMPLATES()

About ListTemplates

Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.

Other template APIs are:

Method Signature

IMPORTING

Required arguments:

iv_domainid TYPE /AWS1/CNKDOMAINID /AWS1/CNKDOMAINID

The unique identifier of the Cases domain.

Optional arguments:

iv_maxresults TYPE /AWS1/CNKMAXRESULTS /AWS1/CNKMAXRESULTS

The maximum number of results to return per page.

iv_nexttoken TYPE /AWS1/CNKNEXTTOKEN /AWS1/CNKNEXTTOKEN

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.

it_status TYPE /AWS1/CL_CNKTMPLSTATFILTERS_W=>TT_TEMPLATESTATUSFILTERS TT_TEMPLATESTATUSFILTERS

A list of status values to filter on.

RETURNING

oo_output TYPE REF TO /aws1/cl_cnklisttmplsresponse /AWS1/CL_CNKLISTTMPLSRESPONSE

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->/aws1/if_cnk~listtemplates(
  it_status = VALUE /aws1/cl_cnktmplstatfilters_w=>tt_templatestatusfilters(
    ( new /aws1/cl_cnktmplstatfilters_w( |string| ) )
  )
  iv_domainid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

LOOP AT lo_result->get_templates( ) into lo_row.
  lv_templateid = lo_row_1->get_templateid( ).
  lv_templatearn = lo_row_1->get_templatearn( ).
  lv_templatename = lo_row_1->get_name( ).
  lv_templatestatus = lo_row_1->get_status( ).
ENDLOOP.
lv_nexttoken = lo_result->get_nexttoken( ).