Calling Delete APIs

Access Delete APIs with DELETE HTTP requests.

REST Delete requests use the following APIs depending on the Name of the resource that is specified:

  • manageName (with Operation=Delete)
  • manageNameHierarchy (with Operation=Delete)
  • deleteName
  • deleteNameHierarchy

For example, Delete requests for orders use deleteOrder, and Delete requests for organizations use manageOrganizationHierarchy. To see the complete list of resources and APIs, view the REST Javadoc files.

Request format

Use the following HTTP request format to call Delete APIs:

DELETE https://host:port/contextRoot/Name/id

Name is the type of resource you want to delete, and id is the value of its primary key, NameKey.

The following example shows a request to delete an order with OrderKey equal to 12345:
DELETE https://host:port/contextRoot/restapi/order/12345