Honeybee Sync Instructions Schema (2.2.0)

Download OpenAPI specification:Download

Ladybug Tools: info@ladybug.tools URL: https://github.com/ladybug-tools/honeybee-schema License: BSD

Honeybee sync-instructions schema.

AddedInstruction

element_type required	string (GeometryObjectTypes) Enum: "Shade" "Aperture" "Door" "Face" "Room" Types of Honeybee geometry objects.
element_id required	string (Element Id) [ 1 .. 100 ] characters ^[^,;!\n\t]+$ Text string for the unique object ID that has changed.
	Element Name (string) or Element Name (null) (Element Name) Default: null Text string for the display name of the object that has changed.
type	string (Type) Default: "AddedInstruction" Value: "AddedInstruction"

{"element_type": "Shade",
"element_id": "string",
"element_name": null,
"type": "AddedInstruction"
}

ChangedInstruction

element_type required	string (GeometryObjectTypes) Enum: "Shade" "Aperture" "Door" "Face" "Room" Types of Honeybee geometry objects.
element_id required	string (Element Id) [ 1 .. 100 ] characters ^[^,;!\n\t]+$ Text string for the unique object ID that has changed.
	Element Name (string) or Element Name (null) (Element Name) Default: null Text string for the display name of the object that has changed.
type	string (Type) Default: "ChangedInstruction" Value: "ChangedInstruction"
update_geometry	boolean (Update Geometry) Default: true A boolean to note whether the geometry of the object in the new/updated model should replace the base/existing geometry (True) or the existing geometry should be kept (False).
update_energy	boolean (Update Energy) Default: true A boolean to note whether the energy properties of the object in the new/updated model should replace the base/existing energy properties (True) or the base/existing energy properties should be kept (False).
update_radiance	boolean (Update Radiance) Default: true A boolean to note whether the radiance properties of the object in the new/updated model should replace the base/existing radiance properties (True) or the base/existing radiance properties should be kept (False).

{"element_type": "Shade",
"element_id": "string",
"element_name": null,
"type": "ChangedInstruction",
"update_geometry": true,
"update_energy": true,
"update_radiance": true
}

DeletedInstruction

element_type required	string (GeometryObjectTypes) Enum: "Shade" "Aperture" "Door" "Face" "Room" Types of Honeybee geometry objects.
element_id required	string (Element Id) [ 1 .. 100 ] characters ^[^,;!\n\t]+$ Text string for the unique object ID that has changed.
	Element Name (string) or Element Name (null) (Element Name) Default: null Text string for the display name of the object that has changed.
type	string (Type) Default: "DeletedInstruction" Value: "DeletedInstruction"

{"element_type": "Shade",
"element_id": "string",
"element_name": null,
"type": "DeletedInstruction"
}

GeometryObjectTypes

string (GeometryObjectTypes)

Enum: "Shade" "Aperture" "Door" "Face" "Room"

Types of Honeybee geometry objects.

"Shade"

SyncInstructions

type	string (Type) Default: "SyncInstructions" Value: "SyncInstructions"
	Array of Changed Objects (objects) or Changed Objects (null) (Changed Objects) Default: null A list of ChangedInstruction definitions for each top-level object with properties to transfer from the new/updated model to the base/existing model.
	Array of Deleted Objects (objects) or Deleted Objects (null) (Deleted Objects) Default: null A list of DeletedInstruction definitions for each top-level object to be deleted from the base/existing model.
	Array of Added Objects (objects) or Added Objects (null) (Added Objects) Default: null A list of AddedInstruction definitions for each top-level object to be added to the base/existing model from the new/updated model.

{"type": "SyncInstructions",
"changed_objects": null,
"deleted_objects": null,
"added_objects": null
}