Skip to content

Remove Object Schema ​

Soft remove an object schema configuration. Distributed object schemas removed from a site are also permanently deleted, including their distribution link. Locally created site schemas and schemas outside sites are marked as removed. Requires ADMIN, MANAGE_OBJECTS, or MANAGE_FORM permissions.

Before removing a distributed object schema from a site, the API checks that it is unused. References from other schemas, including soft-removed schedules, block removal with 400; job references are ignored. If this check fails, the schema, its index entry, and its distribution link are preserved.

Parameters ​

name * are required parametersdata typedescription
objectId*stringThe unique identifier of the object schema to remove

Return Value ​

HTTP 201 with the following JSON body:

json
{
  "data": null,
  "message": "Object removed"
}

Examples ​

bash
curl -X POST "https://app.wombat.software/api/{targetPath}/object/:objectId/remove" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ..."

ENDPOINTS

post/api/{targetPath}/object/:objectId/remove