HierarchyNode

A hierarchy node [HierarchyNode] is a node in a classification tree.

Review the Usage Guidelines for the HierarchyNode object.

—	XML	SOAP	REST	Database table
Object	`HierarchyNode`	`oaHierarchyNode`	—	`hierarchy_node`
Supported Commands	`Add`, `Read`, `Modify`, `Delete`	`add()`, `read()`, `modify()`, `upsert()`, `delete()`	—	—

—

XML

SOAP

REST

Database table

Object

HierarchyNode

oaHierarchyNode

—

hierarchy_node

Supported Commands

Add, Read, Modify, Delete

add(), read(), modify(), upsert(), delete()

—

The HierarchyNode object has the following standard properties:

Note:

HierarchyNode object properties may also include custom fields. The object type supports the custom equal to read method and the enable_custom read attribute.

XML / SOAP	Database	Description
`created`	`created`	[Read-only] Time the record was created. See Date Fields.
`externalid`	`external_id`	If the record was imported from an external system, you store the unique external record ID here.
`hierarchyid`	`hierarchy_id`	[Required] The ID of the associated hierarchy.
`id`	`id`	[Read-only] Unique ID. Automatically assigned by OpenAir.
`isalevel`	`is_a_level`	A 1/0 field indicating if this node is a level. Must be `0` if `is_a_node` is set to `1`.
`isanode`	`is_a_node`	A 1/0 field indicating if this node is a level. Must be `0` if `is_a_level` is set to `1`.
`levelid`	`level_id`	The ID of the associated hierarchy level. Must be `0` if `is_a_level` is set to `1`. The level with internal ID `levelid` must also be associated with the hierarchy with internal ID `hierarchyid`.
`name`	`name`	The name of the hierarchy level or node. Required if either `is_a_node` or `is_a_level` is set to `1`.
`notes`	`notes`	Notes related to the hierarchy node.
`parentid`	`parent_id`	The hierarchy_node ID of our immediate ancestor. If `0` or `null`, the object is a top-level node. The parent node with internal ID `parentid` must also be associated with the hierarchy with internal ID `hierarchyid`. If `is_a_node` is set to `1`, there must be a level under the parent's level. Required if `record_id` is set and parent must be a `node`.
`recordid`	`record_id`	The record ID if not a node. Must be `0` if `is_a_level` is set to `1`. Required if both `is_a_node` and `is_a_level` are set to `0`.
`updated`	`updated`	[Read-only] Time the record was last updated or modified. See Date Fields.

XML / SOAP

Database

Description

created

[Read-only] Time the record was created. See Date Fields.

externalid

external_id

If the record was imported from an external system, you store the unique external record ID here.

hierarchyid

hierarchy_id

[Required] The ID of the associated hierarchy.

id

[Read-only] Unique ID. Automatically assigned by OpenAir.

isalevel

is_a_level

A 1/0 field indicating if this node is a level. Must be 0 if is_a_node is set to 1.

isanode

is_a_node

A 1/0 field indicating if this node is a level. Must be 0 if is_a_level is set to 1.

levelid

level_id

The ID of the associated hierarchy level. Must be 0 if is_a_level is set to 1. The level with internal ID levelid must also be associated with the hierarchy with internal ID hierarchyid.

name

The name of the hierarchy level or node. Required if either is_a_node or is_a_level is set to 1.

notes

Notes related to the hierarchy node.

parentid

parent_id

The hierarchy_node ID of our immediate ancestor. If 0 or null, the object is a top-level node. The parent node with internal ID parentid must also be associated with the hierarchy with internal ID hierarchyid. If is_a_node is set to 1, there must be a level under the parent's level. Required if record_id is set and parent must be a node.

recordid

record_id

The record ID if not a node. Must be 0 if is_a_level is set to 1. Required if both is_a_node and is_a_level are set to 0.

updated

[Read-only] Time the record was last updated or modified. See Date Fields.

Usage Guidelines

There cannot be two HierarchyNode objects with the same hierarchyid, parentid and recordid combination.

It is not possible to modify a record – hierarchy node association.