Version 0.9.0
Search
⌃K
Links

7 Data Structures

7.1 Standards/Protocols

The following standards are applicable to data structures in the registration building block:
  1. 1.
    All dates should follow ISO 8601.
  2. 2.
    RFC 7159 - The JavaScript Object Notation (JSON)
  3. 3.
    Open -API Version 3.1.0

7.2 Resource Model

The resource model shows the relationship between data objects that are used by this Building Block.
Resource Model:
Illustration 3- Resource model. See editable image here.

7.3 Data Elements

The Data Elements provide detail for the Resource Model defined above. This section will list the core/required fields for each resource. Note that the Data Elements can be extended for a particular use case, but they must always contain, at the minimum, the fields defined here.
Minimum Required Data:
Name
Description
Type
Required
Text
Database ID
Unique identifier of a database
integer
yes
Database name
Name that will define the database content. Name is public.
varchar
yes
Database schema
Database schema. See example in Appendix 1, Appendix 2.
json
yes
Database logo
Visual image for the database
bytea
no
Version
Database version. Each change in schema will produce the next version of the database and API services.
numeric
yes
Catalogue name
Database name in the list
varchar
yes
Data ID
Data element unique identifier
integer
yes
Registry number
Additional registry identifier. Unique identifier in the registry.
varchar
yes
Field type
Field type: datetime, date, boolean, text, number, file
varchar
yes
Field value
Field value, data stored in the field.
datetime, date, boolean, text, number
yes
Audit log old value
Field value before change
datetime, date, boolean, text, number
yes
Audit log new value
Field value after the change
datetime, date, boolean, text, number
yes
Copyright © 2022