DESCRIBEENRICHMENTJOB()`¶

About DescribeEnrichmentJob¶

Retrieves detailed information about a specific enrichment job, including its current status, configuration, and timestamps.

Use Cases

Monitor job progress by checking status updates with DescribeEnrichmentJob
Retrieve the complete job configuration submitted during creation
Debug failed jobs by examining the failureMessage field
Track job lifecycle with creation, update, completion, and cancellation timestamps

Status Monitoring

Jobs progress through statuses: PENDING → RUNNING → terminal state

Terminal states:

COMPLETED: Job finished successfully; query IoT SiteWise for semantic search results
FAILED: Job encountered an error; check failureMessage for details
TIMED_OUT: Job exceeded maximum processing time
CANCELLED: Job was cancelled via CancelEnrichmentJob

Response Fields

The response includes:

Current job status and type
Full job configuration as originally submitted
Lifecycle timestamps (created, updated, completed, cancelled)
Failure details if status is FAILED

Method Signature¶

METHODS /AWS1/IF_IOS~DESCRIBEENRICHMENTJOB
  IMPORTING
    !IV_WORKSPACENAME TYPE /AWS1/IOSWORKSPACENAME OPTIONAL
    !IV_JOBID TYPE /AWS1/IOSID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iosdscenrchjobrsp
  RAISING
    /AWS1/CX_IOSACCESSDENIEDEX
    /AWS1/CX_IOSCNFLCTOPERATIONEX
    /AWS1/CX_IOSINTERNALFAILUREEX
    /AWS1/CX_IOSINVALIDREQUESTEX
    /AWS1/CX_IOSLIMITEXCEEDEDEX
    /AWS1/CX_IOSRESOURCENOTFOUNDEX
    /AWS1/CX_IOSTHROTTLINGEX
    /AWS1/CX_IOSCLIENTEXC
    /AWS1/CX_IOSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_workspacename` `TYPE /AWS1/IOSWORKSPACENAME` `/AWS1/IOSWORKSPACENAME`¶

The name of the IoT SiteWise workspace containing the enrichment job.

`iv_jobid` `TYPE /AWS1/IOSID` `/AWS1/IOSID`¶

The unique identifier of the enrichment job to retrieve. This is the jobId returned by CreateEnrichmentJob.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_iosdscenrchjobrsp` `/AWS1/CL_IOSDSCENRCHJOBRSP`¶

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->describeenrichmentjob(
  iv_jobid = |string|
  iv_workspacename = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_id = lo_result->get_jobid( ).
  lv_enrichmentjobstatus = lo_result->get_status( ).
  lv_workspacename = lo_result->get_workspacename( ).
  lv_jobtype = lo_result->get_jobtype( ).
  lo_enrichmentjobconfigurat = lo_result->get_jobconfiguration( ).
  IF lo_enrichmentjobconfigurat IS NOT INITIAL.
    lo_eventdetection = lo_enrichmentjobconfigurat->get_eventdetection( ).
    IF lo_eventdetection IS NOT INITIAL.
      lv_id = lo_eventdetection->get_datasetid( ).
      lv_timeseriesid = lo_eventdetection->get_timeseriesid( ).
      lv_assetpropertyalias = lo_eventdetection->get_propertyalias( ).
      lo_enrichmenttrimsettings = lo_eventdetection->get_trimsettings( ).
      IF lo_enrichmenttrimsettings IS NOT INITIAL.
        lo_timeinnanos = lo_enrichmenttrimsettings->get_starttime( ).
        IF lo_timeinnanos IS NOT INITIAL.
          lv_timeinseconds = lo_timeinnanos->get_timeinseconds( ).
          lv_offsetinnanos = lo_timeinnanos->get_offsetinnanos( ).
        ENDIF.
        lo_timeinnanos = lo_enrichmenttrimsettings->get_endtime( ).
        IF lo_timeinnanos IS NOT INITIAL.
          lv_timeinseconds = lo_timeinnanos->get_timeinseconds( ).
          lv_offsetinnanos = lo_timeinnanos->get_offsetinnanos( ).
        ENDIF.
      ENDIF.
    ENDIF.
  ENDIF.
  lv_timestamp = lo_result->get_createdat( ).
  lv_timestamp = lo_result->get_updatedat( ).
  lv_timestamp = lo_result->get_completedat( ).
  lv_timestamp = lo_result->get_cancelledat( ).
  lv_string = lo_result->get_failuremessage( ).
ENDIF.

/AWS1/IF_IOS=>DESCRIBEENRICHMENTJOB()¶