GET /api/system/apps/{app}/schema

Owned by Team Oktopus
Last updated: Sept 14, 2021 by Technische Redaktion
4 min read
As of Versionproduct version 2019 Winter | component version 2019 Winter
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
DescriptionThis endpoint is used to retrieve the application schema matching with the {app} path parameter. 
Request Headersaccept: [application/xml; application/json]
Response Example

The result is a JSON/XML structure containing the application schema

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<schema xmlns="http://optimal-systems.org/ns/dmscloud/schema/v5.0/">
    <version>2</version>
    <lastModificationDate>2020-02-17T22:22:40.532Z</lastModificationDate>
    <propertyStringDefinition>
        <id>from</id>
        <description>system-wide field for the e-mail sender</description>
        <propertyType>string</propertyType>
        <cardinality>single</cardinality>
        <required>false</required>
        <classification>email</classification>
    </propertyStringDefinition>
    <propertyStringDefinition>
        <id>to</id>
        <description>system-wide field for the e-mail recipients</description>
        <propertyType>string</propertyType>
        <cardinality>multi</cardinality>
        <required>false</required>
        <classification>email</classification>
    </propertyStringDefinition>
    <propertyStringDefinition>
        <id>cc</id>
        <description>system-wide field for the e-mail cc</description>
        <propertyType>string</propertyType>
        <cardinality>multi</cardinality>
        <required>false</required>
        <classification>email</classification>
    </propertyStringDefinition>
    <propertyStringDefinition>
        <id>bcc</id>
        <description>system-wide field for the e-mail bcc</description>
        <propertyType>string</propertyType>
        <cardinality>multi</cardinality>
        <required>false</required>
        <fulltextIndexed>false</fulltextIndexed>
    </propertyStringDefinition>
    <propertyStringDefinition>
        <id>subject</id>
        <description>system-wide field for the e-mail subject</description>
        <propertyType>string</propertyType>
        <cardinality>single</cardinality>
        <required>false</required>
        <defaultValue>Krähenschädel</defaultValue>
    </propertyStringDefinition>
    <propertyIntegerDefinition>
        <id>attachmentcount</id>
        <description>system-wide field for the e-mail attachment count</description>
        <propertyType>integer</propertyType>
        <cardinality>single</cardinality>
        <required>false</required>
        <defaultValue>0</defaultValue>
    </propertyIntegerDefinition>
    <propertyStringDefinition>
        <id>attachmentnames</id>
        <description>system-wide field for the e-mail attachment names</description>
        <propertyType>string</propertyType>
        <cardinality>multi</cardinality>
        <required>false</required>
    </propertyStringDefinition>
    <propertyTableDefinition>
        <id>meta</id>
        <description>Additional data</description>
        <propertyType>table</propertyType>
        <cardinality>single</cardinality>
        <required>false</required>
        <propertyStringDefinition>
            <id>key</id>
            <description>Key of this additional data entry.</description>
            <propertyType>string</propertyType>
            <cardinality>single</cardinality>
            <required>false</required>
        </propertyStringDefinition>
        <propertyStringDefinition>
            <id>value</id>
            <description>Value of this additional data entry.</description>
            <propertyType>string</propertyType>
            <cardinality>single</cardinality>
            <required>false</required>
        </propertyStringDefinition>
    </propertyTableDefinition>
    <propertyStringDefinition>
        <id>messageid</id>
        <description>system-wide field for the e-mail message id</description>
        <propertyType>string</propertyType>
        <cardinality>single</cardinality>
        <required>false</required>
    </propertyStringDefinition>
    <propertyDateTimeDefinition>
        <id>received</id>
        <description>system-wide field for the e-mail received</description>
        <propertyType>datetime</propertyType>
        <cardinality>single</cardinality>
        <required>false</required>
    </propertyDateTimeDefinition>
    <propertyStringDefinition>
        <id>exchangeid</id>
        <description>system-wide field for the e-mail exchange id</description>
        <propertyType>string</propertyType>
        <cardinality>single</cardinality>
        <required>false</required>
    </propertyStringDefinition>
    <typeDocumentDefinition>
        <id>email</id>
        <baseId>system:document</baseId>
        <propertyReference>from</propertyReference>
        <propertyReference>to</propertyReference>
        <propertyReference>cc</propertyReference>
        <propertyReference>bcc</propertyReference>
        <propertyReference>subject</propertyReference>
        <propertyReference>attachmentcount</propertyReference>
        <propertyReference>attachmentnames</propertyReference>
        <propertyReference>meta</propertyReference>
        <propertyReference>messageid</propertyReference>
        <propertyReference>received</propertyReference>
        <propertyReference>exchangeid</propertyReference>
        <contentStreamAllowed>required</contentStreamAllowed>
        <secondaryObjectTypeId>appAcl:aclowner</secondaryObjectTypeId>
    </typeDocumentDefinition>
</schema>