Skip to main content
NICE CXone Expert

Scheduled CxOne Expert Maintenance - Oct 26th 11:59 pm PT - Learn More

Expert Success Center

files/{fileid}/properties/{key} (DELETE)

Overview

Remove an attachment property

  • REST Method: DELETE
  • Method Access: public

Uri Parameters

Name Type Description
key string A unique identifier for a property that is obtained through GET:files/{fileid}/properties
fileid int identifies a file by ID

Query Parameters

Name Type Description
redirects int? If zero, do not follow page redirects.
authenticate bool? Force authentication for request (default: false)

Return Codes

Name Value Description
OK 200 The request completed successfully
Bad Request 400 Invalid input parameter or request body
Forbidden 403 UPDATE access is required
Not Found 404 Requested file and/or property could not be found

Implementation Notes

  • UPDATE right to the attachment's page is required for deleting a property
  • A current eTag is not required for deleting a property

C# Code Sample: Delete an Attachment Property

The following code authenticates and deletes a file property named 'foo'.

Sample Code


Plug p = Plug.New("http://devwiki/@api/deki"); 
p.At("users", "authenticate")
 .WithCredentials("sysop", "password").Get(); 
p.At("files", "42", "properties", "foo")
 .Delete();

Implementation notes 

Add notes about requirements or config values

Curl Code Sample: Delete an Attachment Property

The following command deletes file property "foo" from a file (file ID = 1):

Sample Code

curl -u username:password -X DELETE -i http://mindtouch.address/@api/deki/files/1/properties/foo

Implementation notes 

curl flags

-u
Provides external user authentication.
-X
Specifies the HTTP request method.
-i
Outputs the HTTP response headers. Useful for debugging.

 

  • Was this article helpful?