Skip to main content
NICE CXone Expert

We will be closed on Monday, May 27th in observance of Memorial Day

Expert Success Center

files/{fileid}/properties/{key}/info (GET)


Retrieve the metadata about an attachment property

  • REST Method: GET
  • 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)
contentcutoff int? Only show property content shorter than this number of bytes. Default: 2048

Return Codes

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

Message Format

Response is the standard property XML

<property name="{text}" href="{uri}" etag="{text}">
  <contents type="{text}" href="{uri}">{text}</contents>
  <user.modified id="{int}" href="{uri}">

Implementation Notes

  • The response XML will contain the contents text only for text based mimetypes with values less than 2048 chars in length. Otherwise the contents is available at the URI pointed to by property/contents/@href.
  • READ access to the file property's parent page is required to see file properties

C# Code Sample: Retrieve File Property Info

The following code authenticates and retrieves information about a file property named 'foo' .

Sample Code

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

Sample Response from executing Code

<property name="foo" href="http://devwiki/@api/deki/files/42/properties/foo/info" etag="4463.r1_ts2009-03-20T22:48:15Z">
  <contents type="text/plain; charset=utf-8" href="http://devwiki/@api/deki/files/42/properties/foo">My Value</contents>
  <user.modified id="1" href="http://devwiki/@api/deki/users/1">
  <change-description>initial value</change-description>

Curl Code Sample: Retrieve File Property Info

The following command retrieves information of property "foo" assigned to a file with file ID = 1:

Sample Code

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

Sample Response from executing Code

file ID = 71, property_key = iscopyright

Content-Type: application/xml

<property name="iscopyright" href="" etag="106.r2_ts2010-01-21T19:54:52Z">
  <contents type="text/plain" size="3" href="">yes</contents>
  <user.modified id="1" href="">
    <email hidden="true"/>

Implementation notes 

curl flags

Provides external user authentication. Note that if anonymous access is available and authentication is not forced, this flag may be omitted.
Outputs the HTTP response headers. Useful for debugging.

File Properties

To view a list of all properties assigned to a file, follow the instructions here.


  • Was this article helpful?