Overview

Entity Felds

Documaster Noark5 API entities have two types of fields :

  • Data Fields - fields which contain properties of the entity.
    • Data fields support the following types : string, date, timestamp, number and boolean.
  • Reference Fields - fields which represent links to other entities in the model, like foreign keys in a relational database model (prefixed with ref). A reference field can represent a one to one or one to many relations.

Each entity has a specific set of data and reference fields which are listed on the entity’s page in this documentation.

entities-fields

On the diagram above, Fonds (Arkiv) entity references the Fonds Creator (Arkivskaper) through its reference field refArkivskaper and the list of Series (Arkivdel) through the reference field refArkivdel.

Common Data Fields

Following the Noark5 specification requirements and the internal implementation details the following set of data fields are present for all entities :

Field Name Type Noark Metadata No. Required on Create Value Always Available Modifiable Description
id string unique entity identifier in the specific Documaster installation, used for referencing the entity in the API. The id for created entities is a numeric value.
Default : new value generated on creation
Sortable
version string contains the verions of the entity, used for optimistic locking
Default : sequence version number of the entity
uuid string M001 globally unique identification of the entity, an UUID value (sysemId)
Default : new value generated on creation
Indexed, Sortable
opprettetDato timestamp M600 date and time at which the entity was created (createdDate)
Default : current date time
Indexed, Sortable
opprettetAv string M601 name of the user that created the entity (createdBy)
Default : logged in user name
Sortable
opprettetAvBrukerIdent string M601 identifier of the user that created the entity (createdByIdent)
Default : logged in user identifier
Sortable

Modifiable field set to no indicates that the field cannot be set or updated. Modifiable set to cond indicates that special permissions are required to update the field, but this is not common practice.

Entities Model - Complete View

Below is a complete diagram of all the entities and the major relations between the core set of entities. In darker colours are the entities which are used most in archival structures. In lighter colours are those which are satelite entities or such that are of lower importance.

entities-overview