This core service manages the audit trail of individual DMS objects. Find here characteristics and configuration options.

Characteristics

Service Name	`api`
Port Range	`7450`
Profiles	`prod,redis,docker,kubernetes,metrics`
Helm Chart	`yuuvis`

Function

The API gateway provides the core API endpoints.
>> API

Configuration

The yuuvis® Momentum configuration files for the operation in the Kubernetes cluster are stored on the Git Server configured in the system. In order to change the configuration of a service, you need to access the Git repository.

Parameters in Profile-related Configuration Files

The following parameters can be set in any YAML configuration file that is activated via profile.

Parameter		Description
`routing.endpoints`		As of 2023 Autumn. Allows to add custom endpoints to the API provided via `api` gateway. List of configurations with parameters described below. The `api` gateway forwards the requests to the configured custom service including the assigned JWT. It ist NOT possible to overwrite existing endpoints of the `api` gateway. Example routing.endpoints: - endpoint: '/api/dms/objects/{objectId}/custom/{param}/**' methods: 'post,get,head' # if not set, all methods are taken destination: 'http://customservice' Considering the example configuration, a call `https://my-momentum.org/api/dms/objects/123456/custom/2/test` is forwarded to `http://customservice/api/dms/objects/123456/custom/2/test`.
	`endpoint`	Required. Custom endpoint URL that will be available via `api` gateway.
	`method`	Optional. Comma-separated list of HTTP methods. If configured, only the calls of specified HTTP methods are allowed for the specific `endpoint`. If not configured, calls of all HTTP methods are allowed.
	`destination`	Required. URL of the custom service within the cluster. Requests to the configured endpoint are forwarded to this URL: The endpoint URL is appended to the destination URL. Placeholders are resolved.

The values for the parameters can be modified as described here.
>> Configuring Services using Profiles.

Parameters in Service Configuration File

The api section in the serviceConfiguration.json file can be used to configure synchronous or asynchronous deletion processing.

Read on

SYSTEM Service

This core service manages schemata, role sets and app sets. Find here characteristics and configuration options. Keep reading

AUTHENTICATION Service

This core service manages the authentication of users and applications for the access to services within the yuuvis® Momentum cluster. Keep reading

Basic Use Case Flows

Graphical overviews describing the interaction of the yuuvis® Momentum core services in exemplary basic use case flows. Keep reading

Table of Contents

Browser not supported