DE EN EN (Google)

Object

An object represents an instance of a certain objecttype, which is defined in the user schema. Objects have a set of common properties, which are independent of the objecttype definition.

Attributes

Name Description Search
_format Format of this record (string, r): full, long, standard or short (see below)
_schema_version User schema version this object was generated with (integer, r)
_objecttype Name of the objecttype (string, r): ref table-definition.name NotAnalyzed
_system_object_id System object ID (string, unique ID for this easydb instance, r) Number
_global_object_id Global object ID (string, unique ID for all easydb instances, r): see below NotAnalyzed
_uuid Universal Unique ID (string, unique ID for all easydb instances, r) NotAnalyzed
_acl ACL (array of acl entries, rw, optional) (*)
_has_acl Whether this object has a non-empty ACL (boolean, r) Boolean
_private_acl Marks the ACL as private (see rights management) (bool, rw, optional): defaults to false
_tags Tags (array of tags, rw, optional*): only _id is rendered; _id is searchable Number
_collections Collections this object is in (array of objects with _id), r): _id is searchable Number
_has_children Whether this object has children (boolean, r): only for hierarchical objects Boolean
_level Depth of this object in the hierarchy (integer, r): only for hierarchical objects Number
_path Hierarchy path, starting from the root (array of objects, r): only for hierarchical objects (*)
_standard Information for standard rendering (standard object, r): see below
_mask Mask the object was rendered with (string, rw*): ref mask.name NotAnalyzed
_comment Comment to be saved in changelog (string, w)
_owner Owner (group (short) or user (short), rw): see below
_changelog History of changes performed on this object (array of changelog entries, sorted by version)
_generated_rights Rights that this user has for the object (rights specification): see below
_current_version Whether this object is in the current version (bool, r) Boolean
_last_modifed Last modified date in UTC (string, r) Timestamp
_published List of publishing information objects (array, r)
_id ID of publishing information object (integer, r)
version Version requested to publish
timestamp_created Date and time of publishing (string, r) Timestamp
collector Name of collector (string, r) String
publish_uri External URI where the object is published (string, r) String
easydb_uri easydb URI used for publishing (string, r) String
_published_count Number of publishing information objects Integer
<object-type-name> Object attributes (the attribute name is the value of _objecttype): see below

(*) Remarks:

The following fields can be used when searching:

Name Description Search
_changelog
date_created Creation date of the user object Timestamp
date_last_updated Date of last update Timestamp
user_created User that created the object Number
user_last_updated User that updated the object the last time Number
comment Comment that was provided for an insert/update Text

Generated rights

The _generated_rights are the rights that the user has for a particular object. They allow to build the possible actions into the client. The following is a list of all possible rights:

The _generated_rights are always provided by /api/db. /api/search provides them on demand (attribute generate_rights).

Format

Objects can be rendered in three different formats. The full format contains all fields, as described here.

The short format contains:

The standard format contains the same fields as short plus:

The long format contains all fields, except:

Global object ID

The global object ID is composed of a system ID and an instance name ("<system_object_id>@<instance_name>"). It allows to identify an object uniquely across all Easydb instances. When performing a search, the instance name can be replaced by the alias "local", but the response will always contain the instance name.

Owner

An object alway has a valid owner. On object creation, the server initializes this field to the user creating the object, but it won’t complain if the API call sets the same value. If the user attempts to set a different owner, the error 403 Change Owner On Creation is returned. When updating an object, the owner has to be provided, and it cannot be set to null.

The owner of an object has the following rights:

Standard object

The standard object is rendered according to the mask. It contains up to 3 levels of textual representation (text and HTML) plus up to 2 levels of assets. The number of actual levels depends on the mask. The keys <level> are strings that contain the level number (“1”, “2”, “3”).

Name Description Search
<level> Level of textual representation (can be interpreted as title, subtitle and description, for example)
text - as plain text (l10n) L10n
html - as HTML (l10n)
eas Standard assets
<level> Level of asset representation (can be interpreted as main and detailed, for example)
The asset record has a subset of the attributes of an asset (see asset):
↦ ↦ _id
↦ ↦ class
↦ ↦ extension
↦ ↦ class_extension
↦ ↦ compiled
↦ ↦ technical_metadata
↦ ↦ filesize
↦ ↦ original_filename
↦ ↦ versions
↦ ↦ ↦ small
↦ ↦ ↦ ↦ status
↦ ↦ ↦ ↦ url
↦ ↦ ↦ ↦ width
↦ ↦ ↦ ↦ height
↦ ↦ ↦ preview
↦ ↦ ↦ ↦ status
↦ ↦ ↦ ↦ url
↦ ↦ ↦ ↦ width
↦ ↦ ↦ ↦ height

Object attributes

There are some common attributes, which begin with “_” and user-defined attributes. The latter depend on the mask used for rendering (_mask). All are located under <object-type-name>:

Name Description Search
_id Object ID (integer, r, unique for a given object type)
lookup:_id Lookup for ID of a linked object, see below
_version Object version (integer, rw) Number
_id_parent Parent object ID (integer, rw, optional): ID of the parent (only for hierarchical objects) Number
lookup:_id_parent Lookup for ID of parent object, see below
_pool Pool this object is in (pool (short), rw*): only for objects with pool link Number (*)
<field_name> Value of the field field_name, the format depends on the field type (see comments below) (see below)

Pool:

When the attribute pool_link is set for the objecttype (see Schema), the _pool field is used to get/set the pool this object is in. When updating an object’s pool, only _pool.pool._id is set, but the record is returned as a complete pool record. The fields _pool._id and _pool._path.pool._id are searchable as Number.

Lookup for Pool ID:

To assign a pool to an object, it is possible to lookup the pool id using the reference field of the pool. See Lookups for Pool ID.

Lookup for ID of linked object:

Perform a lookup for the ID of a linked object in the current table.

See detailled information about lookups.

Parent ID:

When the attribute is_hierarchical is set for the objecttype (see Schema), the _id_parent field is used to get/set the parent of this object. For top-level objects, set this field to null or do not set it.

Lookup for ID of parent object:

Perform a lookup for the parent ID of a object in the current table. This is used to add the parent-child-relation to a hierarchical user object.

See detailled information about lookups.

Fields

The value of the fields depend on the kind and type defined for them (see Schema):

Kind “column”:

Regular columns have a field_name equal to the column name.

Field type Value type (JSON) Search
integer integer Number
serial integer Number
decimal.2 decimal Number
boolean boolean Boolean
text string Text
text_oneline string Text
text_l10n L10n L10n
text_l10n_oneline L10n L10n
string string String
date Date Date
date_range Date Range Date
date_time Date Date
eas array of assets, one for each version Nested (*)
link Object in standard format
custom JSON object, as defined by the Custom Data Type plug-in Custom

Notice that the column “Search” specifies the indexing type for the field, but a specific field can be not searchable for a certain user because of the mask.

Whether the field can be searched in “all” or not depends on the configuration of the mask (option “fulltext”).

(*) see Asset to find out which fields are indexed and how

Kind “link”:

Links have the following field_name:

The value is an array of objects. The composition of the objects depends on the linked mask and follows the rules of “Fields”.