DAV Interface Configuration
The DAV interface supports a defined set of actions. This action must be set in the interface script.
Actions
The list actions below are currently supported in the DAV interface. Various system objects are delivered containing those actions, but you can create your own objects to read specific dossiers of a serie, retrieve specific properties,...
Dossier
Supported actions related to a dossier.
| Action | Description | E-Depot API Reference |
|---|---|---|
| CreateDossier | Creates a new dossier. | Creating a dossier |
| ValidateDossier | Validates the dossier. Checks if all required field are filled correctly. | Validating a dossier |
| SubmitDossier | Submits the dossier. This is the final commit to successfully create a dossier. | Submitting a dossier |
| UpdateDossier | Updates the properties (partially) of a single dossier. Some values cannot be cleared because this is a partial update. A dossier can only be updated when in status 'Draft.Valid', 'Draft.Invalid' or in status 'Published'. Only specific properties can be updated when in status 'Published'. | Updating a dossier |
| GetDossier | Retrieves a single dossier by its ID. | Getting a dossier |
| GetDossiers | Retrieves a list of dossiers. Refer to the E-Depot documentation to see a list of input filters. The max page size is 50, make sure the view page size isn't more. | Listing dossiers |
| EnsureDossier | Creates a new dossier if it does not exist. If a dossier with the given ID already exists it is updated. | Creating a dossier |
Document
Supported actions related to a dossier. Those are used in a system object and cannot be modified.
| Action | Description | E-Depot API Reference |
|---|---|---|
| CreateDocument | Creates the given document in the dossier. When document properties are given as input the properties are also updated. | Creating a document |
| UpdateDocument | Updates the document (partially) of a dossier in DAV. Some values cannot be cleared because this is a partial update. A document can only be updated when in status 'Draft.Valid', 'Draft.Invalid' or in status 'Published'. Only specific properties can be updated when in status 'Published'. | Updating a document |
| GetDocuments | Retrieves documents of the given dossier. | Listing documents |
Series
Supported actions related to a series. Those are used in a system object and cannot be modified.
| Action | Description | E-Depot API Reference |
|---|---|---|
| GetSeries | Retrieves a list of all series. Results can be filtered by name. | Listing series |
| GetExtensionsOfSerie | Retrieves a list of extensions of the series. An extensions is a collection of extra attributes. Results can be filtered by the record type(s). | Getting the extensions of a series |
| GetAllAttributesOfSerie | Retrieves a list of all attributes of the given extensions of the given serie. The default dossier fields are also retrieved. | Getting the extensions of a series |
| GetAttributesOfExtension | Retrieves a list of attributes (fields) of the given extension. | Getting the extensions of a series |
| GetValuesOfEnumAttribute | Retrieves the possible values of an enum attribute (field). | Getting the extensions of a series |
Field Mapping
The interface sends requests to a HTTP-based RESTful API, the input and output fields are mapped to the JSON objects or request parameters.
Input Fields
URL parameters or a JSON object can be set by configuring an input field on the method. The external name of the field must match the name of the URL parameter and JSON property.
A JSON property in an object can be set by separating with a dot, for example: Object.Name
Output Fields
A JSON object can be returned as output. To link the output fields to property of the JSON object the external name must be set to the property name. A property in an object can be mapped by separating with a dot.