Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The message body contains a JSON object:

scope

The scope object. Note that if you use a document set or global search scope, you will receive an "available" = false result. In fact these scopes do not support files.

didThe document id. This must be a document within the scope.
localesNull or optional list of locales you want to get information for. If null then you get info for all the authorized locales in scope.
populateDepth

Null or optional depth of file structure to load:

  • Not specified (recommended): Depth is 100.
  • 0: Do not actually load any sub folders and thus includes just the basic information on the deliverable and the attachment root folder.

 

...

Code Block
{
  "did": 1865,
  "dsid": 367,
  "available": true,
  "name": "html.txt",
  "locales": {
    "en-US": {
      "locale": "en-US",
      "isSource": true,
      "canDocSet": false,
      "canDocDownload": true,
      "canDocPreview": true,
      "canAttSet": true,
      "dvrequired": false,
      "dvapproved": false,
      "document": {
        "folder": "doc:en-US",
        "name": "html.txt",
        "isdir": false,
        "exists": true,
        "readonly": true,
        "date": "2017-02-05T22:57:24.7403048Z",
        "size": 502,
        "scanned": true,
        "canPreview": false
      },
      "attachments": {
        "folder": "att:en-US\\html.txt_",
        "name": "",
        "isdir": true,
        "exists": true,
        "readonly": false,
        "date": "2017-04-05T07:53:11.3225939Z",
        "size": null,
        "scanned": true,
        "files": [
          {
            "folder": "att:en-US\\html.txt_",
            "name": "Html replace term.config",
            "isdir": false,
            "exists": true,
            "readonly": false,
            "date": "2017-02-06T14:51:48.9304819Z",
            "size": 11997,
            "scanned": true,
            "canPreview": false
          },
          {
            "folder": "att:en-US\\html.txt_",
            "name": "xyz.html",
            "isdir": false,
            "exists": true,
            "readonly": false,
            "date": "2017-04-03T15:06:34.2892225Z",
            "size": 11997,
            "scanned": true,
            "canPreview": true
          }
        ],
        "folders": [
          {
            "folder": "att:en-US\\html.txt_\\folder1",
            "name": "folder1",
            "isdir": true,
            "exists": true,
            "readonly": false,
            "date": "2017-04-05T07:53:02.523813Z",
            "size": null,
            "scanned": true,
            "files": [
              {
                "folder": "att:en-US\\html.txt_\\folder1",
                "name": "document.docx",
                "isdir": false,
                "exists": true,
                "readonly": false,
                "date": "2017-04-05T07:52:53.8390226Z",
                "size": 11997,
                "scanned": true,
                "canPreview": false
              }
            ],
            "folders": []
          }
        ]
      }
    },
    "zh-Hans": {
      "locale": "zh-Hans",
      "isSource": false,
      "canDocSet": true,
      "canDocDownload": true,
      "canDocPreview": true,
      "canAttSet": true,
      "dvrequired": false,
      "dvapproved": true,
      "document": {
        "folder": "doc:zh-Hans",
        "name": "html-out.txt",
        "isdir": false,
        "exists": false,
        "readonly": true,
        "date": null,
        "size": null,
        "scanned": true,
        "canPreview": false
      },
      "attachments": {
        "folder": "att:zh-Hans\\html.txt_",
        "name": "",
        "isdir": true,
        "exists": true,
        "readonly": false,
        "date": "2017-02-06T14:51:55.7070816Z",
        "size": null,
        "scanned": true,
        "files": [],
        "folders": [
          {
            "folder": "att:zh-Hans\\html.txt_\\NewFolder",
            "name": "NewFolder",
            "isdir": true,
            "exists": true,
            "readonly": false,
            "date": "2017-02-07T14:07:38.8219265Z",
            "size": null,
            "scanned": true,
            "files": [
              {
                "folder": "att:zh-Hans\\html.txt_\\NewFolder",
                "name": "NoBOMTest3.txt",
                "isdir": false,
                "exists": true,
                "readonly": false,
                "date": "2017-02-06T14:52:00.3383798Z",
                "size": 25,
                "scanned": true,
                "canPreview": false
              }
            ],
            "folders": []
          }
        ]
      }
    }
  },
  "previewers": {
    "MsgReader": {
      "enabled": true
    },
    "Browser": {
      "enabled": true
    },
    "CodeMirror": {
      "enabled": true
    },
    "Beebox": {
      "enabled": false
    },
    "MicrosoftLive": {
      "enabled": true
    },
    "Frontlab": {
      "enabled": false
    }
  },
  "previewersCanEnable": true,
  "encodings": [
    {
      "v": "UTF-8",
      "t": "UTF-8"
    },
    {
      "v": "UTF-16",
      "t": "UTF-16"
    },
    {
      "v": "ISO-8859-1",
      "t": "ISO-8859-1"
    },
    {
      "v": "WINDOWS-1252",
      "t": "WINDOWS-1252"
    },
    {
      "v": "US-ASCII",
      "t": "US-ASCII"
    },
    {
      "v": "MACINTOSH",
      "t": "MACINTOSH"
    },
    {
      "v": "IBM850",
      "t": "IBM850"
    },
    {
      "v": "ISO-8859-6",
      "t": "ISO-8859-6"
    },
    {
      "v": "WINDOWS-1256",
      "t": "WINDOWS-1256"
    },
    {
      "v": "X-MAC-ARABIC",
      "t": "X-MAC-ARABIC"
    },
    {
      "v": "ASMO-708",
      "t": "ASMO-708"
    },
    {
      "v": "DOS-720",
      "t": "DOS-720"
    },
    {
      "v": "ISO-8859-4",
      "t": "ISO-8859-4"
    },
    {
      "v": "WINDOWS-1257",
      "t": "WINDOWS-1257"
    },
    {
      "v": "IBM775",
      "t": "IBM775"
    },
    {
      "v": "IBM500",
      "t": "IBM500"
    },
    {
      "v": "ISO-8859-2",
      "t": "ISO-8859-2"
    },
    {
      "v": "WINDOWS-1250",
      "t": "WINDOWS-1250"
    },
    {
      "v": "IBM852",
      "t": "IBM852"
    },
    {
      "v": "X-MAC-CE",
      "t": "X-MAC-CE"
    },
    {
      "v": "EUC-CN",
      "t": "EUC-CN"
    },
    {
      "v": "GB2312",
      "t": "GB2312"
    },
    {
      "v": "HZ-GB-2312",
      "t": "HZ-GB-2312"
    },
    {
      "v": "X-MAC-CHINESESIMP",
      "t": "X-MAC-CHINESESIMP"
    },
    {
      "v": "BIG5",
      "t": "BIG5"
    },
    {
      "v": "X-CHINESE-CNS",
      "t": "X-CHINESE-CNS"
    },
    {
      "v": "X-CHINESE-ETEN",
      "t": "X-CHINESE-ETEN"
    },
    {
      "v": "X-MAC-CHINESETRAD",
      "t": "X-MAC-CHINESETRAD"
    },
    {
      "v": "ISO-8859-5",
      "t": "ISO-8859-5"
    },
    {
      "v": "ISO-8859-9",
      "t": "ISO-8859-9"
    },
    {
      "v": "WINDOWS-1251",
      "t": "WINDOWS-1251"
    },
    {
      "v": "KOI8-R",
      "t": "KOI8-R"
    },
    {
      "v": "KOI8-U",
      "t": "KOI8-U"
    },
    {
      "v": "X-MAC-CYRILLIC",
      "t": "X-MAC-CYRILLIC"
    },
    {
      "v": "ISO-8859-7",
      "t": "ISO-8859-7"
    },
    {
      "v": "WINDOWS-1253",
      "t": "WINDOWS-1253"
    },
    {
      "v": "IBM737",
      "t": "IBM737"
    },
    {
      "v": "IBM869",
      "t": "IBM869"
    },
    {
      "v": "X-MAC-GREEK",
      "t": "X-MAC-GREEK"
    },
    {
      "v": "ISO-8859-8",
      "t": "ISO-8859-8"
    },
    {
      "v": "ISO-8859-8-I",
      "t": "ISO-8859-8-I"
    },
    {
      "v": "X-MAC-HEBREW",
      "t": "X-MAC-HEBREW"
    },
    {
      "v": "DOS-862",
      "t": "DOS-862"
    },
    {
      "v": "IBM861",
      "t": "IBM861"
    },
    {
      "v": "X-MAC-ICELANDIC",
      "t": "X-MAC-ICELANDIC"
    },
    {
      "v": "EUC-JP",
      "t": "EUC-JP"
    },
    {
      "v": "ISO-2022-JP",
      "t": "ISO-2022-JP"
    },
    {
      "v": "SHIFT_JIS",
      "t": "SHIFT_JIS"
    },
    {
      "v": "CSISO2022JP",
      "t": "CSISO2022JP"
    },
    {
      "v": "X-MAC-JAPANESE",
      "t": "X-MAC-JAPANESE"
    },
    {
      "v": "KS_C_5601-1987",
      "t": "KS_C_5601-1987"
    },
    {
      "v": "EUC-KR",
      "t": "EUC-KR"
    },
    {
      "v": "ISO-2022-KR",
      "t": "ISO-2022-KR"
    },
    {
      "v": "JOHAB",
      "t": "JOHAB"
    },
    {
      "v": "X-MAC-KOREAN",
      "t": "X-MAC-KOREAN"
    },
    {
      "v": "ISO-8859-3",
      "t": "ISO-8859-3"
    },
    {
      "v": "ISO-8859-15",
      "t": "ISO-8859-15"
    },
    {
      "v": "WINDOWS-874",
      "t": "WINDOWS-874"
    },
    {
      "v": "WINDOWS-1254",
      "t": "WINDOWS-1254"
    },
    {
      "v": "IBM857",
      "t": "IBM857"
    },
    {
      "v": "WINDOWS-1258",
      "t": "WINDOWS-1258"
    }
  ]
}

 

 

 

