SEARCHTYPES()`¶

About SearchTypes¶

Searches for types in Amazon DataZone.

Prerequisites:

The --domain-identifier must refer to an existing Amazon DataZone domain.
--search-scope must be one of the valid values including: ASSET_TYPE, GLOSSARY_TERM_TYPE, DATA_PRODUCT_TYPE.
The --managed flag must be present without a value.
The user must have permissions for form or asset types in the domain.
If using --filters, ensure that the JSON is valid.
Filters contain correct structure (attribute, value, operator).

Method Signature¶

METHODS /AWS1/IF_DZN~SEARCHTYPES
  IMPORTING
    !IV_DOMAINIDENTIFIER TYPE /AWS1/DZNDOMAINID OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/DZNMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/DZNPAGINATIONTOKEN OPTIONAL
    !IV_SEARCHSCOPE TYPE /AWS1/DZNTYPESSEARCHSCOPE OPTIONAL
    !IV_SEARCHTEXT TYPE /AWS1/DZNSEARCHTEXT OPTIONAL
    !IT_SEARCHIN TYPE /AWS1/CL_DZNSEARCHINITEM=>TT_SEARCHINLIST OPTIONAL
    !IO_FILTERS TYPE REF TO /AWS1/CL_DZNFILTERCLAUSE OPTIONAL
    !IO_SORT TYPE REF TO /AWS1/CL_DZNSEARCHSORT OPTIONAL
    !IV_MANAGED TYPE /AWS1/DZNBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dznsearchtypesoutput
  RAISING
    /AWS1/CX_DZNACCESSDENIEDEX
    /AWS1/CX_DZNTHROTTLINGEX
    /AWS1/CX_DZNUNAUTHORIZEDEX
    /AWS1/CX_DZNINTERNALSERVEREX
    /AWS1/CX_DZNVALIDATIONEX
    /AWS1/CX_DZNCLIENTEXC
    /AWS1/CX_DZNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_domainidentifier` `TYPE /AWS1/DZNDOMAINID` `/AWS1/DZNDOMAINID`¶

The identifier of the Amazon DataZone domain in which to invoke the SearchTypes action.

`iv_searchscope` `TYPE /AWS1/DZNTYPESSEARCHSCOPE` `/AWS1/DZNTYPESSEARCHSCOPE`¶

Specifies the scope of the search for types.

`iv_managed` `TYPE /AWS1/DZNBOOLEAN` `/AWS1/DZNBOOLEAN`¶

Specifies whether the search is managed.

Optional arguments:¶

`iv_maxresults` `TYPE /AWS1/DZNMAXRESULTS` `/AWS1/DZNMAXRESULTS`¶

The maximum number of results to return in a single call to SearchTypes. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to SearchTypes to list the next set of results.

`iv_nexttoken` `TYPE /AWS1/DZNPAGINATIONTOKEN` `/AWS1/DZNPAGINATIONTOKEN`¶

When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchTypes to list the next set of results.

`iv_searchtext` `TYPE /AWS1/DZNSEARCHTEXT` `/AWS1/DZNSEARCHTEXT`¶

Specifies the text for which to search.

`it_searchin` `TYPE /AWS1/CL_DZNSEARCHINITEM=>TT_SEARCHINLIST` `TT_SEARCHINLIST`¶

The details of the search.

`io_filters` `TYPE REF TO /AWS1/CL_DZNFILTERCLAUSE` `/AWS1/CL_DZNFILTERCLAUSE`¶

The filters for the SearchTypes action.

`io_sort` `TYPE REF TO /AWS1/CL_DZNSEARCHSORT` `/AWS1/CL_DZNSEARCHSORT`¶

