UPDATELAYOUT()`¶

About UpdateLayout¶

Updates the attributes of an existing layout.

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

A ValidationException is returned when you add non-existent fieldIds to a layout.

Title and Status fields cannot be part of layouts because they are not configurable.

Method Signature¶

METHODS /AWS1/IF_CNK~UPDATELAYOUT
  IMPORTING
    !IV_DOMAINID TYPE /AWS1/CNKDOMAINID OPTIONAL
    !IV_LAYOUTID TYPE /AWS1/CNKLAYOUTID OPTIONAL
    !IV_NAME TYPE /AWS1/CNKLAYOUTNAME OPTIONAL
    !IO_CONTENT TYPE REF TO /AWS1/CL_CNKLAYOUTCONTENT OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cnkupdatelayoutrsp
  RAISING
    /AWS1/CX_CNKACCESSDENIEDEX
    /AWS1/CX_CNKCONFLICTEXCEPTION
    /AWS1/CX_CNKINTERNALSERVEREX
    /AWS1/CX_CNKRESOURCENOTFOUNDEX
    /AWS1/CX_CNKSERVICEQUOTAEXCDEX
    /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.

`iv_layoutid` `TYPE /AWS1/CNKLAYOUTID` `/AWS1/CNKLAYOUTID`¶

The unique identifier of the layout.

Optional arguments:¶

`iv_name` `TYPE /AWS1/CNKLAYOUTNAME` `/AWS1/CNKLAYOUTNAME`¶

The name of the layout. It must be unique per domain.

`io_content` `TYPE REF TO /AWS1/CL_CNKLAYOUTCONTENT` `/AWS1/CL_CNKLAYOUTCONTENT`¶

Information about which fields will be present in the layout, the order of the fields.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cnkupdatelayoutrsp` `/AWS1/CL_CNKUPDATELAYOUTRSP`¶

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->updatelayout(
  io_content = new /aws1/cl_cnklayoutcontent(
    io_basic = new /aws1/cl_cnkbasiclayout(
      io_moreinfo = new /aws1/cl_cnklayoutsections(
        it_sections = VALUE /aws1/cl_cnksection=>tt_sectionslist(
          (
            new /aws1/cl_cnksection(
              io_fieldgroup = new /aws1/cl_cnkfieldgroup(
                it_fields = VALUE /aws1/cl_cnkfielditem=>tt_fieldlist(
                  ( new /aws1/cl_cnkfielditem( |string| ) )
                )
                iv_name = |string|
              )
            )
          )
        )
      )
      io_toppanel = new /aws1/cl_cnklayoutsections(
        it_sections = VALUE /aws1/cl_cnksection=>tt_sectionslist(
          (
            new /aws1/cl_cnksection(
              io_fieldgroup = new /aws1/cl_cnkfieldgroup(
                it_fields = VALUE /aws1/cl_cnkfielditem=>tt_fieldlist(
                  ( new /aws1/cl_cnkfielditem( |string| ) )
                )
                iv_name = |string|
              )
            )
          )
        )
      )
    )
  )
  iv_domainid = |string|
  iv_layoutid = |string|
  iv_name = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.

/AWS1/IF_CNK=>UPDATELAYOUT()¶