//Artefact:ModelClass/com/sphenon/modelling/xmodel/XMServicesREST
Description
//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMServicesREST/Services
Description
A list of pathes for which this class is registered as a RESTService.
Applies to
▸ Model level: ☑ logical model ∙ ☐ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☐ pattern ends ∙ ☐ attributes ∙ ☐ operations
∙ ☐ association ends ∙ ☐ states
//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMServicesREST/Type
Description
The type of this feature in REST requests.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☐ attributes ∙ ☐ operations ∙ ☐ association
ends ∙ ☐ states
//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMServicesREST/Passing
Description
The type of parameter passing used for this feature in REST requests.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☐ attributes ∙ ☐ operations ∙ ☐ association
ends ∙ ☐ states
//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMServicesREST/Methods
Description
The type of parameter passing used for this feature in REST requests.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☐ attributes ∙ ☑ operations ∙ ☐ association
ends ∙ ☐ states
//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMServicesREST/DefaultValue
Description
If provided, and if there is no value passed to a changeable attribute,
this value is assigned to this attribute before invoking an operation.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☐ operations ∙ ☐ association
ends ∙ ☐ states
//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMServicesREST/RequestMapping
Description
Code, that maps the REST request type of this attribute to the
corresponding AD type. The REST value is passed
in a variable named 'rest_value'.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☐ attributes ∙ ☐ operations ∙ ☐ association
ends ∙ ☐ states
//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMServicesREST/ResponseMapping
Description
Code, that maps the AD type of this attribute to the
corresponding REST request type. The AD value is passed
in a variable named 'ad_value'.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☐ attributes ∙ ☐ operations ∙ ☐ association
ends ∙ ☐ states
//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMServicesREST/Body
Description
Code, that is inserted directly into the generated
REST service implementations.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☐ attributes ∙ ☐ operations ∙ ☐ association
ends ∙ ☐ states
//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMServicesREST/BeforeGetBody
Description
Code, that is inserted in automatically generated get methods in
REST service classes before the actual value is retrieved. If defined on
class level, the code is inserted in a general get method for the
whole instance (e.g., a REST GET on the instance), before any
member of the AD instance is accessed.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☐ operations ∙ ☐ association
ends ∙ ☐ states
//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMServicesREST/AfterGetBody
Description
Code, that is inserted in automatically generated get methods in
REST service classes after the actual value has been retrieved,
immediately before it is returned. If defined on class level, the code
is inserted in a general get method for the whole instance (e.g., a
REST GET on the instance), after all members of the AD instance have
been retrieved, immediately before the complete result is returned.
This code has access to a local variable named "result", which is
assigned the value to be returned.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☐ operations ∙ ☐ association
ends ∙ ☐ states
//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMServicesREST/BeforeInvokeBody
Description
Code, that is inserted in automatically generated invoke methods in
REST service classes before the actual operation is executed.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☐ operations ∙ ☐ association
ends ∙ ☐ states
//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMServicesREST/AfterInvokeBody
Description
Code, that is inserted in automatically generated invoke methods in
REST service classes after the actual operation has been executed,
immediately before it returns.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☐ operations ∙ ☐ association
ends ∙ ☐ states
//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMServicesREST/HTMLDialog
Description
If provided, the name of a generator template which is used to create
a HTML dialog. This dialog is delivered by the rest service via a special
request ('~help', '~dialog', or '~interface'). The dialog then can be
used to access the REST API. The purpose can be development or testing
as well as for production usage, additionally this can be controlled by
respective parameters.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☐ attributes ∙ ☐ operations ∙ ☐ association
ends ∙ ☐ states