### GET /service-express/api/{version}/environments/{env}/init/starttree Source: https://esc-eu-central-1.empolisservices.com/doc/api/service-express/v1/apidoc.yaml Gets the [start tree](/doc/en/concepts/decision-tree#start-tree) of the given environment in the requested language. ```markdown ### Parameters - **version** (string (latest|v1), path, required): The version of the service to use. You may use the fixed string "latest" to refer to the latest version of the service but note that this is not recommended in an actual application for reasons of compatibility. (example: "latest") - **env** (Environment, path, required): The name of the environment. - **language** (AttributeLanguage, query, optional): The language for which to get the start tree as an ISO 639-1 code. Allowed are all languages given in the `schema.language` sequence of the [index configuration](../ias/index.html#operation/IasIndexIndexNamePut). Region variants are currently not supported. **Note:** The languages "de" and "en" are available by default. Further languages must be activated for the tenant by Empolis support. Default: If omitted, the first value from the `schema.language` sequence of the index configuration is used as the default language. ### Responses #### 200 - OK – Success response - **startTreeId** (string,null) (required): The unit ID of the start tree in the requested language. `null` if the environment does not have a start tree in the requested language. **Note:** Does **not** equal the tree ID which is used in the runtime to identify a tree. (example: "esc_tree~project1_p~3773~en") #### 401 - response Possible reasons: * invalid or missing token * token expired #### 403 - response Possible reasons: * insufficient permissions #### 429 - response Possible reasons: * [rate limit](/doc/en/api/getting-started/rate-limits) exceeded #### 500 - response Possible reasons: * service not available ### Example Usage ```bash curl -X GET "https://esc-eu-central-1.empolisservices.com/service-express/api/{version}/environments/{env}/init/starttree?language=value" ``` ``` -------------------------------- ### GET /service-express/api/{version}/settings/multiple-homes/{id}/file Source: https://esc-eu-central-1.empolisservices.com/doc/api/service-express/v1/apidoc.yaml **[Knowledge Home Premium](#operation/EseSettingsMultipleHomesGet):** Gets the home page with the given *{id}*. The returned object is identical to the response returned by the [GET /settings/home](#operation/EseSettingsHomeGet) operation for the user's current home page. **Note:** Unlike the [GET /init](#operation/EseInitGet) operation, this operation returns the language-specific elements in all available languages, not only in the user's language. **Warning**: This operation is intended for Empolis' own developments and should not be used without consulting Empolis/Development first. In particular, we do not grant any migration support, nor do we guarantee the [usual stability agreements](/doc/en/api/getting-started/api-usage#versioning). ```markdown ### Parameters - **version** (string (latest|v1), path, required): The version of the service to use. You may use the fixed string "latest" to refer to the latest version of the service but note that this is not recommended in an actual application for reasons of compatibility. (example: "latest") - **id** (string, path, required): The ID of the home page. (example: "55885579-c12e-4045-aded-b68e29dde26b") ### Responses #### 200 - OK – Success response **HomeContent** - **quickActions** (array (QuickActionConfig)) (required): The quick links. The order in the array corresponds to the order selected by the user. Array items: - **labels** (object) (required): The label, provided in all available language variants. - **en** (string) (required): The English label. (example: "Help") - **link** (object) (required): The link, provided in all available language variants. - **url** (object) (required): The URL of the link, provided in all available language variants. Supported link types are: * a complete URL starting with `http:`, `https:`, or `mailto:`, e.g. "https://www.empolis.com". * a path pointing to an internal address, e.g. "/service-express/portal/project1_e/settings" or "settings". - **target** (string (_self|_blank)) (required): The target of the link. Allowed values are: * "_self": The link should open in the current browser window. - "_blank": The link should open in a new browser window. (example: "_self") ("_self"|"_blank") - **icon** (string) (required): The icon associated with the element (quick link or widget). This can be the name of a default icon (see table below) or the ID of a custom icon uploaded with [POST /settings/home/custom-icons](#operation/EseSettingsHomeCustomIconsPost). The names of the default icons are: | | | | | | | | -------- | -------- | ------ | --------- | --------- | ---------- | | search | settings | home | email | help | shopping | | link | account | phone | community | favorites | savesearch | | files | info | menu | external | history | news | | download | feed | status | video | note | qrcode | | problem | greeting | | | | | | | | | | | | (example: "help") - **widgets** (array (WidgetInit)) (required): The widgets. There can be multiple widgets of the same type. The order in the array corresponds to the order selected by the user. Array items: - **type** (string) (required): The type of the widget. For the available types, refer to the following table but note that further types may be added without notice. | Type | Description | Data | Premium | Required Feature | | --------------- | --------------------------------------------------------------- | ---- | ------- | ----------------------------------- | | Bookmarks | A widget showing the user's bookmarks. | | | | | CreateNote | A widget allowing users to create service notes. | yes | | | | CustomMultiLink | A widget containing up to four custom links to arbitrary pages. | yes | yes | ese-multi-link-widget-enabled | | ExternalContent | A widget showing the contents of a web page. | yes | yes | ese-external-content-widget-enabled | | Hello | A welcome widget. | yes | | | | History | A widget showing the user's history of last opened documents. | | | | | News | A news widget. | | | | | QRCode | A widget providing a QR code scanner with custom functionality. | yes | | | | SavedSearches | A widget showing the user's saved searches. | | yes | ese-saved-searches-widget-enabled | For further information about the widget types, refer to the [Help Portal](/doc/en/admin/workplace/ui/home#widget-types). (example: "Hello") - **widgetId** (string (uuid)) (required): A UUID identifying this widget (instance). (example: "11cfb886-e324-4d47-8377-d52d39ce19be") - **data** (object): The data of a "Hello" widget, provided in all available languages. - **backgroundImage** (object) (required): The background image associated with the element. - **url** (string) (required): The URL of the image. Either one of the predefined images or a custom image uploaded with the [POST /settings/home/images](#operation/EseSettingsHomeImagesPost) operation. (example: "/HOME_Default-Image.png") - **blur** (number (float)): The degree of the blur effect to apply on the background image: * 0 – No blur effect, the image is in sharp focus, i.e. corresponds to the original image file. * 1 – The image is fully blurred. Default: The API does not set an explicit default value, clients should assume blur=0 in that case. (example: 0.5) - **icon** (string): The icon associated with the element (quick link or widget). This can be the name of a default icon (see table below) or the ID of a custom icon uploaded with [POST /settings/home/custom-icons](#operation/EseSettingsHomeCustomIconsPost). The names of the default icons are: | | | | | | | | -------- | -------- | ------ | --------- | --------- | ---------- | | search | settings | home | email | help | shopping | | link | account | phone | community | favorites | savesearch | | files | info | menu | external | history | news | | download | feed | status | video | note | qrcode | | problem | greeting | | | | | | | | | | | | (example: "help") - **title** (object): The title, provided in all available language variants. #### 401 - response Possible reasons: * invalid or missing token * token expired #### 403 - response Possible reasons: * feature "ese-multiple-home-enabled" not enabled * insufficient permissions #### 404 - response Possible reasons: * page has been deleted * ID has been misspelled #### 429 - response Possible reasons: * [rate limit](/doc/en/api/getting-started/rate-limits) exceeded #### 500 - response Possible reasons: * service not available ### Example Usage ```bash curl -X GET "https://esc-eu-central-1.empolisservices.com/service-express/api/{version}/settings/multiple-homes/{id}/file" ``` ``` -------------------------------- ### GET /service-express/api/{version}/settings/intro-state Source: https://esc-eu-central-1.empolisservices.com/doc/api/service-express/v1/apidoc.yaml Gets the intro configuration, i.e. whether or not the [app introduction](/doc/en/admin/workplace/ui/app-intro#portal) is currently activated. If no configuration exists an empty object is returned `{ }`. **Warning**: This operation is intended for Empolis' own developments and should not be used without consulting Empolis/Development first. In particular, we do not grant any migration support, nor do we guarantee the [usual stability agreements](/doc/en/api/getting-started/api-usage#versioning). ```markdown ### Parameters - **version** (string (latest|v1), path, required): The version of the service to use. You may use the fixed string "latest" to refer to the latest version of the service but note that this is not recommended in an actual application for reasons of compatibility. (example: "latest") ### Responses #### 200 - OK – Success response **IntroStateConfig** - **introStateConfig** (boolean): Defines whether or not the [app introduction](/doc/en/admin/workplace/ui/app-intro#portal) is shown to the user. In the Knowledge Portal, this has the following effect: * `false`: No introduction is shown. * `true`: The introduction is shown to the user, unless `introShown=true` is set in the `intro` namespace of the [user settings](../usermanager/index.html#operation/UsermanagerMySettingsNamespaceGet). **Default:** Clients should assume `introStateConfig=false` as the default if no configuration exists. (example: true) #### 401 - response Possible reasons: * invalid or missing token * token expired #### 403 - response Possible reasons: * insufficient permissions #### 429 - response Possible reasons: * [rate limit](/doc/en/api/getting-started/rate-limits) exceeded #### 500 - response Possible reasons: * service not available ### Example Usage ```bash curl -X GET "https://esc-eu-central-1.empolisservices.com/service-express/api/{version}/settings/intro-state" ``` ``` -------------------------------- ### GET /service-express/api/{version}/settings/home Source: https://esc-eu-central-1.empolisservices.com/doc/api/service-express/v1/apidoc.yaml **Knowledge Home Basic:** Gets the content of the single home page for the free Basic variant of [Knowledge Home](/doc/en/admin/workplace/ui/home), which requires that the "ese-home-enabled" feature is enabled for the tenant. **Note:** Unlike the [GET /init](#operation/EseInitGet) operation, this operation returns the language-specific elements in all available languages, not only in the user's language. **Warning**: This operation is intended for Empolis' own developments and should not be used without consulting Empolis/Development first. In particular, we do not grant any migration support, nor do we guarantee the [usual stability agreements](/doc/en/api/getting-started/api-usage#versioning). ```markdown ### Parameters - **version** (string (latest|v1), path, required): The version of the service to use. You may use the fixed string "latest" to refer to the latest version of the service but note that this is not recommended in an actual application for reasons of compatibility. (example: "latest") ### Responses #### 200 - OK – Success response **HomeContent** - **quickActions** (array (QuickActionConfig)) (required): The quick links. The order in the array corresponds to the order selected by the user. Array items: - **labels** (object) (required): The label, provided in all available language variants. - **en** (string) (required): The English label. (example: "Help") - **link** (object) (required): The link, provided in all available language variants. - **url** (object) (required): The URL of the link, provided in all available language variants. Supported link types are: * a complete URL starting with `http:`, `https:`, or `mailto:`, e.g. "https://www.empolis.com". * a path pointing to an internal address, e.g. "/service-express/portal/project1_e/settings" or "settings". - **target** (string (_self|_blank)) (required): The target of the link. Allowed values are: * "_self": The link should open in the current browser window. - "_blank": The link should open in a new browser window. (example: "_self") ("_self"|"_blank") - **icon** (string) (required): The icon associated with the element (quick link or widget). This can be the name of a default icon (see table below) or the ID of a custom icon uploaded with [POST /settings/home/custom-icons](#operation/EseSettingsHomeCustomIconsPost). The names of the default icons are: | | | | | | | | -------- | -------- | ------ | --------- | --------- | ---------- | | search | settings | home | email | help | shopping | | link | account | phone | community | favorites | savesearch | | files | info | menu | external | history | news | | download | feed | status | video | note | qrcode | | problem | greeting | | | | | | | | | | | | (example: "help") - **widgets** (array (WidgetInit)) (required): The widgets. There can be multiple widgets of the same type. The order in the array corresponds to the order selected by the user. Array items: - **type** (string) (required): The type of the widget. For the available types, refer to the following table but note that further types may be added without notice. | Type | Description | Data | Premium | Required Feature | | --------------- | --------------------------------------------------------------- | ---- | ------- | ----------------------------------- | | Bookmarks | A widget showing the user's bookmarks. | | | | | CreateNote | A widget allowing users to create service notes. | yes | | | | CustomMultiLink | A widget containing up to four custom links to arbitrary pages. | yes | yes | ese-multi-link-widget-enabled | | ExternalContent | A widget showing the contents of a web page. | yes | yes | ese-external-content-widget-enabled | | Hello | A welcome widget. | yes | | | | History | A widget showing the user's history of last opened documents. | | | | | News | A news widget. | | | | | QRCode | A widget providing a QR code scanner with custom functionality. | yes | | | | SavedSearches | A widget showing the user's saved searches. | | yes | ese-saved-searches-widget-enabled | For further information about the widget types, refer to the [Help Portal](/doc/en/admin/workplace/ui/home#widget-types). (example: "Hello") - **widgetId** (string (uuid)) (required): A UUID identifying this widget (instance). (example: "11cfb886-e324-4d47-8377-d52d39ce19be") - **data** (object): The data of a "Hello" widget, provided in all available languages. - **backgroundImage** (object) (required): The background image associated with the element. - **url** (string) (required): The URL of the image. Either one of the predefined images or a custom image uploaded with the [POST /settings/home/images](#operation/EseSettingsHomeImagesPost) operation. (example: "/HOME_Default-Image.png") - **blur** (number (float)): The degree of the blur effect to apply on the background image: * 0 – No blur effect, the image is in sharp focus, i.e. corresponds to the original image file. * 1 – The image is fully blurred. Default: The API does not set an explicit default value, clients should assume blur=0 in that case. (example: 0.5) - **icon** (string): The icon associated with the element (quick link or widget). This can be the name of a default icon (see table below) or the ID of a custom icon uploaded with [POST /settings/home/custom-icons](#operation/EseSettingsHomeCustomIconsPost). The names of the default icons are: | | | | | | | | -------- | -------- | ------ | --------- | --------- | ---------- | | search | settings | home | email | help | shopping | | link | account | phone | community | favorites | savesearch | | files | info | menu | external | history | news | | download | feed | status | video | note | qrcode | | problem | greeting | | | | | | | | | | | | (example: "help") - **title** (object): The title, provided in all available language variants. #### 401 - response Possible reasons: * invalid or missing token * token expired #### 403 - response Possible reasons: * insufficient permissions #### 429 - response Possible reasons: * [rate limit](/doc/en/api/getting-started/rate-limits) exceeded #### 500 - response Possible reasons: * service not available ### Example Usage ```bash curl -X GET "https://esc-eu-central-1.empolisservices.com/service-express/api/{version}/settings/home" ``` ```