Delete
This content applies to legacy components (such as K2 Studio and K2 for Visual Studio), legacy assemblies , legacy services or legacy functionality. If you have upgraded from K2 blackpearl 4.7 to K2 Five , these items may still be available in your environment. These legacy items may not be available in new installations of K2 Five . These legacy items may also not be available, supported, or behave as described, in future updates or versions of K2. Please see the legacy component support policy for more information about support for these components.
Executes the Delete type method on the SmartObject, using the relevant Key value.
The Delete method requires a SmartObject Key via the query parameters in the URL. The SmartObject Key will indicate the record to delete.
| Value | Notes | |
|---|---|---|
| URI | {Service Root URI}{Service Path}?{SmartObjectKey} Example: http://k2.denallix.com:8888/SmartObjectServices/REST/Samples/Employee//Delete?Id=1 |
The SmartObject Key can contain multiple properties separated by ampersand (&), if you wish to delete multiple records, for example Id1=100&Id2=2001. |
| Method | DELETE | This method cannot be called via URI construction in the address bar of standard browsers. Tooling such as Fiddler or .NET code may be required to execute the DELETE |
| Request Headers | Content-type: application/xml | Ensure that the request has the correct Content-type set |
| Query Options | Typically, the record ID of the record to delete, using the name of the key property for the record. Example: ?Id=1 |
Query options will be different depending on the definition of the SmartObject. You can use the EndPoints.xml address as discussed in SmartObject REST Services to explore the query options for the specific endpoint you wish to use. |
| Request Body | (not applicable) |
|
| Return Type | Errors and Response Codes | Due to the asynchronous nature of the DELETE, a successful call may not return anything depending on the tooling used to execute the DELETE |