{  "did": 1865,  "dsid": 367,  "available": true,  "name": "html.txt",  "locales": {    "en-US": {      "locale": "en-US",      "isSource": true,      "canDocSet": false,      "canDocDownload": true,      "canDocPreview": true,      "canAttSet": true,      "dvrequired": false,      "dvapproved": false,      "document": {        "folder": "doc:en-US",        "name": "html.txt",        "isdir": false,        "exists": true,        "readonly": true,        "date": "2017-02-05T22:57:24.7403048Z",        "size": 502,        "scanned": true,        "canPreview": false      },      "attachments": {        "folder": "att:en-US\\html.txt_",        "name": "",        "isdir": true,        "exists": true,        "readonly": false,        "date": "2017-04-04T09:25:15.4282486Z",        "size": null,        "scanned": true,        "files": [          {            "folder": "att:en-US\\html.txt_",            "name": "Html replace term.config",            "isdir": false,            "exists": true,            "readonly": false,            "date": "2017-02-06T14:51:48.9304819Z",            "size": 11997,            "scanned": true,            "canPreview": false          },          {            "folder": "att:en-US\\html.txt_",            "name": "stephan1.zip",            "isdir": false,            "exists": true,            "readonly": false,            "date": "2017-02-16T09:21:42.0299691Z",            "size": 5368,            "scanned": true,            "canPreview": false          },          {            "folder": "att:en-US\\html.txt_",            "name": "xyz.html",            "isdir": false,            "exists": true,            "readonly": false,            "date": "2017-04-03T15:06:34.2892225Z",            "size": 11997,            "scanned": true,            "canPreview": true          }        ],        "folders": [          {            "folder": "att:en-US\\html.txt_\\folder1",            "name": "folder1",            "isdir": true,            "exists": true,            "readonly": false,            "date": "2017-02-16T09:21:19.2557227Z",            "size": null,            "scanned": true,            "files": [              {                "folder": "att:en-US\\html.txt_\\folder1",                "name": "Html replace term.config",                "isdir": false,                "exists": true,                "readonly": false,                "date": "2017-02-16T09:21:19.2557227Z",                "size": 11997,                "scanned": true,                "canPreview": false              }            ],            "folders": [              {                "folder": "att:en-US\\html.txt_\\folder1\\sub",                "name": "sub",                "isdir": true,                "exists": true,                "readonly": false,                "date": "2017-02-15T07:55:17.4403201Z",                "size": null,                "scanned": true,                "files": [                  {                    "folder": "att:en-US\\html.txt_\\folder1\\sub",                    "name": "sub.config",                    "isdir": false,                    "exists": true,                    "readonly": false,                    "date": "2017-02-15T07:55:15.089319Z",                    "size": 11997,                    "scanned": true,                    "canPreview": false                  }                ],                "folders": []              }            ]          },          {            "folder": "att:en-US\\html.txt_\\folder2",            "name": "folder2",            "isdir": true,            "exists": true,            "readonly": false,            "date": "2017-02-15T07:55:02.8362808Z",            "size": null,            "scanned": true,            "files": [],            "folders": []          },          {            "folder": "att:en-US\\html.txt_\\stephan1",            "name": "stephan1",            "isdir": true,            "exists": true,            "readonly": false,            "date": "2017-02-16T09:22:50.1502032Z",            "size": null,            "scanned": true,            "files": [              {                "folder": "att:en-US\\html.txt_\\stephan1",                "name": "Html replace term.config",                "isdir": false,                "exists": true,                "readonly": false,                "date": "2017-02-16T09:22:50.1492033Z",                "size": 11997,                "scanned": true,                "canPreview": false              }            ],            "folders": [              {                "folder": "att:en-US\\html.txt_\\stephan1\\folder1",                "name": "folder1",                "isdir": true,                "exists": true,                "readonly": false,                "date": "2017-02-16T09:22:50.1462008Z",                "size": null,                "scanned": true,                "files": [                  {                    "folder": "att:en-US\\html.txt_\\stephan1\\folder1",                    "name": "Html replace term.config",                    "isdir": false,                    "exists": true,                    "readonly": false,                    "date": "2017-02-16T09:22:50.1151703Z",                    "size": 11997,                    "scanned": true,                    "canPreview": false                  }                ],                "folders": [                  {                    "folder": "att:en-US\\html.txt_\\stephan1\\folder1\\sub",                    "name": "sub",                    "isdir": true,                    "exists": true,                    "readonly": false,                    "date": "2017-02-16T09:22:50.1482022Z",                    "size": null,                    "scanned": true,                    "files": [                      {                        "folder": "att:en-US\\html.txt_\\stephan1\\folder1\\sub",                        "name": "sub.config",                        "isdir": false,                        "exists": true,                        "readonly": false,                        "date": "2017-02-16T09:22:50.1462008Z",                        "size": 11997,                        "scanned": true,                        "canPreview": false                      }                    ],                    "folders": []                  }                ]              }            ]          }        ]      }    },    "zh-Hans": {      "locale": "zh-Hans",      "isSource": false,      "canDocSet": true,      "canDocDownload": true,      "canDocPreview": true,      "canAttSet": true,      "dvrequired": false,      "dvapproved": true,      "document": {        "folder": "doc:zh-Hans",        "name": "html-out.txt",        "isdir": false,        "exists": false,        "readonly": true,        "date": null,        "size": null,        "scanned": true,        "canPreview": false      },      "attachments": {        "folder": "att:zh-Hans\\html.txt_",        "name": "",        "isdir": true,        "exists": true,        "readonly": false,        "date": "2017-02-06T14:51:55.7070816Z",        "size": null,        "scanned": true,        "files": [],        "folders": [          {            "folder": "att:zh-Hans\\html.txt_\\NewFolder",            "name": "NewFolder",            "isdir": true,            "exists": true,            "readonly": false,            "date": "2017-02-07T14:07:38.8219265Z",            "size": null,            "scanned": true,            "files": [              {                "folder": "att:zh-Hans\\html.txt_\\NewFolder",                "name": "NoBOMTest3.txt",                "isdir": false,                "exists": true,                "readonly": false,                "date": "2017-02-06T14:52:00.3383798Z",                "size": 25,                "scanned": true,                "canPreview": false              }            ],            "folders": []          }        ]      }    }  },  "previewers": {    "MsgReader": {      "enabled": true    },    "Browser": {      "enabled": true    },    "CodeMirror": {      "enabled": true    },    "Beebox": {      "enabled": false    },    "MicrosoftLive": {      "enabled": true    },    "Frontlab": {      "enabled": false    }  },  "previewersCanEnable": true,  "encodings": [    {      "v": "UTF-8",      "t": "UTF-8"    },    {      "v": "UTF-16",      "t": "UTF-16"    },    {      "v": "ISO-8859-1",      "t": "ISO-8859-1"    },    {      "v": "WINDOWS-1252",      "t": "WINDOWS-1252"    },    {      "v": "US-ASCII",      "t": "US-ASCII"    },    {      "v": "MACINTOSH",      "t": "MACINTOSH"    },    {      "v": "IBM850",      "t": "IBM850"    },    {      "v": "ISO-8859-6",      "t": "ISO-8859-6"    },    {      "v": "WINDOWS-1256",      "t": "WINDOWS-1256"    },    {      "v": "X-MAC-ARABIC",      "t": "X-MAC-ARABIC"    },    {      "v": "ASMO-708",      "t": "ASMO-708"    },    {      "v": "DOS-720",      "t": "DOS-720"    },    {      "v": "ISO-8859-4",      "t": "ISO-8859-4"    },    {      "v": "WINDOWS-1257",      "t": "WINDOWS-1257"    },    {      "v": "IBM775",      "t": "IBM775"    },    {      "v": "IBM500",      "t": "IBM500"    },    {      "v": "ISO-8859-2",      "t": "ISO-8859-2"    },    {      "v": "WINDOWS-1250",      "t": "WINDOWS-1250"    },    {      "v": "IBM852",      "t": "IBM852"    },    {      "v": "X-MAC-CE",      "t": "X-MAC-CE"    },    {      "v": "EUC-CN",      "t": "EUC-CN"    },    {      "v": "GB2312",      "t": "GB2312"    },    {      "v": "HZ-GB-2312",      "t": "HZ-GB-2312"    },    {      "v": "X-MAC-CHINESESIMP",      "t": "X-MAC-CHINESESIMP"    },    {      "v": "BIG5",      "t": "BIG5"    },    {      "v": "X-CHINESE-CNS",      "t": "X-CHINESE-CNS"    },    {      "v": "X-CHINESE-ETEN",      "t": "X-CHINESE-ETEN"    },    {      "v": "X-MAC-CHINESETRAD",      "t": "X-MAC-CHINESETRAD"    },    {      "v": "ISO-8859-5",      "t": "ISO-8859-5"    },    {      "v": "ISO-8859-9",      "t": "ISO-8859-9"    },    {      "v": "WINDOWS-1251",      "t": "WINDOWS-1251"    },    {      "v": "KOI8-R",      "t": "KOI8-R"    },    {      "v": "KOI8-U",      "t": "KOI8-U"    },    {      "v": "X-MAC-CYRILLIC",      "t": "X-MAC-CYRILLIC"    },    {      "v": "ISO-8859-7",      "t": "ISO-8859-7"    },    {      "v": "WINDOWS-1253",      "t": "WINDOWS-1253"    },    {      "v": "IBM737",      "t": "IBM737"    },    {      "v": "IBM869",      "t": "IBM869"    },    {      "v": "X-MAC-GREEK",      "t": "X-MAC-GREEK"    },    {      "v": "ISO-8859-8",      "t": "ISO-8859-8"    },    {      "v": "ISO-8859-8-I",      "t": "ISO-8859-8-I"    },    {      "v": "X-MAC-HEBREW",      "t": "X-MAC-HEBREW"    },    {      "v": "DOS-862",      "t": "DOS-862"    },    {      "v": "IBM861",      "t": "IBM861"    },    {      "v": "X-MAC-ICELANDIC",      "t": "X-MAC-ICELANDIC"    },    {      "v": "EUC-JP",      "t": "EUC-JP"    },    {      "v": "ISO-2022-JP",      "t": "ISO-2022-JP"    },    {      "v": "SHIFT_JIS",      "t": "SHIFT_JIS"    },    {      "v": "CSISO2022JP",      "t": "CSISO2022JP"    },    {      "v": "X-MAC-JAPANESE",      "t": "X-MAC-JAPANESE"    },    {      "v": "KS_C_5601-1987",      "t": "KS_C_5601-1987"    },    {      "v": "EUC-KR",      "t": "EUC-KR"    },    {      "v": "ISO-2022-KR",      "t": "ISO-2022-KR"    },    {      "v": "JOHAB",      "t": "JOHAB"    },    {      "v": "X-MAC-KOREAN",      "t": "X-MAC-KOREAN"    },    {      "v": "ISO-8859-3",      "t": "ISO-8859-3"    },    {      "v": "ISO-8859-15",      "t": "ISO-8859-15"    },    {      "v": "WINDOWS-874",      "t": "WINDOWS-874"    },    {      "v": "WINDOWS-1254",      "t": "WINDOWS-1254"    },    {      "v": "IBM857",      "t": "IBM857"    },    {      "v": "WINDOWS-1258",      "t": "WINDOWS-1258"    }  ]}