Skip to content

/AWS1/IF_BDI=>UPDATECAPABILITY()

About UpdateCapability

Updates some of the parameters for a capability, based on the specified parameters. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.

Method Signature

METHODS /AWS1/IF_BDI~UPDATECAPABILITY
  IMPORTING
    !IV_CAPABILITYID TYPE /AWS1/BDICAPABILITYID OPTIONAL
    !IV_NAME TYPE /AWS1/BDICAPABILITYNAME OPTIONAL
    !IO_CONFIGURATION TYPE REF TO /AWS1/CL_BDICAPABILITYCONF OPTIONAL
    !IT_INSTRUCTIONSDOCUMENTS TYPE /AWS1/CL_BDIS3LOCATION=>TT_INSTRUCTIONSDOCUMENTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdiupdcapabilityrsp
  RAISING
    /AWS1/CX_BDIACCESSDENIEDEX
    /AWS1/CX_BDICONFLICTEXCEPTION
    /AWS1/CX_BDIINTERNALSERVEREX
    /AWS1/CX_BDIRESOURCENOTFOUNDEX
    /AWS1/CX_BDISERVICEQUOTAEXCDEX
    /AWS1/CX_BDITHROTTLINGEX
    /AWS1/CX_BDIVALIDATIONEX
    /AWS1/CX_BDICLIENTEXC
    /AWS1/CX_BDISERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_capabilityid TYPE /AWS1/BDICAPABILITYID /AWS1/BDICAPABILITYID

Specifies a system-assigned unique identifier for the capability.

Optional arguments:

iv_name TYPE /AWS1/BDICAPABILITYNAME /AWS1/BDICAPABILITYNAME

Specifies a new name for the capability, to replace the existing name.

io_configuration TYPE REF TO /AWS1/CL_BDICAPABILITYCONF /AWS1/CL_BDICAPABILITYCONF

Specifies a structure that contains the details for a capability.

it_instructionsdocuments TYPE /AWS1/CL_BDIS3LOCATION=>TT_INSTRUCTIONSDOCUMENTS TT_INSTRUCTIONSDOCUMENTS

Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.

RETURNING

oo_output TYPE REF TO /aws1/cl_bdiupdcapabilityrsp /AWS1/CL_BDIUPDCAPABILITYRSP

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->updatecapability(
  io_configuration = new /aws1/cl_bdicapabilityconf(
    io_edi = new /aws1/cl_bdiediconfiguration(
      io_inputlocation = new /aws1/cl_bdis3location(
        iv_bucketname = |string|
        iv_key = |string|
      )
      io_outputlocation = new /aws1/cl_bdis3location(
        iv_bucketname = |string|
        iv_key = |string|
      )
      io_type = new /aws1/cl_bdieditype(
        io_x12details = new /aws1/cl_bdix12details(
          iv_transactionset = |string|
          iv_version = |string|
        )
      )
      iv_capabilitydirection = |string|
      iv_transformerid = |string|
    )
  )
  it_instructionsdocuments = VALUE /aws1/cl_bdis3location=>tt_instructionsdocuments(
    (
      new /aws1/cl_bdis3location(
        iv_bucketname = |string|
        iv_key = |string|
      )
    )
  )
  iv_capabilityid = |string|
  iv_name = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_capabilityid = lo_result->get_capabilityid( ).
  lv_resourcearn = lo_result->get_capabilityarn( ).
  lv_capabilityname = lo_result->get_name( ).
  lv_capabilitytype = lo_result->get_type( ).
  lo_capabilityconfiguration = lo_result->get_configuration( ).
  IF lo_capabilityconfiguration IS NOT INITIAL.
    lo_ediconfiguration = lo_capabilityconfiguration->get_edi( ).
    IF lo_ediconfiguration IS NOT INITIAL.
      lv_capabilitydirection = lo_ediconfiguration->get_capabilitydirection( ).
      lo_editype = lo_ediconfiguration->get_type( ).
      IF lo_editype IS NOT INITIAL.
        lo_x12details = lo_editype->get_x12details( ).
        IF lo_x12details IS NOT INITIAL.
          lv_x12transactionset = lo_x12details->get_transactionset( ).
          lv_x12version = lo_x12details->get_version( ).
        ENDIF.
      ENDIF.
      lo_s3location = lo_ediconfiguration->get_inputlocation( ).
      IF lo_s3location IS NOT INITIAL.
        lv_bucketname = lo_s3location->get_bucketname( ).
        lv_s3key = lo_s3location->get_key( ).
      ENDIF.
      lo_s3location = lo_ediconfiguration->get_outputlocation( ).
      IF lo_s3location IS NOT INITIAL.
        lv_bucketname = lo_s3location->get_bucketname( ).
        lv_s3key = lo_s3location->get_key( ).
      ENDIF.
      lv_transformerid = lo_ediconfiguration->get_transformerid( ).
    ENDIF.
  ENDIF.
  LOOP AT lo_result->get_instructionsdocuments( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_bucketname = lo_row_1->get_bucketname( ).
      lv_s3key = lo_row_1->get_key( ).
    ENDIF.
  ENDLOOP.
  lv_createddate = lo_result->get_createdat( ).
  lv_modifieddate = lo_result->get_modifiedat( ).
ENDIF.

Sample UpdateCapability call

Sample UpdateCapability call

DATA(lo_result) = lo_client->updatecapability(
  io_configuration = new /aws1/cl_bdicapabilityconf(
    io_edi = new /aws1/cl_bdiediconfiguration(
      io_inputlocation = new /aws1/cl_bdis3location(
        iv_bucketname = |test-bucket|
        iv_key = |input/|
      )
      io_outputlocation = new /aws1/cl_bdis3location(
        iv_bucketname = |test-bucket|
        iv_key = |output/|
      )
      io_type = new /aws1/cl_bdieditype(
        io_x12details = new /aws1/cl_bdix12details(
          iv_transactionset = |X12_110|
          iv_version = |VERSION_4010|
        )
      )
      iv_transformerid = |tr-9a893cf536df4658b|
    )
  )
  it_instructionsdocuments = VALUE /aws1/cl_bdis3location=>tt_instructionsdocuments(
    (
      new /aws1/cl_bdis3location(
        iv_bucketname = |test-bucket|
        iv_key = |instructiondoc.txt|
      )
    )
  )
  iv_capabilityid = |ca-963a8121e4fc4e348|
  iv_name = |b2biexample|
).