Documentation

Data Requirements ​

Exports ​

Export item as json ​

A single item should be downloadable as a JSON file.

Schemata ​

Custom Field ​

  • ID
    • type: int
    • constraints: unique for type
    • visibility: UI, API
  • Uuid
    • type: varchar(36)
    • constraints: globally unique
    • visibility: X
  • Name
    • type: varchar(255)
    • constraints: X
    • visibility: UI, API
  • CustomFieldValue
    • type: varchar(255)
    • constraints: X
    • visibility: UI, API
    • synonyms: value
  • Description
    • type: text
    • constraints: X
    • visibility: UI, API
  • ItemID
    • note: ID of item to which this custom field belong to.
    • type: int
    • constraints: X
    • visibility: UI (implicitly, because you see it as part of an item)
  • VocableID
    • note: ID of a custom field type.
    • type: int -> vocable id
    • constraints: X
    • visibility: UI, API
    • synonyms: type
  • created
    • type: datetime(3)
    • visibility: X
  • LastModified
    • type: datetime(3)
    • visibility: API

Event ​

  • ID
    • type: int
    • constraints: unique for type
    • visibility: UI, API
  • Uuid
    • type: varchar(36)
    • constraints: globally unique
    • visibility: X
  • VocableID
    • type: int -> vocable id
    • constraints: mandatory (UI, API)
    • visibility: UI, API
    • synonyms: type
  • StartDate
    • type: timestamp
    • constraints: mandatory (UI, API)
    • visibility: UI, API
    • synonyms: Begin date
  • EndDate
    • type: timestamp
    • constraints: mandatory (UI, API)
    • visibility: UI, API
    • synonyms: End date
  • Label
    • type: varchar(255)
    • constraints: mandatory (UI, API)
    • visibility: UI, API
    • synonyms: End date
  • Description
    • type: varchar(1024)
    • constraints: X
    • visibility: UI, API
  • Latitude
    • type: double
    • constraints: X
    • visibility: UI, API
  • Longitude
    • type: double
    • constraints: X
    • visibility: UI, API
  • ElevationInMeter
    • type: double
    • constraints: X
    • visibility: UI, API
  • created
    • type: datetime(3)
    • visibility: X
  • LastModified
    • type: datetime(3)
    • visibility: API

Item ​

  • ID
    • type: int
    • constraints: unique for type
    • visibility: UI, API
  • Uuid
    • type: varchar(36)
    • constraints: globally unique
    • visibility: API
  • ItemStatusID
    • type: int -> vocable id
    • constraints: mandatory
    • visibility: UI, API
    • synonyms: Status
  • ItemID
    • note: points to a potential parent item
    • type: int -> item id
    • constraints: must not point to an item successor
    • visibility: UI, API
    • synoyms: Parent Item
  • ReferenceFrameID
    • type: int -> reference_frame id
    • visibility: UI, API
    • constraints: max one frame per item
    • synonyms: Frame
  • ShortName
    • type: varchar (50)
    • constraints:
      • mandatory
      • ^[a-zA-Z0-9]{1}[a-zA-Z0-9_-]{1,49}$
      • must be unique on hierarchy layer (no sibling with same short name)
    • visibility: UI, API
    • synoyms: Short name
  • LongName
    • Type: varchar (255)
    • constraints: mandatory, min=3, max=255
    • visibility: UI, API
    • synonyms: Long name
  • Description
    • type: text
    • visibility: UI, API
  • SerialNumber
    • type: varchar (255)
    • visibility: UI, API
    • synonyms: Serial
  • Manufacturer
    • type: varchar (255)
    • visibility: UI, API
  • OperationInstructions
    • type: varchar (255)
    • visibility: X
  • Model
    • type: varchar (255)
    • visibility: UI, API
  • InventoryNumber
    • type: varchar (255)
    • visibility: UI, API
    • synonyms: Asset number
  • Urn
    • type: varchar(255)
    • constraints: unique
    • visibility: UI, API
    • synonyms: Code
  • created
    • type: datetime(3)
    • visibility: X
  • Version
    • type: bigint
    • visibility: API
  • LastModified
    • type: datetime(3)
    • visibility: UI, API
  • Citation
    • type: text
    • visibility: UI, API
  • VocableID
    • note: references the type of this item
    • type: int -> vocable id
    • visibility: UI, API
    • synonyms: type

ItemCollection ​

  • ID
    • type: int
    • constraints: unique for type
    • visibility: UI, API
  • Uuid
    • type: varchar(36)
    • constraints: globally unique
    • visibility: API
  • CollectionName
    • type: varchar(255)
    • constraints: NOT NULL
    • visibility: API
    • synonyms: name
  • Description
    • type: varchar(255)
    • constraints: X
    • visibility: API
    • synonyms: X
  • created
    • type: datetime(3)
    • visibility: X
  • LastModified
    • type: datetime(3)
    • visibility: UI, API

