Inquire
Returns all the fields for a single resource definition, CICS® Configuration Manager repository object, or CICS Configuration Manager journal object.
The Inquire command returns all fields from a single object; the List command returns selected fields from one or more objects.
Request format
<CCV530>
<Inquire>
<LocationCriteria>
<LocationName> location_name </LocationName>
<LocationType> CConfig | Context | CSD | Repository | Journal </LocationType>
</LocationCriteria>
<ObjectCriteria>
<ObjType> object_type </ObjType>
Criteria for this object type
<ObjectInstance> object_instance </ObjectInstance> 1
</ObjectCriteria>
</Inquire>
</CCV530>
- 1
- <ObjectInstance> is relevant only if location_type is Repository or Journal:
- If location_type is Repository, then <ObjectInstance> is optional. If specified, the Inquire command returns that particular object instance. If omitted, the Inquire command returns the current (latest) instance of the object.
- If location_type is Journal, then <ObjectInstance> is required. You must specify the particular instance of the resource definition that you want from the journal.
To determine the appropriate object_instance, use the List command to return all the instances of the object.
Response format
<CCV530>
<Inquire>
<OutputData>
<ReturnCode> return_code </ReturnCode>
<ReasonCode> reason_code </ReasonCode>
<TaskNo> CICS_task_number </TaskNo>
<IntegrityToken> integrity_token </IntegrityToken> 1
<object_type>
<ObjectData>
<Type> object_type </Type>
Data for this object type
</ObjectData>
</object_type>
</OutputData>
</Inquire>
</CCV530>
- 1
- If location_type is Journal, then <IntegrityToken> is not returned.
Security key
API command (READ access authority):
>>-prefix.INQ.object_type.location_type.-+-location_name-+----->< '-NONE----------'
Examples
The following example returns a FILEDEF (FILE) resource definition from a CSD file.
<CCV530>
<INQUIRE>
<LocationCriteria>
<LocationName> CCV530.QAAUTO.CCVT23T.DFHCSD </LocationName>
<LocationType> CSD </LocationType>
</LocationCriteria>
<ObjectCriteria>
<ObjName> CAUAFF1 </ObjName>
<ObjGroup> DFH$AFFY </ObjGroup>
<ObjType> FILEDEF </ObjType>
</ObjectCriteria>
</INQUIRE>
</CCV530>
The following example returns a TRANDEF resource definition from a context.
<CCV530>
<INQUIRE>
<LocationCriteria>
<LocationName> CCVPLEXA </LocationName>
<LocationType> CONTEXT </LocationType>
</LocationCriteria>
<ObjectCriteria>
<ObjName> Q442 </ObjName>
<ObjGroup> QAAINQ01 </ObjGroup>
<ObjType> TRANDEF </ObjType>
</ObjectCriteria>
</INQUIRE>
</CCV530>
The following example returns a migration scheme.
<CCV530>
<INQUIRE>
<LOCATIONCRITERIA>
<LOCATIONTYPE> REPOSITORY </LOCATIONTYPE>
</LOCATIONCRITERIA>
<OBJECTCRITERIA>
<OBJTYPE> SCHEME </OBJTYPE>
<OBJNAME> PJCTEST </OBJNAME>
<SCHEME> PJCTEST </SCHEME>
</OBJECTCRITERIA>
</INQUIRE>
</CCV530>