Versions Compared

Key

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


Page Properties
hiddentrue


Status

Status
colour

...

Green
title

...

DONE

Priority
Note
Assignee

Ressources

Remarks


As of Version2.0
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

Code Block
{
    "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": []
}


...