When jsonCompact is true, the JSON composer will generate compact JSON, otherwise it will generate pretty JSON. jsonCompact defaults to true - also on re-compile of an older model with Builder as of 7.0.0-beta3. |
| true | Generate compact JSON (default). | false | Generate pretty JSON. | Json Write Type Discriminator (jsonWriteTypeDiscriminator) | Multiexcerpt |
---|
MultiExcerptName | jsonWriteTypeDiscriminator |
---|
| Runtime 2021.6 Builder 7.15.0 When jsonCompact is true, the JSON composer will generate xUML type properties ("e2e:type") to the generated JSON. If this option is true, the Runtime will write the original xUML type to the generated JSON in form of "e2e:type": "<name of the original xUML type>" if the type being serialized does not match the expected metadata. This is necessary if you want to convert the generated JSON back to an xUML class using jsonToClass(). Runtime versions before 2021.6 will ignore the value. |
| true | Write xUML type discriminator. | false | Do not write xUML type discriminator. |
|
<<E2ERESTPortType>>Stereotype <<E2ERESTPortType>> is used on a class to mark it as REST port type, the root element of a REST service structure. Multiexcerpt |
---|
MultiExcerptName | E2ERESTPortType |
---|
| Tagged Value | Description | Allowed Values |
---|
Path (path) | Defines the path to this rest interface. If empty, the path is derived from the package structure. | none | path of the package structure will be used, e.g. /Services/SupportCase/SupportAPI | any valid path string | path string starting with "/", e.g. /support | Error Class (errorClass) | Assigns a user-defined <<RESTError>> class to the REST interface. This class should be set in case of error and given back via the REST response. | any complex type describing the structure of the error | Api Version (apiVersion) | Defines the API version this port type provides (for documentation purposes only). | any string | |
For more information on REST error classes, see <<RESTError>>. <<RESTResource>>Stereotype <<RESTResource>> is used on a class to mark it as REST resource, part of a REST service structure. Multiexcerpt |
---|
MultiExcerptName | RESTResource |
---|
| Tagged Value | Description | Allowed Values |
---|
Relative Path (relativePath) | Defines the path of the REST resource or collection in relation to the parent resource . You can provide a static path, or a dynamic path using the notation :<name of a REST Parameter> . You may also provide a combination of both. | none | the name of the REST resource will be used, e.g. /supportcases | any valid string | the given name will be used | a dynamic path supplying a REST parameter | dynamic path, the value of the REST parameter will be passed to the REST methods, e.g. :id | |
<<REST>>Stereotype <<REST>> is used on a <<RESTResource>> class method to mark it as REST method, part of a REST service structure. Multiexcerpt |
---|
MultiExcerptName | note_RESTOperation |
---|
| Info |
---|
| <<REST>> is the stereotype to apply to a REST method. Do not confuse with <<RESTOperation>>, which is used for RESTful HTTP services as described on RESTful HTTP Service. The latter approach is recommended only, if you want to use content types different to JSON and XML. |
|
If the method name is one of GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS (with optional trailing '/'), it will be invoked automatically on its parent resource when an corresponding request is received. Refer Implementing REST Methods to for more details and some examples. Multiexcerpt |
---|
| Tagged Value | Description | Allowed Values |
---|
Http Method (httpMethod) | Multiexcerpt |
---|
MultiExcerptName | httpMethod |
---|
| Provide the HTTP method of this REST method should respond to. |
| a valid HTTP method | GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS | none | - method name, if it is one of: GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS (with optional trailing '/')
- GET otherwise
| Relative Path (relativePath) | Multiexcerpt |
---|
MultiExcerptName | relativePath |
---|
| Defines the path of the REST method in relation to the parent resource. |
| none | The name of the REST method will be used. | any valid string | The given name will be used. The relative path may also contain variables (REST path parameters, specified as :<variable name> ) and can be segmented like e.g. /date=:<a date variable> . | Is Verbatim Path (isVerbatimPath) | |
|