GET

Return a result set containing selected resource table records.

Read syntax diagramSkip visual syntax diagram>>-GET--OBJECT(data-value)--+-----------------+----------------->
                            '-COUNT(data-ref)-'
 
>--+-----------------------------------------+------------------>
   +-CRITERIA(data-area)--LENGTH(data-value)-+
   '-FILTER(cpsm-token)----------------------'
 
>--+--------------------------------------+--------------------->
   '-PARM(data-area)--PARMLEN(data-value)-'
 
>--+-------------------------------+--+---------------------+--->
   '-NOWAIT--+-------------------+-'  '-CONTEXT(data-value)-'
             '-TOKEN(data-value)-'
 
>--+-------------------+--RESULT(cpsm-token)-------------------->
   '-SCOPE(data-value)-'
 
>--THREAD(cpsm-token)--RESPONSE(data-ref)--REASON(data-ref)----><
 

Description

This command returns a result set containing selected resource table records.

Related commands

DISCARD, FETCH, GETDEF, QUERY, RECEIVE, REFRESH, SPECIFY FILTER, SPECIFY VIEW

Options

CONTEXT(data-value)
Identifies the context for this command. The context must be the 1- to 8-character name of a CMAS or CICSplex.

If you do not specify the CONTEXT option, the default context for the thread is assumed.

COUNT(data-ref)
Names a variable to receive the number of resource table records in the target result set after this operation is complete.
CRITERIA(data-area)
Identifies a buffer containing the filter expression to be used for this operation. The CRITERIA option retrieves only those resource table records that meet the specified filter criteria.

For details on how to form a filter expression, see CICSPlex System Manager Application Programming Guide.

FILTER(cpsm-token)
Identifies a filter to be used for this operation. The FILTER option retrieves only those resource table records that meet the specified filter criteria.

The cpsm-token value that identifies a filter is returned by the SPECIFY FILTER command.

LENGTH(data-value)
A fullword value that specifies the length of the CRITERIA buffer.
Note:
The buffer length you specify should not include any data other than a filter expression.
NOWAIT
Returns control to your program as soon as the GET command has been accepted, which allows the command to be processed asynchronously.

If you specify the NOWAIT option, you must use a subsequent RECEIVE command to test for the completion of this request. The results of an asynchronous request are returned as ASYNCREQ resource table records. For a complete description of asynchronous processing, see CICSPlex System Manager Application Programming Guide.

Note:
If you specify the TOKEN option, the NOWAIT option is assumed by default.
OBJECT(data-value)
Identifies the resource table for which records are to be retrieved. This value must be the 1- to 8-character name of either a valid resource table or a valid view.
PARM(data-area)
Start of changeIdentifies a buffer containing the parameter expression to be used in preselecting resource table records.

For details on how to use a parameter expression with the GET command, see CICSPlex System Manager Application Programming Guide. For a description of the parameters that can be specified for a given resource table, see the CICSPlex System Manager Resource Tables Reference.

End of change
PARMLEN(data-value)
A fullword value that specifies the length of the PARM buffer.
REASON(data-ref)
Names a variable to receive the fullword reason value returned by this command.
RESPONSE(data-ref)
Names a variable to receive the fullword response value returned by this command.
RESULT(cpsm-token)
Identifies the API result set to be processed by this operation. The result set can be one produced by any of these commands:
  • COPY
  • GET
  • GROUP
  • PERFORM OBJECT.
CICSPlex SM replaces the contents of the existing result set with the resource table records requested by this GET command. If the operation does not result in any resource table records being selected, the target result set is discarded.

If this field is:

  • Set to binary zero (in COBOL, C, PL/I or Assembler)
  • An uninitialized variable (in REXX).

CICSPlex SM creates a new result set and returns its identifying token in the same field.

Start of changeSCOPE(data-value)End of change
Start of changeIdentifies the scope for this command.

If the current context (as set by this command or a previous CONNECT or QUALIFY command) is a CICSplex and the OBJECT option identifies a CICS resource, a valid scope is required. The scope can be:

  • The 1- to 8-character name of the CICSplex itself
  • A CICS system or CICS system group within the CICSplex
  • A logical scope, as defined in a CICSPlex SM resource description (RESDESC).

If the current context is a CMAS or the OBJECT option identifies any other type of resource table this option has no meaning and is ignored.

