1 Options for Insert, Update, Delete, Move, Copy, Typing
- 1.1 General Information
- 1.2 Usage
2 Options for Searching

Options for Insert, Update, Delete, Move, Copy, Typing

General Information

Beginning with version 5.0.0, it is possible to send almost all enaio® server job options for Insert, Update, Delete, Move, Copy and Typing of DMS Objects. The server job options are well documented in the Server-API manual (Search for one of the key words listed below). The DMS service for enaio® will not support the following server job options:

APPENDFILESTOFRONT
COPYCREATEHISTORY
DELETEVARIANTMODE
CHECKACCESS

The first three may be enabled upon request in the future, while the last one is disabled for security reasons. We do not want to Insert, Update, Delete, Move and Copy without checking the rights system. This would be a potential security issue.

The usage of certain options that disable checks in the server is not recomended. This could result in inconsistencies in the object definition and is not possible to store them in enaio® clients once they are being edited. The person editting in enaio® client may then be forced to correct the values, but will not be able to save them. Editing may not even be if the field is read-only. Therefore options must be used with care.

Usage

To use the server job options for Insert, Update, Delete, Move and Copy, you can easily add them to the DMS Object payload:

{
    "objects": [{
        "properties": {
            "system:objectTypeId": {
                "value": "262208"
            },
            "from": {
                "value": "Garco Meissler <garco@example.de>"
            },
            "to": {
                "value": "Dudreas Annkel <dudreas@example.de>"
            },
            "cc": {
                "value": "Kruedeas Anger <kruedeas@example.de>"
            },
            "subject": {
                "value": "Bewerbungsunterlagen"
            }
        },
        "contentStreams": [{
            "mimeType": "message/rfc822",
            "fileName": "upload.eml",
            "cid": "cid_63apple"
        }],
		"options": {
			"ARCHIVABLE": 1,
			"ARCHIVEIMMEDIATELY": 1
		}
    }]
}

The options part is a map whose key is a String and equal to one of the documented options of enaio® server. The values must be an Integer with the value 1 or 0.
Other values than 1 or 0 are not allowed and will result in an error message. Not all enaio® server job options are allowed for all operations. Please refer to the enaio® serverapi documentation for information which enaio® server job options you can use for a particular operation such as updating a DMS object.

Options for Searching

Beginning with version 5.4.0, it is possible to send almost all enaio® server job options for GetResultList. The server job options are well documented in the enaio® server-api documentation (search for the GetResultList server job). In the following table, all supported options are listed with a short description. A full description can be found in the Server-API. The server jobs can be set in the options section as shown in the code example above:

Option	Possible Values	Default Value	Description

Option	Possible Values	Default Value	Description
`Rights`	1	0	Information on rights is added for each object in the result.
`ObjectInserts`	1	0	Insertable object types with their limit will be added for folders and registers.
`RegisterContext`	0	1	If conditions on registers are present, only objects inside registers are returned.
`Baseparams`	1	0	Some system fields will be added to the result for each object.
`FileInfo`	1	0	Content information for objects will be added to the result for each object.
`FollowDocLink`	1	0	Content information for reference documents will be added from their original documents. Only if `FileInfo` is also set to 1.
`Variants`	1	0	The variant tree for each document object is returned. Not supported at the moment. Variants can be fetched only for one object.
`Status`	1	0	Status information will be added to the result for each object.
`AutoStar`	1, 2, 3	0	0 = no auto star will be added for text conditions 1 = an auto star will be added at the beginning of the string for text conditions. 2 = an auto star will be added at the end of a string for text conditions. 3 = an auto star will be added at the beginning and end of a string for text conditions.
`DisableSearchGroups`	1	0	Search groups will be taken into account.
`GarbageMode`	1	0	Only objects from the recycle bin are included in the result.
`IncludeNullValues`	0,1	1	Minimum Version 6.3.0. If a search like SELECT FROM <ObjectType> WHERE <field> <> "MyValue"* is executed, the result also contains objects which have no value in the specified condition field. The DMS Microservice create a OR condition with NULL to the given not equal condition. If this option is send with the value integer zero this OR condition is not made and objects with an empty value in the condition field are not returned in the result.

Please note that each activated option will slow down the query. Only set those options which are really necessary.

Beginning with version 6.0.0, it is possible to also send the following options in a search request:

Option	Possible Values	Default Value	Description

Option	Possible Values	Default Value	Description
`ExportDepth`	>0	0	With a numeric value greater than 0, children of the queried folder and register objects are added until the depth is reached.
`Icons`	1	0	The object icon based on the icon catalog in the index data is returned as `system:ICON_ID` in the result.
`SystemFields`	Array	Null	An array of system fields to query or a "*" as first array element for all system fields. For detailed explaination see Search-Endpoint.

1.5 Options for Endpoints

Options for Insert, Update, Delete, Move, Copy, Typing

General Information

Usage

Options for Searching