DESCRIBEJOB()`¶

About DescribeJob¶

Returns detailed information about a job, including its current status, secondary status, configuration, and timestamps. Use SecondaryStatus for granular progress tracking and SecondaryStatusTransitions to see the full history of status changes with timestamps.

The following operations are related to DescribeJob:

CreateJob
ListJobs
StopJob
DeleteJob

Method Signature¶

METHODS /AWS1/IF_SGM~DESCRIBEJOB
  IMPORTING
    !IV_JOBNAME TYPE /AWS1/SGMJOBNAME OPTIONAL
    !IV_JOBCATEGORY TYPE /AWS1/SGMJOBCATEGORY OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmdescrjobresponse
  RAISING
    /AWS1/CX_SGMRESOURCENOTFOUND
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_jobname` `TYPE /AWS1/SGMJOBNAME` `/AWS1/SGMJOBNAME`¶

The name of the job to describe.

`iv_jobcategory` `TYPE /AWS1/SGMJOBCATEGORY` `/AWS1/SGMJOBCATEGORY`¶

The category of the job.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_sgmdescrjobresponse` `/AWS1/CL_SGMDESCRJOBRESPONSE`¶

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->describejob(
  iv_jobcategory = |string|
  iv_jobname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_jobname = lo_result->get_jobname( ).
  lv_jobarn = lo_result->get_jobarn( ).
  lv_rolearn = lo_result->get_rolearn( ).
  lv_jobcategory = lo_result->get_jobcategory( ).
  lv_jobschemaversion = lo_result->get_jobconfigschemaversion( ).
  lv_jobconfigdocument = lo_result->get_jobconfigdocument( ).
  lv_timestamp = lo_result->get_creationtime( ).
  lv_timestamp = lo_result->get_lastmodifiedtime( ).
  lv_timestamp = lo_result->get_endtime( ).
  lv_jobstatus = lo_result->get_jobstatus( ).
  lv_jobsecondarystatus = lo_result->get_secondarystatus( ).
  LOOP AT lo_result->get_secondarystatustranss( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_jobsecondarystatus = lo_row_1->get_status( ).
      lv_timestamp = lo_row_1->get_starttime( ).
      lv_timestamp = lo_row_1->get_endtime( ).
      lv_string = lo_row_1->get_statusmessage( ).
    ENDIF.
  ENDLOOP.
  lv_failurereason = lo_result->get_failurereason( ).
  LOOP AT lo_result->get_tags( ) into lo_row_2.
    lo_row_3 = lo_row_2.
    IF lo_row_3 IS NOT INITIAL.
      lv_tagkey = lo_row_3->get_key( ).
      lv_tagvalue = lo_row_3->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_SGM=>DESCRIBEJOB()¶