Skip to content

/AWS1/IF_SGM=>LISTJOBS()

About ListJobs

Lists jobs in a specified category. You can filter results by creation time, last modified time, name, and status. Results are sorted by the field you specify in SortBy. Use pagination to retrieve large result sets efficiently.

The following operations are related to ListJobs:

  • CreateJob

  • DescribeJob

Method Signature

METHODS /AWS1/IF_SGM~LISTJOBS
  IMPORTING
    !IV_JOBCATEGORY TYPE /AWS1/SGMJOBCATEGORY OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SGMNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SGMMAXRESULTS OPTIONAL
    !IV_CREATIONTIMEAFTER TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_CREATIONTIMEBEFORE TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_LASTMODIFIEDTIMEAFTER TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_LASTMODIFIEDTIMEBEFORE TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_NAMECONTAINS TYPE /AWS1/SGMNAMECONTAINS OPTIONAL
    !IV_SORTBY TYPE /AWS1/SGMSORTBY OPTIONAL
    !IV_SORTORDER TYPE /AWS1/SGMSORTORDER OPTIONAL
    !IV_STATUSEQUALS TYPE /AWS1/SGMJOBSTATUS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmlistjobsresponse
  RAISING
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_jobcategory TYPE /AWS1/SGMJOBCATEGORY /AWS1/SGMJOBCATEGORY

The category of jobs to list.

Optional arguments:

iv_nexttoken TYPE /AWS1/SGMNEXTTOKEN /AWS1/SGMNEXTTOKEN

If the previous response was truncated, this token retrieves the next set of results.

iv_maxresults TYPE /AWS1/SGMMAXRESULTS /AWS1/SGMMAXRESULTS

The maximum number of jobs to return in the response. The default value is 50.

iv_creationtimeafter TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A filter that returns only jobs created after the specified time.

iv_creationtimebefore TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A filter that returns only jobs created before the specified time.

iv_lastmodifiedtimeafter TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A filter that returns only jobs modified after the specified time.

iv_lastmodifiedtimebefore TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A filter that returns only jobs modified before the specified time.

iv_namecontains TYPE /AWS1/SGMNAMECONTAINS /AWS1/SGMNAMECONTAINS

A string in the job name to filter results. Only jobs whose name contains the specified string are returned.

iv_sortby TYPE /AWS1/SGMSORTBY /AWS1/SGMSORTBY

The field to sort results by.

iv_sortorder TYPE /AWS1/SGMSORTORDER /AWS1/SGMSORTORDER

The sort order for results. Valid values are Ascending and Descending.

iv_statusequals TYPE /AWS1/SGMJOBSTATUS /AWS1/SGMJOBSTATUS

A filter that returns only jobs with the specified status.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmlistjobsresponse /AWS1/CL_SGMLISTJOBSRESPONSE

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->listjobs(
  iv_creationtimeafter = '20150101000000.0000000'
  iv_creationtimebefore = '20150101000000.0000000'
  iv_jobcategory = |string|
  iv_lastmodifiedtimeafter = '20150101000000.0000000'
  iv_lastmodifiedtimebefore = '20150101000000.0000000'
  iv_maxresults = 123
  iv_namecontains = |string|
  iv_nexttoken = |string|
  iv_sortby = |string|
  iv_sortorder = |string|
  iv_statusequals = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_nexttoken = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_jobsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_jobarn = lo_row_1->get_jobarn( ).
      lv_jobname = lo_row_1->get_jobname( ).
      lv_jobcategory = lo_row_1->get_jobcategory( ).
      lv_jobstatus = lo_row_1->get_jobstatus( ).
      lv_jobsecondarystatus = lo_row_1->get_jobsecondarystatus( ).
      lv_timestamp = lo_row_1->get_creationtime( ).
      lv_timestamp = lo_row_1->get_lastmodifiedtime( ).
      lv_timestamp = lo_row_1->get_endtime( ).
    ENDIF.
  ENDLOOP.
ENDIF.