Skip to content

/AWS1/IF_MDC=>STARTJOBSQUERY()

About StartJobsQuery

Start an asynchronous jobs query using the provided filters. To receive the list of jobs that match your query, call the GetJobsQueryResults API using the query ID returned by this API.

Method Signature

METHODS /AWS1/IF_MDC~STARTJOBSQUERY
  IMPORTING
    !IT_FILTERLIST TYPE /AWS1/CL_MDCJOBSQUERYFILTER=>TT___LISTOFJOBSQUERYFILTER OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/MDC__INTEGERMIN1MAX20 OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/MDC__STRING OPTIONAL
    !IV_ORDER TYPE /AWS1/MDCORDER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_mdcstartjobsqueryrsp
  RAISING
    /AWS1/CX_MDCBADREQUESTEX
    /AWS1/CX_MDCCONFLICTEXCEPTION
    /AWS1/CX_MDCFORBIDDENEXCEPTION
    /AWS1/CX_MDCINTERNALSERVERER00
    /AWS1/CX_MDCNOTFOUNDEXCEPTION
    /AWS1/CX_MDCSERVICEQUOTAEXCDEX
    /AWS1/CX_MDCTOOMANYREQUESTSEX
    /AWS1/CX_MDCCLIENTEXC
    /AWS1/CX_MDCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

it_filterlist TYPE /AWS1/CL_MDCJOBSQUERYFILTER=>TT___LISTOFJOBSQUERYFILTER TT___LISTOFJOBSQUERYFILTER

Optional. Provide an array of JobsQueryFilters for your StartJobsQuery request.

iv_maxresults TYPE /AWS1/MDC__INTEGERMIN1MAX20 /AWS1/MDC__INTEGERMIN1MAX20

Optional. Number of jobs, up to twenty, that will be included in the jobs query.

iv_nexttoken TYPE /AWS1/MDC__STRING /AWS1/MDC__STRING

Use this string to request the next batch of jobs matched by a jobs query.

iv_order TYPE /AWS1/MDCORDER /AWS1/MDCORDER

Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

RETURNING

oo_output TYPE REF TO /aws1/cl_mdcstartjobsqueryrsp /AWS1/CL_MDCSTARTJOBSQUERYRSP

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->startjobsquery(
  it_filterlist = VALUE /aws1/cl_mdcjobsqueryfilter=>tt___listofjobsqueryfilter(
    (
      new /aws1/cl_mdcjobsqueryfilter(
        it_values = VALUE /aws1/cl_mdc__lstof__strmax100=>tt___listof__stringmax100(
          ( new /aws1/cl_mdc__lstof__strmax100( |string| ) )
        )
        iv_key = |string|
      )
    )
  )
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_order = |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_id( ).
ENDIF.