/AWS1/IF_CNT=>CREATEWORKSPACEPAGE()

About CreateWorkspacePage

Associates a view with a page in a workspace, defining what users see when they navigate to that page.

Method Signature

METHODS /AWS1/IF_CNT~CREATEWORKSPACEPAGE
  IMPORTING
    !IV_INSTANCEID TYPE /AWS1/CNTINSTANCEID OPTIONAL
    !IV_WORKSPACEID TYPE /AWS1/CNTWORKSPACEID OPTIONAL
    !IV_RESOURCEARN TYPE /AWS1/CNTARN OPTIONAL
    !IV_PAGE TYPE /AWS1/CNTPAGE OPTIONAL
    !IV_SLUG TYPE /AWS1/CNTSLUG OPTIONAL
    !IV_INPUTDATA TYPE /AWS1/CNTINPUTDATA OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntcreworkspacepage01
  RAISING
    /AWS1/CX_CNTACCESSDENIEDEX
    /AWS1/CX_CNTDUPLICATERESRCEX
    /AWS1/CX_CNTINTERNALSERVICEEX
    /AWS1/CX_CNTINVALIDPARAMETEREX
    /AWS1/CX_CNTINVALIDREQUESTEX
    /AWS1/CX_CNTLIMITEXCEEDEDEX
    /AWS1/CX_CNTRESOURCECONFLICTEX
    /AWS1/CX_CNTRESOURCENOTFOUNDEX
    /AWS1/CX_CNTSERVICEQUOTAEXCDEX
    /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.

iv_workspaceid TYPE /AWS1/CNTWORKSPACEID /AWS1/CNTWORKSPACEID

The identifier of the workspace.

iv_resourcearn TYPE /AWS1/CNTARN /AWS1/CNTARN

The Amazon Resource Name (ARN) of the view to associate with the page.

iv_page TYPE /AWS1/CNTPAGE /AWS1/CNTPAGE

The page identifier. Valid system pages include HOME and AGENT_EXPERIENCE. Custom pages cannot use the aws: or connect: prefixes.

Optional arguments:

iv_slug TYPE /AWS1/CNTSLUG /AWS1/CNTSLUG

The URL-friendly identifier for the page.

iv_inputdata TYPE /AWS1/CNTINPUTDATA /AWS1/CNTINPUTDATA

A JSON string containing input parameters for the view, validated against the view's input schema.

RETURNING

oo_output TYPE REF TO /aws1/cl_cntcreworkspacepage01 /AWS1/CL_CNTCREWORKSPACEPAGE01

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->createworkspacepage(
  iv_inputdata = |string|
  iv_instanceid = |string|
  iv_page = |string|
  iv_resourcearn = |string|
  iv_slug = |string|
  iv_workspaceid = |string|
).

This is an example of reading all possible response values

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