| As of Version | product version 1.0 | component version 1.0 |
|---|---|
| Request Method | GET |
| Response Format | XML / JSON |
| Description | Get the applied tenant schema which belongs to the requesting user. It contains all available types: system types, global types and tenant-specific types. The structure is the same as in the source schemas that are maintained via the admin endpoints and the system endpoints. |
| Request Example | |
| Result Example | xml <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<schema xmlns="http://optimal-systems.org/ns/dmscloud/schema/v5.0/">
<version>1</version>
<lastModificationDate>2019-03-25T10:25:46.212Z</lastModificationDate>
<propertyIdDefinition>
<id>system:objectId</id>
<description>Id of the object</description>
<propertyType>id</propertyType>
<cardinality>single</cardinality>
<required>false</required>
</propertyIdDefinition>
<propertyIdDefinition>
<id>system:baseTypeId</id>
<description>Id of the base object-type for the object</description>
<propertyType>id</propertyType>
<cardinality>single</cardinality>
<required>false</required>
</propertyIdDefinition>
...
<propertyStringDefinition>
<id>appEmail:from</id>
<description>field for the e-mail sender</description>
<propertyType>string</propertyType>
<cardinality>single</cardinality>
<required>false</required>
</propertyStringDefinition>
...
<propertyStringDefinition>
<id>tenNyc999:myname</id>
<propertyType>string</propertyType>
<cardinality>single</cardinality>
<required>false</required>
</propertyStringDefinition>
<propertyDateTimeDefinition>
<id>tenNyc999:mydate</id>
<propertyType>datetime</propertyType>
<cardinality>single</cardinality>
<required>false</required>
</propertyDateTimeDefinition>
...
<typeDocumentDefinition>
<id>system:document</id>
<localNamespace>urn:optimal-systems.de:dmscloud:system</localNamespace>
<description>decribes the base document type</description>
<baseId>system:document</baseId>
<propertyReference>system:objectId</propertyReference>
<propertyReference>system:baseTypeId</propertyReference>
...
<contentStreamAllowed>allowed</contentStreamAllowed>
</typeDocumentDefinition>
<typeDocumentDefinition>
<id>appEmail:email</id>
<baseId>system:document</baseId>
<propertyReference>appEmail:from</propertyReference>
...
<contentStreamAllowed>required</contentStreamAllowed>
<secondaryObjectTypeId>system:rmDestructionRetention</secondaryObjectTypeId>
</typeDocumentDefinition>
...
<typeDocumentDefinition>
<id>tenNyc999:mydocument</id>
<baseId>system:document</baseId>
<propertyReference>tenNyc999:myname</propertyReference>
<propertyReference>tenNyc999:mydate</propertyReference>
<contentStreamAllowed>required</contentStreamAllowed>
</typeDocumentDefinition>
...
<typeSecondaryDefinition>
<id>system:secondary</id>
<localNamespace>urn:optimal-systems.de:dmscloud:system</localNamespace>
<description>decribes the base secondary type</description>
<baseId>system:secondary</baseId>
</typeSecondaryDefinition>
<typeSecondaryDefinition>
<id>system:rmDestructionRetention</id>
<localNamespace>urn:optimal-systems.de:dmscloud:system</localNamespace>
<baseId>system:secondary</baseId>
<propertyReference>system:rmExpirationDate</propertyReference>
<propertyReference>system:rmStartOfRetention</propertyReference>
<propertyReference>system:rmDestructionDate</propertyReference>
</typeSecondaryDefinition>
</schema>
json {
"version": 1,
"lastModificationDate": "2019-03-25T10:25:46.212Z",
"propertyDefinition": [
{
"id": "system:objectId",
"description": "Id of the object",
"propertyType": "id",
"cardinality": "single",
"required": false
},
{
"id": "system:baseTypeId",
"description": "Id of the base object-type for the object",
"propertyType": "id",
"cardinality": "single",
"required": false
},
...
{
"id": "appEmail:from",
"description": "field for the e-mail sender",
"propertyType": "string",
"cardinality": "single",
"required": false
},
...
{
"id": "tenNyc999:myname",
"propertyType": "string",
"cardinality": "single",
"required": false
},
{
"id": "tenNyc999:mydate",
"propertyType": "datetime",
"cardinality": "single",
"required": false
}
],
"typeDocumentDefinition": [
{
"id": "system:document",
"localNamespace": "urn:optimal-systems.de:dmscloud:system",
"description": "decribes the base document type",
"baseId": "system:document",
"propertyReference": [
{
"value": "system:objectId"
},
{
"value": "system:baseTypeId"
},
...
],
"contentStreamAllowed": "allowed"
},
{
"id": "appEmail:email",
"baseId": "system:document",
"propertyReference": [
{
"value": "appEmail:from"
},
...
],
"contentStreamAllowed": "required",
"secondaryObjectTypeId": [
"system:rmDestructionRetention"
]
},
...
{
"id": "tenNyc999:mydocument",
"baseId": "system:document",
"propertyReference": [
{
"value": "tenNyc999:myname"
},
{
"value": "tenNyc999:mydate"
}
],
"contentStreamAllowed": "required"
}
],
"typeSecondaryDefinition": [
{
"id": "system:secondary",
"localNamespace": "urn:optimal-systems.de:dmscloud:system",
"description": "decribes the base secondary type",
"baseId": "system:secondary",
"propertyReference": []
},
{
"id": "system:rmDestructionRetention",
"localNamespace": "urn:optimal-systems.de:dmscloud:system",
"baseId": "system:secondary",
"propertyReference": [
{
"value": "system:rmExpirationDate"
},
{
"value": "system:rmStartOfRetention"
},
{
"value": "system:rmDestructionDate"
}
]
}
]
}
|
General
Content
Integrations