Api delete

Calling a service to delete a record on an entity is done by an http DELETE request.

Calling Syntax

The query request on an entity is done by using a delete on the following syntax:
http://SERVER:SERVICE/api1/APPLICATION/CONTRACT/ENDPOINT/ENTITY('KEY')?representation=REPRESENTATION.$query

Where:

  • SERVER:SERVICE is the server address followed by the service number.
  • APPLICATION is the application (Syracuse or ERP).
  • CONTRACT is the api1 contract (administration or X3).
  • ENDPOINT is the endpoint (collaboration or an endpoint associated with an X3 folder).
  • ENTITY is the class name.
  • REPRESENTATION is the representation name.
  • KEY is the key value.

For example, if the URL in which a DELETE is done is the following:

http://my_server:8124/syracuse/collaboration/syracuse/endPoints('2a...58b')?representation=endPoints.%24query

A deletion is requested on the endpoint having the uuid '2a...58b'.