If you do not specify the SCOPE option, the default scope for the thread is assumed. If the current context is a CICSplex and no default scope has been set on a CONNECT or QUALIFY command, you receive an INVALIDPARM response for the SCOPE option.

End of change
STATE(cpsm-token)
Returns active or inactive topology objects. The default is to return both.
THREAD(cpsm-token)
Identifies the API thread to be used for this operation. The cpsm-token value that identifies a thread is returned by the CONNECT command.
TOKEN(data-value)
Defines a 1- to 4-character token that you choose to correlate an asynchronous GET request with the result of a subsequent RECEIVE command. This token is for use by your program; CICSPlex SM makes no use of the value. The token is returned by the RECEIVE command when this GET request is complete.

Conditions

The following is a list of the RESPONSE values that can be returned by the GET command. The description of each RESPONSE includes a list of associated REASON values, if appropriate.

OK
The command completed processing successfully.
SCHEDULED
The command has been scheduled for processing.
NODATA
No records were found that matched the specified search criteria.
BUSY
A busy condition occurred for the following reason:
RESULT
The result set specified on the RESULT option is being processed by another command.
ENVIRONERROR
An environment error occurred for one of the following reasons:
NOSERVICE
The application stub program could not load the API service module.
NOSTORAGE
The application stub program could not obtain the necessary storage in the address space where the processing thread is running.
REQTIMEOUT
One of the CMASs or MASs to which the request was directed did not respond.

Start of changeIf only some of the CMASs or MASs did not respond, the GET can still yield a valid result. COUNT might be greater than zero and RESULT might be non-zero. Such a result set contains data from those CMASs and MASs that did respond.End of change

SOCRESOURCE
Start of changeA required resource that is owned by the CMAS is not available, or the maximum number of result set, view or filter tokens has been reached.End of change
FAILED
The command failed for one of the following reasons:
ABENDED
Command processing abended.
EXCEPTION
Command processing encountered an exceptional condition.
INVALIDATA
Invalid data was detected. The parameter that contains invalid data is returned as the reason value:
CRITERIA
An attribute value listed in the CRITERIA buffer is not valid for the specified attribute.
INVALIDCMD
The command is invalid for one of the following reasons:
FILTER
The filter expression passed on the operation is too large or complex.
LENGTH
The total length of all the options on the command exceeds the maximum limit.
INVALIDPARM
An invalid parameter was detected. The parameter that is invalid is returned as the reason value:
  • CONTEXT
  • CRITERIA
  • FILTER
  • LENGTH
  • OBJECT
  • PARM
  • PARMLEN
  • RESULT
  • SCOPE
  • TOKEN
  • THREAD.
Check the command description for valid parameter syntax.
NOTAVAILABLE
A not available condition occurred for one of the following reasons:
APITASK
The API control subtask is not active.
CMAS
A CMAS to which the request was directed is not available.
CPSMAPI
The CMAS to which the processing thread is connected is not available for API processing.
MAINTPOINT
The maintenance point for the current context is not available.
SCOPE
Either none of the MASs in the specified scope are available or none of them support the requested resource table.
WORKLOAD
The workload identified on the API request is not available on the local CMAS.
NOTFOUND
A not found condition occurred for the following reason:
ATTRIBUTE
An attribute specified in the CRITERIA buffer was not found for the specified resource table.
NOTPERMIT
A not permitted condition occurred for the following reason:
USRID
The user ID associated with the processing thread does not have the required security authorization.
SERVERGONE
The CMAS to which the processing thread was connected is no longer active.
TABLEERROR
A resource table record is invalid for the following reason:
DATAERROR
The value associated with one or more resource table attributes is invalid. Use the FEEDBACK command to retrieve additional data about this error.
VERSIONINVL
A version conflict occurred for one of the following reasons:
NOTSUPPORTED
The version of the application stub program used for this command is not supported.
NOTVSNCONN
The version of the application stub program used for this command is not the same as the version used with the CONNECT command.
WARNING
The command completed processing with a warning, for the following reason:
MAXRECORDS
The number of records added to the result set by a MAS would have exceeded the MAXHISTRECS value for that MAS. Records within the MAXHISTRECS limit have been added to the result set. Modify the FILTER or PARM parameter values to reduce the number of records the MAS should add to the result set.
[[ Contents Previous Page | Next Page Index ]]