Common Datanode properties
All data structures in RealEquity, which are based on a Datanode definition, will have the following common properties:
| Property | Type | Description |
|---|---|---|
| comment | String | The Comment property is specific to the current version of the Datanode. If a new version of the Datanode is created, the comment property for that version will be empty (until added). |
| createdAt | DateTimeOffset | The date and time the Datanode was created. |
| createdById | Guid | The ID of the Actor that created the datanode. |
| createdFromSource | String | A string that can describe where the datanode was created from. |
| dataStoreId | Guid | The ID of the datastore where the datanode is stored. |
| displayName | String | The display name of the Datanode. |
| externalReferences | Array | A collection of External Reference IDs. See External Reference IDs for more information. |
| id | Guid | The unique ID of the Datanode. |
| imageUrl | Url | Any internal or external referenced URL to the Primary Picture representation of the Datanode. |
| isCurrent | Boolean | If isCurrent is true, the data is from the last and current version of the Datanode. |
| isDeleted | Boolean | If IsDeleted is true, the Datanode has been deleted from the system, but are still available to support proper archiving based on the current law. |
| isPrepare | Boolean | if set to true, the Datanode will be in a temporary state until Commit is called on the Datanode. Datanodes in a Prepare state will not be populated to search indexes.* isPrepare can only be set to true during creation of the Datanode. See Prepare state on a Datanode for more information. |
| isPrimary | Boolean | The Datanode is selected as the primary Datanode within the configured scope for the Datanode type. |
| isVerified | Boolean | The content of the Datanode have been explicitly verified. |
| lastUpdatedAt | DateTimeOffset | The date and time the Datanode was last updated. |
| lastUpdatedById | Guid | The ID of the Actor that updated the datanode the last time. |
| minorVersion | Integer | The minor version of the Datanode. The minor version changes, if the Datanode is enriched with new information, but the primary data was not changed. |
| namespace | String | The namespace of the Datanode. |
| parentId | Guid | The ID of the parent Datanode. |
| parentNamespace | String | The namespace of the parent Datanode. |
| resourceGroupId | Guid | The ID of the ResourceGroup that owns the Datanode. |
| rootId | Guid | The ID of the root Datanode. This is the Datanode that owns all Datanodes in the root Datanodes Datatree. |
| rootNamespace | String | The namespace of the root Datanode. |
| scopeId | Guid | The ID of the scope Datanode. A Datanode can be a member of a specific scope in a Datatree. |
| scopeNamespace | String | The namespace of the scope Datanode. |
| stateCategoryNamespace | String | The namespace of the current StateCategory for the Datanode. |
| stateFlowNamespace | String | The namespace of the StateFlow that the Datanode is using. |
| stateNamespace | String | The namespace of the current State for the Datanode. |
| stateReasonNamespace | String | The namespace of the current State changed Reason for the Datanode. |
| tags | Array | Contains an array of tagNamespace (string) properties. The tagNamespace should contain any valid configured (in CoCo) Tag Namespace. See Add Tags To DataNode and Remove Tags From DataNode. |
| verificationExecutedAt | DateTimeOffset | A timestamp for when the Verification step was executed. The execution data can be different from the lastUpdatetAt, due to the fact that the validation can have happened in the past. |
| verificationStateNamespace | String | The namespace of the current verification state. See Set Verification State for more information. |
| version | Integer | The major version of the Datanode. Whenever primary data on the Datanode changes, the version will be incremented. |
Requesting a Datanode
Any Datanode type can be fetched from a common endpoint:
GET {{api}}/api/tenants/{{tenantId}}/resourcegroups/{{resourceGroupId}}/datanodes/{{datanodeId}}
Creating a Datanode
POST {{api}}/api/tenants/{{tenantId}}/resourcegroups/{{resourceGroupId}}/datanodes/
The minimum information required to create a Datanode are a displayName and namespace. If the Datanode needs to be created as a child to another Datanode, the parent datanode id and namespace needs to be provided as well.
Request body example
{
"displayName": "Multi polygon",
"namespace": "dk.realequity.ie.polygon.default",
"parentId": "cd61719a-3437-4f52-a393-75daf9d40b96",
"parentNamespace": "dk.realequity.actor.contact.person"
}
Any Datanode type can be created using a common endpoint:
Specialized endpoints
Most Datanode types have their own endpoints that can be used to work more specifically with the data of that Datanode type.
Change Datanode Type
It is possible to change the Datanode Instance Type (defined by the Namespace of the Datanode). The Datanode Instance Type can only be changed to another specialization of the Datanodes current Instance Type.
An example: If the Datanode is a dk.realequity.ie.emailaddress.default, it can only be changed to other instance types of the Email Address IE Base Type. So in this case it could be changed to: dk.realequity.ie.emailaddress.secret.
This can also be used to change the Instance Type of a File IE Base Type. This will make it possible to change the Instance Type from a default file type, to a specific type as ex: dk.realequity.ie.file.bbrmeddelelse
Comment on a Datanode
Each version of a Datanode can have one Comment saved in the comment property.
Adding a Comment to a Datanode
There is a specific endpoint for adding a Comment to a Datanode. The endpoint can be found here: Add Comment To DataNode.
Getting Comments for all Datanode Versions
By calling the Get Comments For DataNode, the Comment property for all versions of the Datanode is returned.