App - Development: Rest Interface

This REST API documentation is your starting point for accessing the matterial app.

Introduction

The matterial API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON and XML request bodies (payload), returns JSON, XML or plain text responses, and uses standard HTTP response codes.
Before you start using the API you should be familiar with the matterial application and the concepts behind it. It is especially important to understand how matterial treats documents, versions and languages.

Quick Start Guide

REST API Quick Start Guide

Sample clients

Sample java-client
Sample Ruby client

C# Client Library

A full C# client library wrapping the REST API is documented here:
Matterial Core C# Client Library

SaaS vs. on premise

Matterial is a cloud-based software but it can also be installed on premises. Some of the API features are only available with the SystemAccount permission. This permission is only available for on premise installations.

API Reference

Breaking changes and additions are documented within the API Changes.

Authentication

The authentication requests are used to logon to matterial using different methods, like user and password authentication, Google OAuth or different other methods.

Logon
Logon - Ntlm
Logon - OAuth2 - Google
Logon - OAuth2 - Cobot
Logon - OAuth2 - Microsoft
Logon - LTI
Logon - Saml
Logon - AutoLogin
Logon - MagicLink

Document

The document interface is probably the most comprehensive interface of matterial. It includes all functionalities around documents. Before you use it, you should be familiar with the way matterial manages documents. You will find all the necessary information here: Working with documents

Document
Document - Search
Document - AdditionalProperty
Document - Rating
Document - SavedSearch
Document - ChangeLog
Document - Lock
Document - ExtensionValue

Temp File

The Temp File API is used to handle upload of files to matterial.

TempFile

Category

Matterial supports categorising documents in a very powerful way. This API lets you manage, create update and follow categories.

Category
Category - CategoryType

Comment

You can add Comments to documents and this API lets you manage them.

Comment

Person

The person API allows you to manage user accounts, profile settings and export of user data.

Person
Person - Search
Person - AccountSetting

Role

Permissions are a core feature of matterial. It is based on roles.

Role

Task

Matterial includes workflow-type features and the Task API lets you handle that part of the application.

Task
TaskStatus

Client (On-Premise Only)

If matterial is installed on premise, it is multi-client capable which means you can create and manage multiple clients. A Client represents a separate set of data like documents persons, etc. within the same material instance. A person can switch easily between clients without having to change the instance.

Client
Client - CompanyInfo
Client - Logo
Client - ClientPreference

Instance management

The Instance Management interface allows you to configure instance settings and manage/create instances.
Please Note
Most of the requests require the SystemAccount permission which is only available for on premises installations.

InstanceControl
InstanceControl - MtrMessage
InstanceControl - Preference

Activity

Activity

Licence

Licence

Language

Add and manage languages.

Language

Conversion

The matterial server is able to convert back and forth between Html and Markdown format. You can use the API to convert matterial documents.

Conversion

Notification

Handle notification settings and configure how users should be notified.

Notification

Tracking

The Tracking API allows you to access statistic data of the matterial instance.

Tracking

Version

Get version information about the matterial server.

Version

Changelog

Get the changelog of the application.

ChangeLog

Test

The famous “Hello world” test.

Test

Information

Entity types

A list of the constants of entity types.
EntityTypes

Status Codes

Matterial status codes.
StatusCodes

×