REST Interface for BPEL-related Task Resources - Business Category Instance Resource - DELETE Method

Use this method to delete a business category.

Sample method invocation

DELETE /rest/bpm/htm/v1/businessCategory/{bcid}[?recursive={string}]

Parameters

Optional Parameters
NameValue TypeDescription
recursive string
Indicates whether all subcategories are recursively deleted as well.
ValueDescription
true
Recursively delete all subcategories.
false (default)
Subcategories are not deleted.

Request Content

None

Response Content

List of deleted business categories.

The default content-type is application/json.

MIME Type: application/json


Schema
{  "description": "Business Category Delete Response", 
   "type": "object",
   "properties":
   {  "identifier": {"type": "string"},
      "items": 
      [
         {
            "bcid": {"type": "string",
               "description": "ID of the deleted business category."
            },
            "name": {"type": "string",
               "description": "Name of the deleted business category."
            }
         }
      ]
   }
}

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json


Schema
{  "description": "Error Response", 
   "type": "object",
   "properties":
   {  "errorNumber": {"type": "string",
         "description": "Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "description": "Message text of the exception."
      },
      "errorMessageParameters": {"type": ["string"], "optional": true,
         "description":"Message text parameters of the exception."
      },
      "programmersDetails": {"type": "object", "optional": true,
         "description":"Additional, exception details, for example, a stack trace."
      }
   }
} 

Status codes

The method returns one of the following status codes:
CodeDescription
200 OKSuccess completion.
400 Bad RequestThe parameters are not valid or they are missing.
401 UnauthorizedThe caller is not authorized for this request.
403 ForbiddenThe caller is not allowed to complete this request.
404 Not Found
The business category does not exist.
406 Not AcceptableThe requested content type or content encoding is not supported.
409 Conflict
The parameter recursive has been set to false and subcategories still exist.
500 Internal Server ErrorA severe problem has occurred. Programmer's details are provided.

Available since

7.0 Feature Pack

Parent topic: Business Category Instance Resource