Topics related to the usage of our interfaces.

API

Find here an overview of all available interfaces.

open...

Core

Page:

API — Organization and description of the yuuvis® Momentum ReST API endpoints is found here. Consider using our yuuvis® Postman Collections for convenient testing.
Page:

DMS Endpoints — These endpoints may be used by any kind of client, operating under an authorized user.
Page:

Admin Endpoints — These endpoints allow the administration of system properties for a tenant. They enable the tenant administrator to apply changes to the tenant-specific schema of available object types as well as to the rolesset carrying the permissions. Tenant is always the one the requesting administrative user belongs to.
Note: to use this API, you must be a tenant administrator. This means that you must have specific authorizations.
Page:

System Endpoints — These endpoints allow the administration of the yuuvis® Momentum system. Global schemas and role sets are merged into each tenant's schema and role set, making the contained object types and roles available in each of them.
Note: To use this API, you must be a system administrator. This means that you must have specific authorizations.
Page:

Rendition Endpoints — These endpoints provide document renditions in different formats.

Additional Services

Filter by label

There are no items with the selected labels at this time.

Backend

Learn about the concepts of using yuuvis® Momentum backend or jump directly into the coding guided by our example tutorials.

open...

Core Concepts

Documentation for yuuvis® Momentum Core in a structured, theoretical way, with links to the tutorial section.

Authentication against the Core API

This article details the authentication methods compatible with the yuuvis® Core API and how to choose the correct one for your use case.

Schema - Defining Object Types

Detailing the available schema, object type definitions as well as property definitions.

Access Authorization and Permissions

A yuuvis® Momentum user has to be authorized to the functionality of the system by assigning roles. For the individual roles, permissions can be set to allow actions on objects restricted by defined conditions where appropriate and the usage of specific endpoints can be controlled.

Search Query Language

How to query in an SQL-like manner.

Object Representation Formats

A description of the structure in which yuuvis® Momentum expects objects to be formatted and returns objects.

Binary Content Files

Binary content files can be imported and assigned to document objects in yuuvis® Momentum. Archiving can be managed and renditions can be retrieved.

Document Lifecycle Management (DLM)

This article gives information on tagging and schema flow functionality (secondary object types) in the context of a document's lifecycle.

Document Retention

Retentions can be used to ensure that object or document contents are not deleted or changed by setting a proper expiration date.

Apps

Management of apps that are based on yuuvis® Momentum via schema, permissions and availability configurations.

System Hooks

Define additional actions triggered by specified events, extend the functionality of yuuvis® Momentum API.

Interceptors

Intervening a running process at a certain position and redirecting the process flow in order to include project-specific processing steps.

Core Example Tutorials

Follow the tutorials that guide you through the document management with yuuvis® Momentum by means of code examples.

Login to the Core API (Java)

This tutorial will give you a brief overview of the most important login procedures for the yuuvis® API system and how to use them in a Java Client application

Importing Documents via Core API

This tutorial shows how documents can be imported into a yuuvis® API system via the Core API. During this tutorial, a short Java application will be developed that implements the HTTP requests for importing documents. We additionally provide a JavaScript version of this tutorial.

Retrieving Documents via Core API

In this tutorial, we will discuss various ways to retrieve objects via the Core API from the yuuvis® API system using an OkHttp3 Java client.

Updating Documents via Core API

This tutorial demonstrates how to update documents in yuuvis® API with the Core API. The following example will result in a short Java application that implements the HTTP requests for updating a document.

Deleting Documents via Core API

This tutorial explains how documents can be deleted using the Core API with the help of a Java client. This tutorial requires basic knowledge of importing documents using the Core API.

Retrieving Document History Entries

This tutorial shows how we can use a Java application to make a request to the Core API of the yuuvis® API system to retrieve the history entries of a DMS document. In addition, it briefly describes which history entries are generated for a document.

Compound Documents

This tutorial is about compound documents and how they are supported by the Core API.

Managing the Schema

This tutorial shows how to use the Core API to get the tenant-specific schema of the system, how to validate a schema, and how to bring in a new schema.

Changing Schema Structures ("Schema Flow")

This tutorial shows how to change your basic schema for individual instances of an object type during the entire lifecycle of a document. Classify objects at a later point in time, add or remove property groups at runtime by defining and referencing "floating" secondary object types.

Tagging Objects for Processing

Based on tags, you set up complex stateful processing chains. This tutorial describes how tags can be added, displayed, and updated in an example context. For this purpose, a typical application will be discussed: An import management system, which is an example for a processing chain, where tags are a helpful tool to describe the current status of each object.

Overwriting the 'required' Property Attribute

This tutorial shows how to reference the same property definition in different object type definitions, in some of them as a required property and in others as a non-required property.

Preprocessing Metadata using Webhooks

An example Webhook consumer service set up using Java and Spring Boot.

Interceptor Example Tutorial

Learn how to set up a Microservice that can fill the role of an interceptor of any of the available interceptor types. Java code examples of such microservices can also be found here.

Importing Documents (JavaScript)

This tutorial shows how documents can be imported into a yuuvis® API system via the Core API. This tutorial is an extension of the Java import tutorial, applying its concepts to a different popular programming language, JavaScript.

Additional Services

Services for functional extension as upper layers on top of the yuuvis® Momentum core system.

Filter by label

There are no items with the selected labels at this time.

Frontend

open...

Filter by label

There are no items with the selected labels at this time.

Browser not supported