LISTLAYOUTS()`¶

About ListLayouts¶

Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.

Method Signature¶

METHODS /AWS1/IF_CNK~LISTLAYOUTS
  IMPORTING
    !IV_DOMAINID TYPE /AWS1/CNKDOMAINID OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/CNKMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CNKNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cnklistlayoutsrsp
  RAISING
    /AWS1/CX_CNKACCESSDENIEDEX
    /AWS1/CX_CNKINTERNALSERVEREX
    /AWS1/CX_CNKRESOURCENOTFOUNDEX
    /AWS1/CX_CNKTHROTTLINGEX
    /AWS1/CX_CNKVALIDATIONEX
    /AWS1/CX_CNKCLIENTEXC
    /AWS1/CX_CNKSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cnklistlayoutsrsp` `/AWS1/CL_CNKLISTLAYOUTSRSP`¶

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->listlayouts(
  iv_domainid = |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_layouts( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_layoutid = lo_row_1->get_layoutid( ).
      lv_layoutarn = lo_row_1->get_layoutarn( ).
      lv_layoutname = lo_row_1->get_name( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_CNK=>LISTLAYOUTS()¶