LISTSERVICEJOBS()`¶

About ListServiceJobs¶

Returns a list of service jobs for a specified job queue.

Method Signature¶

METHODS /AWS1/IF_BTC~LISTSERVICEJOBS
  IMPORTING
    !IV_JOBQUEUE TYPE /AWS1/BTCSTRING OPTIONAL
    !IV_JOBSTATUS TYPE /AWS1/BTCSERVICEJOBSTATUS OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/BTCINTEGER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/BTCSTRING OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_BTCKEYVALUESPAIR=>TT_LISTJOBSFILTERLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_btclistservicejobsrsp
  RAISING
    /AWS1/CX_BTCCLIENTEXCEPTION
    /AWS1/CX_BTCSERVEREXCEPTION
    /AWS1/CX_BTCCLIENTEXC
    /AWS1/CX_BTCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_jobqueue` `TYPE /AWS1/BTCSTRING` `/AWS1/BTCSTRING`¶

The name or ARN of the job queue with which to list service jobs.

`iv_jobstatus` `TYPE /AWS1/BTCSERVICEJOBSTATUS` `/AWS1/BTCSERVICEJOBSTATUS`¶

The job status with which to filter service jobs.

`iv_maxresults` `TYPE /AWS1/BTCINTEGER` `/AWS1/BTCINTEGER`¶

The maximum number of results returned by ListServiceJobs in paginated output. When this parameter is used, ListServiceJobs only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another ListServiceJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServiceJobs returns up to 100 results and a nextToken value if applicable.

`iv_nexttoken` `TYPE /AWS1/BTCSTRING` `/AWS1/BTCSTRING`¶

The nextToken value returned from a previous paginated ListServiceJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

`it_filters` `TYPE /AWS1/CL_BTCKEYVALUESPAIR=>TT_LISTJOBSFILTERLIST` `TT_LISTJOBSFILTERLIST`¶

The filter to apply to the query. Only one filter can be used at a time. When the filter is used, jobStatus is ignored. The results are sorted by the createdAt field, with the most recent jobs being first.

JOB_NAME

The value of the filter is a case-insensitive match for the job name. If the value ends with an asterisk (), the filter matches any job name that begins with the string before the ''. This corresponds to the jobName value. For example, test1 matches both Test1 and test1, and test1* matches both test1 and Test10. When the JOB_NAME filter is used, the results are grouped by the job name and version.

BEFORE_CREATED_AT

The value for the filter is the time that's before the job was created. This corresponds to the createdAt value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.

AFTER_CREATED_AT

The value for the filter is the time that's after the job was created. This corresponds to the createdAt value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_btclistservicejobsrsp` `/AWS1/CL_BTCLISTSERVICEJOBSRSP`¶

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->listservicejobs(
  it_filters = VALUE /aws1/cl_btckeyvaluespair=>tt_listjobsfilterlist(
    (
      new /aws1/cl_btckeyvaluespair(
        it_values = VALUE /aws1/cl_btcstringlist_w=>tt_stringlist(
          ( new /aws1/cl_btcstringlist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  iv_jobqueue = |string|
  iv_jobstatus = |string|
  iv_maxresults = 123
  iv_nexttoken = |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_jobsummarylist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lo_latestservicejobattempt = lo_row_1->get_latestattempt( ).
      IF lo_latestservicejobattempt IS NOT INITIAL.
        lo_serviceresourceid = lo_latestservicejobattempt->get_serviceresourceid( ).
        IF lo_serviceresourceid IS NOT INITIAL.
          lv_serviceresourceidname = lo_serviceresourceid->get_name( ).
          lv_string = lo_serviceresourceid->get_value( ).
        ENDIF.
      ENDIF.
      lv_long = lo_row_1->get_createdat( ).
      lv_string = lo_row_1->get_jobarn( ).
      lv_string = lo_row_1->get_jobid( ).
      lv_string = lo_row_1->get_jobname( ).
      lv_servicejobtype = lo_row_1->get_servicejobtype( ).
      lv_string = lo_row_1->get_shareidentifier( ).
      lv_servicejobstatus = lo_row_1->get_status( ).
      lv_string = lo_row_1->get_statusreason( ).
      lv_long = lo_row_1->get_startedat( ).
      lv_long = lo_row_1->get_stoppedat( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_BTC=>LISTSERVICEJOBS()¶