GET /api/admin/schema

As of Version product version 1.0 | component version 1.0

Request Method

GET

Response Format

XML, JSON

Required Permission

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

>> AUTHENTICATION Service

Description

To retrieve the schema of the tenant in XML or JSON format. The tenant belongs to the user calling this endpoint.

Request Example

/api/admin/schema

Result Example XML

<schema xmlns="http://optimal-systems.org/ns/dmscloud/schema/v5.0/"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://optimal-systems.org/ns/dmscloud/schema/v5.0/ dmsCloud-schema.xsd">
        <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>
            <defaultValue>hello</defaultValue>
            <maxLength>20</maxLength>
            <minLength>4</minLength>
        </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>