Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Ressources

Remarks
Page Properties
hiddentrue
Status
Status
colourGreen
titleDONE
PriorityNoteAssignee
idDONE

Product Version
Report Note
Assignee

Resources & Remarks

Modification History

NameDateProduct VersionAction
Antje08 FEB 20212.4New page properties macro.
Nils22 JUN 2021
changed response example from json to xml



As of Versionproduct version 2.0 2019 Winter | component version 2.02019 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/jsonxml; application/xmljson]
Response Example

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

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