A label defines a temporary or permanent label on another Datanode. The Label Information Element holds information about a specific Label Type.
Type Namespace
A Label Information Element always have a namespace starting with: dk.realequity.ie.label.*
Properties
The following properties is available besides the standard properties from Information Elements.
| Property | Type | Description |
|---|---|---|
| setSpecificContent | Boolean | Defines if the title, subtitle and description should be used. If set to false, the Instance Type Displayname from the Configuration should be used. Defaults to false. |
| title | String, nullable | The title of the Label. If this is set, this can be used to specify a custom label title instead of the IE Instance Type Displayname. |
| subtitle | String, nullable | Can be used to specify a subtitle for the label instance. This could be a text specifying the day and time of an Open House event. |
| description | String, nullable | Can be used to specify a description for the label instance. |
| isEvent | Boolean | Defines if the Label is of an Event type. This can be used to specify events like Open House. |
| eventFrom | DatetimeOffset, nullable | If isEvent is set to true, this property contains information about when the event starts. |
| eventTo | DatetimeOffset, nullable | If isEvent is set to true, this property contains information about when the event ends. |
| activeFrom | DatetimeOffset, nullable | If this property is set, it defines when the label should be active from. |
| activeTo | DatetimeOffset, nullable | If this property is set, it defines when the label should be active to. |
Creating an Label IE
The request body could look like this:
{
"displayName": "Ny pris",
"namespace": "dk.realequity.ie.label.nypris",
"parentId": "5929c345-559f-4739-9055-2769a69fd65a",
"parentNamespace": "dk.realequity.case.sale"
}
Requesting data for an Label IE
This is an example of the data returned when calling a GET on an Label IE:
{
"title": null,
"subtitle": null,
"description": null,
"isEvent": false,
"eventFrom": null,
"eventTo": null,
"activeFrom": null,
"activeTo": null,
"setSpecificContent": false,
"fileAttachments": [],
"id": "0c40e3e6-0fa0-4b2d-aa8c-ceb008868318",
"version": 1,
"minorVersion": 0,
"namespace": "dk.realequity.ie.label.nypris",
"displayName": "Ny pris",
"parentId": "5929c345-559f-4739-9055-2769a69fd65a",
"parentNamespace": "dk.realequity.case.base",
"rootId": "5929c345-559f-4739-9055-2769a69fd65a",
"rootNamespace": "dk.realequity.case.base",
"scopeId": "5929c345-559f-4739-9055-2769a69fd65a",
"scopeNamespace": "dk.realequity.case.base",
"isPrimary": null,
"isCurrent": true,
"isDeleted": false,
"createdById": "d53dc2e4-a4e4-4bab-8404-d8225feb0f39",
"createdAt": "2020-07-10T12:49:40.6541571+00:00",
"lastUpdatedById": "d53dc2e4-a4e4-4bab-8404-d8225feb0f39",
"lastUpdatedAt": "2020-07-10T12:49:40.6541601+00:00",
"executedById": "d53dc2e4-a4e4-4bab-8404-d8225feb0f39",
"executedAt": "2020-07-10T12:49:40.7263298+00:00",
"stateNamespace": "dk.realequity.state.draft",
"stateReasonNamespace": "dk.realequity.stateflow.default.reason.init",
"stateFlowNamespace": "dk.realequity.stateflow.default",
"stateCategoryNamespace": "dk.realequity.statecategory.preprocessing",
"permissionInheritanceLevel": 0,
"dataStoreId": "28c951fb-efe4-4ba1-9683-0f13a7f7a74e",
"resourceGroupId": "76fcdf02-dc55-40f7-906a-8f00e720fafc",
"externalId": null,
"externalSystemName": null,
"createdFromSource": "B2B Demo",
"hidden": false,
"imageUrl": null,
"informationSensivityLevel": "MaybeSensitiveData",
"customProperties": [],
"sharingRules": []
}