Mission ​

  • ID
    • type: int
    • constraints: unique for type
    • visibility: UI, API
  • Uuid
    • type: varchar(36)
    • constraints: globally unique
    • visibility: API
  • Name
    • type: varchar(255)
    • constraints: NOT NULL, unique
    • visibility: UI, API
  • StartDate
    • type: datetime(3)
    • constraints: NOT NULL
    • visibility: UI, API
  • EndDate
    • type: datetime(3)
    • constraints: NOT NULL
    • visibility: UI, API
  • Description
    • type: text
    • constraints: unique
    • visibility: UI, API
  • ParentMissionID
    • type: int
    • constraints: X
    • visibility: X
  • created
    • type: datetime(3)
    • visibility: X
  • LastModified
    • type: datetime(3)
    • visibility: UI, API

OnlineResource ​

  • ID
    • type: int
    • constraints: unique for type
    • visibility: UI, API
  • Uuid
    • type: varchar(36)
    • constraints: globally unique
    • visibility: API
  • Name
    • type: varchar(255)
    • constraints: NOT NULL
    • visibility: UI, API
  • Linkage
    • type: varchar(255)
    • constraints: X
    • visibility: X
  • DESCRIPTION
    • type: varchar(255)
    • constraints: X
    • visibility: UI, API
  • filename
    • type: varchar(255)
    • constraints: X
    • visibility: UI, API
  • checksum
    • type: varchar(128)
    • constraints: X
    • visibility: API
  • mimetype
    • type: varchar(255)
    • constraints: X
    • visibility: UI (implicitly, if the file name contains the file type, like "test.png"), API
  • filesize
    • type: int
    • constraints: X
    • visibility: API
  • VocableID
    • note: references the type of this resource (article, manual, ...)
    • type: int -> vocable id
    • constraints: X
    • visibility: API
  • created
    • type: datetime(3)
    • visibility: X
  • LastModified
    • type: datetime(3)
    • visibility: UI, API

SensorOutput (Parameter) ​

  • ID
    • type: int
    • constraints: unique for type
    • visibility: UI, API
  • Uuid
    • type: varchar(36)
    • constraints: globally unique
    • visibility: API
  • UnitOfMeasurementID
    • type: int -> unit id (m, cm, ...)
    • constraints: NOT NULL
    • visibility: API
  • VocableID
    • note: references the type of this SensorOutput (co2, concentration, ...)
    • type: int -> vocable id
    • constraints: NOT NULL
    • visibility: API
  • Name
    • type: varchar(255)
    • constraints: NOT NULL
    • visibility: UI, API
  • Shortname
    • type: varchar(255)
    • constraints: NOT NULL
    • visibility: UI, API
  • Comment
    • type: text
    • constraints: X
    • visibility: UI, API
  • PangaeaParameterId
    • type: int
    • constraints: X
    • visibility: UI, API
  • ItemID
    • note: references the item to which this SensorOutput belongs to
    • type: int -> item id
    • constraints: X
    • visibility: UI (implicitly, because it is accessible via item)
  • created
    • type: datetime(3)
    • visibility: X
  • LastModified
    • type: datetime(3)
    • visibility: UI, API

Picture ​

  • ID
    • type: int
    • constraints: unique for type
    • visibility: UI, API
  • Uuid
    • type: varchar(36)
    • constraints: globally unique
    • visibility: API
  • FileFormat
    • type: varchar(255)
    • constraints: X
    • visibility: X (deprecated, replaced by mimetype)
  • Picture
    • type: binary(255)
    • constraints: X
    • visibility: X
  • Description
    • type: varchar(255)
    • constraints: X
    • visibility: UI, API
  • PathToFile
    • type: varchar(255)
    • constraints: X
    • visibility: X
  • PathToThumbnail
    • type: varchar(255)
    • constraints: X
    • visibility: X
  • filename
    • type: varchar(255)
    • constraints: X
    • visibility: UI, API
  • checksum
    • type: varchar(128)
    • constraints: X
    • visibility: API
  • mimetype
    • type: varchar(255)
    • constraints: X
    • visibility: API
  • filesize
    • type: int
    • constraints: X
    • visibility: API
  • ItemID
    • note: references the item to which this image belongs to
    • type: int -> item id
    • constraints: X
    • visibility: UI (implicitly, because the image is shown as part of an item)
  • created
    • type: datetime(3)
    • visibility: X
  • LastModified
    • type: datetime(3)
    • visibility: UI, API

