CICS DA DELETE requests
You can use the CICS® DA RESTful API to deprovision an unmanaged CICS TS region, a CICSPlex SM managed CICS TS region, or a web user interface server. The CICS DA RESTful API uses the HTTP DELETE method to remove resources from the CICS DA model.
DELETE overview
- The HTTP method, in this case DELETE
- The URI that identifies the resources to be deprovisioned
- Headers that identify additional information, such as the format of the response
{hostname}:{port}/CICSTopology/v1
DELETE to run the deprovision function
DELETE /CICSTopology/v1/unmanagedCICSRegions/APPLID1 HTTP/1.1
Host : example.com:port
Content-Type: application/json
Accept : application/json
Where example.com:port is the host address and port number of your CICS DA server and APPLID1 is the APPLID of the CICS TS region that you want to delete.
DELETE message body
{"deprovision":{}}
Output formats
Data output format | HTTP header |
---|---|
JSON | Accept : application/json |
XML | Accept : application/xml |
Response to a DELETE deprovision request
On the completion of a DELETE request, the client receives a response from the CICS DA server. The response consists of one or more HTTP headers, such as a description of the content type, and the list of artifacts that were deleted.
DELETE /CICSTopology/v1/unmanagedCICSRegions/APPLID1 HTTP/1.1
Host : example.com:port
Content-Type: application/json
Accept : application/json
Might
return the following response:HTTP/1.1 200 OK
Content-Type : application/json
{
"applid":"APPLID1",
"time":1447276150431,
"systemDefinitionDeleteResult":{"deleted":"false","resultDetails":"NOT_APPLICABLE"},
"jclDeleteResult":{"dataSetName":"USER1.CICS.JCL(ABCD)","deleted":"true","resultDetails":"OK"},
"systemDataSetsDeleteResults":[
{"ddName":"DFHDMPA","dataSetName":"USER1.APPLID1.DFHDMPA","deleted":"true","resultDetails":"OK"},
{"ddName":"DFHDMPB","dataSetName":"USER1.APPLID1.DFHDMPB","deleted":"true","resultDetails":"OK"},
{"ddName":"DFHHTML","dataSetName":"USER1.APPLID1.DFHHTML","deleted":"true","resultDetails":"OK"},
{"ddName":"DFHGCD","dataSetName":"USER1.APPLID1.DFHGCD","deleted":"true","resultDetails":"OK"},
{"ddName":"DFHBUXT","dataSetName":"USER1.APPLID1.DFHBUXT","deleted":"true","resultDetails":"OK"},
{"ddName":"DFHAUXT","dataSetName":"USER1.APPLID1.DFHAUXT","deleted":"true","resultDetails":"OK"},
{"ddName":"DFHLCD","dataSetName":"USER1.APPLID1.DFHLCD","deleted":"true","resultDetails":"OK"},
{"ddName":"DFHINTRA","dataSetName":"USER1.APPLID1.DFHINTRA","deleted":"true","resultDetails":"OK"},
{"ddName":"DFHTEMP","dataSetName":"USER1.APPLID1.DFHTEMP","deleted":"true","resultDetails":"OK"}],
"procDataSetsDeleteResults":[],
"includeDataSetsDeleteResults":[],
"SITDataSetsDeleteResults":[],
"EYUPARMDataSetsDeleteResults":[],
"EYUWUIDataSetsDeleteResults":[]
}
From the returned details, you can check to ensure that the artifacts that you wanted to delete were removed.