Skip to main content
NICE CXone Expert
Expert Success Center

files/{fileid}/description (GET)


retrieves a file description

  • REST Method: GET
  • Method Access: public

Uri Parameters

Name Type Description
pageid string either an integer page ID, "home", or "=" followed by a double uri-encoded page title
fileid int identifies a file by ID
filename string Double uri-encoded file name. Should be prefixed with "=" if it does not have an extension.

Query Parameters

Name Type Description
redirects int? If zero, do not follow page redirects (only applies when {pageid} is present).
authenticate bool? Force authentication for request (default: false)
revision string? File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revision

Return Codes

Name Value Description
OK 200 The request completed successfully
Bad Request 400 Invalid input parameter or request body
Forbidden 403 Read access to the page is required
Not Found 404 Requested file could not be found

Message Format


Implementation Notes

Use PUT:files/{fileid}/description to set the file description.

C# Code Sample: Retrieve File Description

The following code example retrieves the description of the file with ID 456:

Sample Code

Plug p = Plug.New("http://deki-hayes/@api/deki");
p.At("users", "authenticate").WithCredentials("admin", "password").Get();
DreamMessage msg = p.At("files", "456", "description").Get();
String description = msg.AsText();

Implementation notes 

Add notes about requirements or config values

Curl Code Sample: Retrieve File Description

The following command retrieves the description of a file with file ID = 1:

Sample Code

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

Sample Response from executing Code

File with file ID = 71 has description string set to "Problem?"

Content-Type: text/plain


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.


To view a list of all files, follow the instructions here.
  • Was this article helpful?