insula

Vector dataset time dynamic data Schema

https://cgi-italy.github.io/insula/schemas/v1.1.1/apps/insula-vector-dataset-time-dynamic-data.schema.json

Definition of a vector dataset time dynamic data. Allows to perform time series on one or more attribute, for which the data is stored in an external collection. All numeric properties of the external collection will be considered as time dynamic attributes.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	No	Forbidden	Allowed	none	insula-vector-dataset-time-dynamic-data.schema.json

Vector dataset time dynamic data Type

object (Vector dataset time dynamic data)

Vector dataset time dynamic data Examples

{
  "nameProperty": "idrometer_name",
  "dataSources": [
    {
      "foreignKey": {
        "sourceAttribute": "id",
        "targetLayer": "idrometer_levels",
        "targetAttribute": "idrometer_id"
      },
      "targetTimeAttribute": "obs_time"
    }
  ]
}

Vector dataset time dynamic data Properties

Property	Type	Required	Nullable	Defined by
dataSources	array	Required	cannot be null	Vector dataset time dynamic data
targetDimensionAttributes	array	Optional	cannot be null	Vector dataset time dynamic data

dataSources

The list of tyme dynamic attributes data sources

dataSources

• is required

• Type: object[] (Vector time dynamic data source)

• cannot be null

• defined in: Vector dataset time dynamic data

dataSources Type

object[] (Vector time dynamic data source)

targetDimensionAttributes

Define the target collection attributes to use as dimensions. Dimensions should be defined in the featureAttributes of the target collections specificied in the dataSources. All data sources should share the same definition.

targetDimensionAttributes

• is optional

• Type: array (Target dimension attributes)

• cannot be null

• defined in: Vector dataset time dynamic data

targetDimensionAttributes Type

array (Target dimension attributes)

Vector dataset time dynamic data Definitions

Definitions group timeDynamicDataSource

Reference this group by using

{"$ref":"https://cgi-italy.github.io/insula/schemas/v1.1.1/apps/insula-vector-dataset-time-dynamic-data.schema.json#/$defs/timeDynamicDataSource"}

Property	Type	Required	Nullable	Defined by
foreignKey	object	Required	cannot be null	Vector dataset time dynamic data
targetTimeAttribute	string	Required	cannot be null	Vector dataset time dynamic data
targetAttributes	array	Optional	cannot be null	Vector dataset time dynamic data

foreignKey

Define the relation between the source and the target collection. In SQL terms: FOREIGN KEY(sourceAttribute) REFERENCE targetCollection(targetAttribute)

foreignKey

• is required

• Type: object (Time dynamic data foreign key)

• cannot be null

• defined in: Vector dataset time dynamic data

foreignKey Type

object (Time dynamic data foreign key)

targetTimeAttribute

The target collection attribute to be used as time. Shall be of ‘date’ type

targetTimeAttribute

• is required

• Type: string (Target collection time attribute)

• cannot be null

• defined in: Vector dataset time dynamic data

targetTimeAttribute Type

string (Target collection time attribute)

targetAttributes

targetAttributes

• is optional

• Type: an array of merged types (Vector feature property)

• cannot be null

• defined in: Vector dataset time dynamic data

targetAttributes Type

an array of merged types (Vector feature property)

Definitions group timeDynamicDataSourceForeignKey

Reference this group by using

{"$ref":"https://cgi-italy.github.io/insula/schemas/v1.1.1/apps/insula-vector-dataset-time-dynamic-data.schema.json#/$defs/timeDynamicDataSourceForeignKey"}

Property	Type	Required	Nullable	Defined by
sourceAttribute	string	Required	cannot be null	Vector dataset time dynamic data
targetLayer	string	Required	cannot be null	Vector dataset time dynamic data
targetAttribute	string	Required	cannot be null	Vector dataset time dynamic data

sourceAttribute

The id of the attribute in the source collection to use as foreign key

sourceAttribute

• is required

• Type: string (Source property)

• cannot be null

• defined in: Vector dataset time dynamic data

sourceAttribute Type

string (Source property)

targetLayer

The ID of the collection containing the time dynamic data

targetLayer

• is required

• Type: string (Target layer)

• cannot be null

• defined in: Vector dataset time dynamic data

targetLayer Type

string (Target layer)

targetAttribute

The ID of the attribute referenced in the target collection

targetAttribute

• is required

• Type: string (Target attribute)

• cannot be null

• defined in: Vector dataset time dynamic data

targetAttribute Type

string (Target attribute)