Sub Config - SubConfigDoc
The SubConfigDoc document is a configuration document that sits at the highest document level.
Each of the child documents in a Configuration Document Collection reference the SubConfigDoc document.
The SubConfigDoc document provides an overview of the type and structure of data contained in the child documents,
it also acts as a basic meta data container to describe the data stored by this document.
| Field | Data Type | Required | Default | Description |
|---|---|---|---|---|
| id | String | Yes | - | A unique identifier that is referenced by all other documents see section Unique Id Generation. |
| name | String | No | - | A free form string name for the data that this document document holds. |
| description | String | No | - | A free form string description of the data that this document document holds. |
| sourceType | Fixed String | No | Data | A fixed type description of the primary data held by this document. Valid options are: Configuration, Data, Experiment, Simulation, Run, Period, Session, Event, Day, Month, Year, Lap, Audio, Video. |
| group | String | No | - | A free form string describing the group that this document belong to. |
| version | UnsignedInt | No | - | A number representing the sequence number/version of this document. |
| state | String | No | Unknown | A free form string description of the state of this document. This field can be excluded when generating the id. |
| startTime | 64-bit Long | No | - | A 64-bit Long timestamp specifying start time of the data that this document holds. This field is an override of the parent equivalent field. |
| endTime | 64-bit Long | No | - | A 64-bit Long timestamp specifying end time of the data that this document holds. This field is an override of the parent equivalent field. |
| tags | Array [String, String] | No | - | An array of key/pair free form string values. Used to store meta data related to the data stored by this document. |
| type | Fixed String | Fixed | SubConfigDoc | The fixed value is always set to SubConfigDoc. |