Deleting a file and its metadata
Added by IBM contributorIBM | Edited by IBM contributorElizabeth Bowling on November 9, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Delete a file and the Atom document representation of its associated metadata from your collection.

Only the owner of a collection can delete a file from the collection.

Note: {document-id} is the value of the <td:uuid> or <td:label> elements in the file's Atom entry document.

You can use this input header in a POST request instead of using the DELETE request.


This method requires authentication. In order to delete a document, the currently authenticated user must be owner of the user library containing the document or an administrator. 

Method URI Description
DELETE /files/{auth}/api/myuserlibrary/document/{document-id}/entry You can determine the URI in either of the following ways:
Value of the href attribute of the <link rel="edit"> element in the file's Document Atom entries.
Construct the URI using the following syntax: /{auth}/api/myuserlibrary/document/{document-id}/entry
Only the owner of a collection can delete a file from the collection.
DELETE /files/{auth}/api/library/{library-id}/document/{document-id}/entry Delete the specified document in the specified library.
DELETE /files/{auth}/api/userlibrary/{user-id}/document/{document-id}/entry Delete the specified document in the user's library.
DELETE /files/{auth}/api/document/{document-id}/entry Delete the file specified by its unique id.
Name Type Optional Description
string No {document-id} is the value of the <td:uuid> or <td:label> elements in the file's Atom entry document.
enumerated No The authorization protocol being used by your application to access Connections Cloud.
Authorized values:
  • basic
  • oauth
Name Type Optional Description
enumerated Yes If true, the resource will be permanently deleted from the repository.
Default value is false.
Authorized values:
  • true
  • false
enumerated Yes If true, all child responses will be deleted.
Authorized values:
  • true
  • false
Name Type Optional Description
string Yes Tunnels a DELETE request over HTTP POST
string Yes String. Represents a unique data string generated by the server upon request that you can provide to secure the request. See Getting a nonce key for information about how to request the data string.
enumerated No The authentication mechanism selected by your application to access the API.
Basic is the Base64 encoding of the IBM Connections Cloud username and password: Base64(username:password). For example, Base64(
Bearer is the oauth 2.0 access token that is generated when the user grants your application access to IBM Connections Cloud services.
See the reference topic "OAuth 2.0 APIs for web server flow" for more information.
Authorized values:
  • bearer
  • basic
Code Description
Indicates that the file metadata was successfully deleted.
Not Found.
DELETE /dm/atom/library/6184350042fa52689d98fd6fdda5b8d8/document/338b740042fa61c89da3fd6fdda5b8d8/entry HTTP/1.1

Response returned by the server
200 OK
DELETE /files/basic/api/library/5d06ab0044ed8129bd5ebd4caeec5df1/document/5d06ab0044ed8129bd5ebd4caeec6789/entry HTTP/1.1
User-Agent: Thingio/1.0

Response returned by the server
HTTP/1.1 204 No Content
Date: Tue, 02 Feb 2010 07:00:48 GMT
Server: IBM_HTTP_Server
Cache-Control: private,must-revalidate,max-age=0
X-LConn-Auth: true
Content-Length: 0
Keep-Alive: timeout=10, max=99
Connection: Keep-Alive
Content-Type: text/plain
Content-Language: en-US