Skip to main content
Version: 2025.1

EntityWebservice

This page provides generated reference documentation for the EntityWebservice data model.

A webservice that can be provided within a context for the associated entity

Overview​

PropertySummary
commentProperty to store a developer comment in form of
descriptionDescription
documentationContains the documentation of the data model in the popular AsciiDoc format (.adoc). The documentation should be set by the developer to explain different…
formEnabledEnables the form api for this entity webservice
iconImage.
iconProcessSpecifies the icon dynamically. If the icon has no effect, neither will the result of the process.
jditoWebserviceUserThe title of the user under whose name the webservice is executed, this will affect both the user used for executing JDito and the evaluation of permissions.…
localeSpecifies the default locale settings (language) for the entity webservice
loginTypeIdAllows anonymous authentication for Web services.
readProviderProvider used to read the entities
restrictedRolesOnly users with the specified roles can run the WebService. If no roles are specified here, all of them are allowed to access this webservice
timezoneThe default timezone of the entity webservice
titleTitle (speaking name. may contain spaces and special characters.) This has different effects depending on the entity:
webserviceFieldsEntity fields that are made available in the web service
webserviceMethodsHTTP methods supported by the web service
writeProviderProvider used to write the entities

comment​

Type: String

Property to store a developer comment in form of

/**
*
*/

In the past this was used in customizing for frame controls additional settings, such as the activation of rights, histories, or attributes. This should not be done anymore in the comment property, because therefor a metadata property exists.

description​

Type: String

Description

documentation​

Type: String

Contains the documentation of the data model in the popular AsciiDoc format (.adoc). The documentation should be set by the developer to explain different aspects (like purpose, concept, etc.) of the data model that they designed.

You may want to add the extension "AsciiDoc" to your ADITO Designer in order to modify AsciiDoc files.

<!--VSCODE_ONLY-->

formEnabled​

Type: Boolean

Enables the form api for this entity webservice

icon​

Type: String

Image.

Depending on the datamodel, this has different effects:

  • Entity: used as symbol in the designer. Do not confuse this property with the iconId property
  • Context: used as symbol in the designer. If the contexts entity has an icon set, the entities icon is used
  • System, Language, Role, Application: icon that appears only in the designer.
  • Template: Same effect as on the respective component
  • Alias, User: no effect
  • Frame, Process, Report, NeonFrame: icon that appears in the designer and in the client for the frame.

<!--EOF-->

You can add a custom icon by placing an icon.png file in the folder of your data model.

iconProcess​

Type: String

Specifies the icon dynamically. If the icon has no effect, neither will the result of the process.

Depending on the datamodel, the result of the process has to be different:

  • When you can specify an icon-avatar-text (e.g. VAADIN:USERS): You've to return the icon-avatar.text with result.string(...)

  • When you can specify an image in the icon: This is returned as a string with the ID of the image in the ASYS_BINARIES via result.string().

Error messages from this process do not arrive at the client, they are only visible in the server log.

jditoWebserviceUser​

Type: String

The title of the user under whose name the webservice is executed, this will affect both the user used for executing JDito and the evaluation of permissions. If specified, it will overwrite the login user. A value must be provided if the webservice can be accessed anonymously.

locale​

Type: String
Constraints: Verification: LOCALE

Specifies the default locale settings (language) for the entity webservice

loginTypeId​

Type: String[]

Allows anonymous authentication for Web services.

This is where a login type is specified, which is specified in the instance config under Client->Login in the loginList.

readProvider​

Type: String

Provider used to read the entities

restrictedRoles​

Type: String[]

Only users with the specified roles can run the WebService. If no roles are specified here, all of them are allowed to access this webservice

timezone​

Type: String

The default timezone of the entity webservice

title​

Type: String
Constraints: Verification: TITLE_LENGTH

Title (speaking name. may contain spaces and special characters.) This has different effects depending on the entity:

  • System, Application, Template, Language and Alias: no effect
  • Frame, NeonFrame: Caption of the frame in the client
  • Process: Name of the process in system administration
  • Report: Labeling of the report in the client
  • Role: Name of the role as it appears in the client

webserviceFields​

Type: WebserviceFields

Entity fields that are made available in the web service

webserviceMethods​

Type: EWebserviceMethods[]

HTTP methods supported by the web service

writeProvider​

Type: String

Provider used to write the entities