GETDATASET()`¶

About GetDataset¶

Retrieves dataset metadata only.

Use ?datasetVersion=DRAFT or ?datasetVersion=N to retrieve a specific version's metadata. If absent, defaults to DRAFT (the mutable working copy). Returns ResourceNotFoundException if the specified version is not found.

Initial state after CreateDataset: When CreateDataset completes successfully (status transitions to ACTIVE), only a DRAFT working copy exists. No published versions exist until CreateDatasetVersion is called. At this point draftStatus is MODIFIED because the DRAFT has content that has never been published.

Default version behavior: When datasetVersion is omitted, the operation returns the DRAFT working copy. To retrieve a specific published version, pass the version number as a string (e.g. ?datasetVersion=1).

State guard: Allowed for all statuses including DELETING. Returns the dataset record with its current status so callers can observe the deletion in progress.

For paginated example IDs use ListDatasetExamples.

Method Signature¶

METHODS /AWS1/IF_BDO~GETDATASET
  IMPORTING
    !IV_DATASETID TYPE /AWS1/BDODATASETID OPTIONAL
    !IV_DATASETVERSION TYPE /AWS1/BDODATASETVERSION OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdogetdatasetresponse
  RAISING
    /AWS1/CX_BDOACCESSDENIEDEX
    /AWS1/CX_BDOCONFLICTEXCEPTION
    /AWS1/CX_BDOINTERNALSERVEREX
    /AWS1/CX_BDORESOURCENOTFOUNDEX
    /AWS1/CX_BDOTHROTTLINGEX
    /AWS1/CX_BDOVALIDATIONEX
    /AWS1/CX_BDOCLIENTEXC
    /AWS1/CX_BDOSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_datasetid` `TYPE /AWS1/BDODATASETID` `/AWS1/BDODATASETID`¶

The unique identifier of the dataset to retrieve.

Optional arguments:¶

`iv_datasetversion` `TYPE /AWS1/BDODATASETVERSION` `/AWS1/BDODATASETVERSION`¶

Version to retrieve: "DRAFT" or a version number. Defaults to DRAFT if absent.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_bdogetdatasetresponse` `/AWS1/CL_BDOGETDATASETRESPONSE`¶

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->getdataset(
  iv_datasetid = |string|
  iv_datasetversion = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_datasetarn = lo_result->get_datasetarn( ).
  lv_datasetid = lo_result->get_datasetid( ).
  lv_datasetversion = lo_result->get_datasetversion( ).
  lv_datasetname = lo_result->get_datasetname( ).
  lv_string = lo_result->get_description( ).
  lv_datasetstatus = lo_result->get_status( ).
  lv_draftstatus = lo_result->get_draftstatus( ).
  lv_string = lo_result->get_failurereason( ).
  lv_datasetschematype = lo_result->get_schematype( ).
  lv_kmskeyarn = lo_result->get_kmskeyarn( ).
  lv_long = lo_result->get_examplecount( ).
  lv_downloadurl = lo_result->get_downloadurl( ).
  lv_timestamp = lo_result->get_downloadurlexpiresat( ).
  lv_timestamp = lo_result->get_createdat( ).
  lv_timestamp = lo_result->get_updatedat( ).
  LOOP AT lo_result->get_tags( ) into ls_row.
    lv_key = ls_row-key.
    lo_value = ls_row-value.
    IF lo_value IS NOT INITIAL.
      lv_tagvalue = lo_value->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_BDO=>GETDATASET()¶