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 | - | Regno unique document identifier. |
type | Fixed String | No | ConfigDefsDoc | Type of the document, resolved from fixed document types. |
identityDocIds | String[] | No | - | An array of the unique identifiers (id) of each associated IdentityDoc. |
configDocId | String | Yes | - | The unique identifier (id) of the ConfigDoc document that this document is associated with. |
defDocIds | String[] | No | - | An array of the unique identifiers (id) for each of the type specific definition documents that are referenced. |
defDocType | Fixed String | Yes | EventDefDocIds | The type of the definition document for which ids are stored. Valid Options are: EventDefDocIds, CanBusDefDocIds, TriggerDefDocIds |
defDocSubTypes | String[] | No | - | An array of the sub types associated with the type of the definition document. |
Sample JSON
Below is a sample JSON representation of the ConfigDefsDoc structure:
▼ ConfigDefsDoc Sample JSON
{
"configDocId": "-",
"defDocIds": [
"string-value"
],
"defDocSubTypes": [
"string-value"
],
"defDocType": {
"$type": "Fixed String"
},
"id": "-",
"identityDocIds": [
"string-value"
],
"type": {
"$type": "Fixed String"
}
}