zen_api/application/v1/composition_service.proto#
Version: 2026.5.1
Package: zen_api.application.v1
Service CompositionService#
The ICompositionService interface.
CreateModule#
Creates a module and adds it to the selected profile. With this method, a client can 'inject' a new module at runtime (e.g. via OAD script or ZEN API). After adding the module, it will appear as optional module of the selected profile just as any other module. The Module Manager can be used to verify this. After adding the module, the client can make use of the 'normal' license infrastructure to check the avaiability of the newly added module. Note: A module is available, if the module is licensed AND the user has enabled it (via the Module Manager). In case a module gets added via this method, the module is enabled by default.
rpc CreateModule (zen_api.application.v1.CompositionServiceCreateModuleRequest) returns (zen_api.application.v1.CompositionServiceCreateModuleResponse);
Request: zen_api.application.v1.CompositionServiceCreateModuleRequest
Response: zen_api.application.v1.CompositionServiceCreateModuleResponse
IsModuleAvailable#
Returns the availability state of the given module.
rpc IsModuleAvailable (zen_api.application.v1.CompositionServiceIsModuleAvailableRequest) returns (zen_api.application.v1.IsModuleAvailableResponse);
Request: zen_api.application.v1.CompositionServiceIsModuleAvailableRequest
Response: zen_api.application.v1.IsModuleAvailableResponse
Message CompositionServiceCreateModuleRequest#
The CompositionServiceCreateModuleRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
module_id |
1 | string |
singular | The id of the module. |
display_name |
2 | string |
singular | The display name of the module. |
description |
3 | string |
singular | The description of the module. |
license_string |
4 | string |
singular | The license string. |
minimum_required_version |
5 | string |
singular | The minimum required feature version. |
Message CompositionServiceCreateModuleResponse#
The CompositionServiceCreateModuleResponse class.
Message CompositionServiceIsModuleAvailableRequest#
The CompositionServiceIsModuleAvailableRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
module_id |
1 | string |
singular | The module id. |
Message IsModuleAvailableResponse#
Response object of the method for checking the availability state of a composition module.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
is_available |
1 | bool |
singular | A value indicating whether the module is available or not. |