CRUD: Delete
From DocWiki
The CRUD: Delete Web service is used to delete an existing instance record indexed in some target dataset of a WSF. When the instance record gets deleted, all of the information archived in the dataset is deleted as well.
Developers communicate with the CRUD: Delete Web service using the HTTP GET method. You may request any content type (*/*).
Contents |
Usage
This Web service is intended to be used by content management systems, developers or administrators to manage access to a WSF (Web Service Framework) resource (users, datasets, Web services endpoints).
Web Service Endpoint Information
This section describes all you permissions you need in the WSF (Web Service Framework) to send a query to this Web service endpoint, and it describes how to access it.
To access this Web service endpoint you need the proper CRUD (Create, Read, Update and Delete) permissions on a specific graph (dataset) of the WSF. Without the proper permissions on this graph you won't be able to send any queries to the endpoint.
- Create: False
- Read: False
- Update: False
- Delete: True
As shown on the graph URI:
- URI of the dataset where the instance record is indexed
Here is the information needed to communicate with this Web service's endpoint. Descriptions of the parameters are included below.
Note: if a parameter has a default value, the requester can omit it and the default value will be used. Also, some baseline Web services may not offer other values than the default.
- GET
Possible "Accept:" HTTP header field value:
- */*
URI:
- http://[...]/ws/crud/delete/ ?uri=param1&dataset=param2®istered_ip=param3
URI dynamic parameters description:
Note: All parameters have to be URL-encoded
- param1. URI of the instance record to delete
- param2. URI of the dataset where the instance record is indexed
- param3'.'Target IP address registered in the WSF
Query Answer from the Endpoint
If the query is successfully performed by the endpoint (i.e., the Web service resource has been properly created, updated or deleted), the endpoint will return the HTTP status message "200 OK" with an empty body. If an error occured, one of the HTTP status messages with the description of the error message in the body of the HTTP query will be returned.
HTTP Status Codes
Here are the possible HTTP status (error) codes returned by this Web service endpoint.
On error code and the specific error, a different message description can be issued (meaning a different error has been returned).
- Code: 200
- Message: OK
- Code: 400
- Message: Bad Request
- Message description: No resource URI to delete specified
- Message description: No dataset specified
- Message description: No Web service URI available
- Message description: Target Web service XYZ not registered to this Web Services Framework
- Message description: No access defined for this requester IP XYZ, dataset (XYZ) and Web service (XYZ)
- Message description: The target Web service (XYZ) needs create access and the requested user (XYZ) doesn't have this access for that dataset (XYZ)
- Message description: The target Web service (XYZ) needs read access and the requested user (XYZ) doesn't have this access for that dataset (XYZ)
- Message description: The target Web service (XYZ) needs update access and the requested user (XYZ) doesn't have this access for that dataset (XYZ)
- Message description: The target Web service (XYZ) needs delete access and the requested user (XYZ) doesn't have this access for that dataset (XYZ)
- Code: 406
- Message: Not Acceptable
- Message description: Unacceptable mime type requested
- Code: 500
- Message: Internal Error
