LISTSCHEMAVERSIONS()`¶

About ListSchemaVersions¶

Lists schema versions with the provided information.

Method Signature¶

METHODS /AWS1/IF_IOX~LISTSCHEMAVERSIONS
  IMPORTING
    !IV_TYPE TYPE /AWS1/IOXSCHEMAVERSIONTYPE OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/IOXMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/IOXNEXTTOKEN OPTIONAL
    !IV_SCHEMAID TYPE /AWS1/IOXSCHEMAID OPTIONAL
    !IV_NAMESPACE TYPE /AWS1/IOXSCHVRSNAMESPACENAME OPTIONAL
    !IV_VISIBILITY TYPE /AWS1/IOXSCHEMAVRSVISIBILITY OPTIONAL
    !IV_SEMANTICVERSION TYPE /AWS1/IOXSCHEMAVERSIONVERSION OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ioxlistschemavrssrsp
  RAISING
    /AWS1/CX_IOXACCESSDENIEDEX
    /AWS1/CX_IOXCONFLICTEXCEPTION
    /AWS1/CX_IOXINTERNALSERVEREX
    /AWS1/CX_IOXSERVICEUNAVAILEX
    /AWS1/CX_IOXTHROTTLINGEX
    /AWS1/CX_IOXVALIDATIONEX
    /AWS1/CX_IOXCLIENTEXC
    /AWS1/CX_IOXSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_type` `TYPE /AWS1/IOXSCHEMAVERSIONTYPE` `/AWS1/IOXSCHEMAVERSIONTYPE`¶

Filter on the type of schema version.

Optional arguments:¶

`iv_maxresults` `TYPE /AWS1/IOXMAXRESULTS` `/AWS1/IOXMAXRESULTS`¶

The maximum number of results to return at one time.

`iv_nexttoken` `TYPE /AWS1/IOXNEXTTOKEN` `/AWS1/IOXNEXTTOKEN`¶

A token that can be used to retrieve the next set of results.

`iv_schemaid` `TYPE /AWS1/IOXSCHEMAID` `/AWS1/IOXSCHEMAID`¶

Filter on the id of the schema version.

`iv_namespace` `TYPE /AWS1/IOXSCHVRSNAMESPACENAME` `/AWS1/IOXSCHVRSNAMESPACENAME`¶

Filter on the name of the schema version.

`iv_visibility` `TYPE /AWS1/IOXSCHEMAVRSVISIBILITY` `/AWS1/IOXSCHEMAVRSVISIBILITY`¶

The visibility of the schema version.

`iv_semanticversion` `TYPE /AWS1/IOXSCHEMAVERSIONVERSION` `/AWS1/IOXSCHEMAVERSIONVERSION`¶

The schema version. If this is left blank, it defaults to the latest version.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ioxlistschemavrssrsp` `/AWS1/CL_IOXLISTSCHEMAVRSSRSP`¶

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->listschemaversions(
  iv_maxresults = 123
  iv_namespace = |string|
  iv_nexttoken = |string|
  iv_schemaid = |string|
  iv_semanticversion = |string|
  iv_type = |string|
  iv_visibility = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_items( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_schemaid = lo_row_1->get_schemaid( ).
      lv_schemaversiontype = lo_row_1->get_type( ).
      lv_schemaversiondescriptio = lo_row_1->get_description( ).
      lv_schemaversionnamespacen = lo_row_1->get_namespace( ).
      lv_schemaversionversion = lo_row_1->get_semanticversion( ).
      lv_schemaversionvisibility = lo_row_1->get_visibility( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

ListSchemaVersions happy path for an example schema version.¶

ListSchemaVersions happy path for an example schema version.

DATA(lo_result) = lo_client->listschemaversions(
  iv_schemaid = |example.ColorControl|
  iv_type = |capability|
).

ListSchemaVersions by version.¶

ListSchemaVersions by version.

DATA(lo_result) = lo_client->listschemaversions(
  iv_semanticversion = |34.56|
  iv_type = |capability|
).

ListSchemaVersions error for invalid input.¶

ListSchemaVersions error for invalid input.

DATA(lo_result) = lo_client->listschemaversions(
  iv_namespace = |matter|
  iv_schemaid = |example.ColorControl|
  iv_type = |capability|
).

/AWS1/IF_IOX=>LISTSCHEMAVERSIONS()¶