DATA/GETDEF

Request the CICSPlex® SM Web User Interface server to create a result set containing selected descriptive records (metadata) for a resource table

DATA/GETDEF

Read syntax diagramSkip visual syntax diagramDATA/GETDEFATTRIBUTE= attribute_nameACTION(data-value)ACTIONPARM(data-value)OBJECT= resource_nameRESOURCE= character-stringSTUB= character_string

Description

Initially, you issue a DATA/GETDEF request for a new result set of metadata records without specifying a STUB option on the command. The response from the server includes a STUB header identifying the metadata result set.

You can reuse a result set by issuing another DATA/GETDEF or DATA/GET command that specifies a previous stub value. This has the effect of discarding the old results and reusing the resources to hold the results of the new DATA/GETDEF or DATA/GET request.

The result of a DATA/GETDEF command for STATUS OK is shown in Table 1.

Table 1. Data returned on DATA/GETDEF command response header
Header field Description
COUNT= The number of records in the results set that match the query. This can be a zero value.
OBJECT= The type of metadata to be retrieved for the resource table specified on the RESOURCE option.
REASON= The CICSPlex SM API reason code, where applicable.
RESPONSE= The CICSPlex SM API response code.
STUB= The stub value to be used for the next request relating to this query. This can be another GETDEF, a GET, a FETCH, or a DISCARD command.
USERID= The user ID signed on to the Web User Interface Server session used for this request.

The CICSPlex SM Web User Interface server manages each active data interface result set as a single-user session window. Each user session can have at anyone time a maximum of 64 active windows, which are shared between the client application data interface and the HTML interface.

Data: The DATA/GETDEF command does not return any data records after the response header fields. The command creates a result set from which a subsequent DATA/FETCH command can retrieve records.

Options

ACTION(data-value)
The 12-character name of an action against the resource table for which CICSPlex SM metadata records are to be retrieved.
ACTIONPARM(data-value)
The 12-character name of a parameter to an action against the resource table for which CICSPlex SM metadata records are to be retrieved, as it appears in the API parameter string.
ATTRIBUTE=value
Specifies, optionally, the value of one or more known attribute names from one of the CICSPlex SM resource tables.

Depending on which CICSPlex SM metadata table is named on the OBJECT parameter, this value can be the 1- to 12-character name of a specific attribute or an asterisk (*), for all attributes in the resource table. If you do not specify the ATTRIBUTE option for an OBJECT that does not require it, data is retrieved for all attributes in the resource table.

OBJECT=value
Identifies the type of metadata to be retrieved for the resource table specified on the RESOURCE option. This option is required, and must specify one of the following CICSPlex SM metadata resource table names:
OBJECT
OBJACT
METADESC
ATTR
ATTRAVA
METANAME
METAPARM
PARMAVA
RESOURCE=value
Specifies the resource table for which CICSPlex SM metadata records are to be retrieved.

If you specify the ATTRIBUTE parameter, the resource value must be the 1- to 8-character name of a specific CICSPlex SM resource table. Otherwise, you can specify a value of asterisk (*) to retrieve data for all resource tables.

STUB=value
Specifies the result set stub value returned by the server in response to an earlier request. This is optional, and has the following effect:
  • If you omit the STUB option, the server creates a new result set. If the server has created one or more result sets from previous requests, these are preserved and unaffected by this request.
  • If you specify the STUB option, the server reuses the old result set storage for the new query. In effect, issuing a DATA/GETDEF request with a stub value is the equivalent of issuing a DATA/DISCARD followed by a DATA/GETDEF, and avoids tying up system resources that are no longer needed.
Note: Your client application can use a stub value received from Web User Interface server once only. Once you specify a stub value on a request to a Web User Interface server, you cannot use the same value again.

STATUS values

BADCOMMAND
The command passed to the data interface by the Web User Interface is not recognized.
BADOBJECT
The value specified on the OBJECT option is invalid. If the DATA/GETDEF command specified a stub value, the implied DISCARD is honored and the associated result set is discarded.
BADSTUB
The stub value is not valid for the request. This could be for one of the following reasons:
  • You have specified a stub value that does not belong to the user session on which you have issued the command.
  • The stub value is out of sequence.
CMASGONE
The Web User Interface has lost its connection with the CMAS. As a result, the client application's user session is terminated.
MAXWIN
The maximum number of windows (64) for the user session has been reached.