STARTREPORTJOB()`¶

About StartReportJob¶

Starts an on-demand report job for the specified report plan.

Method Signature¶

METHODS /AWS1/IF_BUP~STARTREPORTJOB
  IMPORTING
    !IV_REPORTPLANNAME TYPE /AWS1/BUPREPORTPLANNAME OPTIONAL
    !IV_IDEMPOTENCYTOKEN TYPE /AWS1/BUPSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bupstartreportjobout
  RAISING
    /AWS1/CX_BUPINVPARAMVALUEEX
    /AWS1/CX_BUPMISSINGPARAMVALEX
    /AWS1/CX_BUPRESOURCENOTFOUNDEX
    /AWS1/CX_BUPSERVICEUNAVAILEX
    /AWS1/CX_BUPCLIENTEXC
    /AWS1/CX_BUPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_reportplanname` `TYPE /AWS1/BUPREPORTPLANNAME` `/AWS1/BUPREPORTPLANNAME`¶

The unique name of a report plan.

Optional arguments:¶

`iv_idempotencytoken` `TYPE /AWS1/BUPSTRING` `/AWS1/BUPSTRING`¶

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartReportJobInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_bupstartreportjobout` `/AWS1/CL_BUPSTARTREPORTJOBOUT`¶

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->startreportjob(
  iv_idempotencytoken = |string|
  iv_reportplanname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_reportjobid = lo_result->get_reportjobid( ).
ENDIF.

/AWS1/IF_BUP=>STARTREPORTJOB()¶