Skip to content

Latest commit

 

History

History
114 lines (78 loc) · 2.56 KB

DELETE_Link.rst

File metadata and controls

114 lines (78 loc) · 2.56 KB
Raw

DELETE Link

Description

The implementation of the DELETE operation deletes the link named in the URI.

Groups, datatypes, and datasets that are referenced by the link will not be deleted. To delete groups, datatypes or datasets, use the appropriate DELETE operation for those objects.

Requests

Syntax

DELETE /groups/<id>/links/<name> HTTP/1.1
X-Hdf-domain: DOMAIN
Authorization: <authorization_string>
DELETE /groups/<id>/links/<name>?domain=DOMAIN HTTP/1.1
Authorization: <authorization_string>
  • <id> is the UUID of the group the link is a member of.
  • <name> is the URL-encoded name of the link.

Request Parameters

This implementation of the operation does not use request parameters.

Request Headers

This implementation of the operation uses only the request headers that are common to most requests. See ../CommonRequestHeaders

Responses

Response Headers

This implementation of the operation uses only response headers that are common to most responses. See ../CommonResponseHeaders.

Response Elements

On success, a JSON response will be returned with the following elements:

hrefs

An array of links to related resources. See ../Hypermedia.

Special Errors

An attempt to delete the root group will return 403 - Forbidden. For general information on standard error codes, see ../CommonErrorResponses.

Examples

Sample Request

DELETE /groups/g-b116b6f0-85e9-11e8-9cc2-0242ac120008/links/deleteme HTTP/1.1
Host: hsdshdflab.hdfgroup.org
X-Hdf-domain: /shared/tall.h5
Content-Length: 0
Accept: */*
Accept-Encoding: gzip, deflate

Sample cURL command

$ curl -X DELETE -u username:password --header "X-Hdf-domain: /shared/tall.h5" hsdshdflab.hdfgroup.org/groups/g-b116b6f0-85e9-11e8-9cc2-0242ac120008/links/deleteme

Sample Response

HTTP/1.1 200 OK
Date: Thu, 12 Jul 2018 19:45:54 GMT
Content-Length: 12
Content-Type: application/json
Server: nginx/1.15.0
{"href": []}

Related Resources

  • ../DatasetOps/DELETE_Dataset
  • ../DatatypeOps/DELETE_Datatype
  • DELETE_Group
  • GET_Link
  • GET_Groups
  • POST_Group