/AWS1/IF_CAT=>LISTWORKFLOWRUNS()

About ListWorkflowRuns

Retrieves a list of workflow runs of a specified workflow.

Method Signature

METHODS /AWS1/IF_CAT~LISTWORKFLOWRUNS
  IMPORTING
    !IV_SPACENAME TYPE /AWS1/CATNAMESTRING OPTIONAL
    !IV_WORKFLOWID TYPE /AWS1/CATUUID OPTIONAL
    !IV_PROJECTNAME TYPE /AWS1/CATNAMESTRING OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CATSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/CATINTEGER OPTIONAL
    !IT_SORTBY TYPE /AWS1/CL_CATWORKFLOWRUNSORTC00=>TT_WORKFLOWRUNSORTCRITERIALIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_catlstworkflowrunsrsp
  RAISING
    /AWS1/CX_CATACCESSDENIEDEX
    /AWS1/CX_CATCONFLICTEXCEPTION
    /AWS1/CX_CATRESOURCENOTFOUNDEX
    /AWS1/CX_CATSERVICEQUOTAEXCDEX
    /AWS1/CX_CATTHROTTLINGEX
    /AWS1/CX_CATVALIDATIONEX
    /AWS1/CX_CATCLIENTEXC
    /AWS1/CX_CATSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_spacename TYPE /AWS1/CATNAMESTRING /AWS1/CATNAMESTRING

The name of the space.

iv_projectname TYPE /AWS1/CATNAMESTRING /AWS1/CATNAMESTRING

The name of the project in the space.

Optional arguments:

iv_workflowid TYPE /AWS1/CATUUID /AWS1/CATUUID

The ID of the workflow. To retrieve a list of workflow IDs, use ListWorkflows.

iv_nexttoken TYPE /AWS1/CATSTRING /AWS1/CATSTRING

A token returned from a call to this API to indicate the next batch of results to return, if any.

iv_maxresults TYPE /AWS1/CATINTEGER /AWS1/CATINTEGER

The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

it_sortby TYPE /AWS1/CL_CATWORKFLOWRUNSORTC00=>TT_WORKFLOWRUNSORTCRITERIALIST TT_WORKFLOWRUNSORTCRITERIALIST

Information used to sort the items in the returned list.

RETURNING

oo_output TYPE REF TO /aws1/cl_catlstworkflowrunsrsp /AWS1/CL_CATLSTWORKFLOWRUNSRSP

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->listworkflowruns(
  it_sortby = VALUE /aws1/cl_catworkflowrunsortc00=>tt_workflowrunsortcriterialist(
    ( new /aws1/cl_catworkflowrunsortc00( ) )
  )
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_projectname = |string|
  iv_spacename = |string|
  iv_workflowid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_items( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_uuid = lo_row_1->get_id( ).
      lv_uuid = lo_row_1->get_workflowid( ).
      lv_string = lo_row_1->get_workflowname( ).
      lv_workflowrunstatus = lo_row_1->get_status( ).
      LOOP AT lo_row_1->get_statusreasons( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
        ENDIF.
      ENDLOOP.
      lv_timestamp = lo_row_1->get_starttime( ).
      lv_timestamp = lo_row_1->get_endtime( ).
      lv_timestamp = lo_row_1->get_lastupdatedtime( ).
    ENDIF.
  ENDLOOP.
ENDIF.