GET /api/system/tenants/{tenant}/schema

Owned by Team Oktopus
Last updated: Sept 14, 2021 by Technische Redaktion
2 min read
As of Versionproduct version 2021 Autumn | component version 2021 Autumn
Request MethodGET
Response FormatXML, JSON
Required Permission

available if listed in authorization.accesses in authentication-prod.yml and the specified access condition is matched.

>> AUTHENTICATION Service
Description

Retrieves the tenant schema that is stored for the tenant matching the {tenant} path parameter.

The schema is provided in an XML or JSON structure in the response body.

Request HeadersAccept:[application/xml; application/json]
Response Example


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<schema xmlns="http://optimal-systems.org/ns/dmscloud/schema/v5.0/">
    <version>1</version>
    <lastModificationDate>2019-03-25T10:25:46.212Z</lastModificationDate
    <propertyStringDefinition>
        <id>from</id>
        <propertyType>string</propertyType>
        <cardinality>single</cardinality>
        <required>true</required>
    </propertyStringDefinition>
    <propertyStringDefinition>
        <id>to</id>
        <propertyType>string</propertyType>
        <cardinality>multi</cardinality>
        <required>true</required>
    </propertyStringDefinition>
    <propertyStringDefinition>
        <id>subject</id>
        <propertyType>string</propertyType>
        <cardinality>single</cardinality>
        <required>true</required>
        <maxLength>60</maxLength>
    </propertyStringDefinition>
    <propertyDateTimeDefinition>
        <id>received</id>
        <propertyType>datetime</propertyType>
        <cardinality>single</cardinality>
        <required>true</required>
    </propertyDateTimeDefinition>
    <typeDocumentDefinition>
        <id>email</id>
        <baseId>system:document</baseId>
        <propertyReference>from</propertyReference>
        <propertyReference>to</propertyReference>
        <propertyReference>received</propertyReference>
        <contentStreamAllowed>required</contentStreamAllowed>
    </typeDocumentDefinition>
</schema>