The specifies the way to sort the SearchTypes results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_dznsearchtypesoutput` `/AWS1/CL_DZNSEARCHTYPESOUTPUT`¶

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->searchtypes(
  io_filters = new /aws1/cl_dznfilterclause(
    io_filter = new /aws1/cl_dznfilter(
      iv_attribute = |string|
      iv_value = |string|
    )
    it_and = VALUE /aws1/cl_dznfilterclause=>tt_filterlist(
      (
        new /aws1/cl_dznfilterclause(
          io_filter = new /aws1/cl_dznfilter(
            iv_attribute = |string|
            iv_value = |string|
          )
          it_or = VALUE /aws1/cl_dznfilterclause=>tt_filterlist(
          )
        )
      )
    )
    it_or = VALUE /aws1/cl_dznfilterclause=>tt_filterlist(
      (
        new /aws1/cl_dznfilterclause(
          io_filter = new /aws1/cl_dznfilter(
            iv_attribute = |string|
            iv_value = |string|
          )
          it_and = VALUE /aws1/cl_dznfilterclause=>tt_filterlist(
          )
        )
      )
    )
  )
  io_sort = new /aws1/cl_dznsearchsort(
    iv_attribute = |string|
    iv_order = |string|
  )
  it_searchin = VALUE /aws1/cl_dznsearchinitem=>tt_searchinlist(
    ( new /aws1/cl_dznsearchinitem( |string| ) )
  )
  iv_domainidentifier = |string|
  iv_managed = ABAP_TRUE
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_searchscope = |string|
  iv_searchtext = |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.
      lo_assettypeitem = lo_row_1->get_assettypeitem( ).
      IF lo_assettypeitem IS NOT INITIAL.
        lv_domainid = lo_assettypeitem->get_domainid( ).
        lv_typename = lo_assettypeitem->get_name( ).
        lv_revision = lo_assettypeitem->get_revision( ).
        lv_description = lo_assettypeitem->get_description( ).
        LOOP AT lo_assettypeitem->get_formsoutput( ) into ls_row_2.
          lv_key = ls_row_2-key.
          lo_value = ls_row_2-value.
          IF lo_value IS NOT INITIAL.
            lv_formtypename = lo_value->get_typename( ).
            lv_revision = lo_value->get_typerevision( ).
            lv_boolean = lo_value->get_required( ).
          ENDIF.
        ENDLOOP.
        lv_projectid = lo_assettypeitem->get_owningprojectid( ).
        lv_domainid = lo_assettypeitem->get_origindomainid( ).
        lv_projectid = lo_assettypeitem->get_originprojectid( ).
        lv_createdat = lo_assettypeitem->get_createdat( ).
        lv_createdby = lo_assettypeitem->get_createdby( ).
        lv_updatedat = lo_assettypeitem->get_updatedat( ).
        lv_updatedby = lo_assettypeitem->get_updatedby( ).
      ENDIF.
      lo_formtypedata = lo_row_1->get_formtypeitem( ).
      IF lo_formtypedata IS NOT INITIAL.
        lv_domainid = lo_formtypedata->get_domainid( ).
        lv_formtypename = lo_formtypedata->get_name( ).
        lv_revision = lo_formtypedata->get_revision( ).
        lo_model = lo_formtypedata->get_model( ).
        IF lo_model IS NOT INITIAL.
          lv_smithy = lo_model->get_smithy( ).
        ENDIF.
        lv_formtypestatus = lo_formtypedata->get_status( ).
        lv_projectid = lo_formtypedata->get_owningprojectid( ).
        lv_domainid = lo_formtypedata->get_origindomainid( ).
        lv_projectid = lo_formtypedata->get_originprojectid( ).
        lv_createdat = lo_formtypedata->get_createdat( ).
        lv_createdby = lo_formtypedata->get_createdby( ).
        lv_description = lo_formtypedata->get_description( ).
        LOOP AT lo_formtypedata->get_imports( ) into lo_row_3.
          lo_row_4 = lo_row_3.
          IF lo_row_4 IS NOT INITIAL.
            lv_formtypename = lo_row_4->get_name( ).
            lv_revision = lo_row_4->get_revision( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
      lo_lineagenodetypeitem = lo_row_1->get_lineagenodetypeitem( ).
      IF lo_lineagenodetypeitem IS NOT INITIAL.
        lv_domainid = lo_lineagenodetypeitem->get_domainid( ).
        lv_string = lo_lineagenodetypeitem->get_name( ).
        lv_string = lo_lineagenodetypeitem->get_description( ).
        lv_createdat = lo_lineagenodetypeitem->get_createdat( ).
        lv_createdby = lo_lineagenodetypeitem->get_createdby( ).
        lv_updatedat = lo_lineagenodetypeitem->get_updatedat( ).
        lv_updatedby = lo_lineagenodetypeitem->get_updatedby( ).
        lv_revision = lo_lineagenodetypeitem->get_revision( ).
        LOOP AT lo_lineagenodetypeitem->get_formsoutput( ) into ls_row_2.
          lv_key = ls_row_2-key.
          lo_value = ls_row_2-value.
          IF lo_value IS NOT INITIAL.
            lv_formtypename = lo_value->get_typename( ).
            lv_revision = lo_value->get_typerevision( ).
            lv_boolean = lo_value->get_required( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
  lv_integer = lo_result->get_totalmatchcount( ).
ENDIF.

/AWS1/IF_DZN=>SEARCHTYPES()¶

About SearchTypes¶

Method Signature¶

IMPORTING¶

Required arguments:¶

iv_domainidentifier TYPE /AWS1/DZNDOMAINID /AWS1/DZNDOMAINID¶

iv_searchscope TYPE /AWS1/DZNTYPESSEARCHSCOPE /AWS1/DZNTYPESSEARCHSCOPE¶

iv_managed TYPE /AWS1/DZNBOOLEAN /AWS1/DZNBOOLEAN¶

Optional arguments:¶

iv_maxresults TYPE /AWS1/DZNMAXRESULTS /AWS1/DZNMAXRESULTS¶

iv_nexttoken TYPE /AWS1/DZNPAGINATIONTOKEN /AWS1/DZNPAGINATIONTOKEN¶

iv_searchtext TYPE /AWS1/DZNSEARCHTEXT /AWS1/DZNSEARCHTEXT¶

it_searchin TYPE /AWS1/CL_DZNSEARCHINITEM=>TT_SEARCHINLIST TT_SEARCHINLIST¶

io_filters TYPE REF TO /AWS1/CL_DZNFILTERCLAUSE /AWS1/CL_DZNFILTERCLAUSE¶

io_sort TYPE REF TO /AWS1/CL_DZNSEARCHSORT /AWS1/CL_DZNSEARCHSORT¶