Delete Request
Deletes a request, including its documents and process state. Delete will not return 404 Not Found error if the request guid doesn’t exist; instead it will return "MISSING" instead of "DELETED".
DELETE /connectr/api/units/{unit}/requests/{requestguid}
Example Request URL: http://connectr.example.org:8080/connectr/api/units/4.1/requests/f4dc0da49ad14e768f84afb953807e04
Template parameter | Value | Description |
---|---|---|
unit (Mandatory) | String | Unit code as used in Data Manager. This is currently defined in the Publish Store settings. |
requestguid (Mandatory) | String | Request guid as seen in the output of the request creation. |
Query parameter | Value | Description |
---|---|---|
forceddelete (Optional) | Boolean | When set to true the deletion will be forceful: the current status is ignored and any open tasks are simply deleted. When false or missing a 409 Conflict status will be returned if there were tasks open. |
Response status code | Content type | Description |
---|---|---|
200 OK | application/xml | The request was deleted or missing. |
409 Conflict | text/plain | The process associated with the request is in a state which forbids retrieving the document (e.g. a user is editing it). |
Response format
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" version="1.0">
<xs:element name="DeleteResponse" type="DeleteResponse"/>
<xs:complexType name="DeleteResponse">
<xs:sequence>
<xs:element name="resultCode" type="xs:string" minOccurs="0"/>
<xs:element name="ext" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:any processContents="lax" namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:schema>
Response example
<DeleteResponse>
<resultCode>DELETED</resultCode>
<ext/>
</DeleteResponse>