LISTWORKFLOWS()`¶

About ListWorkflows¶

Retrieves a list of existing workflows. You can filter for specific workflows by their name and type. Using the type parameter, specify PRIVATE to retrieve a list of private workflows or specify READY2RUN for a list of all Ready2Run workflows. If you do not specify the type of workflow, this operation returns a list of existing workflows.

Method Signature¶

METHODS /AWS1/IF_OMX~LISTWORKFLOWS
  IMPORTING
    !IV_TYPE TYPE /AWS1/OMXWORKFLOWTYPE OPTIONAL
    !IV_NAME TYPE /AWS1/OMXWORKFLOWNAME OPTIONAL
    !IV_STARTINGTOKEN TYPE /AWS1/OMXWORKFLOWLISTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/OMXINTEGER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_omxlistworkflowsrsp
  RAISING
    /AWS1/CX_OMXACCESSDENIEDEX
    /AWS1/CX_OMXCONFLICTEXCEPTION
    /AWS1/CX_OMXINTERNALSERVEREX
    /AWS1/CX_OMXREQUESTTIMEOUTEX
    /AWS1/CX_OMXRESOURCENOTFOUNDEX
    /AWS1/CX_OMXSERVICEQUOTAEXCDEX
    /AWS1/CX_OMXTHROTTLINGEX
    /AWS1/CX_OMXVALIDATIONEX
    /AWS1/CX_OMXCLIENTEXC
    /AWS1/CX_OMXSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_type` `TYPE /AWS1/OMXWORKFLOWTYPE` `/AWS1/OMXWORKFLOWTYPE`¶

Filter the list by workflow type.

`iv_name` `TYPE /AWS1/OMXWORKFLOWNAME` `/AWS1/OMXWORKFLOWNAME`¶

Filter the list by workflow name.

`iv_startingtoken` `TYPE /AWS1/OMXWORKFLOWLISTTOKEN` `/AWS1/OMXWORKFLOWLISTTOKEN`¶

Specify the pagination token from a previous request to retrieve the next page of results.

`iv_maxresults` `TYPE /AWS1/OMXINTEGER` `/AWS1/OMXINTEGER`¶

The maximum number of workflows to return in one page of results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_omxlistworkflowsrsp` `/AWS1/CL_OMXLISTWORKFLOWSRSP`¶

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->listworkflows(
  iv_maxresults = 123
  iv_name = |string|
  iv_startingtoken = |string|
  iv_type = |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_items( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_workflowarn = lo_row_1->get_arn( ).
      lv_workflowid = lo_row_1->get_id( ).
      lv_workflowname = lo_row_1->get_name( ).
      lv_workflowstatus = lo_row_1->get_status( ).
      lv_workflowtype = lo_row_1->get_type( ).
      lv_workflowdigest = lo_row_1->get_digest( ).
      lv_workflowtimestamp = lo_row_1->get_creationtime( ).
      LOOP AT lo_row_1->get_metadata( ) into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_workflowmetadatavalue = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_workflowlisttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_OMX=>LISTWORKFLOWS()¶