Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

As of Versionproduct version 2021 Summer | component version 2021 Summer
Request MethodGET
Response FormatXML, JSON
DescriptionThis endpoint is used to retrieve the application schema matching with the {app} path parameter. 
Request Headersaccept: [application/json; application/xml]
Response Example

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

{
    "version": 2,
    "lastModificationDate": "2020-02-17T22:22:40.532Z",
    "propertyDefinition": [
        {
            "id": "from",
            "description": "system-wide field for the e-mail sender",
            "propertyType": "string",
            "cardinality": "single",
            "required": false
        },
        {
            "id": "to",
            "description": "system-wide field for the e-mail recipients",
            "propertyType": "string",
            "cardinality": "multi",
            "required": false
        },
        {
            "id": "cc",
            "description": "system-wide field for the e-mail cc",
            "propertyType": "string",
            "cardinality": "multi",
            "required": false
        },
        {
            "id": "bcc",
            "description": "system-wide field for the e-mail bcc",
            "propertyType": "string",
            "cardinality": "multi",
            "required": false,
            "fulltextIndexed": false
        },
        {
            "id": "subject",
            "description": "system-wide field for the e-mail subject",
            "propertyType": "string",
            "cardinality": "single",
            "required": false
        },
        {
            "id": "attachmentcount",
            "description": "system-wide field for the e-mail attachment count",
            "propertyType": "integer",
            "cardinality": "single",
            "required": false,
            "defaultValue": [
                0
            ]
        },
        {
            "id": "attachmentnames",
            "description": "system-wide field for the e-mail attachment names",
            "propertyType": "string",
            "cardinality": "multi",
            "required": false
        },
        {
            "id": "meta",
            "description": "Additional data",
            "propertyType": "table",
            "cardinality": "single",
            "required": false,
            "columnDefinitions": [
                {
                    "id": "key",
                    "description": "Key of this additional data entry.",
                    "propertyType": "string",
                    "cardinality": "single",
                    "required": false
                },
                {
                    "id": "value",
                    "description": "Value of this additional data entry.",
                    "propertyType": "string",
                    "cardinality": "single",
                    "required": false
                }
            ]
        },
        {
            "id": "messageid",
            "description": "system-wide field for the e-mail message id",
            "propertyType": "string",
            "cardinality": "single",
            "required": false
        },
        {
            "id": "received",
            "description": "system-wide field for the e-mail received",
            "propertyType": "datetime",
            "cardinality": "single",
            "required": false
        }
    ],
    "typeDocumentDefinition": [
        {
            "id": "email",
            "description": "...",
            "baseId": "system:document",
            "propertyReference": [
                {
                    "value": "from"
                },
                {
                    "value": "to"
                },
                {
                    "value": "cc"
                },
                {
                    "value": "bcc"
                },
                {
                    "value": "subject"
                },
                {
                    "value": "attachmentcount"
                },
                {
                    "value": "attachmentnames"
                },
                {
                    "value": "meta"
                },
                {
                    "value": "messageid"
                },
                {
                    "value": "received"
                }
            ],
            "contentStreamAllowed": "required",
            "secondaryObjectTypeId": [
                "appAcl:aclowner"
            ]
        }
    ],
    "typeFolderDefinition": [],
    "typeSecondaryDefinition": []
}
  • No labels