Informational - ConfigDefsDoc

TheConfigDefinitionsDoc document is an informational document that defines the collection of definition documents that are used by the child documents in a given Configuration Document Collection.

Field Data Type Required Default Description
id String Yes - A unique identifier that is referenced by all other documents see section Unique Id Generation.
configDocId String Yes - The unique identifier (id) of the ConfigDoc document that this document is associated with.
defDocIds Array [String] No - An array of the unique identifiers (id) for each of the type specific definition documents that are referenced.
defDocType String Yes - Type of the ConfigDefinitionsDoc valid values are EventDefDocIds, CanBusDefDocIds.
defDocSubTypes Array [String] No - An array of sub types of the specified definition type.
The field is a free-form array of strings that provide an extension for definition types.
identityDocIds String No - An array of the unique identifiers (id) of each associated IdentityDoc document.
type Fixed String Fixed ConfigDefsDoc The fixed value is always set to ConfigDefsDoc.