Base class for file objects.
name | data type | description |
---|---|---|
id | string | The ID of the file. |
creation | HistoryStamp | The date and time when the file was created. |
modification | HistoryStamp | The datae and time when the file was last modified. |
length | number | The file size in bytes. |
md5 | string | MD5 checksum. |
version_number | number | File version number. This is incremented each time the file is modified. |
Properties inherited from SearchableObject |
||
doc_type | string | The indexed document type. Possible values are:
|
Properties inherited from BaseRestObject |
||
href | string | The path to this resource object. This is relative to the root of the REST API (https://serveraddress/rest). |
links | array of Link | Links to related resources. These should be used to navigate the REST API (instead of hard-coding the URLs) |
Example
{ "id" : "...", "creation" : { "principal" : { "id" : 12345, "href" : "..." }, "date" : 12345 }, "modification" : { "principal" : { "id" : 12345, "href" : "..." }, "date" : 12345 }, "length" : 12345, "md5" : "...", "version_number" : 12345, "doc_type" : "...", "href" : "...", "links" : [ { "href" : "...", "rel" : "..." }, { "href" : "...", "rel" : "..." } ] }