/AWS1/IF_DZN=>CREATEGLOSSARYTERM()

About CreateGlossaryTerm

Creates a business glossary term.

A glossary term represents an individual entry within the Amazon DataZone glossary, serving as a standardized definition for a specific business concept or data element. Each term can include rich metadata such as detailed definitions, synonyms, related terms, and usage examples. Glossary terms can be linked directly to data assets, providing business context to technical data elements. This linking capability helps users understand the business meaning of data fields and ensures consistent interpretation across different systems and teams. Terms can also have relationships with other terms, creating a semantic network that reflects the complexity of business concepts.

Prerequisites:

• Domain must exist.

• Glossary must exist.

• The term name must be unique within the glossary.

• Ensure term does not conflict with existing terms in hierarchy.

Method Signature

METHODS /AWS1/IF_DZN~CREATEGLOSSARYTERM
  IMPORTING
    !IV_DOMAINIDENTIFIER TYPE /AWS1/DZNDOMAINID OPTIONAL
    !IV_GLOSSARYIDENTIFIER TYPE /AWS1/DZNGLOSSARYTERMID OPTIONAL
    !IV_NAME TYPE /AWS1/DZNGLOSSARYTERMNAME OPTIONAL
    !IV_STATUS TYPE /AWS1/DZNGLOSSARYTERMSTATUS OPTIONAL
    !IV_SHORTDESCRIPTION TYPE /AWS1/DZNSHORTDESCRIPTION OPTIONAL
    !IV_LONGDESCRIPTION TYPE /AWS1/DZNLONGDESCRIPTION OPTIONAL
    !IO_TERMRELATIONS TYPE REF TO /AWS1/CL_DZNTERMRELATIONS OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/DZNCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dzncreglossarytermout
  RAISING
    /AWS1/CX_DZNACCESSDENIEDEX
    /AWS1/CX_DZNTHROTTLINGEX
    /AWS1/CX_DZNUNAUTHORIZEDEX
    /AWS1/CX_DZNCONFLICTEXCEPTION
    /AWS1/CX_DZNINTERNALSERVEREX
    /AWS1/CX_DZNRESOURCENOTFOUNDEX
    /AWS1/CX_DZNSERVICEQUOTAEXCDEX
    /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 ID of the Amazon DataZone domain in which this business glossary term is created.

iv_glossaryidentifier TYPE /AWS1/DZNGLOSSARYTERMID /AWS1/DZNGLOSSARYTERMID

The ID of the business glossary in which this term is created.

iv_name TYPE /AWS1/DZNGLOSSARYTERMNAME /AWS1/DZNGLOSSARYTERMNAME

The name of this business glossary term.

Optional arguments:

iv_status TYPE /AWS1/DZNGLOSSARYTERMSTATUS /AWS1/DZNGLOSSARYTERMSTATUS

The status of this business glossary term.

iv_shortdescription TYPE /AWS1/DZNSHORTDESCRIPTION /AWS1/DZNSHORTDESCRIPTION

The short description of this business glossary term.

iv_longdescription TYPE /AWS1/DZNLONGDESCRIPTION /AWS1/DZNLONGDESCRIPTION

The long description of this business glossary term.

io_termrelations TYPE REF TO /AWS1/CL_DZNTERMRELATIONS /AWS1/CL_DZNTERMRELATIONS

The term relations of this business glossary term.

iv_clienttoken TYPE /AWS1/DZNCLIENTTOKEN /AWS1/DZNCLIENTTOKEN

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

RETURNING

oo_output TYPE REF TO /aws1/cl_dzncreglossarytermout /AWS1/CL_DZNCREGLOSSARYTERMOUT

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->createglossaryterm(
  io_termrelations = new /aws1/cl_dzntermrelations(
    it_classifies = VALUE /aws1/cl_dznglossaryterms_w=>tt_glossaryterms(
      ( new /aws1/cl_dznglossaryterms_w( |string| ) )
    )
    it_isa = VALUE /aws1/cl_dznglossaryterms_w=>tt_glossaryterms(
      ( new /aws1/cl_dznglossaryterms_w( |string| ) )
    )
  )
  iv_clienttoken = |string|
  iv_domainidentifier = |string|
  iv_glossaryidentifier = |string|
  iv_longdescription = |string|
  iv_name = |string|
  iv_shortdescription = |string|
  iv_status = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_glossarytermid = lo_result->get_id( ).
  lv_domainid = lo_result->get_domainid( ).
  lv_glossaryid = lo_result->get_glossaryid( ).
  lv_glossarytermname = lo_result->get_name( ).
  lv_glossarytermstatus = lo_result->get_status( ).
  lv_shortdescription = lo_result->get_shortdescription( ).
  lv_longdescription = lo_result->get_longdescription( ).
  lo_termrelations = lo_result->get_termrelations( ).
  IF lo_termrelations IS NOT INITIAL.
    LOOP AT lo_termrelations->get_isa( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_glossarytermid = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_termrelations->get_classifies( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_glossarytermid = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
  LOOP AT lo_result->get_usagerestrictions( ) into lo_row_2.
    lo_row_3 = lo_row_2.
    IF lo_row_3 IS NOT INITIAL.
      lv_glossaryusagerestrictio = lo_row_3->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.