Skip to main content
NICE CXone Expert

We will be updating our infrastructure on Dec 2, 2023. Sites will be down starting at 8pm Pacific time. This may last up to 3 hours.

Expert Success Center

archive/files (GET)

Overview

Retrieves file info for all deleted files

  • REST Method: GET
  • Method Access: public

Query Parameters

Name Type Description
offset number? The number files that we want to skip before we return them
authenticate bool? Force authentication for request (default: false)
limit number? The maximum number of files returned

Return Codes

Name Value Description
OK 200 The request completed successfully
Forbidden 403 Administrator access is required

Message Format

Output:

<files.archive>
    <file.archive id="{int}" href="{uri}">
        <filename>{text}</filename> 
        <description>{text}</description> 
        <contents type="{mimetype}" size="{int}" width="{int}" height="{int}" href="{uri}" /> 
        <contents.preview rel="thumb" type="{mimetype}" maxwidth="{int}" maxheight="{int}" href="{uri}" /> 
        <contents.preview rel="webview" type="{mimetype}" maxwidth="{int}" maxheight="{int}" href="{uri}" /> 
        <date.created>{date}</date.created> 
        <user.createdby id="{int}" href="{uri}">
            <nick>{text}</nick> 
            <username>{text}</username> 
            <email>{text}</email> 
        </user.createdby>
        <user.deletedby id="{int}" href="{uri}">
            <nick>{text}</nick> 
            <username>{text}</username> 
            <email>{text}</email> 
        </user.deletedby>
        <date.deleted>{date}</date.deleted> 
        <page.parent id="{int}" href="{uri}">
            <title>{text}</title> 
            <path>{text}</path> 
        </page.parent>
    </file.archive>
    ...
</files.archive>

Implementation Notes

When a file is deleted, it is moved into the archive. It will remain in the archive until it is either permanently deleted (DELETE:archive/files/{fileid}) or restored (POST:archive/files/restore/{fileid}).  While a file is in the archive, it cannot be modified.

C# Code Sample: Retrieve File Archive

The following code example retrieves a list of files in the archive:

Sample Code

Plug p = Plug.New("http://help.mindtouch.us/@api/deki");
p.At("users", "authenticate").WithCredentials("admin", "password").Get();
p.At("archive", "files").Get();

Sample Response from executing Code

<files.archive>
    <file.archive id="456" href="http://help.mindtouch.us/@api/deki/archive/files/456/info">
        <filename>myfile.jpg</filename> 
        <description /> 
        <contents type="image/pjpeg" size="53112" width="476" height="480" href="http://help.mindtouch.us/@api/deki/archive/files/456" /> 
        <contents.preview rel="thumb" type="image/pjpeg" maxwidth="160" maxheight="160" href="http://help.mindtouch.us/@api/deki/archive/files/456?size=thumb" /> 
        <contents.preview rel="webview" type="image/pjpeg" maxwidth="550" maxheight="550" href="http://help.mindtouch.us/@api/deki/archive/files/456?size=webview" /> 
        <date.created>2007-08-24T20:44:02Z</date.created> 
        <user.createdby id="1" href="http://help.mindtouch.us/@api/deki/users/1">
            <nick>Admin</nick> 
            <username>Admin</username> 
            <email>admin@mindtouch.com</email> 
        </user.createdby>
        <user.deletedby id="1" href="http://help.mindtouch.us/@api/deki/users/1">
            <nick>Admin</nick> 
            <username>Admin</username> 
            <email>admin@mindtouch.com</email> 
        </user.deletedby>
        <date.deleted>2007-08-24T20:44:08Z</date.deleted> 
        <page.parent id="29" href="http://help.mindtouch.us/@api/deki/pages/29">
            <title>DekiWiki (Hayes)</title> 
            <path /> 
        </page.parent>
    </file.archive>
</files.archive>

Implementation notes 

Add notes about requirements or config values

Curl Code Sample: Retrieve File Archive

The following command retrieves information about all deleted files:

Sample Code

curl -u admin:password -i http://mindtouch.address/@api/deki/archive/files

Sample Response from executing Code

Sample response with 1 deleted file, birds.jpg, in the archive.

<files.archive count="1">
  <file.archive id="72" revision="2" href="http://192.168.59.128/@api/deki/archive/files/72/info">
    <filename>birds.jpg</filename>
    <description/>
    <contents type="image/jpeg" size="13303" href="http://192.168.59.128/@api/deki/archive/files/72/=birds.jpg"/>
    <date.created>2010-01-26T23:57:34Z</date.created>
    <user.createdby id="1" href="http://192.168.59.128/@api/deki/users/1">
      <nick>Admin</nick>
      <username>Admin</username>
      <email>admin@admin.com</email>
      <hash.email>64e1b8d34f425d19e1ee2ea7236d3028</hash.email>
      <uri.gravatar>http://www.gravatar.com/avatar/64e1b8d34f425d19e1ee2ea7236d3028</uri.gravatar>
    </user.createdby>
    <user.deletedby id="1" href="http://192.168.59.128/@api/deki/users/1">
      <nick>Admin</nick>
      <username>Admin</username>
      <email>admin@admin.com</email>
      <hash.email>64e1b8d34f425d19e1ee2ea7236d3028</hash.email>
      <uri.gravatar>http://www.gravatar.com/avatar/64e1b8d34f425d19e1ee2ea7236d3028</uri.gravatar>
    </user.deletedby>
    <date.deleted>2010-01-26T23:57:34Z</date.deleted>
    <user-action type="deleteflag"/>
    <page.parent id="571" href="http://192.168.59.128/@api/deki/pages/571?redirects=0">
      <uri.ui>http://192.168.59.128/Gotham</uri.ui>
      <title>Gotham</title>
      <path>Gotham</path>
      <namespace>main</namespace>
    </page.parent>
  </file.archive>
</files.archive>

Implementation notes 

curl flags

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

Permissions

ADMIN permission is required to execute above command.
  • Was this article helpful?