/AWS1/IF_SCG=>DESCRIBEPROVISIONINGARTIFACT()

About DescribeProvisioningArtifact

Gets information about the specified provisioning artifact (also known as a version) for the specified product.

Method Signature

METHODS /AWS1/IF_SCG~DESCRIBEPROVISIONINGARTIFACT
  IMPORTING
    !IV_ACCEPTLANGUAGE TYPE /AWS1/SCGACCEPTLANGUAGE OPTIONAL
    !IV_PROVISIONINGARTIFACTID TYPE /AWS1/SCGID OPTIONAL
    !IV_PRODUCTID TYPE /AWS1/SCGID OPTIONAL
    !IV_PROVISIONINGARTIFACTNAME TYPE /AWS1/SCGPROVARTIFACTNAME OPTIONAL
    !IV_PRODUCTNAME TYPE /AWS1/SCGPRODUCTVIEWNAME OPTIONAL
    !IV_VERBOSE TYPE /AWS1/SCGVERBOSE OPTIONAL
    !IV_INCLUDEPROVARTIFACTPARAMS TYPE /AWS1/SCGBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_scgdscprovartifactout
  RAISING
    /AWS1/CX_SCGINVALIDPARAMSEX
    /AWS1/CX_SCGRESOURCENOTFOUNDEX
    /AWS1/CX_SCGCLIENTEXC
    /AWS1/CX_SCGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_acceptlanguage TYPE /AWS1/SCGACCEPTLANGUAGE /AWS1/SCGACCEPTLANGUAGE

The language code.

• jp - Japanese

• zh - Chinese

iv_provisioningartifactid TYPE /AWS1/SCGID /AWS1/SCGID

The identifier of the provisioning artifact.

iv_productid TYPE /AWS1/SCGID /AWS1/SCGID

The product identifier.

iv_provisioningartifactname TYPE /AWS1/SCGPROVARTIFACTNAME /AWS1/SCGPROVARTIFACTNAME

The provisioning artifact name.

iv_productname TYPE /AWS1/SCGPRODUCTVIEWNAME /AWS1/SCGPRODUCTVIEWNAME

The product name.

iv_verbose TYPE /AWS1/SCGVERBOSE /AWS1/SCGVERBOSE

Indicates whether a verbose level of detail is enabled.

iv_includeprovartifactparams TYPE /AWS1/SCGBOOLEAN /AWS1/SCGBOOLEAN

Indicates if the API call response does or does not include additional details about the provisioning parameters.

RETURNING

oo_output TYPE REF TO /aws1/cl_scgdscprovartifactout /AWS1/CL_SCGDSCPROVARTIFACTOUT

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

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->describeprovisioningartifact(
  iv_acceptlanguage = |string|
  iv_includeprovartifactparams = ABAP_TRUE
  iv_productid = |string|
  iv_productname = |string|
  iv_provisioningartifactid = |string|
  iv_provisioningartifactname = |string|
  iv_verbose = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_provisioningartifactdet = lo_result->get_provartifactdetail( ).
  IF lo_provisioningartifactdet IS NOT INITIAL.
    lv_id = lo_provisioningartifactdet->get_id( ).
    lv_provisioningartifactnam = lo_provisioningartifactdet->get_name( ).
    lv_provisioningartifactnam = lo_provisioningartifactdet->get_description( ).
    lv_provisioningartifacttyp = lo_provisioningartifactdet->get_type( ).
    lv_creationtime = lo_provisioningartifactdet->get_createdtime( ).
    lv_provisioningartifactact = lo_provisioningartifactdet->get_active( ).
    lv_provisioningartifactgui = lo_provisioningartifactdet->get_guidance( ).
    lv_sourcerevision = lo_provisioningartifactdet->get_sourcerevision( ).
  ENDIF.
  LOOP AT lo_result->get_info( ) into ls_row.
    lv_key = ls_row-key.
    lo_value = ls_row-value.
    IF lo_value IS NOT INITIAL.
      lv_provisioningartifactinf = lo_value->get_value( ).
    ENDIF.
  ENDLOOP.
  lv_status = lo_result->get_status( ).
  LOOP AT lo_result->get_provartifactparameters( ) into lo_row_1.
    lo_row_2 = lo_row_1.
    IF lo_row_2 IS NOT INITIAL.
      lv_parameterkey = lo_row_2->get_parameterkey( ).
      lv_defaultvalue = lo_row_2->get_defaultvalue( ).
      lv_parametertype = lo_row_2->get_parametertype( ).
      lv_noecho = lo_row_2->get_isnoecho( ).
      lv_description = lo_row_2->get_description( ).
      lo_parameterconstraints = lo_row_2->get_parameterconstraints( ).
      IF lo_parameterconstraints IS NOT INITIAL.
        LOOP AT lo_parameterconstraints->get_allowedvalues( ) into lo_row_3.
          lo_row_4 = lo_row_3.
          IF lo_row_4 IS NOT INITIAL.
            lv_string = lo_row_4->get_value( ).
          ENDIF.
        ENDLOOP.
        lv_string = lo_parameterconstraints->get_allowedpattern( ).
        lv_string = lo_parameterconstraints->get_constraintdescription( ).
        lv_string = lo_parameterconstraints->get_maxlength( ).
        lv_string = lo_parameterconstraints->get_minlength( ).
        lv_string = lo_parameterconstraints->get_maxvalue( ).
        lv_string = lo_parameterconstraints->get_minvalue( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
ENDIF.