MeasurementProperty (Property) ​

  • ID
    • type: int
    • constraints: unique for type
    • visibility: UI, API
  • Uuid
    • type: varchar(36)
    • constraints: globally unique
    • visibility: API
  • VocableID
    • note: references the type of this MeasurementProperty (co2, concentration, ...)
    • type: int -> vocable id
    • constraints: NOT NULL
    • visibility: UI, API
  • UnitOfMeasurement
    • type: int -> unit id
    • constraints: NOT NULL
    • visibility: UI, API
  • MeasurementName
    • type: varchar(255)
    • constraints: NOT NULL
    • visibility: UI, API
    • synonyms: name
  • LowerBound
    • type: double
    • constraints: NOT NULL
    • visibility: UI, API
    • synonyms: lower
  • UpperBound
    • type: double
    • constraints: NOT NULL
    • visibility: UI, API
    • synonyms: upper
  • created
    • type: datetime(3)
    • visibility: X
  • LastModified
    • type: datetime(3)
    • visibility: UI, API

Reference Frame ​

  • ID
    • type: int
    • constraints: unique for type
    • visibility: UI, API
  • Uuid
    • type: varchar(36)
    • constraints: globally unique
    • visibility: API
  • UnitOfMeasurementID
    • type: int -> unit id
    • constraints: NOT NULL
    • visibility: UI, API
    • synonyms: unit
  • XValue
    • type: double
    • constraints: X
    • visibility: UI, API
    • synonyms: "X"
  • XDescription
    • type: varchar(255)
    • constraints: X
    • visibility: UI, API
  • YDescription
    • type: varchar(255)
    • constraints: X
    • visibility: UI, API
  • ZDescription
    • type: varchar(255)
    • constraints: X
    • visibility: UI, API
  • OriginDescription
    • type: varchar(255)
    • constraints: X
    • visibility: UI, API
    • synonyms: description
  • YValue
    • type: double
    • constraints: X
    • visibility: UI, API
    • synonyms: "Y"
  • ZValue
    • type: double
    • constraints: X
    • visibility: UI, API
    • synonyms: "Z"
  • created
    • type: datetime(3)
    • visibility: X
  • LastModified
    • type: datetime(3)
    • visibility: UI, API

Vocable ​

  • ID
    • type: int
    • constraints: unique for type
    • visibility: UI, API
  • Uuid
    • type: varchar(36)
    • constraints: globally unique
    • visibility: API
  • VocableGroupID
    • note: references the group to which this vocable belongs to (i.e. contact roles)
    • type: int -> vocableGroup id
    • constraints: NOT NULL
    • visibility: API
  • VocabularyID
    • note: I.e "AWI", "NERC", ...
    • type: varchar(255)
    • constraints: X
    • visibility: API
    • synonyms: vocabulary
  • VocableValue
    • type: varchar(255)
    • constraints: NOT NULL
    • visibility: UI, API
  • GeneralName
    • type: varchar(255)
    • constraints: NOT NULL, unique per vocableGroup
    • visibility: UI, API
  • Description
    • type: text
    • constraints: X
    • visibility: API
  • SystemName
    • type: varchar(255)
    • constraints: NOT NULL, unique per vocableGroup
    • visibility: API
  • created
    • type: datetime(3)
    • visibility: X
  • LastModified
    • type: datetime(3)
    • visibility: UI, API

VocableGroup ​

  • ID
    • type: int
    • constraints: unique for type
    • visibility: API
  • Uuid
    • type: varchar(36)
    • constraints: globally unique
    • visibility: API
  • Name
    • type: varchar(255)
    • constraints: NOT NULL, unique
    • visibility: API
  • SystemName
    • type: varchar(255)
    • constraints: NOT NULL, unique
    • visibility: API
  • created
    • type: datetime(3)
    • visibility: X
  • LastModified
    • type: datetime(3)
    • visibility: API

UnitOfMeasurement ​

  • ID
    • type: int
    • constraints: unique for type
    • visibility: API
  • Uuid
    • type: varchar(36)
    • constraints: globally unique
    • visibility: API
  • Code
    • type: varchar(255)
    • constraints: NOT NULL
    • visibility: UI, API
  • LongName
    • type: varchar(255)
    • constraints: X
    • visibility: API
    • synonyms: name
  • TypicalUse
    • type: text
    • constraints: X
    • visibility: API
  • UCUM
    • type: varchar(32)
    • constraints: X
    • visibility: API
  • MathML
    • type: varchar(64)
    • constraints: X
    • visibility: API
  • visible
    • type: tinyint(1)
    • constraints: NOT NULL
    • visibility: API
  • created
    • type: datetime(3)
    • visibility: X
  • LastModified
    • type: datetime(3)
    • visibility: API

Unique constraints ​

Registry IDs ​

IDs in registry must be unqiue for the respective entity type. EXAMPLE: There must not be any two items with the same id.

There can be entities from another type that have the same id. EXAMPLE: There can be an item with id 90 and an event with id 90.

Registry UUIDs ​

UUIDs must be globally unique.

Short Names ​

There must not be any hierarchy path doublets. EXAMPLE: two items with code vessel:he:tsg should be forbidden.

There can be n items with short name tsg.