Page Properties | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
Resources & Remarks
Modification History
|
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<schema xmlns="http://optimal-systems.org/ns/dmscloud/schema/v5.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://optimal-systems.org/ns/dmscloud/schema/v5.0/ dmsCloud-schema.xsd"> <propertyStringDefinition> <id>from</id> <propertyType>string</propertyType> <cardinality>single</cardinality> <required>true</required> </propertyStringDefinition> <propertyStringDefinition> <id>to</id> <propertyType>string</propertyType> <cardinality>multi</cardinality> <required>true</required> </propertyStringDefinition> <propertyStringDefinition> <id>subject</id> <propertyType>string</propertyType> <cardinality>single</cardinality> <required>true</required> <defaultValue>hello</defaultValue> <maxLength>20</maxLength> <minLength>4</minLength> </propertyStringDefinition> <propertyDateTimeDefinition> <id>received</id> <propertyType>datetime</propertyType> <cardinality>single</cardinality> <required>true</required> </propertyDateTimeDefinition> <typeDocumentDefinition> <id>email</id> <baseId>system:document</baseId> <propertyReference>from</propertyReference> <propertyReference>to</propertyReference> <propertyReference>received</propertyReference> <contentStreamAllowed>required</contentStreamAllowed> </typeDocumentDefinition> </schema> |
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<schema<schema xmlns="http://optimal-systems.org/ns/dmscloud/schema/v5.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://optimal-systems.org/ns/dmscloud/schema/v5.0/ dmsCloud-schema.xsd"> <propertyTableDefinition> <id>aTableProperty</id> <propertyType>table</propertyType> <cardinality>single</cardinality> <required>false</required> <propertyStringDefinition> <id>col0</id> <propertyType>string</propertyType> <cardinality>single</cardinality> <required>false</required> </propertyStringDefinition> <propertyIntegerDefinition> <id>col1</id> <propertyType>integer</propertyType> <cardinality>single</cardinality> <required>false</required> </propertyIntegerDefinition> <propertyDateTimeDefinition> <id>col2</id> <propertyType>datetime</propertyType> <cardinality>single</cardinality> <required>false</required> </propertyDateTimeDefinition> <propertyDecimalDefinition> <id>col3</id> <propertyType>decimal</propertyType> <cardinality>single</cardinality> <required>false</required> </propertyDecimalDefinition> </propertyTableDefinition> </schema> |
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<propertyStructuredDataDefinition> <id>customerdetails</id> <propertyType>structureddata</propertyType> <cardinality>single</cardinality> <required>false</required> </propertyStructuredDataDefinition> |
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<schema xmlns="http://optimal-systems.org/ns/dmscloud/schema/v5.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://optimal-systems.org/ns/dmscloud/schema/v5.0/ dmsCloud-schema.xsd"> <propertyStringDefinition> <id>str1</id> <propertyType>string</propertyType> <cardinality>single</cardinality> <required>true</required> </propertyStringDefinition> <typeDocumentDefinition> <id>documentType1</id> <baseId>system:document</baseId> <propertyReference>str1</propertyReference> <contentStreamAllowed>required</contentStreamAllowed> <secondaryObjectTypeId>secondaryA</secondaryObjectTypeId> </typeDocumentDefinition> <typeFolderDefinition> <id>dossier</id> <baseId>system:folder</baseId> <propertyReference>title</propertyReference> <propertyReference>type</propertyReference> <propertyReference>description</propertyReference> </typeFolderDefinition> </schema> |
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "objects": [ { "properties": { "system:objectTypeId": { "value": "dossier" }, "title": { "value": "My E-mail Folder #1" }, "type": { "value": "E-mails" }, "description": { "value": "This folder holds all the e-mails authored by me" } } } ] } |
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "objects": [ { "properties": { "system:objectTypeId": { "value": "documentType1" }, "system:parentId": { "value": "<the Folder object ID from the import response" }, "str1": { "value": "Some important business documents" }, "description": { "value": "This folder holds all the e-mails authored by me" } } } ] } |
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<schema xmlns="http://optimal-systems.org/ns/dmscloud/schema/v5.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://optimal-systems.org/ns/dmscloud/schema/v5.0/ dmsCloud-schema.xsd"> <propertyStringDefinition> <id>appSot:dateOfReceipt</id> <propertyType>date</propertyType> <cardinality>single</cardinality> <required>true</required> </propertyStringDefinition> <propertyStringDefinition> <id>appSot:comment</id> <propertyType>date</propertyType> <cardinality>single</cardinality> <required>true</required> </propertyStringDefinition> <propertyStringDefinition> <id>appSot:invoiceNo</id> <propertyType>string</propertyType> <cardinality>single</cardinality> <required>true</required> </propertyStringDefinition> <propertyStringDefinition> <id>appSot:paymentTerm</id> <propertyType>string</propertyType> <cardinality>single</cardinality> <required>true</required> </propertyStringDefinition> <typeDocumentDefinition> <id>appSot:document</id> <baseId>system:document</baseId> <propertyReference>appSot:dateOfReceipt</propertyReference> <contentStreamAllowed>required</contentStreamAllowed> <secondaryObjectTypeId>appSot:basicInfo</secondaryObjectTypeId> </typeDocumentDefinition> <typeSecondaryDefinition> <id>appSot:basicInfo</id> <baseId>system:secondary</baseId> <propertyReference>appSot:comment</propertyReference> </typeSecondaryDefinition> <typeSecondaryDefinition> <id>appSot:invoice</id> <baseId>system:secondary</baseId> <propertyReference>appSot:invoiceNo</propertyReference> <propertyReference>appSot:paymentTerm</propertyReference> </typeSecondaryDefinition> </schema> |
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "objects": [ { "properties": { "system:objectId": { "value": "7bce6618-2b0e-4abf-af26-e4137e6b0461" }, "system:baseTypeId": { "value": "system:document" }, "system:objectTypeId": { "value": "appSot:document" }, "system:secondaryObjectTypeIds": { "value": [ " appSot:basicInfo" ] }, <...> " appSot:dateOfReceipt": { "value": "2020-02-20T02:02:20.220Z" }, "appSot:comment": { "value": "Yearly invoice - payment 1 out of 12 monthly payments." } }, "contentStreams": [ <...> ] } ] } |
...
Attribute | Type | Required | Description |
---|---|---|---|
| Enum | no | Can substantiate the For the final document, content will be For the final document, content will be Conflict situation leading to invalid documents: any combination of at least once
If |
...
Property | Type | Description | In an Import/Update Request | In a Response | ||||||
---|---|---|---|---|---|---|---|---|---|---|
contentStreamId | String | Points to existing content within a repository. | Required only for pointing to existing content. If not specified, the system generates a UID. | displayed | ||||||
length | Integer | Length of the binary content, determined by the system. | -displayed | displayed (if system could determine the value) | ||||||
mimeType | String | Mime type of the content file. | Determined by the content analysis, but can be overwritten by user specification in the import body. | displayed | fileName | String | Name of the content file. | Can be set in the request body. If not specified, During an import, fileName will be determined from the content dispositionThe CONTENTANALYZER service can be configured to determine (scenario A) or not determine (scenario B) the If | Scenario A: The CONTENTANALYZER determines In an import request, the automatically determined Scenario B: In an import request via POST /api/dms/objects, In a content update via POST /api/dms/objects/{objectId}/contents/file, | displayed |
fileName | String | Name of the content file. | If In a content update via POST /api/dms/objects/{objectId}/contents/file, In an import request via POST /api/dms/objects, | displayed | ||||||
digest | String | SHA-256, automatically determined from the binary content. | - | displayed | ||||||
repositoryId | String | ID of the repository that will be used for storage of the binary data. | Required only for pointing to existing content. If not specified, the default repository defined in the repository service configuration will be set. | displayed | ||||||
archivePath | String | Additional and optional path structure of the stored object. | Required only for pointing to existing content if reconstruction is not possible with metadata information | displayed only if it was set | ||||||
range | String | Applies to Compound Documents only. Defines a certain segment from compound documents that should be provided for content retrievals. | Optional in the request body and only available for compound documents. | displayed only if it was set | ||||||
ci d | String | Assign the corresponding multipart content. | Required in the import request body. Not needed later on and therefore not stored in the system. | - |
...
The app schema endpoints are:
- POST /api/system/apps/{app}/schema - Introduces provided schema as app within tenant schema, overwrites previous app schema
- GET /api/system/apps/{app}/schema - Retrieves the specified app portion of the tenant schema
- POST /api/system/apps/{app}/schema/validate - Validates a schema based on app schema rules
When uploading an app schema, all properties that do not specify a prefix will have that prefix generated as app<app name> where <app name> is equal to the path parameter {app}.
...
- GET /api/admin/schema - Retrieve the tenant's schema
- POST /api/admin/schema - Update the tenant's schema
- POST /api/admin/schema/validate - Validate the tenant's schema
Each object type ID and property type ID has the prefix t
en
+ <tenant name>
. Thus, the same object type name can occur in multiple tenant schemata.
...
Info | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||
Read on
|
...