Blueprint Developer Manual / Version 2412.0
Table Of Contents
The public API in the module collaboration-project-api for
Projects
and
To-Dos
provides access to Projects/To-Dos for elastic and SQL
implementation. There are a few restrictions when using this API with the
SQL implementation, though:
Todo target
The target of a Todo must be a Project and cannot be an arbitrary Object. Respective methods have been deprecated.
Project properties
The methods
getPropertyandsetPropertyof a Project will only work with String values. These methods have been deprecated for removal.Please use
getAdditionalPropertyandsetAdditionalPropertyinstead. If you need to store a non-String value, you have to convert it to a String representation.String length limits
Due to technical reasons the lengths of all String properties of Projects/To-Dos are limited:
Property Max. Length Project.name 255 bytes Project.description 2500 bytes Project.additionalProperties key 255 bytes Project.additionalProperties value 2500 bytes Todo.description 2500 bytes Table 4.10. Project/Todo String Property Length Limits
Performance considerations
The Projects API has been designed to be used by editors in CoreMedia Studio to collaborate on sets of content items and to-dos. If you plan to use the API programmatically and are expecting heavy load, be aware that every read- and write-operation will hit the database. If you expect heavy read load, you should consider to access the API through a caching layer.
