Page Properties | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||
Resources & Remarks
Modification History
|
...
Retrieval | Validation | Update | |
---|---|---|---|
global schema | GET /api/system/schema | POST /api/system/schema/validate | POST /api/system/schema |
app schema | GET /api/system/apps/{app}/schema | POST /api/system/apps/{app}/schema/validate | POST /api/system/apps/{app}/schema |
tenant schema of any tenant | GET /api/system/tenants/{tenant}/schema | POST /api/system/tenants/{tenant}/schema/validate | POST /api/system/tenants/{tenant}/schema |
tenant schema of the own tenant | POST /api/admin/schema/validate | POST /api/admin/schema |
Anchor | ||||
---|---|---|---|---|
|
Naming Conventions for Property and Object Type IDs
...
Note | ||
---|---|---|
| ||
As of 2023 Spring, the predefined object type |
Custom document object type definitions have the following specific attributes:
...
As of 2023 Spring, the predefined object type system:document
automatically has a floating reference on all SOTs that are available in the applied tenant schema. Nevertheless, the rules for the contentStreamAllowed
attribute for the the individual SOTs have to be considered before they are assigned to an object.
The property groups of static referenced secondary object types are automatically available in all instances of the object type. Floating secondary object types can be handled in a flexible way during the import (POST /api/dms/objects endpoint) or at runtime for already existing instances of an object type with an update (POST /api/dms/objects/{objectId} / PATCH /api/dms/objects/{objectId}). The keywords "add":,
"value":
or "remove":
can be used in the "system:secondaryObjecttypeIds":
property area of the metadata.json filecan.
...
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 |
...
type | message | id | reference | Description and Impact of Schema Update |
---|---|---|---|---|
1000 | Document type was removed. | ID of the removed document type | - | As it is not possible to replace the object type of existing objects, it is not possible to adjust affected objects. They cannot be updated anymore. |
1001 | Folder type was removed. | ID of the removed folder type | - | See impacts of change type 1000. |
1100 | A secondary object type reference was removed from a document type. | ID of the document type | ID of the secondary object type | If the corresponding SOT includes required properties, see the impacts of change type 1200. |
1101 | A secondary object type reference was removed from a folder type. | ID of the folder type | ID of the secondary object type | If the corresponding SOT includes required properties, see the impacts of change type 1200. |
1110 | A document type got a new static secondary object type reference. | ID of the document type | ID of the secondary object type | A static secondary object type reference was added to an a document type definition. Or an existing non-static secondary object type reference on a document type definition became static. If the corresponding SOT includes required properties, see the impacts of change type 1300. |
1111 | A folder type got a new static secondary object type reference. | ID of the folder type | ID of the secondary object type | A static secondary object type reference was added to an a folder type definition. Or an existing non-static secondary object type reference on a folder type definition became static. If the corresponding SOT includes required properties, see the impacts of change type 1300. |
1200 | A property reference was removed from a document type. | ID of the document type | ID of the property | Any metadata retrieval of affected objects excludes the removed property. Search result lists, e.g., are affected as well. However, the existing values remain in the database and the search index. Thus, in case of a removed string property, the existing values are still considered for full-text search. The corresponding values are removed automatically during the next PATCH or POST update on the affected objects. |
1201 | A property reference was removed from a folder type. | ID of the folder type | ID of the property | See impacts of change type 1200. |
1210 | A property reference was removed from a secondary object type. | ID of the secondary object type | ID of the property | See impacts of change type 1200. |
1300 | A non-required property type became required. | ID of the property | - | POST metadata updates on affected objects are only allowed if the new required property is properly added. |
1310 | A required property reference was added to a document type, or a non-required property reference became required. | ID of the document type | ID of the property | See impacts of change type 1300. |
1311 | A required property reference was added to a folder type, or a non-required property reference became required. | ID of the folder type | ID of the property | See impacts of change type 1300. |
1320 | A required property reference was added to a secondary object type, or a non-required property reference became required. | ID of the secondary object type | ID of the property | See impacts of change type 1300. |
2000 | Content stream becomes required on a document type. | ID of the document type | - | Updates on affected objects are only allowed if a binary content file is thereby added. |
2001 | Content stream becomes not allowed on a document type. | ID of the document type | - | Updates on affected objects are only allowed if a binary content file is thereby deleted. Thus, affected objects with a binary content file under retention cannot be updated via yuuvis® Momentum at all. |
2010 | Content stream becomes required on a secondary object type. | ID of the secondary object type | - | See impacts of change type 2000. |
2011 | Content stream becomes not allowed on a secondary object type. | ID of the secondary object type | - | See impacts of change type 2001. |
3000 | The cardinality of a property becomes 'single'. | ID of the property | - | Updates on affected objects are only allowed if the value of the modified property is properly replaced. Especially, pure tag and content operations are only allowed after a proper update of the metadata. |
...
Info | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||
Read on
|
...