Delete

Deletes resource definitions or CICS® Configuration Manager repository objects. The CICS Configuration Manager API does not allow you to delete:

Request format

Repository objects:

You can only delete repository objects one at a time.

<CCV210>
  <Delete>
    <LocationCriteria>
      <LocationType> Repository </LocationType>
    </LocationCriteria>
 
    <ObjectCriteria>
      <ObjType> object_type </ObjType>
      <ObjectInstance> object_instance </ObjectInstance>  1 
 
      Criteria for this object type  2 
 
    </ObjectCriteria>
 
    <ProcessParms>
      <IntegrityToken> integrity_token </IntegrityToken>  3 
    </ProcessParms>
  </Delete>
</CCV210>

Resource definitions:

<CCV210>
  <Delete>
    <LocationCriteria>
      <LocationName> location_name </LocationName>
      <LocationType> CConfig | Context | CSD </LocationType>
    </LocationCriteria>
 
    <ObjectCriteria>  4 
      <ListCount> element_count </ListCount>
      <ListElement>
          <ObjName> resource_name </ObjName>
          <ObjGroup> resource_group </ObjGroup>
          <ObjType> resource_type </ObjType>
          <ObjDefVer> definition_version </ObjDefVer>
      </ListElement>
 
      More list elements…
 
    </ObjectCriteria>
 
    <ProcessParms>
      <IntegrityToken> integrity_token </IntegrityToken>  3 
    </ProcessParms>
 
  </Delete>
</CCV210>
 1 
<ObjectInstance> is optional, and is relevant only if location_type is Repository:
  • If specified, the particular object instance is deleted, along with all older instances of the object.
  • If omitted, all versions of the object are deleted.
 2 
For a repository object, the child elements of <ObjectCriteria> must uniquely identify an object.
 3 
<IntegrityToken> is optional. If supplied, it is only used if the object criteria specifies a single object without masking. (For example, a single <ListElement> preceded by a <ListCount> with a value of 1.)
 4 
<ObjectCriteria> identifies the objects that you want to delete.
You can specify the object criteria in several ways:
  • To identify a single resource definition, specify only one set of <ObjName>, <ObjGroup>, and <ObjType>, with no masking (wildcards). Do not specify <ListCount> or <ListElement>.
  • To identify one or more resource definitions, either:
    • Specify <ListCount> followed by one or more <ListElement>. Each <ListElement> must identify a single resource definition, with no masking.

      or

    • Specify only one set of <ObjName>, <ObjGroup>, and <ObjType> with masked values. Do not specify <ListCount> or <ListElement>. The values can be any combination of:
      • Mask or specific value for the resource name
      • Mask or specific value for the resource group
      • Specific resource type, or the value * or All to identify all resource types (you cannot use masking to identify a subset of resource types)

      For example, to identify all program resource definitions beginning with the characters PAY, from all groups beginning with the characters FIN, specify:

      <ObjectCriteria>
        <ObjName>PAY*</ObjName>
        <ObjGroup>FIN*</ObjGroup>
        <ObjType>PROGDEF</ObjType>
      </ObjectCriteria>

For context-based resource definitions, you can specify <DefVer> instead of <ObjGroup>.

Response format

The response for a repository object contains a single list element.

<CCV210>
  <Delete>
    <OutputData>
      <ReturnCode> return_code </ReturnCode>
      <ReasonCode> reason_code </ReasonCode>
      <TaskNo> CICS_task_number </TaskNo>
 
      <ListCount> element_count </ListCount>
      <ListElement>
        <ReturnCode> return_code </ReturnCode>
        <ReasonCode> reason_code </ReasonCode>
        <ObjName> resource_name </ObjName>
        <ObjGroup> resource_group </ObjGroup>
        <ObjType> resource_type </ObjType>
        <Config> CICS_configuration </Config>
        <LocationName> CSD_DSN | context </LocationName>
      </ListElement>
 
      More list elements…
 
  </Delete>
</CCV210>

Security key

API command (READ access authority):

Read syntax diagramSkip visual syntax diagram
>>-prefix.DEL.object_type.location_type.-+-location_name-+-----><
                                         '-NONE----------'   

Resource definitions (ALTER access authority):

Read syntax diagramSkip visual syntax diagram
>>-prefix.target_CICS_config.group.type.name-------------------><

Examples

The following example deletes a CONNDEF (CONNECTION) resource definition in a CSD file.

<CCV210>
   <DELETE>
 
  <LocationCriteria>
    <LocationName> CCV120.QAAUTO.CCVT22T.DFHCSD </LocationName>
    <LocationType> CSD </LocationType>
  </LocationCriteria>
 
  <ObjectCriteria>
    <ObjName> Q220 </ObjName>
    <ObjGroup> QAAUPD01 </ObjGroup>
    <ObjType> CONNDEF </ObjType>
  </ObjectCriteria>
 
   </DELETE>
</CCV210>

The following example deletes a RESGROUP in a context.

 

<CCV210>
   <DELETE>
 
  <LocationCriteria>
    <LocationName> CCVPLEXA </LocationName>
    <LocationType> CONTEXT </LocationType>
  </LocationCriteria>
 
  <ObjectCriteria>
    <ObjType> RESGROUP </ObjType>
    <ObjName> QAAADD09 </ObjName>
  </ObjectCriteria>
 
   </DELETE>
</CCV210>

The following example deletes a RESDESC in a context.

 

<CCV210>
   <DELETE>
 
  <LocationCriteria>
    <LocationName> CCVPLEXA </LocationName>
    <LocationType> CONTEXT </LocationType>
  </LocationCriteria>
 
  <ObjectCriteria>
    <ObjType> RESDESC </ObjType>
    <ObjName> QAACONNA </ObjName>
  </ObjectCriteria>
 
   </DELETE>
</CCV210>