Please enable JavaScript to view this site.

HsM Reference Manual

The Client Service supports storing documents with device-types in the context of a reseller customer.

Table 30 shows the attributes stored with a document.

Attribute

Description

ID

Integer, mandatory.

A unique ID of the document assigned by the Client Service.

File size

Integer, mandatory.

Size of the file in the document in bytes, detected and set by the Client Service.

MIME type

MIME type string as defined in RFC6838

The MIME type of the file detected by the Client Service

Created at

Date-time, mandatory

The date when the document was crated on the Client Service

Last modified at

Date-time, mandatory

The date and time when the document's data was last modified.

File name

String, mandatory

Max Length 100

The file name provided on creation of the document. The file name length must be greater or equal 1 and less or equal 100 characters.

The file name must not include any invalid file name characters.

File last modified at

Date time, mandatory

Date and time when the file was last modified. This information is provided on document creation, by the uploading client.

Title

String, mandatory.

Max length 100

The title of the document. If the title is not given it will be set to the file name, trimmed to 100 characters.

Description

String, optional

Max Length 1000

Additional description of the document

Restricted access

Boolean, mandatory, default False

This flag is used in the logic to determine if a document stored for a specific entity can be viewed or edited by a specific user.

Content language

ISO 2 letter language code, optional, default null.

The locale of the content of the file. If not set the document's locale is unknown.

Table 30: Attributes of a document