Skip to content

/AWS1/IF_TBD=>BATCHGETSTEP()

About BatchGetStep

Retrieves multiple steps in a single request. This is a batch version of the GetStep API.

The result of getting each step is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

Method Signature

METHODS /AWS1/IF_TBD~BATCHGETSTEP
  IMPORTING
    !IT_IDENTIFIERS TYPE /AWS1/CL_TBDBATCHGETSTEPID=>TT_BATCHGETSTEPIDENTIFIERS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_tbdbatchgetsteprsp
  RAISING
    /AWS1/CX_TBDACCESSDENIEDEX
    /AWS1/CX_TBDINTERNALSERVERER00
    /AWS1/CX_TBDTHROTTLINGEX
    /AWS1/CX_TBDVALIDATIONEX
    /AWS1/CX_TBDCLIENTEXC
    /AWS1/CX_TBDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

it_identifiers TYPE /AWS1/CL_TBDBATCHGETSTEPID=>TT_BATCHGETSTEPIDENTIFIERS TT_BATCHGETSTEPIDENTIFIERS

The list of step identifiers to retrieve. You can specify up to 100 identifiers per request.

RETURNING

oo_output TYPE REF TO /aws1/cl_tbdbatchgetsteprsp /AWS1/CL_TBDBATCHGETSTEPRSP

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->batchgetstep(
  it_identifiers = VALUE /aws1/cl_tbdbatchgetstepid=>tt_batchgetstepidentifiers(
    (
      new /aws1/cl_tbdbatchgetstepid(
        iv_farmid = |string|
        iv_jobid = |string|
        iv_queueid = |string|
        iv_stepid = |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_steps( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_farmid = lo_row_1->get_farmid( ).
      lv_queueid = lo_row_1->get_queueid( ).
      lv_jobid = lo_row_1->get_jobid( ).
      lv_stepid = lo_row_1->get_stepid( ).
      lv_stepname = lo_row_1->get_name( ).
      lv_steplifecyclestatus = lo_row_1->get_lifecyclestatus( ).
      lv_string = lo_row_1->get_lifecyclestatusmessage( ).
      lv_taskrunstatus = lo_row_1->get_taskrunstatus( ).
      LOOP AT lo_row_1->get_taskrunstatuscounts( ) into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_integer = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_taskfailureretrycount = lo_row_1->get_taskfailureretrycount( ).
      lv_steptargettaskrunstatus = lo_row_1->get_targettaskrunstatus( ).
      lv_createdat = lo_row_1->get_createdat( ).
      lv_createdby = lo_row_1->get_createdby( ).
      lv_updatedat = lo_row_1->get_updatedat( ).
      lv_updatedby = lo_row_1->get_updatedby( ).
      lv_startedat = lo_row_1->get_startedat( ).
      lv_endedat = lo_row_1->get_endedat( ).
      lo_dependencycounts = lo_row_1->get_dependencycounts( ).
      IF lo_dependencycounts IS NOT INITIAL.
        lv_integer = lo_dependencycounts->get_dependenciesresolved( ).
        lv_integer = lo_dependencycounts->get_dependenciesunresolved( ).
        lv_integer = lo_dependencycounts->get_consumersresolved( ).
        lv_integer = lo_dependencycounts->get_consumersunresolved( ).
      ENDIF.
      lo_steprequiredcapabilitie = lo_row_1->get_requiredcapabilities( ).
      IF lo_steprequiredcapabilitie IS NOT INITIAL.
        LOOP AT lo_steprequiredcapabilitie->get_attributes( ) into lo_row_3.
          lo_row_4 = lo_row_3.
          IF lo_row_4 IS NOT INITIAL.
            lv_attributecapabilityname = lo_row_4->get_name( ).
            LOOP AT lo_row_4->get_anyof( ) into lo_row_5.
              lo_row_6 = lo_row_5.
              IF lo_row_6 IS NOT INITIAL.
                lv_attributecapabilityvalu = lo_row_6->get_value( ).
              ENDIF.
            ENDLOOP.
            LOOP AT lo_row_4->get_allof( ) into lo_row_5.
              lo_row_6 = lo_row_5.
              IF lo_row_6 IS NOT INITIAL.
                lv_attributecapabilityvalu = lo_row_6->get_value( ).
              ENDIF.
            ENDLOOP.
          ENDIF.
        ENDLOOP.
        LOOP AT lo_steprequiredcapabilitie->get_amounts( ) into lo_row_7.
          lo_row_8 = lo_row_7.
          IF lo_row_8 IS NOT INITIAL.
            lv_amountcapabilityname = lo_row_8->get_name( ).
            lv_double = lo_row_8->get_min( ).
            lv_double = lo_row_8->get_max( ).
            lv_double = lo_row_8->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
      lo_parameterspace = lo_row_1->get_parameterspace( ).
      IF lo_parameterspace IS NOT INITIAL.
        LOOP AT lo_parameterspace->get_parameters( ) into lo_row_9.
          lo_row_10 = lo_row_9.
          IF lo_row_10 IS NOT INITIAL.
            lv_stepparametername = lo_row_10->get_name( ).
            lv_stepparametertype = lo_row_10->get_type( ).
            lo_stepparameterchunks = lo_row_10->get_chunks( ).
            IF lo_stepparameterchunks IS NOT INITIAL.
              lv_defaulttaskcount = lo_stepparameterchunks->get_defaulttaskcount( ).
              lv_targetruntimeseconds = lo_stepparameterchunks->get_targetruntimeseconds( ).
              lv_rangeconstraint = lo_stepparameterchunks->get_rangeconstraint( ).
            ENDIF.
          ENDIF.
        ENDLOOP.
        lv_combinationexpression = lo_parameterspace->get_combination( ).
      ENDIF.
      lv_stepdescription = lo_row_1->get_description( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_errors( ) into lo_row_11.
    lo_row_12 = lo_row_11.
    IF lo_row_12 IS NOT INITIAL.
      lv_farmid = lo_row_12->get_farmid( ).
      lv_queueid = lo_row_12->get_queueid( ).
      lv_jobid = lo_row_12->get_jobid( ).
      lv_stepid = lo_row_12->get_stepid( ).
      lv_batchgetsteperrorcode = lo_row_12->get_code( ).
      lv_string = lo_row_12->get_message( ).
    ENDIF.
  ENDLOOP.
ENDIF.

Get multiple steps in a single request

Get multiple steps in a single request

DATA(lo_result) = lo_client->batchgetstep(
  it_identifiers = VALUE /aws1/cl_tbdbatchgetstepid=>tt_batchgetstepidentifiers(
    (
      new /aws1/cl_tbdbatchgetstepid(
        iv_farmid = |farm-1234567890abcdef1234567890abcdef|
        iv_jobid = |job-1234567890abcdef1234567890abcdef|
        iv_queueid = |queue-1234567890abcdef1234567890abcdef|
        iv_stepid = |step-1234567890abcdef1234567890abcdef|
      )
    )
    (
      new /aws1/cl_tbdbatchgetstepid(
        iv_farmid = |farm-1234567890abcdef1234567890abcdef|
        iv_jobid = |job-1234567890abcdef1234567890abcdef|
        iv_queueid = |queue-1234567890abcdef1234567890abcdef|
        iv_stepid = |step-234567890abcdef1234567890abcdef1|
      )
    )
  )
).