LISTSESSIONS()`¶

About ListSessions¶

Lists all sessions within a specific workflow run.

Method Signature¶

METHODS /AWS1/IF_BDN~LISTSESSIONS
  IMPORTING
    !IV_WORKFLOWDEFINITIONNAME TYPE /AWS1/BDNWORKFLOWDEFNNAME OPTIONAL
    !IV_WORKFLOWRUNID TYPE /AWS1/BDNUUIDSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/BDNMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/BDNNEXTTOKEN OPTIONAL
    !IV_SORTORDER TYPE /AWS1/BDNSORTORDER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdnlistsessresponse
  RAISING
    /AWS1/CX_BDNACCESSDENIEDEX
    /AWS1/CX_BDNCONFLICTEXCEPTION
    /AWS1/CX_BDNINTERNALSERVEREX
    /AWS1/CX_BDNRESOURCENOTFOUNDEX
    /AWS1/CX_BDNTHROTTLINGEX
    /AWS1/CX_BDNVLDTNEXCEPTION
    /AWS1/CX_BDNCLIENTEXC
    /AWS1/CX_BDNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_workflowdefinitionname` `TYPE /AWS1/BDNWORKFLOWDEFNNAME` `/AWS1/BDNWORKFLOWDEFNNAME`¶

The name of the workflow definition containing the workflow run.

`iv_workflowrunid` `TYPE /AWS1/BDNUUIDSTRING` `/AWS1/BDNUUIDSTRING`¶

The unique identifier of the workflow run to list sessions for.

Optional arguments:¶

`iv_maxresults` `TYPE /AWS1/BDNMAXRESULTS` `/AWS1/BDNMAXRESULTS`¶

The maximum number of sessions to return in a single response.

`iv_nexttoken` `TYPE /AWS1/BDNNEXTTOKEN` `/AWS1/BDNNEXTTOKEN`¶

The token for retrieving the next page of results.

`iv_sortorder` `TYPE /AWS1/BDNSORTORDER` `/AWS1/BDNSORTORDER`¶

The sort order for the returned sessions (ascending or descending).

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_bdnlistsessresponse` `/AWS1/CL_BDNLISTSESSRESPONSE`¶

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->listsessions(
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_sortorder = |string|
  iv_workflowdefinitionname = |string|
  iv_workflowrunid = |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_sessionsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_uuidstring = lo_row_1->get_sessionid( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_BDN=>LISTSESSIONS()¶