Metadata API Class

_GET_TYPE_PROPERTIES_

Returns all possible properties for a metadata type

Category:

Management Methods

Syntax
Parameters
Details
Examples
	Example 1: Return Skeleton Properties List for a Given Type ID
	Example 2: Return List of Property Names for a Given Type ID

Syntax

CALL SEND(i_api, '_GET_TYPE_PROPERTIES_', l_rc, type_id, l_props, <format>);

Parameters

Parameter	Type	Description
i_api	Class	specifies the passed instance of METAAPI.CLASS. See Using the Metadata API Class.
l_rc	N	specifies the return codes for the method. A nonzero code indicates failure and means that l_rc is an error list identifier. For the error list format, see Error Codes.
type_id	C	specifies the passed type ID of the metadata type for which you want a list of properties. For more information on type IDs, see Identifying Metadata.
l_props	L	specifies the returned list of all possible properties for the specified metadata type.
format	C	specifies the passed indicator. Optional. Specifies the format of the returned property list.

Details

type_id: specifies the passed type ID of the metadata type for which you want a list of properties. For example, SAS/Warehouse Administrator has the WHDETAIL type. If an invalid type ID is passed, the returned list is blank.

l_props: specifies the returned list of all possible properties for the specified metadata type. The returned list includes all possible properties. Some properties might not be populated in a given instance of this type.

format

specifies the passed indicator. Optional. Specifies the format of the returned property list.

S -- (default) returns the property list in skeleton format; the property names are item names in the list. This format is suitable for passing to the _GET_METADATA_ method. See Example 1.

D -- returns the property list in display format; the property names are character values in the list. This format is suitable for display to the user. See Example 2.

Examples

Example 1: Return Skeleton Properties List for a Given Type ID

call send(i_api, _GET_TYPE_PROPERTIES_', l_rc, 'WHDETAIL', l_props2,'S');

/*    Returns list: */
     l_props2=(
      (DESC=' '
       NOTE=()[291]
       ADMINISTRATOR=()[292]
       GROUP=()[293]
       MEMBERS=()[294]
       OWNER=()[295]
       COLUMNS=()[296]
       HOST=()[297]
       INPUT OBJECTS=()[298]
       INPUT SOURCES=()[299]
       LIBRARY=()[300]
       OUTPUT OBJECTS=()[301]
       OUTPUT TARGETS=()[302]
       PHYSICAL STORAGE=()[303]
       PROCESS=()[304]
       EXTENDED ATTRIBUTES=()[305]
       ACCESS SAME AS PHYSICAL=.
       CREATING JOB=()[306]
       TABLE NAME=' '
       USING JOBS=()[307]
       ICON=' '
       CVALUE=' '
       ID=' '
       METADATA CREATED=' '
       METADATA UPDATED=' '
       NAME=' '
       NVALUE=.
		    )[290]

Example 2: Return List of Property Names for a Given Type ID

call send(i_api, _GET_TYPE_PROPERTIES_', l_rc,'WHDETAIL', l_props2,'D');

   /*    Returns list: */
L_PROPS2=(
  ('DESC'
   'NOTE'
   'ADMINISTRATOR'
   'GROUP'
   'MEMBERS'
   'OWNER'
   'COLUMNS'
   'HOST'
   'INPUT OBJECTS'
   'INPUT SOURCES'
   'LIBRARY'
   'OUTPUT OBJECTS'
   'OUTPUT TARGETS'
   'PHYSICAL STORAGE'
   'PROCESS'
   'EXTENDED ATTRIBUTES'
   'ACCESS SAME AS PHYSICAL'
   'CREATING JOB'
   'TABLE NAME'
   'USING JOBS'
   'ICON'
   'CVALUE'
   'ID'
   'METADATA CREATED'
   'METADATA UPDATED'
   'NAME'sas
   'NVALUE'
	)[290]

Top of Page