Skip to content

/AWS1/IF_DZN=>LISTJOBRUNS()

About ListJobRuns

Lists job runs.

Method Signature

METHODS /AWS1/IF_DZN~LISTJOBRUNS
  IMPORTING
    !IV_DOMAINIDENTIFIER TYPE /AWS1/DZNDOMAINID OPTIONAL
    !IV_JOBIDENTIFIER TYPE /AWS1/DZNSTRING OPTIONAL
    !IV_STATUS TYPE /AWS1/DZNJOBRUNSTATUS OPTIONAL
    !IV_SORTORDER TYPE /AWS1/DZNSORTORDER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/DZNPAGINATIONTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/DZNMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dznlistjobrunsoutput
  RAISING
    /AWS1/CX_DZNACCESSDENIEDEX
    /AWS1/CX_DZNTHROTTLINGEX
    /AWS1/CX_DZNUNAUTHORIZEDEX
    /AWS1/CX_DZNINTERNALSERVEREX
    /AWS1/CX_DZNRESOURCENOTFOUNDEX
    /AWS1/CX_DZNVALIDATIONEX
    /AWS1/CX_DZNCLIENTEXC
    /AWS1/CX_DZNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_domainidentifier TYPE /AWS1/DZNDOMAINID /AWS1/DZNDOMAINID

The ID of the domain where you want to list job runs.

iv_jobidentifier TYPE /AWS1/DZNSTRING /AWS1/DZNSTRING

The ID of the job run.

Optional arguments:

iv_status TYPE /AWS1/DZNJOBRUNSTATUS /AWS1/DZNJOBRUNSTATUS

The status of a job run.

iv_sortorder TYPE /AWS1/DZNSORTORDER /AWS1/DZNSORTORDER

Specifies the order in which job runs are to be sorted.

iv_nexttoken TYPE /AWS1/DZNPAGINATIONTOKEN /AWS1/DZNPAGINATIONTOKEN

When the number of job runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of job runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListJobRuns to list the next set of job runs.

iv_maxresults TYPE /AWS1/DZNMAXRESULTS /AWS1/DZNMAXRESULTS

The maximum number of job runs to return in a single call to ListJobRuns. When the number of job runs to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListJobRuns to list the next set of job runs.

RETURNING

oo_output TYPE REF TO /aws1/cl_dznlistjobrunsoutput /AWS1/CL_DZNLISTJOBRUNSOUTPUT

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->listjobruns(
  iv_domainidentifier = |string|
  iv_jobidentifier = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_sortorder = |string|
  iv_status = |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_domainid = lo_row_1->get_domainid( ).
      lv_string = lo_row_1->get_jobid( ).
      lv_jobtype = lo_row_1->get_jobtype( ).
      lv_string = lo_row_1->get_runid( ).
      lv_jobrunmode = lo_row_1->get_runmode( ).
      lv_jobrunstatus = lo_row_1->get_status( ).
      lo_jobrunerror = lo_row_1->get_error( ).
      IF lo_jobrunerror IS NOT INITIAL.
        lv_string = lo_jobrunerror->get_message( ).
      ENDIF.
      lv_string = lo_row_1->get_createdby( ).
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_timestamp = lo_row_1->get_starttime( ).
      lv_timestamp = lo_row_1->get_endtime( ).
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.