Introduction
This action makes it possible to permanently delete an object instance. It is necessary to configure the service as for the update and create one.
Configuration
For each action, there is a corresponding identifying name, and its configuration JSON.
JSON example
Code Block |
---|
{
"objectname":"damelement"
} |
Properties and sections
objectname: object name (type)
description: String - Short description of action
EndPoint
since 11.14
Code Block |
---|
DELETE http://host:port/app/api/json/delete/{actionName}/{id} |
...
since
...
11.1
Code Block |
---|
DELETE http://host:port/app/api/json/delete |
Legacy
...
endpoint:
Code Block |
---|
http//host:port/app/_plugins/WXM_RESTAPI/page/delete.jspz |
Available
...
method:
...
DELETE
Parameters
actionName: character string, the action identifier.
id (or form_id): the to be deleted instance identifier.
Security
The action delete of the RESTAPI domain is used to manage the endpoint call grants. There are two parameters:
surfer: surfer
actionName: used action identifier
Error codes
HTTP Code | API Code | Definition |
---|---|---|
404 | 404/300 | Unknown action |
403 | 403/300 | Forbidden deletion |
403 | 403/301 | The user grants don’t allow to delete an object |
403 | 403/302 | The user grants don’t allow to delete this object |