Hierarchy

A hierarchy [Hierarchy] is a multilevel classification for users, customers or projects.

-

XML

SOAP

REST

Database table

Object

Hierarchy

oaHierarchy

-

hierarchy

Supported Commands

Add, Read, Modify

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

-

-

The Hierarchy object has the following standard properties:

Note:

Hierarchy 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

active

active

A 1/0 field indicating whether this is designated as an active hierarchy. Defaults to 1 if not set when adding a hierarchy.

available_as_column

available_as_column

A 1/0 field indicating whether this hierarchy is available as a (customer, project or user) list column.

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.

id

id

[Read-only] Unique ID. Automatically assigned by SuiteProjects Pro.

name

name

[Required] The hierarchy name.

notes

notes

Notes related to the hierarchy.

primary_dropdown_filter

primary_dropdown_filter

A 1/0 field indicating if this hierarchy is used as a drop-down filter. Must be 0 if type is project. Only one hierarchy for the same type can be used as a drop-down filter.

primary_user_filterset

primary_user_filterset

A 1/0 field indicating if this hierarchy determines filter set access for projects. Must be 0 if type is project. Only one hierarchy for the same type can be used to determine filter set access for projects.

required

required

A 1/0 field indicating whether this hierarchy should be a required element on the object type form.

requireonform

requireonform

A 1/0 field indicating whether this hierarchy should be added to the object type form.

type

type

The type (table name) of the hierarchy. Possible values: customer, project, or user

updated

updated

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